Amazonka.GlobalAccelerator.Lens

Operations

AddCustomRoutingEndpoints

addCustomRoutingEndpoints_endpointConfigurations :: Lens' AddCustomRoutingEndpoints (NonEmpty CustomRoutingEndpointConfiguration)

The list of endpoint objects to add to a custom routing accelerator.

addCustomRoutingEndpoints_endpointGroupArn :: Lens' AddCustomRoutingEndpoints Text

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

addCustomRoutingEndpointsResponse_endpointDescriptions :: Lens' AddCustomRoutingEndpointsResponse (Maybe [CustomRoutingEndpointDescription])

The endpoint objects added to the custom routing accelerator.

addCustomRoutingEndpointsResponse_endpointGroupArn :: Lens' AddCustomRoutingEndpointsResponse (Maybe Text)

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

addCustomRoutingEndpointsResponse_httpStatus :: Lens' AddCustomRoutingEndpointsResponse Int

The response's http status code.

AddEndpoints

addEndpoints_endpointConfigurations :: Lens' AddEndpoints [EndpointConfiguration]

The list of endpoint objects.

addEndpoints_endpointGroupArn :: Lens' AddEndpoints Text

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

addEndpointsResponse_endpointDescriptions :: Lens' AddEndpointsResponse (Maybe [EndpointDescription])

The list of endpoint objects.

addEndpointsResponse_endpointGroupArn :: Lens' AddEndpointsResponse (Maybe Text)

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

addEndpointsResponse_httpStatus :: Lens' AddEndpointsResponse Int

The response's http status code.

AdvertiseByoipCidr

advertiseByoipCidr_cidr :: Lens' AdvertiseByoipCidr Text

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.

advertiseByoipCidrResponse_byoipCidr :: Lens' AdvertiseByoipCidrResponse (Maybe ByoipCidr)

Information about the address range.

advertiseByoipCidrResponse_httpStatus :: Lens' AdvertiseByoipCidrResponse Int

The response's http status code.

AllowCustomRoutingTraffic

allowCustomRoutingTraffic_allowAllTrafficToEndpoint :: Lens' AllowCustomRoutingTraffic (Maybe Bool)

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_destinationAddresses :: Lens' AllowCustomRoutingTraffic (Maybe [Text])

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])

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

allowCustomRoutingTraffic_endpointGroupArn :: Lens' AllowCustomRoutingTraffic Text

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

allowCustomRoutingTraffic_endpointId :: Lens' AllowCustomRoutingTraffic Text

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

CreateAccelerator

createAccelerator_enabled :: Lens' CreateAccelerator (Maybe Bool)

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)

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

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

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

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 Global Accelerator Developer Guide.

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

Create tags for an accelerator.

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

createAccelerator_name :: Lens' CreateAccelerator Text

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

createAccelerator_idempotencyToken :: Lens' CreateAccelerator Text

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)

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

createAcceleratorResponse_httpStatus :: Lens' CreateAcceleratorResponse Int

The response's http status code.

CreateCustomRoutingAccelerator

createCustomRoutingAccelerator_enabled :: Lens' CreateCustomRoutingAccelerator (Maybe Bool)

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_ipAddressType :: Lens' CreateCustomRoutingAccelerator (Maybe IpAddressType)

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

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

Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address when you create an accelerator.

After you bring an address range to Amazon Web Services, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to Amazon Web Services, you can assign one IPv4 address from each range to your accelerator. This restriction is because Global Accelerator assigns each address range to a different network zone, for high availability.

You can specify one or two addresses, separated by a space. Do not include the /32 suffix.

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 Global Accelerator Developer Guide.

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

Create tags for an accelerator.

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

createCustomRoutingAccelerator_name :: Lens' CreateCustomRoutingAccelerator Text

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

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

createCustomRoutingAcceleratorResponse_accelerator :: Lens' CreateCustomRoutingAcceleratorResponse (Maybe CustomRoutingAccelerator)

The accelerator that is created.

createCustomRoutingAcceleratorResponse_httpStatus :: Lens' CreateCustomRoutingAcceleratorResponse Int

The response's http status code.

CreateCustomRoutingEndpointGroup

createCustomRoutingEndpointGroup_listenerArn :: Lens' CreateCustomRoutingEndpointGroup Text

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

createCustomRoutingEndpointGroup_endpointGroupRegion :: Lens' CreateCustomRoutingEndpointGroup Text

The Amazon Web Services 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)

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

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)

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

createCustomRoutingEndpointGroupResponse_httpStatus :: Lens' CreateCustomRoutingEndpointGroupResponse Int

The response's http status code.

CreateCustomRoutingListener

createCustomRoutingListener_acceleratorArn :: Lens' CreateCustomRoutingListener Text

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

