libZSservicesZSamazonka-globalacceleratorZSamazonka-globalaccelerator
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GlobalAccelerator.Lens

Contents

Description

 
Synopsis

Operations

DenyCustomRoutingTraffic

denyCustomRoutingTraffic_destinationAddresses :: Lens' DenyCustomRoutingTraffic (Maybe [Text]) Source #

A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.

denyCustomRoutingTraffic_destinationPorts :: Lens' DenyCustomRoutingTraffic (Maybe [Natural]) Source #

A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic.

denyCustomRoutingTraffic_denyAllTrafficToEndpoint :: Lens' DenyCustomRoutingTraffic (Maybe Bool) Source #

Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

The default value is FALSE.

denyCustomRoutingTraffic_endpointGroupArn :: Lens' DenyCustomRoutingTraffic Text Source #

The Amazon Resource Name (ARN) of the endpoint group.

denyCustomRoutingTraffic_endpointId :: Lens' DenyCustomRoutingTraffic Text Source #

An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

DescribeCustomRoutingListener

describeCustomRoutingListener_listenerArn :: Lens' DescribeCustomRoutingListener Text Source #

The Amazon Resource Name (ARN) of the listener to describe.

CreateCustomRoutingEndpointGroup

createCustomRoutingEndpointGroup_listenerArn :: Lens' CreateCustomRoutingEndpointGroup Text Source #

The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.

createCustomRoutingEndpointGroup_endpointGroupRegion :: Lens' CreateCustomRoutingEndpointGroup Text Source #

The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

createCustomRoutingEndpointGroup_destinationConfigurations :: Lens' CreateCustomRoutingEndpointGroup (NonEmpty CustomRoutingDestinationConfiguration) Source #

Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.

createCustomRoutingEndpointGroup_idempotencyToken :: Lens' CreateCustomRoutingEndpointGroup Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

createCustomRoutingEndpointGroupResponse_endpointGroup :: Lens' CreateCustomRoutingEndpointGroupResponse (Maybe CustomRoutingEndpointGroup) Source #

The information about the endpoint group created for a custom routing accelerator.

DescribeCustomRoutingAcceleratorAttributes

describeCustomRoutingAcceleratorAttributes_acceleratorArn :: Lens' DescribeCustomRoutingAcceleratorAttributes Text Source #

The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.

DeleteCustomRoutingEndpointGroup

deleteCustomRoutingEndpointGroup_endpointGroupArn :: Lens' DeleteCustomRoutingEndpointGroup Text Source #

The Amazon Resource Name (ARN) of the endpoint group to delete.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.

DescribeAcceleratorAttributes

describeAcceleratorAttributes_acceleratorArn :: Lens' DescribeAcceleratorAttributes Text Source #

The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.

DeleteEndpointGroup

deleteEndpointGroup_endpointGroupArn :: Lens' DeleteEndpointGroup Text Source #

The Amazon Resource Name (ARN) of the endpoint group to delete.

UpdateEndpointGroup

updateEndpointGroup_thresholdCount :: Lens' UpdateEndpointGroup (Maybe Natural) Source #

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

updateEndpointGroup_healthCheckPath :: Lens' UpdateEndpointGroup (Maybe Text) Source #

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

updateEndpointGroup_healthCheckIntervalSeconds :: Lens' UpdateEndpointGroup (Maybe Natural) Source #

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

updateEndpointGroup_healthCheckProtocol :: Lens' UpdateEndpointGroup (Maybe HealthCheckProtocol) Source #

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

updateEndpointGroup_trafficDialPercentage :: Lens' UpdateEndpointGroup (Maybe Double) Source #

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

updateEndpointGroup_endpointConfigurations :: Lens' UpdateEndpointGroup (Maybe [EndpointConfiguration]) Source #

The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.

updateEndpointGroup_healthCheckPort :: Lens' UpdateEndpointGroup (Maybe Natural) Source #

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.

updateEndpointGroup_portOverrides :: Lens' UpdateEndpointGroup (Maybe [PortOverride]) Source #

Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Port overrides in the AWS Global Accelerator Developer Guide.

updateEndpointGroup_endpointGroupArn :: Lens' UpdateEndpointGroup Text Source #

