The AWS Global Accelerator API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Accelerator (p. 150)
• AcceleratorAttributes (p. 152)
• ByoipCidr (p. 153)
• ByoipCidrEvent (p. 155)
• CidrAuthorizationContext (p. 156)
• CustomRoutingAccelerator (p. 157)
• CustomRoutingAcceleratorAttributes (p. 159)
• CustomRoutingDestinationConfiguration (p. 160)
• CustomRoutingDestinationDescription (p. 161)
• CustomRoutingEndpointConfiguration (p. 162)
• CustomRoutingEndpointDescription (p. 163)
• CustomRoutingEndpointGroup (p. 164)
• CustomRoutingListener (p. 165)
• DestinationPortMapping (p. 166)
• EndpointConfiguration (p. 168)
• EndpointDescription (p. 170)
• EndpointGroup (p. 172)
• IpSet (p. 175)
• Listener (p. 176)
• PortMapping (p. 178)
• PortOverride (p. 180)
• PortRange (p. 181)
• SocketAddress (p. 182)
• Tag (p. 183)
API Version 2018-08-08 149
Accelerator
Accelerator
An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.
Contents
AcceleratorArn
The Amazon Resource Name (ARN) of the accelerator.
Type: String
Length Constraints: Maximum length of 255.
Required: No CreatedTime
The date and time that the accelerator was created.
Type: Timestamp Required: No 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.
Type: String
Length Constraints: Maximum length of 255.
Required: No 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.
Type: Boolean Required: No IpAddressType
The value for the address type must be IPv4.
Type: String Valid Values: IPV4
Required: No IpSets
The static IP addresses that Global Accelerator associates with the accelerator.
Type: Array of IpSet (p. 175) objects Required: No
LastModifiedTime
The date and time that the accelerator was last modified.
Type: Timestamp Required: No Name
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
Type: String
Length Constraints: Maximum length of 255.
Required: No Status
Describes the deployment status of the accelerator.
Type: String
Valid Values: DEPLOYED | IN_PROGRESS Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 151
AcceleratorAttributes
AcceleratorAttributes
Attributes of an accelerator.
Contents
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.
Type: Boolean Required: No 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.
Type: String
Length Constraints: Maximum length of 255.
Required: No FlowLogsS3Prefix
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 Type: String
Length Constraints: Maximum length of 255.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ByoipCidr
Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP address (BYOIP).
The following describes each BYOIP State that your IP address range can be in.
• PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.
• READY — The address range is provisioned with AWS Global Accelerator and can be advertised.
• PENDING_ADVERTISING — You’ve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.
• ADVERTISING — The address range is being advertised by AWS Global Accelerator.
• PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.
• PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.
• DEPROVISIONED — The address range is deprovisioned from AWS Global Accelerator.
• FAILED_PROVISION — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
• FAILED_ADVERTISING — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
• FAILED_WITHDRAW — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
• FAILED_DEPROVISION — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
Contents
Cidr
The address range, in CIDR notation.
Type: String
Length Constraints: Maximum length of 255.
Required: No Events
A history of status changes for an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
Type: Array of ByoipCidrEvent (p. 155) objects Required: No
State
The state of the address pool.
API Version 2018-08-08 153
See Also
Type: String
Valid Values: PENDING_PROVISIONING | READY | PENDING_ADVERTISING | ADVERTISING
| PENDING_WITHDRAWING | PENDING_DEPROVISIONING | DEPROVISIONED |
FAILED_PROVISION | FAILED_ADVERTISING | FAILED_WITHDRAW | FAILED_DEPROVISION Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ByoipCidrEvent
A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
Contents
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).
Type: String
Length Constraints: Maximum length of 255.
Required: No 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).
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 155
CidrAuthorizationContext
CidrAuthorizationContext
Provides authorization for Amazon to bring a specific IP address range to a specific AWS account using bring your own IP addresses (BYOIP).
For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
Contents
Message
The plain-text authorization message for the prefix and account.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes Signature
The signed authorization message for the prefix and account.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CustomRoutingAccelerator
Attributes of a custom routing accelerator.
Contents
AcceleratorArn
The Amazon Resource Name (ARN) of the custom routing accelerator.
Type: String
Length Constraints: Maximum length of 255.
Required: No CreatedTime
The date and time that the accelerator was created.
Type: Timestamp Required: No 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.
Type: String
Length Constraints: Maximum length of 255.
Required: No 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.
Type: Boolean Required: No IpAddressType
The value for the address type must be IPv4.
Type: String Valid Values: IPV4 Required: No
API Version 2018-08-08 157
See Also
IpSets
The static IP addresses that Global Accelerator associates with the accelerator.
Type: Array of IpSet (p. 175) objects Required: No
LastModifiedTime
The date and time that the accelerator was last modified.
Type: Timestamp Required: No Name
The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
Type: String
Length Constraints: Maximum length of 255.
Required: No Status
Describes the deployment status of the accelerator.
Type: String
Valid Values: DEPLOYED | IN_PROGRESS Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CustomRoutingAcceleratorAttributes
Attributes of a custom routing accelerator.
Contents
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.
Type: Boolean Required: No 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.
Type: String
Length Constraints: Maximum length of 255.
Required: No 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:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id Type: String
Length Constraints: Maximum length of 255.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-08-08 159