createCustomRoutingListener_portRanges :: Lens' CreateCustomRoutingListener (NonEmpty PortRange)

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

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

createCustomRoutingListenerResponse_listener :: Lens' CreateCustomRoutingListenerResponse (Maybe CustomRoutingListener)

The listener that you've created for a custom routing accelerator.

createCustomRoutingListenerResponse_httpStatus :: Lens' CreateCustomRoutingListenerResponse Int

The response's http status code.

CreateEndpointGroup

createEndpointGroup_endpointConfigurations :: Lens' CreateEndpointGroup (Maybe [EndpointConfiguration])

The list of endpoint objects.

createEndpointGroup_healthCheckIntervalSeconds :: Lens' CreateEndpointGroup (Maybe Natural)

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

createEndpointGroup_healthCheckPath :: Lens' CreateEndpointGroup (Maybe Text)

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_healthCheckPort :: Lens' CreateEndpointGroup (Maybe Natural)

The port that 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_healthCheckProtocol :: Lens' CreateEndpointGroup (Maybe HealthCheckProtocol)

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

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

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 Overriding listener ports in the Global Accelerator Developer Guide.

createEndpointGroup_thresholdCount :: Lens' CreateEndpointGroup (Maybe Natural)

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_trafficDialPercentage :: Lens' CreateEndpointGroup (Maybe Double)

The percentage of traffic to send to an Amazon Web Services 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_listenerArn :: Lens' CreateEndpointGroup Text

The Amazon Resource Name (ARN) of the listener.

createEndpointGroup_endpointGroupRegion :: Lens' CreateEndpointGroup Text

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

createEndpointGroup_idempotencyToken :: Lens' CreateEndpointGroup Text

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)

The information about the endpoint group that was created.

createEndpointGroupResponse_httpStatus :: Lens' CreateEndpointGroupResponse Int

The response's http status code.

CreateListener

createListener_clientAffinity :: Lens' CreateListener (Maybe ClientAffinity)

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.

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

The Amazon Resource Name (ARN) of your accelerator.

createListener_portRanges :: Lens' CreateListener (NonEmpty PortRange)

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

createListener_protocol :: Lens' CreateListener Protocol

The protocol for connections from clients to your accelerator.

createListener_idempotencyToken :: Lens' CreateListener Text

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

createListenerResponse_listener :: Lens' CreateListenerResponse (Maybe Listener)

The listener that you've created.

createListenerResponse_httpStatus :: Lens' CreateListenerResponse Int

The response's http status code.

DeleteAccelerator

deleteAccelerator_acceleratorArn :: Lens' DeleteAccelerator Text

The Amazon Resource Name (ARN) of an accelerator.

DeleteCustomRoutingAccelerator

deleteCustomRoutingAccelerator_acceleratorArn :: Lens' DeleteCustomRoutingAccelerator Text

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

DeleteCustomRoutingEndpointGroup

deleteCustomRoutingEndpointGroup_endpointGroupArn :: Lens' DeleteCustomRoutingEndpointGroup Text

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

DeleteCustomRoutingListener

deleteCustomRoutingListener_listenerArn :: Lens' DeleteCustomRoutingListener Text

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

DeleteEndpointGroup

deleteEndpointGroup_endpointGroupArn :: Lens' DeleteEndpointGroup Text

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

DeleteListener

deleteListener_listenerArn :: Lens' DeleteListener Text

The Amazon Resource Name (ARN) of the listener.

DenyCustomRoutingTraffic

denyCustomRoutingTraffic_denyAllTrafficToEndpoint :: Lens' DenyCustomRoutingTraffic (Maybe Bool)

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_destinationAddresses :: Lens' DenyCustomRoutingTraffic (Maybe [Text])

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])

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

denyCustomRoutingTraffic_endpointGroupArn :: Lens' DenyCustomRoutingTraffic Text

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

denyCustomRoutingTraffic_endpointId :: Lens' DenyCustomRoutingTraffic Text

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

DeprovisionByoipCidr

deprovisionByoipCidr_cidr :: Lens' DeprovisionByoipCidr Text

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

deprovisionByoipCidrResponse_byoipCidr :: Lens' DeprovisionByoipCidrResponse (Maybe ByoipCidr)

Information about the address range.

deprovisionByoipCidrResponse_httpStatus :: Lens' DeprovisionByoipCidrResponse Int

The response's http status code.

DescribeAccelerator

describeAccelerator_acceleratorArn :: Lens' DescribeAccelerator Text

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

describeAcceleratorResponse_accelerator :: Lens' DescribeAcceleratorResponse (Maybe Accelerator)

The description of the accelerator.

describeAcceleratorResponse_httpStatus :: Lens' DescribeAcceleratorResponse Int

The response's http status code.

DescribeAcceleratorAttributes

describeAcceleratorAttributes_acceleratorArn :: Lens' DescribeAcceleratorAttributes Text

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