The Amazon Resource Name (ARN) of the endpoint group.

updateEndpointGroupResponse_endpointGroup :: Lens' UpdateEndpointGroupResponse (Maybe EndpointGroup) Source #

The information about the endpoint group that was updated.

ListCustomRoutingListeners

listCustomRoutingListeners_nextToken :: Lens' ListCustomRoutingListeners (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listCustomRoutingListeners_maxResults :: Lens' ListCustomRoutingListeners (Maybe Natural) Source #

The number of listener objects that you want to return with this call. The default value is 10.

listCustomRoutingListeners_acceleratorArn :: Lens' ListCustomRoutingListeners Text Source #

The Amazon Resource Name (ARN) of the accelerator to list listeners for.

listCustomRoutingListenersResponse_nextToken :: Lens' ListCustomRoutingListenersResponse (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

DeleteCustomRoutingListener

deleteCustomRoutingListener_listenerArn :: Lens' DeleteCustomRoutingListener Text Source #

The Amazon Resource Name (ARN) of the listener to delete.

UpdateCustomRoutingListener

updateCustomRoutingListener_listenerArn :: Lens' UpdateCustomRoutingListener Text Source #

The Amazon Resource Name (ARN) of the listener to update.

updateCustomRoutingListener_portRanges :: Lens' UpdateCustomRoutingListener (NonEmpty PortRange) Source #

The updated port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails.

Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

updateCustomRoutingListenerResponse_listener :: Lens' UpdateCustomRoutingListenerResponse (Maybe CustomRoutingListener) Source #

Information for the updated listener for a custom routing accelerator.

CreateAccelerator

createAccelerator_enabled :: Lens' CreateAccelerator (Maybe Bool) Source #

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

createAccelerator_ipAddressType :: Lens' CreateAccelerator (Maybe IpAddressType) Source #

The value for the address type must be IPv4.

createAccelerator_tags :: Lens' CreateAccelerator (Maybe [Tag]) Source #

Create tags for an accelerator.

For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

createAccelerator_ipAddresses :: Lens' CreateAccelerator (Maybe [Text]) Source #

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

createAccelerator_name :: Lens' CreateAccelerator Text Source #

The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

createAccelerator_idempotencyToken :: Lens' CreateAccelerator Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

createAcceleratorResponse_accelerator :: Lens' CreateAcceleratorResponse (Maybe Accelerator) Source #

The accelerator that is created by specifying a listener and the supported IP address types.

AllowCustomRoutingTraffic

allowCustomRoutingTraffic_destinationAddresses :: Lens' AllowCustomRoutingTraffic (Maybe [Text]) Source #

A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.

DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is not specified.

allowCustomRoutingTraffic_destinationPorts :: Lens' AllowCustomRoutingTraffic (Maybe [Natural]) Source #

A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.

allowCustomRoutingTraffic_allowAllTrafficToEndpoint :: Lens' AllowCustomRoutingTraffic (Maybe Bool) Source #

Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.

When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.

When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don't specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.

The default value is FALSE.

allowCustomRoutingTraffic_endpointGroupArn :: Lens' AllowCustomRoutingTraffic Text Source #

The Amazon Resource Name (ARN) of the endpoint group.

allowCustomRoutingTraffic_endpointId :: Lens' AllowCustomRoutingTraffic Text Source #

An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

WithdrawByoipCidr

withdrawByoipCidr_cidr :: Lens' WithdrawByoipCidr Text Source #

The address range, in CIDR notation.

AdvertiseByoipCidr

advertiseByoipCidr_cidr :: Lens' AdvertiseByoipCidr Text Source #

The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

DeleteAccelerator

deleteAccelerator_acceleratorArn :: Lens' DeleteAccelerator Text Source #

The Amazon Resource Name (ARN) of an accelerator.

UpdateAccelerator

updateAccelerator_enabled :: Lens' UpdateAccelerator (Maybe Bool) Source #

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

updateAccelerator_name :: Lens' UpdateAccelerator (Maybe Text) Source #

The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

updateAccelerator_acceleratorArn :: Lens' UpdateAccelerator Text Source #

The Amazon Resource Name (ARN) of the accelerator to update.

ListAccelerators

