String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator.
String name
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
String ipAddressType
The value for the address type must be IPv4.
Boolean enabled
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.
List<E> ipSets
The static IP addresses that Global Accelerator associates with the accelerator.
String dnsName
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.
String status
Describes the deployment status of the accelerator.
Date createdTime
The date and time that the accelerator was created.
Date lastModifiedTime
The date and time that the accelerator was last modified.
Boolean flowLogsEnabled
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.
String flowLogsS3Bucket
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.
String flowLogsS3Prefix
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
String cidr
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.
ByoipCidr byoipCidr
Information about the address range.
String message
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).
Date timestamp
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).
String name
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.
String ipAddressType
The value for the address type must be IPv4.
List<E> ipAddresses
Optionally, if you've added your own IP address pool to Global Accelerator, you can choose IP addresses from your own pool to use for the accelerator's static IP addresses. You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.
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.
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
Boolean enabled
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.
String idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.
List<E> tags
Create tags for an accelerator.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
Accelerator accelerator
The accelerator that is created by specifying a listener and the supported IP address types.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
String endpointGroupRegion
The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
List<E> endpointConfigurations
The list of endpoint objects.
Float trafficDialPercentage
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.
Integer healthCheckPort
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.
String healthCheckProtocol
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.
String healthCheckPath
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
Integer healthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
Integer thresholdCount
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.
String idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
EndpointGroup endpointGroup
The information about the endpoint group that was created.
String acceleratorArn
The Amazon Resource Name (ARN) of your accelerator.
List<E> portRanges
The list of port ranges to support for connections from clients to your accelerator.
String protocol
The protocol for connections from clients to your accelerator.
String 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. Clienty 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.
String idempotencyToken
A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.
Listener listener
The listener that you've created.
String acceleratorArn
The Amazon Resource Name (ARN) of an accelerator.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group to delete.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
String cidr
The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
ByoipCidr byoipCidr
Information about the address range.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.
AcceleratorAttributes acceleratorAttributes
The attributes of the accelerator.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator to describe.
Accelerator accelerator
The description of the accelerator.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group to describe.
EndpointGroup endpointGroup
The description of an endpoint group.
String listenerArn
The Amazon Resource Name (ARN) of the listener to describe.
Listener listener
The description of a listener.
String endpointId
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 EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
Integer weight
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.
Boolean clientIPPreservationEnabled
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.
String endpointId
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 EC2 instances, this is the EC2 instance ID.
An Application Load Balancer can be either internal or internet-facing.
Integer weight
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.
String healthState
The health status of the endpoint.
String healthReason
The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.
If the endpoint state is unhealthy, the reason code can be one of the following values:
Timeout: The health check requests to the endpoint are timing out before returning a status.
Failed: The health check failed, for example because the endpoint response was invalid (malformed).
If the endpoint state is initial, the reason code can be one of the following values:
ProvisioningInProgress: The endpoint is in the process of being provisioned.
InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.
Boolean clientIPPreservationEnabled
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.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
String endpointGroupRegion
The AWS Region that this endpoint group belongs.
List<E> endpointDescriptions
The list of endpoint objects.
Float trafficDialPercentage
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.
Integer healthCheckPort
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.
String 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.
String healthCheckPath
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 (/).
Integer healthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
Integer thresholdCount
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.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
Integer maxResults
The number of endpoint group objects that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String listenerArn
The Amazon Resource Name (ARN) of the listener.
List<E> portRanges
The list of port ranges for the connections from clients to the accelerator.
String protocol
The protocol for the connections from clients to the accelerator.
String 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. Clienty 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.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
Integer maxResults
The number of listener objects that you want to return with this call. The default value is 10.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String resourceArn
The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.
String cidr
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.
CidrAuthorizationContext cidrAuthorizationContext
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
ByoipCidr byoipCidr
Information about the address range.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator that you want to update.
Boolean flowLogsEnabled
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.
String flowLogsS3Bucket
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.
String flowLogsS3Prefix
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
AcceleratorAttributes acceleratorAttributes
Updated attributes for the accelerator.
String acceleratorArn
The Amazon Resource Name (ARN) of the accelerator to update.
String name
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.
String ipAddressType
The value for the address type must be IPv4.
Boolean enabled
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.
Accelerator accelerator
Information about the updated accelerator.
String endpointGroupArn
The Amazon Resource Name (ARN) of the endpoint group.
List<E> endpointConfigurations
The list of endpoint objects.
Float trafficDialPercentage
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.
Integer healthCheckPort
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.
String healthCheckProtocol
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.
String healthCheckPath
If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
Integer healthCheckIntervalSeconds
The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
Integer thresholdCount
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 endpointGroup
The information about the endpoint group that was updated.
String listenerArn
The Amazon Resource Name (ARN) of the listener to update.
List<E> portRanges
The updated list of port ranges for the connections from clients to the accelerator.
String protocol
The updated protocol for the connections from clients to the accelerator.
String 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. Clienty 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.
Listener listener
Information for the updated listener.
String cidr
The address range, in CIDR notation.
ByoipCidr byoipCidr
Information about the address pool.
Copyright © 2020. All rights reserved.