describeAcceleratorAttributesResponse_acceleratorAttributes :: Lens' DescribeAcceleratorAttributesResponse (Maybe AcceleratorAttributes)

The attributes of the accelerator.

describeAcceleratorAttributesResponse_httpStatus :: Lens' DescribeAcceleratorAttributesResponse Int

The response's http status code.

DescribeCustomRoutingAccelerator

describeCustomRoutingAccelerator_acceleratorArn :: Lens' DescribeCustomRoutingAccelerator Text

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

describeCustomRoutingAcceleratorResponse_accelerator :: Lens' DescribeCustomRoutingAcceleratorResponse (Maybe CustomRoutingAccelerator)

The description of the custom routing accelerator.

describeCustomRoutingAcceleratorResponse_httpStatus :: Lens' DescribeCustomRoutingAcceleratorResponse Int

The response's http status code.

DescribeCustomRoutingAcceleratorAttributes

describeCustomRoutingAcceleratorAttributes_acceleratorArn :: Lens' DescribeCustomRoutingAcceleratorAttributes Text

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

describeCustomRoutingAcceleratorAttributesResponse_acceleratorAttributes :: Lens' DescribeCustomRoutingAcceleratorAttributesResponse (Maybe CustomRoutingAcceleratorAttributes)

The attributes of the custom routing accelerator.

describeCustomRoutingAcceleratorAttributesResponse_httpStatus :: Lens' DescribeCustomRoutingAcceleratorAttributesResponse Int

The response's http status code.

DescribeCustomRoutingEndpointGroup

describeCustomRoutingEndpointGroup_endpointGroupArn :: Lens' DescribeCustomRoutingEndpointGroup Text

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

describeCustomRoutingEndpointGroupResponse_endpointGroup :: Lens' DescribeCustomRoutingEndpointGroupResponse (Maybe CustomRoutingEndpointGroup)

The description of an endpoint group for a custom routing accelerator.

describeCustomRoutingEndpointGroupResponse_httpStatus :: Lens' DescribeCustomRoutingEndpointGroupResponse Int

The response's http status code.

DescribeCustomRoutingListener

describeCustomRoutingListener_listenerArn :: Lens' DescribeCustomRoutingListener Text

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

describeCustomRoutingListenerResponse_listener :: Lens' DescribeCustomRoutingListenerResponse (Maybe CustomRoutingListener)

The description of a listener for a custom routing accelerator.

describeCustomRoutingListenerResponse_httpStatus :: Lens' DescribeCustomRoutingListenerResponse Int

The response's http status code.

DescribeEndpointGroup

describeEndpointGroup_endpointGroupArn :: Lens' DescribeEndpointGroup Text

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

describeEndpointGroupResponse_endpointGroup :: Lens' DescribeEndpointGroupResponse (Maybe EndpointGroup)

The description of an endpoint group.

describeEndpointGroupResponse_httpStatus :: Lens' DescribeEndpointGroupResponse Int

The response's http status code.

DescribeListener

describeListener_listenerArn :: Lens' DescribeListener Text

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

describeListenerResponse_listener :: Lens' DescribeListenerResponse (Maybe Listener)

The description of a listener.

describeListenerResponse_httpStatus :: Lens' DescribeListenerResponse Int

The response's http status code.

ListAccelerators

listAccelerators_maxResults :: Lens' ListAccelerators (Maybe Natural)

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

listAccelerators_nextToken :: Lens' ListAccelerators (Maybe Text)

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

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

The list of accelerators for a customer account.

listAcceleratorsResponse_nextToken :: Lens' ListAcceleratorsResponse (Maybe Text)

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

listAcceleratorsResponse_httpStatus :: Lens' ListAcceleratorsResponse Int

The response's http status code.

ListByoipCidrs

listByoipCidrs_maxResults :: Lens' ListByoipCidrs (Maybe Natural)

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

listByoipCidrs_nextToken :: Lens' ListByoipCidrs (Maybe Text)

The token for the next page of results.

listByoipCidrsResponse_byoipCidrs :: Lens' ListByoipCidrsResponse (Maybe [ByoipCidr])

Information about your address ranges.

listByoipCidrsResponse_nextToken :: Lens' ListByoipCidrsResponse (Maybe Text)

The token for the next page of results.

listByoipCidrsResponse_httpStatus :: Lens' ListByoipCidrsResponse Int

The response's http status code.

ListCustomRoutingAccelerators

listCustomRoutingAccelerators_maxResults :: Lens' ListCustomRoutingAccelerators (Maybe Natural)

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

listCustomRoutingAccelerators_nextToken :: Lens' ListCustomRoutingAccelerators (Maybe Text)

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