listAccelerators_nextToken :: Lens' ListAccelerators (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listAccelerators_maxResults :: Lens' ListAccelerators (Maybe Natural) Source #

The number of Global Accelerator objects that you want to return with this call. The default value is 10.

listAcceleratorsResponse_nextToken :: Lens' ListAcceleratorsResponse (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listAcceleratorsResponse_accelerators :: Lens' ListAcceleratorsResponse (Maybe [Accelerator]) Source #

The list of accelerators for a customer account.

DescribeEndpointGroup

describeEndpointGroup_endpointGroupArn :: Lens' DescribeEndpointGroup Text Source #

The Amazon Resource Name (ARN) of the endpoint group to describe.

UpdateAcceleratorAttributes

updateAcceleratorAttributes_flowLogsS3Prefix :: Lens' UpdateAcceleratorAttributes (Maybe Text) Source #

Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

s3-bucket_name//AWSLogs/aws_account_id

updateAcceleratorAttributes_flowLogsEnabled :: Lens' UpdateAcceleratorAttributes (Maybe Bool) Source #

Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

updateAcceleratorAttributes_flowLogsS3Bucket :: Lens' UpdateAcceleratorAttributes (Maybe Text) Source #

The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

updateAcceleratorAttributes_acceleratorArn :: Lens' UpdateAcceleratorAttributes Text Source #

The Amazon Resource Name (ARN) of the accelerator that you want to update.

CreateCustomRoutingAccelerator

createCustomRoutingAccelerator_enabled :: Lens' CreateCustomRoutingAccelerator (Maybe Bool) Source #

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

createCustomRoutingAccelerator_tags :: Lens' CreateCustomRoutingAccelerator (Maybe [Tag]) Source #

Create tags for an accelerator.

For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

createCustomRoutingAccelerator_ipAddresses :: Lens' CreateCustomRoutingAccelerator (Maybe [Text]) Source #

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.

Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.

For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

createCustomRoutingAccelerator_name :: Lens' CreateCustomRoutingAccelerator Text Source #

The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

createCustomRoutingAccelerator_idempotencyToken :: Lens' CreateCustomRoutingAccelerator Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

ListCustomRoutingPortMappingsByDestination

listCustomRoutingPortMappingsByDestination_nextToken :: Lens' ListCustomRoutingPortMappingsByDestination (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listCustomRoutingPortMappingsByDestination_maxResults :: Lens' ListCustomRoutingPortMappingsByDestination (Maybe Natural) Source #

The number of destination port mappings that you want to return with this call. The default value is 10.

listCustomRoutingPortMappingsByDestination_destinationAddress :: Lens' ListCustomRoutingPortMappingsByDestination Text Source #

The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.

listCustomRoutingPortMappingsByDestinationResponse_nextToken :: Lens' ListCustomRoutingPortMappingsByDestinationResponse (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

DeleteListener

deleteListener_listenerArn :: Lens' DeleteListener Text Source #

The Amazon Resource Name (ARN) of the listener.

UpdateListener

updateListener_portRanges :: Lens' UpdateListener (Maybe (NonEmpty PortRange)) Source #

The updated list of port ranges for the connections from clients to the accelerator.

updateListener_protocol :: Lens' UpdateListener (Maybe Protocol) Source #

The updated protocol for the connections from clients to the accelerator.

updateListener_clientAffinity :: Lens' UpdateListener (Maybe ClientAffinity) Source #

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

updateListener_listenerArn :: Lens' UpdateListener Text Source #

The Amazon Resource Name (ARN) of the listener to update.

ListListeners

listListeners_nextToken :: Lens' ListListeners (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listListeners_maxResults :: Lens' ListListeners (Maybe Natural) Source #

The number of listener objects that you want to return with this call. The default value is 10.

listListeners_acceleratorArn :: Lens' ListListeners Text Source #

The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

listListenersResponse_nextToken :: Lens' ListListenersResponse (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listListenersResponse_listeners :: Lens' ListListenersResponse (Maybe [Listener]) Source #

The list of listeners for an accelerator.

ListCustomRoutingEndpointGroups

listCustomRoutingEndpointGroups_nextToken :: Lens' ListCustomRoutingEndpointGroups (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listCustomRoutingEndpointGroups_maxResults :: Lens' ListCustomRoutingEndpointGroups (Maybe Natural) Source #