listCustomRoutingAcceleratorsResponse_accelerators :: Lens' ListCustomRoutingAcceleratorsResponse (Maybe [CustomRoutingAccelerator])

The list of custom routing accelerators for a customer account.

listCustomRoutingAcceleratorsResponse_nextToken :: Lens' ListCustomRoutingAcceleratorsResponse (Maybe Text)

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

listCustomRoutingAcceleratorsResponse_httpStatus :: Lens' ListCustomRoutingAcceleratorsResponse Int

The response's http status code.

ListCustomRoutingEndpointGroups

listCustomRoutingEndpointGroups_maxResults :: Lens' ListCustomRoutingEndpointGroups (Maybe Natural)

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

listCustomRoutingEndpointGroups_nextToken :: Lens' ListCustomRoutingEndpointGroups (Maybe Text)

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

listCustomRoutingEndpointGroups_listenerArn :: Lens' ListCustomRoutingEndpointGroups Text

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

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

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

listCustomRoutingEndpointGroupsResponse_nextToken :: Lens' ListCustomRoutingEndpointGroupsResponse (Maybe Text)

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

listCustomRoutingEndpointGroupsResponse_httpStatus :: Lens' ListCustomRoutingEndpointGroupsResponse Int

The response's http status code.

ListCustomRoutingListeners

listCustomRoutingListeners_maxResults :: Lens' ListCustomRoutingListeners (Maybe Natural)

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

listCustomRoutingListeners_nextToken :: Lens' ListCustomRoutingListeners (Maybe Text)

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

listCustomRoutingListeners_acceleratorArn :: Lens' ListCustomRoutingListeners Text

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

listCustomRoutingListenersResponse_listeners :: Lens' ListCustomRoutingListenersResponse (Maybe [CustomRoutingListener])

The list of listeners for a custom routing accelerator.

listCustomRoutingListenersResponse_nextToken :: Lens' ListCustomRoutingListenersResponse (Maybe Text)

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

listCustomRoutingListenersResponse_httpStatus :: Lens' ListCustomRoutingListenersResponse Int

The response's http status code.

ListCustomRoutingPortMappings

listCustomRoutingPortMappings_endpointGroupArn :: Lens' ListCustomRoutingPortMappings (Maybe Text)

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

listCustomRoutingPortMappings_maxResults :: Lens' ListCustomRoutingPortMappings (Maybe Natural)

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

listCustomRoutingPortMappings_nextToken :: Lens' ListCustomRoutingPortMappings (Maybe Text)

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

listCustomRoutingPortMappings_acceleratorArn :: Lens' ListCustomRoutingPortMappings Text

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

listCustomRoutingPortMappingsResponse_nextToken :: Lens' ListCustomRoutingPortMappingsResponse (Maybe Text)

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

listCustomRoutingPortMappingsResponse_portMappings :: Lens' ListCustomRoutingPortMappingsResponse (Maybe [PortMapping])

The port mappings for a custom routing accelerator.

listCustomRoutingPortMappingsResponse_httpStatus :: Lens' ListCustomRoutingPortMappingsResponse Int

The response's http status code.

ListCustomRoutingPortMappingsByDestination

listCustomRoutingPortMappingsByDestination_maxResults :: Lens' ListCustomRoutingPortMappingsByDestination (Maybe Natural)

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

listCustomRoutingPortMappingsByDestination_nextToken :: Lens' ListCustomRoutingPortMappingsByDestination (Maybe Text)

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

listCustomRoutingPortMappingsByDestination_endpointId :: Lens' ListCustomRoutingPortMappingsByDestination Text

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

listCustomRoutingPortMappingsByDestination_destinationAddress :: Lens' ListCustomRoutingPortMappingsByDestination Text

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

listCustomRoutingPortMappingsByDestinationResponse_destinationPortMappings :: Lens' ListCustomRoutingPortMappingsByDestinationResponse (Maybe [DestinationPortMapping])

The port mappings for the endpoint IP address that you specified in the request.

listCustomRoutingPortMappingsByDestinationResponse_nextToken :: Lens' ListCustomRoutingPortMappingsByDestinationResponse (Maybe Text)

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

listCustomRoutingPortMappingsByDestinationResponse_httpStatus :: Lens' ListCustomRoutingPortMappingsByDestinationResponse Int

The response's http status code.

ListEndpointGroups

listEndpointGroups_maxResults :: Lens' ListEndpointGroups (Maybe Natural)

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

listEndpointGroups_nextToken :: Lens' ListEndpointGroups (Maybe Text)

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

listEndpointGroups_listenerArn :: Lens' ListEndpointGroups Text

The Amazon Resource Name (ARN) of the listener.

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

The list of the endpoint groups associated with a listener.

listEndpointGroupsResponse_nextToken :: Lens' ListEndpointGroupsResponse (Maybe Text)

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