The number of endpoint group objects that you want to return with this call. The default value is 10.

listCustomRoutingEndpointGroups_listenerArn :: Lens' ListCustomRoutingEndpointGroups Text Source #

The Amazon Resource Name (ARN) of the listener to list endpoint groups for.

listCustomRoutingEndpointGroupsResponse_nextToken :: Lens' ListCustomRoutingEndpointGroupsResponse (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listCustomRoutingEndpointGroupsResponse_endpointGroups :: Lens' ListCustomRoutingEndpointGroupsResponse (Maybe [CustomRoutingEndpointGroup]) Source #

The list of the endpoint groups associated with a listener for a custom routing accelerator.

CreateListener

createListener_clientAffinity :: Lens' CreateListener (Maybe ClientAffinity) Source #

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

createListener_acceleratorArn :: Lens' CreateListener Text Source #

The Amazon Resource Name (ARN) of your accelerator.

createListener_portRanges :: Lens' CreateListener (NonEmpty PortRange) Source #

The list of port ranges to support for connections from clients to your accelerator.

createListener_protocol :: Lens' CreateListener Protocol Source #

The protocol for connections from clients to your accelerator.

createListener_idempotencyToken :: Lens' CreateListener Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

DescribeAccelerator

describeAccelerator_acceleratorArn :: Lens' DescribeAccelerator Text Source #

The Amazon Resource Name (ARN) of the accelerator to describe.

CreateCustomRoutingListener

createCustomRoutingListener_acceleratorArn :: Lens' CreateCustomRoutingListener Text Source #

The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.

createCustomRoutingListener_portRanges :: Lens' CreateCustomRoutingListener (NonEmpty PortRange) Source #

The port range to support for connections from clients to your accelerator.

Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

createCustomRoutingListener_idempotencyToken :: Lens' CreateCustomRoutingListener Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

DescribeCustomRoutingAccelerator

describeCustomRoutingAccelerator_acceleratorArn :: Lens' DescribeCustomRoutingAccelerator Text Source #

The Amazon Resource Name (ARN) of the accelerator to describe.

ListEndpointGroups

listEndpointGroups_nextToken :: Lens' ListEndpointGroups (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listEndpointGroups_maxResults :: Lens' ListEndpointGroups (Maybe Natural) Source #

The number of endpoint group objects that you want to return with this call. The default value is 10.

listEndpointGroups_listenerArn :: Lens' ListEndpointGroups Text Source #

The Amazon Resource Name (ARN) of the listener.

listEndpointGroupsResponse_nextToken :: Lens' ListEndpointGroupsResponse (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listEndpointGroupsResponse_endpointGroups :: Lens' ListEndpointGroupsResponse (Maybe [EndpointGroup]) Source #

The list of the endpoint groups associated with a listener.

ProvisionByoipCidr

provisionByoipCidr_cidr :: Lens' ProvisionByoipCidr Text Source #

The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this or another Region.

provisionByoipCidr_cidrAuthorizationContext :: Lens' ProvisionByoipCidr CidrAuthorizationContext Source #

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

CreateEndpointGroup

createEndpointGroup_thresholdCount :: Lens' CreateEndpointGroup (Maybe Natural) Source #

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

createEndpointGroup_healthCheckPath :: Lens' CreateEndpointGroup (Maybe Text) Source #

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

createEndpointGroup_healthCheckIntervalSeconds :: Lens' CreateEndpointGroup (Maybe Natural) Source #

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

createEndpointGroup_healthCheckProtocol :: Lens' CreateEndpointGroup (Maybe HealthCheckProtocol) Source #

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

createEndpointGroup_trafficDialPercentage :: Lens' CreateEndpointGroup (Maybe Double) Source #

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

createEndpointGroup_healthCheckPort :: Lens' CreateEndpointGroup (Maybe Natural) Source #

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

createEndpointGroup_portOverrides :: Lens' CreateEndpointGroup (Maybe [PortOverride]) Source #

Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

For more information, see Port overrides in the AWS Global Accelerator Developer Guide.

createEndpointGroup_listenerArn :: Lens' CreateEndpointGroup Text Source #

The Amazon Resource Name (ARN) of the listener.

createEndpointGroup_endpointGroupRegion :: Lens' CreateEndpointGroup Text Source #

The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

createEndpointGroup_idempotencyToken :: Lens' CreateEndpointGroup Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

createEndpointGroupResponse_endpointGroup :: Lens' CreateEndpointGroupResponse (Maybe EndpointGroup) Source #

The information about the endpoint group that was created.

ListByoipCidrs

listByoipCidrs_nextToken :: Lens' ListByoipCidrs (Maybe Text) Source #

The token for the next page of results.

listByoipCidrs_maxResults :: Lens' ListByoipCidrs (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

listByoipCidrsResponse_nextToken :: Lens' ListByoipCidrsResponse (Maybe Text) Source #

The token for the next page of results.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.

tagResource_tags :: Lens' TagResource [Tag] Source #

The tags to add to a resource. A tag consists of a key and a value that you define.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag key pairs that you want to remove from the specified resources.

DescribeListener

describeListener_listenerArn :: Lens' DescribeListener Text Source #

The Amazon Resource Name (ARN) of the listener to describe.

ListCustomRoutingPortMappings

listCustomRoutingPortMappings_endpointGroupArn :: Lens' ListCustomRoutingPortMappings (Maybe Text) Source #

The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.

listCustomRoutingPortMappings_nextToken :: Lens' ListCustomRoutingPortMappings (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listCustomRoutingPortMappings_maxResults :: Lens' ListCustomRoutingPortMappings (Maybe Natural) Source #

The number of destination port mappings that you want to return with this call. The default value is 10.

listCustomRoutingPortMappings_acceleratorArn :: Lens' ListCustomRoutingPortMappings Text Source #

The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.

listCustomRoutingPortMappingsResponse_nextToken :: Lens' ListCustomRoutingPortMappingsResponse (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

AddCustomRoutingEndpoints

addCustomRoutingEndpoints_endpointGroupArn :: Lens' AddCustomRoutingEndpoints Text Source #

The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.

addCustomRoutingEndpointsResponse_endpointGroupArn :: Lens' AddCustomRoutingEndpointsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.

DescribeCustomRoutingEndpointGroup

describeCustomRoutingEndpointGroup_endpointGroupArn :: Lens' DescribeCustomRoutingEndpointGroup Text Source #

The Amazon Resource Name (ARN) of the endpoint group to describe.

UpdateCustomRoutingAcceleratorAttributes

updateCustomRoutingAcceleratorAttributes_flowLogsS3Prefix :: Lens' UpdateCustomRoutingAcceleratorAttributes (Maybe Text) Source #

Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id

updateCustomRoutingAcceleratorAttributes_flowLogsEnabled :: Lens' UpdateCustomRoutingAcceleratorAttributes (Maybe Bool) Source #

Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

updateCustomRoutingAcceleratorAttributes_flowLogsS3Bucket :: Lens' UpdateCustomRoutingAcceleratorAttributes (Maybe Text) Source #

The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

updateCustomRoutingAcceleratorAttributes_acceleratorArn :: Lens' UpdateCustomRoutingAcceleratorAttributes Text Source #

The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.

RemoveCustomRoutingEndpoints

removeCustomRoutingEndpoints_endpointIds :: Lens' RemoveCustomRoutingEndpoints [Text] Source #

The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs.

removeCustomRoutingEndpoints_endpointGroupArn :: Lens' RemoveCustomRoutingEndpoints Text Source #

The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.

UpdateCustomRoutingAccelerator

updateCustomRoutingAccelerator_enabled :: Lens' UpdateCustomRoutingAccelerator (Maybe Bool) Source #

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

updateCustomRoutingAccelerator_name :: Lens' UpdateCustomRoutingAccelerator (Maybe Text) Source #

The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

updateCustomRoutingAccelerator_acceleratorArn :: Lens' UpdateCustomRoutingAccelerator Text Source #

The Amazon Resource Name (ARN) of the accelerator to update.

DeleteCustomRoutingAccelerator

deleteCustomRoutingAccelerator_acceleratorArn :: Lens' DeleteCustomRoutingAccelerator Text Source #