listEndpointGroupsResponse_httpStatus :: Lens' ListEndpointGroupsResponse Int

The response's http status code.

ListListeners

listListeners_maxResults :: Lens' ListListeners (Maybe Natural)

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

listListeners_nextToken :: Lens' ListListeners (Maybe Text)

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

listListeners_acceleratorArn :: Lens' ListListeners Text

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

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

The list of listeners for an accelerator.

listListenersResponse_nextToken :: Lens' ListListenersResponse (Maybe Text)

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

listListenersResponse_httpStatus :: Lens' ListListenersResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text

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

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])

Root level tag for the Tags parameters.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

ProvisionByoipCidr

provisionByoipCidr_cidr :: Lens' ProvisionByoipCidr Text

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

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

provisionByoipCidrResponse_byoipCidr :: Lens' ProvisionByoipCidrResponse (Maybe ByoipCidr)

Information about the address range.

provisionByoipCidrResponse_httpStatus :: Lens' ProvisionByoipCidrResponse Int

The response's http status code.

RemoveCustomRoutingEndpoints

removeCustomRoutingEndpoints_endpointIds :: Lens' RemoveCustomRoutingEndpoints [Text]

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

removeCustomRoutingEndpoints_endpointGroupArn :: Lens' RemoveCustomRoutingEndpoints Text

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

RemoveEndpoints

removeEndpoints_endpointIdentifiers :: Lens' RemoveEndpoints (NonEmpty EndpointIdentifier)

The identifiers of the endpoints that you want to remove.

removeEndpoints_endpointGroupArn :: Lens' RemoveEndpoints Text

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

TagResource

tagResource_resourceArn :: Lens' TagResource Text

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]

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

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text

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]

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

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UpdateAccelerator

updateAccelerator_enabled :: Lens' UpdateAccelerator (Maybe Bool)

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_ipAddressType :: Lens' UpdateAccelerator (Maybe IpAddressType)

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

updateAccelerator_name :: Lens' UpdateAccelerator (Maybe Text)

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

updateAccelerator_acceleratorArn :: Lens' UpdateAccelerator Text

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

updateAcceleratorResponse_accelerator :: Lens' UpdateAcceleratorResponse (Maybe Accelerator)

Information about the updated accelerator.

updateAcceleratorResponse_httpStatus :: Lens' UpdateAcceleratorResponse Int

The response's http status code.

UpdateAcceleratorAttributes

updateAcceleratorAttributes_flowLogsEnabled :: Lens' UpdateAcceleratorAttributes (Maybe Bool)

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 Global Accelerator Developer Guide.

updateAcceleratorAttributes_flowLogsS3Bucket :: Lens' UpdateAcceleratorAttributes (Maybe Text)

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 Global Accelerator permission to write to the bucket.

updateAcceleratorAttributes_flowLogsS3Prefix :: Lens' UpdateAcceleratorAttributes (Maybe Text)

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

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_acceleratorArn :: Lens' UpdateAcceleratorAttributes Text

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

updateAcceleratorAttributesResponse_acceleratorAttributes :: Lens' UpdateAcceleratorAttributesResponse (Maybe AcceleratorAttributes)

Updated attributes for the accelerator.

updateAcceleratorAttributesResponse_httpStatus :: Lens' UpdateAcceleratorAttributesResponse Int

The response's http status code.

UpdateCustomRoutingAccelerator

updateCustomRoutingAccelerator_enabled :: Lens' UpdateCustomRoutingAccelerator (Maybe Bool)

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_ipAddressType :: Lens' UpdateCustomRoutingAccelerator (Maybe IpAddressType)

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

updateCustomRoutingAccelerator_name :: Lens' UpdateCustomRoutingAccelerator (Maybe Text)

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

updateCustomRoutingAccelerator_acceleratorArn :: Lens' UpdateCustomRoutingAccelerator Text

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

updateCustomRoutingAcceleratorResponse_accelerator :: Lens' UpdateCustomRoutingAcceleratorResponse (Maybe CustomRoutingAccelerator)

Information about the updated custom routing accelerator.

updateCustomRoutingAcceleratorResponse_httpStatus :: Lens' UpdateCustomRoutingAcceleratorResponse Int

The response's http status code.

UpdateCustomRoutingAcceleratorAttributes

updateCustomRoutingAcceleratorAttributes_flowLogsEnabled :: Lens' UpdateCustomRoutingAcceleratorAttributes (Maybe Bool)

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 Global Accelerator Developer Guide.

updateCustomRoutingAcceleratorAttributes_flowLogsS3Bucket :: Lens' UpdateCustomRoutingAcceleratorAttributes (Maybe Text)

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 Global Accelerator permission to write to the bucket.

updateCustomRoutingAcceleratorAttributes_flowLogsS3Prefix :: Lens' UpdateCustomRoutingAcceleratorAttributes (Maybe Text)

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_acceleratorArn :: Lens' UpdateCustomRoutingAcceleratorAttributes Text

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

updateCustomRoutingAcceleratorAttributesResponse_acceleratorAttributes :: Lens' UpdateCustomRoutingAcceleratorAttributesResponse (Maybe CustomRoutingAcceleratorAttributes)

Updated custom routing accelerator.

updateCustomRoutingAcceleratorAttributesResponse_httpStatus :: Lens' UpdateCustomRoutingAcceleratorAttributesResponse Int

The response's http status code.

UpdateCustomRoutingListener

updateCustomRoutingListener_listenerArn :: Lens' UpdateCustomRoutingListener Text

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

updateCustomRoutingListener_portRanges :: Lens' UpdateCustomRoutingListener (NonEmpty PortRange)

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)

Information for the updated listener for a custom routing accelerator.

updateCustomRoutingListenerResponse_httpStatus :: Lens' UpdateCustomRoutingListenerResponse Int

The response's http status code.

UpdateEndpointGroup

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

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

updateEndpointGroup_healthCheckIntervalSeconds :: Lens' UpdateEndpointGroup (Maybe Natural)

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

updateEndpointGroup_healthCheckPath :: Lens' UpdateEndpointGroup (Maybe Text)

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_healthCheckPort :: Lens' UpdateEndpointGroup (Maybe Natural)

The port that 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_healthCheckProtocol :: Lens' UpdateEndpointGroup (Maybe HealthCheckProtocol)

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

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

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 Overriding listener ports in the Global Accelerator Developer Guide.

updateEndpointGroup_thresholdCount :: Lens' UpdateEndpointGroup (Maybe Natural)

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_trafficDialPercentage :: Lens' UpdateEndpointGroup (Maybe Double)

The percentage of traffic to send to an Amazon Web Services 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_endpointGroupArn :: Lens' UpdateEndpointGroup Text

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

updateEndpointGroupResponse_endpointGroup :: Lens' UpdateEndpointGroupResponse (Maybe EndpointGroup)

The information about the endpoint group that was updated.

updateEndpointGroupResponse_httpStatus :: Lens' UpdateEndpointGroupResponse Int

The response's http status code.

UpdateListener

updateListener_clientAffinity :: Lens' UpdateListener (Maybe ClientAffinity)

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.

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_portRanges :: Lens' UpdateListener (Maybe (NonEmpty PortRange))

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

updateListener_protocol :: Lens' UpdateListener (Maybe Protocol)

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

updateListener_listenerArn :: Lens' UpdateListener Text

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

updateListenerResponse_listener :: Lens' UpdateListenerResponse (Maybe Listener)

Information for the updated listener.

updateListenerResponse_httpStatus :: Lens' UpdateListenerResponse Int

The response's http status code.

WithdrawByoipCidr

withdrawByoipCidr_cidr :: Lens' WithdrawByoipCidr Text

The address range, in CIDR notation.

withdrawByoipCidrResponse_byoipCidr :: Lens' WithdrawByoipCidrResponse (Maybe ByoipCidr)

Information about the address pool.

withdrawByoipCidrResponse_httpStatus :: Lens' WithdrawByoipCidrResponse Int

The response's http status code.

Types

Accelerator

accelerator_acceleratorArn :: Lens' Accelerator (Maybe Text)

The Amazon Resource Name (ARN) of the accelerator.

accelerator_createdTime :: Lens' Accelerator (Maybe UTCTime)

The date and time that the accelerator was created.

accelerator_dnsName :: Lens' Accelerator (Maybe Text)

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

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

If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

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

accelerator_dualStackDnsName :: Lens' Accelerator (Maybe Text)

The Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

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

Note: Global Accelerator also assigns a default DNS name, DnsName, to your accelerator that points just to the static IPv4 addresses.

For more information, see Support for DNS addressing in Global Accelerator in the Global Accelerator Developer Guide.

accelerator_enabled :: Lens' Accelerator (Maybe Bool)

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_events :: Lens' Accelerator (Maybe [AcceleratorEvent])

A history of changes that you make to an accelerator in Global Accelerator.

accelerator_ipAddressType :: Lens' Accelerator (Maybe IpAddressType)

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

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

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

accelerator_lastModifiedTime :: Lens' Accelerator (Maybe UTCTime)

The date and time that the accelerator was last modified.

accelerator_name :: Lens' Accelerator (Maybe Text)

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

accelerator_status :: Lens' Accelerator (Maybe AcceleratorStatus)

Describes the deployment status of the accelerator.

AcceleratorAttributes

acceleratorAttributes_flowLogsEnabled :: Lens' AcceleratorAttributes (Maybe Bool)

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 Global Accelerator Developer Guide.