The Amazon Resource Name (ARN) of the custom routing accelerator to delete.

ListCustomRoutingAccelerators

listCustomRoutingAccelerators_nextToken :: Lens' ListCustomRoutingAccelerators (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

listCustomRoutingAccelerators_maxResults :: Lens' ListCustomRoutingAccelerators (Maybe Natural) Source #

The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.

listCustomRoutingAcceleratorsResponse_nextToken :: Lens' ListCustomRoutingAcceleratorsResponse (Maybe Text) Source #

The token for the next set of results. You receive this token from a previous call.

DeprovisionByoipCidr

deprovisionByoipCidr_cidr :: Lens' DeprovisionByoipCidr Text Source #

The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

Types

Accelerator

accelerator_status :: Lens' Accelerator (Maybe AcceleratorStatus) Source #

Describes the deployment status of the accelerator.

accelerator_acceleratorArn :: Lens' Accelerator (Maybe Text) Source #

The Amazon Resource Name (ARN) of the accelerator.

accelerator_enabled :: Lens' Accelerator (Maybe Bool) Source #

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

accelerator_createdTime :: Lens' Accelerator (Maybe UTCTime) Source #

The date and time that the accelerator was created.

accelerator_lastModifiedTime :: Lens' Accelerator (Maybe UTCTime) Source #

The date and time that the accelerator was last modified.

accelerator_ipAddressType :: Lens' Accelerator (Maybe IpAddressType) Source #

The value for the address type must be IPv4.

accelerator_name :: Lens' Accelerator (Maybe Text) Source #

The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

accelerator_ipSets :: Lens' Accelerator (Maybe [IpSet]) Source #

The static IP addresses that Global Accelerator associates with the accelerator.

accelerator_dnsName :: Lens' Accelerator (Maybe Text) Source #

The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

AcceleratorAttributes

acceleratorAttributes_flowLogsS3Prefix :: Lens' AcceleratorAttributes (Maybe Text) Source #

The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

s3-bucket_name//AWSLogs/aws_account_id

acceleratorAttributes_flowLogsEnabled :: Lens' AcceleratorAttributes (Maybe Bool) Source #

Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

acceleratorAttributes_flowLogsS3Bucket :: Lens' AcceleratorAttributes (Maybe Text) Source #

The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

ByoipCidr

byoipCidr_state :: Lens' ByoipCidr (Maybe ByoipCidrState) Source #

The state of the address pool.

byoipCidr_cidr :: Lens' ByoipCidr (Maybe Text) Source #

The address range, in CIDR notation.

byoipCidr_events :: Lens' ByoipCidr (Maybe [ByoipCidrEvent]) Source #

A history of status changes for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

ByoipCidrEvent

byoipCidrEvent_message :: Lens' ByoipCidrEvent (Maybe Text) Source #

A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

byoipCidrEvent_timestamp :: Lens' ByoipCidrEvent (Maybe UTCTime) Source #

A timestamp when you make a status change for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).

CidrAuthorizationContext

cidrAuthorizationContext_message :: Lens' CidrAuthorizationContext Text Source #

The plain-text authorization message for the prefix and account.

cidrAuthorizationContext_signature :: Lens' CidrAuthorizationContext Text Source #

The signed authorization message for the prefix and account.

CustomRoutingAccelerator

customRoutingAccelerator_acceleratorArn :: Lens' CustomRoutingAccelerator (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom routing accelerator.

customRoutingAccelerator_enabled :: Lens' CustomRoutingAccelerator (Maybe Bool) Source #

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

customRoutingAccelerator_createdTime :: Lens' CustomRoutingAccelerator (Maybe UTCTime) Source #

The date and time that the accelerator was created.

customRoutingAccelerator_lastModifiedTime :: Lens' CustomRoutingAccelerator (Maybe UTCTime) Source #

The date and time that the accelerator was last modified.

customRoutingAccelerator_name :: Lens' CustomRoutingAccelerator (Maybe Text) Source #

The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

customRoutingAccelerator_ipSets :: Lens' CustomRoutingAccelerator (Maybe [IpSet]) Source #

The static IP addresses that Global Accelerator associates with the accelerator.