acceleratorAttributes_flowLogsS3Bucket :: Lens' AcceleratorAttributes (Maybe Text)

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 Global Accelerator permission to write to the bucket.

acceleratorAttributes_flowLogsS3Prefix :: Lens' AcceleratorAttributes (Maybe Text)

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

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

AcceleratorEvent

acceleratorEvent_message :: Lens' AcceleratorEvent (Maybe Text)

A string that contains an Event message describing changes or errors when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

acceleratorEvent_timestamp :: Lens' AcceleratorEvent (Maybe UTCTime)

A timestamp for when you update an accelerator in Global Accelerator from IPv4 to dual-stack, or dual-stack to IPv4.

ByoipCidr

byoipCidr_cidr :: Lens' ByoipCidr (Maybe Text)

The address range, in CIDR notation.

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

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

byoipCidr_state :: Lens' ByoipCidr (Maybe ByoipCidrState)

The state of the address pool.

ByoipCidrEvent

byoipCidrEvent_message :: Lens' ByoipCidrEvent (Maybe Text)

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

byoipCidrEvent_timestamp :: Lens' ByoipCidrEvent (Maybe UTCTime)

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

CidrAuthorizationContext

cidrAuthorizationContext_message :: Lens' CidrAuthorizationContext Text

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

cidrAuthorizationContext_signature :: Lens' CidrAuthorizationContext Text

The signed authorization message for the prefix and account.

CustomRoutingAccelerator

customRoutingAccelerator_acceleratorArn :: Lens' CustomRoutingAccelerator (Maybe Text)

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

customRoutingAccelerator_createdTime :: Lens' CustomRoutingAccelerator (Maybe UTCTime)

The date and time that the accelerator was created.

customRoutingAccelerator_dnsName :: Lens' CustomRoutingAccelerator (Maybe Text)

The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 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.

If you have a dual-stack accelerator, you also have a second DNS name, DualStackDnsName, that points to both the A record and the AAAA record for all four static addresses for the accelerator: two IPv4 addresses and two IPv6 addresses.

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

customRoutingAccelerator_enabled :: Lens' CustomRoutingAccelerator (Maybe Bool)

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_ipAddressType :: Lens' CustomRoutingAccelerator (Maybe IpAddressType)

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

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

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

customRoutingAccelerator_lastModifiedTime :: Lens' CustomRoutingAccelerator (Maybe UTCTime)

The date and time that the accelerator was last modified.

customRoutingAccelerator_name :: Lens' CustomRoutingAccelerator (Maybe Text)

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

customRoutingAccelerator_status :: Lens' CustomRoutingAccelerator (Maybe CustomRoutingAcceleratorStatus)

Describes the deployment status of the accelerator.

CustomRoutingAcceleratorAttributes

customRoutingAcceleratorAttributes_flowLogsEnabled :: Lens' CustomRoutingAcceleratorAttributes (Maybe Bool)

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 Global Accelerator Developer Guide.

customRoutingAcceleratorAttributes_flowLogsS3Bucket :: Lens' CustomRoutingAcceleratorAttributes (Maybe Text)

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 Global Accelerator permission to write to the bucket.

customRoutingAcceleratorAttributes_flowLogsS3Prefix :: Lens' CustomRoutingAcceleratorAttributes (Maybe Text)

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

CustomRoutingDestinationConfiguration

customRoutingDestinationConfiguration_fromPort :: Lens' CustomRoutingDestinationConfiguration Natural

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

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)

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)

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])

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)

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)

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)

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

CustomRoutingEndpointGroup

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

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.

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

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

customRoutingEndpointGroup_endpointGroupArn :: Lens' CustomRoutingEndpointGroup (Maybe Text)

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

customRoutingEndpointGroup_endpointGroupRegion :: Lens' CustomRoutingEndpointGroup (Maybe Text)

The Amazon Web Services Region where the endpoint group is located.

CustomRoutingListener

customRoutingListener_listenerArn :: Lens' CustomRoutingListener (Maybe Text)

The Amazon Resource Name (ARN) of the listener.

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

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.

DestinationPortMapping

destinationPortMapping_acceleratorArn :: Lens' DestinationPortMapping (Maybe Text)

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

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

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

destinationPortMapping_destinationSocketAddress :: Lens' DestinationPortMapping (Maybe SocketAddress)

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

destinationPortMapping_destinationTrafficState :: Lens' DestinationPortMapping (Maybe CustomRoutingDestinationTrafficState)

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.

destinationPortMapping_endpointGroupArn :: Lens' DestinationPortMapping (Maybe Text)

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

destinationPortMapping_endpointGroupRegion :: Lens' DestinationPortMapping (Maybe Text)

The Amazon Web Services Region for the endpoint group.

destinationPortMapping_endpointId :: Lens' DestinationPortMapping (Maybe Text)

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