customRoutingAccelerator_dnsName :: Lens' CustomRoutingAccelerator (Maybe Text) Source #

The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

The naming convention for the DNS name is the following: A lowercase letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

CustomRoutingAcceleratorAttributes

customRoutingAcceleratorAttributes_flowLogsS3Prefix :: Lens' CustomRoutingAcceleratorAttributes (Maybe Text) Source #

The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id

customRoutingAcceleratorAttributes_flowLogsEnabled :: Lens' CustomRoutingAcceleratorAttributes (Maybe Bool) Source #

Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

customRoutingAcceleratorAttributes_flowLogsS3Bucket :: Lens' CustomRoutingAcceleratorAttributes (Maybe Text) Source #

The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

CustomRoutingDestinationConfiguration

customRoutingDestinationConfiguration_fromPort :: Lens' CustomRoutingDestinationConfiguration Natural Source #

The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

customRoutingDestinationConfiguration_toPort :: Lens' CustomRoutingDestinationConfiguration Natural Source #

The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

customRoutingDestinationConfiguration_protocols :: Lens' CustomRoutingDestinationConfiguration (NonEmpty CustomRoutingProtocol) Source #

The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.

CustomRoutingDestinationDescription

customRoutingDestinationDescription_fromPort :: Lens' CustomRoutingDestinationDescription (Maybe Natural) Source #

The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

customRoutingDestinationDescription_protocols :: Lens' CustomRoutingDestinationDescription (Maybe [Protocol]) Source #

The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.

customRoutingDestinationDescription_toPort :: Lens' CustomRoutingDestinationDescription (Maybe Natural) Source #

The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

CustomRoutingEndpointConfiguration

customRoutingEndpointConfiguration_endpointId :: Lens' CustomRoutingEndpointConfiguration (Maybe Text) Source #

An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

CustomRoutingEndpointDescription

customRoutingEndpointDescription_endpointId :: Lens' CustomRoutingEndpointDescription (Maybe Text) Source #

An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

CustomRoutingEndpointGroup

customRoutingEndpointGroup_endpointGroupArn :: Lens' CustomRoutingEndpointGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the endpoint group.

customRoutingEndpointGroup_endpointGroupRegion :: Lens' CustomRoutingEndpointGroup (Maybe Text) Source #

The AWS Region where the endpoint group is located.

customRoutingEndpointGroup_endpointDescriptions :: Lens' CustomRoutingEndpointGroup (Maybe [CustomRoutingEndpointDescription]) Source #

For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

customRoutingEndpointGroup_destinationDescriptions :: Lens' CustomRoutingEndpointGroup (Maybe [CustomRoutingDestinationDescription]) Source #

For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

CustomRoutingListener

customRoutingListener_portRanges :: Lens' CustomRoutingListener (Maybe (NonEmpty PortRange)) Source #

The port range to support for connections from clients to your accelerator.

Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

customRoutingListener_listenerArn :: Lens' CustomRoutingListener (Maybe Text) Source #

The Amazon Resource Name (ARN) of the listener.

DestinationPortMapping

destinationPortMapping_destinationSocketAddress :: Lens' DestinationPortMapping (Maybe SocketAddress) Source #

The endpoint IP address/port combination for traffic received on the accelerator socket address.

destinationPortMapping_acceleratorArn :: Lens' DestinationPortMapping (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom routing accelerator that you have port mappings for.

destinationPortMapping_endpointGroupArn :: Lens' DestinationPortMapping (Maybe Text) Source #

The Amazon Resource Name (ARN) of the endpoint group.

destinationPortMapping_acceleratorSocketAddresses :: Lens' DestinationPortMapping (Maybe [SocketAddress]) Source #

The IP address/port combinations (sockets) that map to a given destination socket address.

destinationPortMapping_endpointId :: Lens' DestinationPortMapping (Maybe Text) Source #

The ID for the virtual private cloud (VPC) subnet.

destinationPortMapping_destinationTrafficState :: Lens' DestinationPortMapping (Maybe CustomRoutingDestinationTrafficState) Source #

Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

EndpointConfiguration

endpointConfiguration_weight :: Lens' EndpointConfiguration (Maybe Natural) Source #

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

endpointConfiguration_clientIPPreservationEnabled :: Lens' EndpointConfiguration (Maybe Bool) Source #

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Preserve Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

endpointConfiguration_endpointId :: Lens' EndpointConfiguration (Maybe Text) Source #

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.

An Application Load Balancer can be either internal or internet-facing.

EndpointDescription

endpointDescription_weight :: Lens' EndpointDescription (Maybe Natural) Source #

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

endpointDescription_clientIPPreservationEnabled :: Lens' EndpointDescription (Maybe Bool) Source #

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

endpointDescription_endpointId :: Lens' EndpointDescription (Maybe Text) Source #

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID.

An Application Load Balancer can be either internal or internet-facing.

EndpointGroup

endpointGroup_thresholdCount :: Lens' EndpointGroup (Maybe Natural) Source #

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

endpointGroup_healthCheckPath :: Lens' EndpointGroup (Maybe Text) Source #

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

endpointGroup_healthCheckIntervalSeconds :: Lens' EndpointGroup (Maybe Natural) Source #

The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

endpointGroup_endpointGroupArn :: Lens' EndpointGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the endpoint group.

endpointGroup_healthCheckProtocol :: Lens' EndpointGroup (Maybe HealthCheckProtocol) Source #

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

endpointGroup_endpointGroupRegion :: Lens' EndpointGroup (Maybe Text) Source #

The AWS Region where the endpoint group is located.

endpointGroup_trafficDialPercentage :: Lens' EndpointGroup (Maybe Double) Source #

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

endpointGroup_healthCheckPort :: Lens' EndpointGroup (Maybe Natural) Source #

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

endpointGroup_portOverrides :: Lens' EndpointGroup (Maybe [PortOverride]) Source #

Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you to map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.

IpSet

ipSet_ipFamily :: Lens' IpSet (Maybe Text) Source #

The types of IP addresses included in this IP set.

ipSet_ipAddresses :: Lens' IpSet (Maybe [Text]) Source #

The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

Listener

listener_portRanges :: Lens' Listener (Maybe (NonEmpty PortRange)) Source #

The list of port ranges for the connections from clients to the accelerator.

listener_listenerArn :: Lens' Listener (Maybe Text) Source #

The Amazon Resource Name (ARN) of the listener.

listener_protocol :: Lens' Listener (Maybe Protocol) Source #

The protocol for the connections from clients to the accelerator.

listener_clientAffinity :: Lens' Listener (Maybe ClientAffinity) Source #

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

PortMapping

portMapping_destinationSocketAddress :: Lens' PortMapping (Maybe SocketAddress) Source #

The EC2 instance IP address and port number in the virtual private cloud (VPC) subnet.

portMapping_protocols :: Lens' PortMapping (Maybe (NonEmpty CustomRoutingProtocol)) Source #

The protocols supported by the endpoint group.

portMapping_endpointGroupArn :: Lens' PortMapping (Maybe Text) Source #

The Amazon Resource Name (ARN) of the endpoint group.

portMapping_endpointId :: Lens' PortMapping (Maybe Text) Source #

The IP address of the VPC subnet (the subnet ID).

portMapping_destinationTrafficState :: Lens' PortMapping (Maybe CustomRoutingDestinationTrafficState) Source #

Indicates whether or not a port mapping destination can receive traffic. The value is either ALLOW, if traffic is allowed to the destination, or DENY, if traffic is not allowed to the destination.

PortOverride

portOverride_endpointPort :: Lens' PortOverride (Maybe Natural) Source #

The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.

portOverride_listenerPort :: Lens' PortOverride (Maybe Natural) Source #

The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.

PortRange

portRange_fromPort :: Lens' PortRange (Maybe Natural) Source #

The first port in the range of ports, inclusive.

portRange_toPort :: Lens' PortRange (Maybe Natural) Source #

The last port in the range of ports, inclusive.

SocketAddress

socketAddress_ipAddress :: Lens' SocketAddress (Maybe Text) Source #

The IP address for the socket address.

socketAddress_port :: Lens' SocketAddress (Maybe Natural) Source #

The port for the socket address.

Tag

tag_key :: Lens' Tag Text Source #

A string that contains a Tag key.

tag_value :: Lens' Tag Text Source #

A string that contains a Tag value.