destinationPortMapping_ipAddressType :: Lens' DestinationPortMapping (Maybe IpAddressType)

The IP address type that an accelerator supports. For a custom routing accelerator, the value must be IPV4.

EndpointConfiguration

endpointConfiguration_clientIPPreservationEnabled :: Lens' EndpointConfiguration (Maybe Bool)

Indicates whether client IP address preservation is enabled for an 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 endpoint fronted by the accelerator.

Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.

For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.

endpointConfiguration_endpointId :: Lens' EndpointConfiguration (Maybe Text)

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.

endpointConfiguration_weight :: Lens' EndpointConfiguration (Maybe Natural)

The weight associated with the endpoint. When you add weights to endpoints, you configure 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 Global Accelerator Developer Guide.

EndpointDescription

endpointDescription_clientIPPreservationEnabled :: Lens' EndpointDescription (Maybe Bool)

Indicates whether client IP address preservation is enabled for an 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 endpoint fronted by the accelerator.

Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.

For more information, see Preserve client IP addresses in Global Accelerator in the Global Accelerator Developer Guide.

endpointDescription_endpointId :: Lens' EndpointDescription (Maybe Text)

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.

endpointDescription_healthReason :: Lens' EndpointDescription (Maybe Text)

Returns a null result.

endpointDescription_healthState :: Lens' EndpointDescription (Maybe HealthState)

The health status of the endpoint.

endpointDescription_weight :: Lens' EndpointDescription (Maybe Natural)

The weight associated with the endpoint. When you add weights to endpoints, you configure 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 Global Accelerator Developer Guide.

EndpointGroup

endpointGroup_endpointDescriptions :: Lens' EndpointGroup (Maybe [EndpointDescription])

The list of endpoint objects.

endpointGroup_endpointGroupArn :: Lens' EndpointGroup (Maybe Text)

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

endpointGroup_endpointGroupRegion :: Lens' EndpointGroup (Maybe Text)

The Amazon Web Services Region where the endpoint group is located.

endpointGroup_healthCheckIntervalSeconds :: Lens' EndpointGroup (Maybe Natural)

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

endpointGroup_healthCheckPath :: Lens' EndpointGroup (Maybe Text)

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_healthCheckPort :: Lens' EndpointGroup (Maybe Natural)

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_healthCheckProtocol :: Lens' EndpointGroup (Maybe HealthCheckProtocol)

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_portOverrides :: Lens' EndpointGroup (Maybe [PortOverride])

Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you 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.

endpointGroup_thresholdCount :: Lens' EndpointGroup (Maybe Natural)

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_trafficDialPercentage :: Lens' EndpointGroup (Maybe Double)

The percentage of traffic to send to an Amazon Web Services 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.

EndpointIdentifier

endpointIdentifier_clientIPPreservationEnabled :: Lens' EndpointIdentifier (Maybe Bool)

Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false.

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 endpoint fronted by the accelerator.

endpointIdentifier_endpointId :: Lens' EndpointIdentifier Text

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.

IpSet

ipSet_ipAddressFamily :: Lens' IpSet (Maybe IpAddressFamily)

The types of IP addresses included in this IP set.

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

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

ipSet_ipFamily :: Lens' IpSet (Maybe Text)

IpFamily is deprecated and has been replaced by IpAddressFamily.

Listener

listener_clientAffinity :: Lens' Listener (Maybe ClientAffinity)

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.

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.

listener_listenerArn :: Lens' Listener (Maybe Text)

The Amazon Resource Name (ARN) of the listener.

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

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

listener_protocol :: Lens' Listener (Maybe Protocol)

The protocol for the connections from clients to the accelerator.

PortMapping

portMapping_acceleratorPort :: Lens' PortMapping (Maybe Natural)

The accelerator port.

portMapping_destinationSocketAddress :: Lens' PortMapping (Maybe SocketAddress)

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

portMapping_destinationTrafficState :: Lens' PortMapping (Maybe CustomRoutingDestinationTrafficState)

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.

portMapping_endpointGroupArn :: Lens' PortMapping (Maybe Text)

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

portMapping_endpointId :: Lens' PortMapping (Maybe Text)

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

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

The protocols supported by the endpoint group.

PortOverride

portOverride_endpointPort :: Lens' PortOverride (Maybe Natural)

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)

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)

The first port in the range of ports, inclusive.

portRange_toPort :: Lens' PortRange (Maybe Natural)

The last port in the range of ports, inclusive.

SocketAddress

socketAddress_ipAddress :: Lens' SocketAddress (Maybe Text)

The IP address for the socket address.

socketAddress_port :: Lens' SocketAddress (Maybe Natural)

The port for the socket address.

Tag

tag_key :: Lens' Tag Text

A string that contains a Tag key.

tag_value :: Lens' Tag Text

A string that contains a Tag value.