AWS SDK for PHP 3.x

Client: Aws\GlobalAccelerator\GlobalAcceleratorClient

Service ID: globalaccelerator

Version: 2018-08-08

This page describes the parameters and results for the operations of the AWS Global Accelerator (2018-08-08), and shows how to use the Aws\GlobalAccelerator\GlobalAcceleratorClient object to call the described operations. This documentation is specific to the 2018-08-08 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AddCustomRoutingEndpoints ( array $params = [] )
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
AddEndpoints ( array $params = [] )
Add endpoints to an endpoint group.
AdvertiseByoipCidr ( array $params = [] )
Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
AllowCustomRoutingTraffic ( array $params = [] )
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator.
CreateAccelerator ( array $params = [] )
Create an accelerator.
CreateCustomRoutingAccelerator ( array $params = [] )
Create a custom routing accelerator.
CreateCustomRoutingEndpointGroup ( array $params = [] )
Create an endpoint group for the specified listener for a custom routing accelerator.
CreateCustomRoutingListener ( array $params = [] )
Create a listener to process inbound connections from clients to a custom routing accelerator.
CreateEndpointGroup ( array $params = [] )
Create an endpoint group for the specified listener.
CreateListener ( array $params = [] )
Create a listener to process inbound connections from clients to an accelerator.
DeleteAccelerator ( array $params = [] )
Delete an accelerator.
DeleteCustomRoutingAccelerator ( array $params = [] )
Delete a custom routing accelerator.
DeleteCustomRoutingEndpointGroup ( array $params = [] )
Delete an endpoint group from a listener for a custom routing accelerator.
DeleteCustomRoutingListener ( array $params = [] )
Delete a listener for a custom routing accelerator.
DeleteEndpointGroup ( array $params = [] )
Delete an endpoint group from a listener.
DeleteListener ( array $params = [] )
Delete a listener from an accelerator.
DenyCustomRoutingTraffic ( array $params = [] )
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator.
DeprovisionByoipCidr ( array $params = [] )
Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
DescribeAccelerator ( array $params = [] )
Describe an accelerator.
DescribeAcceleratorAttributes ( array $params = [] )
Describe the attributes of an accelerator.
DescribeCustomRoutingAccelerator ( array $params = [] )
Describe a custom routing accelerator.
DescribeCustomRoutingAcceleratorAttributes ( array $params = [] )
Describe the attributes of a custom routing accelerator.
DescribeCustomRoutingEndpointGroup ( array $params = [] )
Describe an endpoint group for a custom routing accelerator.
DescribeCustomRoutingListener ( array $params = [] )
The description of a listener for a custom routing accelerator.
DescribeEndpointGroup ( array $params = [] )
Describe an endpoint group.
DescribeListener ( array $params = [] )
Describe a listener.
ListAccelerators ( array $params = [] )
List the accelerators for an Amazon Web Services account.
ListByoipCidrs ( array $params = [] )
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
ListCustomRoutingAccelerators ( array $params = [] )
List the custom routing accelerators for an Amazon Web Services account.
ListCustomRoutingEndpointGroups ( array $params = [] )
List the endpoint groups that are associated with a listener for a custom routing accelerator.
ListCustomRoutingListeners ( array $params = [] )
List the listeners for a custom routing accelerator.
ListCustomRoutingPortMappings ( array $params = [] )
Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator.
ListCustomRoutingPortMappingsByDestination ( array $params = [] )
List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint.
ListEndpointGroups ( array $params = [] )
List the endpoint groups that are associated with a listener.
ListListeners ( array $params = [] )
List the listeners for an accelerator.
ListTagsForResource ( array $params = [] )
List all tags for an accelerator.
ProvisionByoipCidr ( array $params = [] )
Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool.
RemoveCustomRoutingEndpoints ( array $params = [] )
Remove endpoints from a custom routing accelerator.
RemoveEndpoints ( array $params = [] )
Remove endpoints from an endpoint group.
TagResource ( array $params = [] )
Add tags to an accelerator resource.
UntagResource ( array $params = [] )
Remove tags from a Global Accelerator resource.
UpdateAccelerator ( array $params = [] )
Update an accelerator.
UpdateAcceleratorAttributes ( array $params = [] )
Update the attributes for an accelerator.
UpdateCustomRoutingAccelerator ( array $params = [] )
Update a custom routing accelerator.
UpdateCustomRoutingAcceleratorAttributes ( array $params = [] )
Update the attributes for a custom routing accelerator.
UpdateCustomRoutingListener ( array $params = [] )
Update a listener for a custom routing accelerator.
UpdateEndpointGroup ( array $params = [] )
Update an endpoint group.
UpdateListener ( array $params = [] )
Update a listener.
WithdrawByoipCidr ( array $params = [] )
Stops advertising an address range that is provisioned as an address pool.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAccelerators
ListByoipCidrs
ListCustomRoutingAccelerators
ListCustomRoutingEndpointGroups
ListCustomRoutingListeners
ListCustomRoutingPortMappings
ListCustomRoutingPortMappingsByDestination
ListEndpointGroups
ListListeners

Operations

AddCustomRoutingEndpoints

$result = $client->addCustomRoutingEndpoints([/* ... */]);
$promise = $client->addCustomRoutingEndpointsAsync([/* ... */]);

Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.

The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.

Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.

By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.

Parameter Syntax

$result = $client->addCustomRoutingEndpoints([
    'EndpointConfigurations' => [ // REQUIRED
        [
            'EndpointId' => '<string>',
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EndpointConfigurations

Required: Yes
Type: Array of CustomRoutingEndpointConfiguration structures

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

EndpointGroupArn

Required: Yes
Type: string

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

Result Syntax

[
    'EndpointDescriptions' => [
        [
            'EndpointId' => '<string>',
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>',
]

Result Details

Members

EndpointDescriptions

Type: Array of CustomRoutingEndpointDescription structures

The endpoint objects added to the custom routing accelerator.

EndpointGroupArn

Type: string

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

Errors

EndpointAlreadyExistsException:
The endpoint that you specified doesn't exist.
EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.
AccessDeniedException:
You don't have access permission.
ConflictException:
You can't use both of those options.

AddEndpoints

$result = $client->addEndpoints([/* ... */]);
$promise = $client->addEndpointsAsync([/* ... */]);

Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API).

There are two advantages to using AddEndpoints to add endpoints:

It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding.
It's more convenient, because you don't need to specify all of the current endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.

Parameter Syntax

$result = $client->addEndpoints([
    'EndpointConfigurations' => [ // REQUIRED
        [
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>',
            'Weight' => <integer>,
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EndpointConfigurations

Required: Yes
Type: Array of EndpointConfiguration structures

The list of endpoint objects.

EndpointGroupArn

Required: Yes
Type: string

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

Result Syntax

[
    'EndpointDescriptions' => [
        [
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>',
            'HealthReason' => '<string>',
            'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
            'Weight' => <integer>,
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>',
]

Result Details

Members

EndpointDescriptions

Type: Array of EndpointDescription structures

The list of endpoint objects.

EndpointGroupArn

Type: string

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

Errors

TransactionInProgressException:
There's already a transaction in progress. Another transaction can't be processed.
EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.
AccessDeniedException:
You don't have access permission.

AdvertiseByoipCidr

$result = $client->advertiseByoipCidr([/* ... */]);
$promise = $client->advertiseByoipCidrAsync([/* ... */]);

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.

To stop advertising the BYOIP address range, use WithdrawByoipCidr.

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

Parameter Syntax

$result = $client->advertiseByoipCidr([
    'Cidr' => '<string>', // REQUIRED
]);

Parameter Details

Members

Cidr

Required: Yes
Type: string

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.

Result Syntax

[
    'ByoipCidr' => [
        'Cidr' => '<string>',
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
    ],
]

Result Details

Members

ByoipCidr

Type: ByoipCidr structure

Information about the address range.

Errors

InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
AccessDeniedException:
You don't have access permission.
ByoipCidrNotFoundException:
The CIDR that you specified was not found or is incorrect.
IncorrectCidrStateException:
The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

AllowCustomRoutingTraffic

$result = $client->allowCustomRoutingTraffic([/* ... */]);
$promise = $client->allowCustomRoutingTrafficAsync([/* ... */]);

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.

After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.

Parameter Syntax

$result = $client->allowCustomRoutingTraffic([
    'AllowAllTrafficToEndpoint' => true || false,
    'DestinationAddresses' => ['<string>', ...],
    'DestinationPorts' => [<integer>, ...],
    'EndpointGroupArn' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AllowAllTrafficToEndpoint

Type: boolean

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.

DestinationAddresses

Type: Array of strings

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.

DestinationPorts

Type: Array of ints

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

EndpointGroupArn

Required: Yes
Type: string

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

EndpointId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InvalidArgumentException:
An argument that you specified is invalid.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

CreateAccelerator

$result = $client->createAccelerator([/* ... */]);
$promise = $client->createAcceleratorAsync([/* ... */]);

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify --region us-west-2 on AWS CLI commands.

Parameter Syntax

$result = $client->createAccelerator([
    'Enabled' => true || false,
    'IdempotencyToken' => '<string>', // REQUIRED
    'IpAddressType' => 'IPV4|DUAL_STACK',
    'IpAddresses' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Enabled

Type: boolean

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.

IdempotencyToken

Required: Yes
Type: string

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

IpAddressType

Type: string

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

IpAddresses

Type: Array of strings

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.

Name

Required: Yes
Type: string

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.

Tags

Type: Array of Tag structures

Create tags for an accelerator.

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

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'DualStackDnsName' => '<string>',
        'Enabled' => true || false,
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Members

Accelerator

Type: Accelerator structure

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

Errors

InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.

CreateCustomRoutingAccelerator

$result = $client->createCustomRoutingAccelerator([/* ... */]);
$promise = $client->createCustomRoutingAcceleratorAsync([/* ... */]);

Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.

Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.

Parameter Syntax

$result = $client->createCustomRoutingAccelerator([
    'Enabled' => true || false,
    'IdempotencyToken' => '<string>', // REQUIRED
    'IpAddressType' => 'IPV4|DUAL_STACK',
    'IpAddresses' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

Enabled

Type: boolean

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.

IdempotencyToken

Required: Yes
Type: string

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

IpAddressType

Type: string

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

IpAddresses

Type: Array of strings

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.

Name

Required: Yes
Type: string

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.

Tags

Type: Array of Tag structures

Create tags for an accelerator.

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

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'Enabled' => true || false,
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Members

Accelerator

Type: CustomRoutingAccelerator structure

The accelerator that is created.

Errors

InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.
AccessDeniedException:
You don't have access permission.

CreateCustomRoutingEndpointGroup

$result = $client->createCustomRoutingEndpointGroup([/* ... */]);
$promise = $client->createCustomRoutingEndpointGroupAsync([/* ... */]);

Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.

Parameter Syntax

$result = $client->createCustomRoutingEndpointGroup([
    'DestinationConfigurations' => [ // REQUIRED
        [
            'FromPort' => <integer>, // REQUIRED
            'Protocols' => ['<string>', ...], // REQUIRED
            'ToPort' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'EndpointGroupRegion' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>', // REQUIRED
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DestinationConfigurations

Required: Yes
Type: Array of CustomRoutingDestinationConfiguration structures

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

EndpointGroupRegion

Required: Yes
Type: string

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

IdempotencyToken

Required: Yes
Type: string

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

ListenerArn

Required: Yes
Type: string

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

Result Syntax

[
    'EndpointGroup' => [
        'DestinationDescriptions' => [
            [
                'FromPort' => <integer>,
                'Protocols' => ['<string>', ...],
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'EndpointDescriptions' => [
            [
                'EndpointId' => '<string>',
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
    ],
]

Result Details

Members

EndpointGroup

Type: CustomRoutingEndpointGroup structure

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

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
EndpointGroupAlreadyExistsException:
The endpoint group that you specified already exists.
ListenerNotFoundException:
The listener that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
InvalidPortRangeException:
The port numbers that you specified are not valid numbers or are not unique for this accelerator.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.
AccessDeniedException:
You don't have access permission.

CreateCustomRoutingListener

$result = $client->createCustomRoutingListener([/* ... */]);
$promise = $client->createCustomRoutingListenerAsync([/* ... */]);

Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.

Parameter Syntax

$result = $client->createCustomRoutingListener([
    'AcceleratorArn' => '<string>', // REQUIRED
    'IdempotencyToken' => '<string>', // REQUIRED
    'PortRanges' => [ // REQUIRED
        [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

IdempotencyToken

Required: Yes
Type: string

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

PortRanges

Required: Yes
Type: Array of PortRange structures

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.

Result Syntax

[
    'Listener' => [
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

Listener

Type: CustomRoutingListener structure

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

Errors

InvalidArgumentException:
An argument that you specified is invalid.
AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InvalidPortRangeException:
The port numbers that you specified are not valid numbers or are not unique for this accelerator.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.

CreateEndpointGroup

$result = $client->createEndpointGroup([/* ... */]);
$promise = $client->createEndpointGroupAsync([/* ... */]);

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.

Parameter Syntax

$result = $client->createEndpointGroup([
    'EndpointConfigurations' => [
        [
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>',
            'Weight' => <integer>,
        ],
        // ...
    ],
    'EndpointGroupRegion' => '<string>', // REQUIRED
    'HealthCheckIntervalSeconds' => <integer>,
    'HealthCheckPath' => '<string>',
    'HealthCheckPort' => <integer>,
    'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
    'IdempotencyToken' => '<string>', // REQUIRED
    'ListenerArn' => '<string>', // REQUIRED
    'PortOverrides' => [
        [
            'EndpointPort' => <integer>,
            'ListenerPort' => <integer>,
        ],
        // ...
    ],
    'ThresholdCount' => <integer>,
    'TrafficDialPercentage' => <float>,
]);

Parameter Details

Members

EndpointConfigurations

Type: Array of EndpointConfiguration structures

The list of endpoint objects.

EndpointGroupRegion

Required: Yes
Type: string

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

HealthCheckIntervalSeconds

Type: int

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

HealthCheckPath

Type: string

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

HealthCheckPort

Type: int

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.

HealthCheckProtocol

Type: string

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

IdempotencyToken

Required: Yes
Type: string

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

ListenerArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the listener.

PortOverrides

Type: Array of PortOverride structures

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.

ThresholdCount

Type: int

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.

TrafficDialPercentage

Type: float

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.

Result Syntax

[
    'EndpointGroup' => [
        'EndpointDescriptions' => [
            [
                'ClientIPPreservationEnabled' => true || false,
                'EndpointId' => '<string>',
                'HealthReason' => '<string>',
                'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
                'Weight' => <integer>,
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
        'HealthCheckIntervalSeconds' => <integer>,
        'HealthCheckPath' => '<string>',
        'HealthCheckPort' => <integer>,
        'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
        'PortOverrides' => [
            [
                'EndpointPort' => <integer>,
                'ListenerPort' => <integer>,
            ],
            // ...
        ],
        'ThresholdCount' => <integer>,
        'TrafficDialPercentage' => <float>,
    ],
]

Result Details

Members

EndpointGroup

Type: EndpointGroup structure

The information about the endpoint group that was created.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
EndpointGroupAlreadyExistsException:
The endpoint group that you specified already exists.
ListenerNotFoundException:
The listener that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.
AccessDeniedException:
You don't have access permission.

CreateListener

$result = $client->createListener([/* ... */]);
$promise = $client->createListenerAsync([/* ... */]);

Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.

Parameter Syntax

$result = $client->createListener([
    'AcceleratorArn' => '<string>', // REQUIRED
    'ClientAffinity' => 'NONE|SOURCE_IP',
    'IdempotencyToken' => '<string>', // REQUIRED
    'PortRanges' => [ // REQUIRED
        [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        // ...
    ],
    'Protocol' => 'TCP|UDP', // REQUIRED
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of your accelerator.

ClientAffinity

Type: string

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.

IdempotencyToken

Required: Yes
Type: string

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

PortRanges

Required: Yes
Type: Array of PortRange structures

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

Protocol

Required: Yes
Type: string

The protocol for connections from clients to your accelerator.

Result Syntax

[
    'Listener' => [
        'ClientAffinity' => 'NONE|SOURCE_IP',
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'Protocol' => 'TCP|UDP',
    ],
]

Result Details

Members

Listener

Type: Listener structure

The listener that you've created.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InvalidPortRangeException:
The port numbers that you specified are not valid numbers or are not unique for this accelerator.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.

DeleteAccelerator

$result = $client->deleteAccelerator([/* ... */]);
$promise = $client->deleteAcceleratorAsync([/* ... */]);

Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.

When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.

The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.

Parameter Syntax

$result = $client->deleteAccelerator([
    'AcceleratorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of an accelerator.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
AcceleratorNotDisabledException:
The accelerator that you specified could not be disabled.
AssociatedListenerFoundException:
The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

DeleteCustomRoutingAccelerator

$result = $client->deleteCustomRoutingAccelerator([/* ... */]);
$promise = $client->deleteCustomRoutingAcceleratorAsync([/* ... */]);

Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.

When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.

Parameter Syntax

$result = $client->deleteCustomRoutingAccelerator([
    'AcceleratorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
AcceleratorNotDisabledException:
The accelerator that you specified could not be disabled.
AssociatedListenerFoundException:
The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

DeleteCustomRoutingEndpointGroup

$result = $client->deleteCustomRoutingEndpointGroup([/* ... */]);
$promise = $client->deleteCustomRoutingEndpointGroupAsync([/* ... */]);

Delete an endpoint group from a listener for a custom routing accelerator.

Parameter Syntax

$result = $client->deleteCustomRoutingEndpointGroup([
    'EndpointGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EndpointGroupArn

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

DeleteCustomRoutingListener

$result = $client->deleteCustomRoutingListener([/* ... */]);
$promise = $client->deleteCustomRoutingListenerAsync([/* ... */]);

Delete a listener for a custom routing accelerator.

Parameter Syntax

$result = $client->deleteCustomRoutingListener([
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ListenerArn

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
ListenerNotFoundException:
The listener that you specified doesn't exist.
AssociatedEndpointGroupFoundException:
The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

DeleteEndpointGroup

$result = $client->deleteEndpointGroup([/* ... */]);
$promise = $client->deleteEndpointGroupAsync([/* ... */]);

Delete an endpoint group from a listener.

Parameter Syntax

$result = $client->deleteEndpointGroup([
    'EndpointGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EndpointGroupArn

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

DeleteListener

$result = $client->deleteListener([/* ... */]);
$promise = $client->deleteListenerAsync([/* ... */]);

Delete a listener from an accelerator.

Parameter Syntax

$result = $client->deleteListener([
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ListenerArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the listener.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
ListenerNotFoundException:
The listener that you specified doesn't exist.
AssociatedEndpointGroupFoundException:
The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

DenyCustomRoutingTraffic

$result = $client->denyCustomRoutingTraffic([/* ... */]);
$promise = $client->denyCustomRoutingTrafficAsync([/* ... */]);

Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.

After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.

Parameter Syntax

$result = $client->denyCustomRoutingTraffic([
    'DenyAllTrafficToEndpoint' => true || false,
    'DestinationAddresses' => ['<string>', ...],
    'DestinationPorts' => [<integer>, ...],
    'EndpointGroupArn' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DenyAllTrafficToEndpoint

Type: boolean

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.

DestinationAddresses

Type: Array of strings

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.

DestinationPorts

Type: Array of ints

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

EndpointGroupArn

Required: Yes
Type: string

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

EndpointId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InvalidArgumentException:
An argument that you specified is invalid.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

DeprovisionByoipCidr

$result = $client->deprovisionByoipCidr([/* ... */]);
$promise = $client->deprovisionByoipCidrAsync([/* ... */]);

Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range.

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

Parameter Syntax

$result = $client->deprovisionByoipCidr([
    'Cidr' => '<string>', // REQUIRED
]);

Parameter Details

Members

Cidr

Required: Yes
Type: string

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

Result Syntax

[
    'ByoipCidr' => [
        'Cidr' => '<string>',
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
    ],
]

Result Details

Members

ByoipCidr

Type: ByoipCidr structure

Information about the address range.

Errors

InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
AccessDeniedException:
You don't have access permission.
ByoipCidrNotFoundException:
The CIDR that you specified was not found or is incorrect.
IncorrectCidrStateException:
The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

DescribeAccelerator

$result = $client->describeAccelerator([/* ... */]);
$promise = $client->describeAcceleratorAsync([/* ... */]);

Describe an accelerator.

Parameter Syntax

$result = $client->describeAccelerator([
    'AcceleratorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'DualStackDnsName' => '<string>',
        'Enabled' => true || false,
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Members

Accelerator

Type: Accelerator structure

The description of the accelerator.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

DescribeAcceleratorAttributes

$result = $client->describeAcceleratorAttributes([/* ... */]);
$promise = $client->describeAcceleratorAttributesAsync([/* ... */]);

Describe the attributes of an accelerator.

Parameter Syntax

$result = $client->describeAcceleratorAttributes([
    'AcceleratorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

Result Syntax

[
    'AcceleratorAttributes' => [
        'FlowLogsEnabled' => true || false,
        'FlowLogsS3Bucket' => '<string>',
        'FlowLogsS3Prefix' => '<string>',
    ],
]

Result Details

Members

AcceleratorAttributes

Type: AcceleratorAttributes structure

The attributes of the accelerator.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

DescribeCustomRoutingAccelerator

$result = $client->describeCustomRoutingAccelerator([/* ... */]);
$promise = $client->describeCustomRoutingAcceleratorAsync([/* ... */]);

Describe a custom routing accelerator.

Parameter Syntax

$result = $client->describeCustomRoutingAccelerator([
    'AcceleratorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'Enabled' => true || false,
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Members

Accelerator

Type: CustomRoutingAccelerator structure

The description of the custom routing accelerator.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

DescribeCustomRoutingAcceleratorAttributes

$result = $client->describeCustomRoutingAcceleratorAttributes([/* ... */]);
$promise = $client->describeCustomRoutingAcceleratorAttributesAsync([/* ... */]);

Describe the attributes of a custom routing accelerator.

Parameter Syntax

$result = $client->describeCustomRoutingAcceleratorAttributes([
    'AcceleratorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

Result Syntax

[
    'AcceleratorAttributes' => [
        'FlowLogsEnabled' => true || false,
        'FlowLogsS3Bucket' => '<string>',
        'FlowLogsS3Prefix' => '<string>',
    ],
]

Result Details

Members

AcceleratorAttributes

Type: CustomRoutingAcceleratorAttributes structure

The attributes of the custom routing accelerator.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

DescribeCustomRoutingEndpointGroup

$result = $client->describeCustomRoutingEndpointGroup([/* ... */]);
$promise = $client->describeCustomRoutingEndpointGroupAsync([/* ... */]);

Describe an endpoint group for a custom routing accelerator.

Parameter Syntax

$result = $client->describeCustomRoutingEndpointGroup([
    'EndpointGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EndpointGroupArn

Required: Yes
Type: string

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

Result Syntax

[
    'EndpointGroup' => [
        'DestinationDescriptions' => [
            [
                'FromPort' => <integer>,
                'Protocols' => ['<string>', ...],
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'EndpointDescriptions' => [
            [
                'EndpointId' => '<string>',
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
    ],
]

Result Details

Members

EndpointGroup

Type: CustomRoutingEndpointGroup structure

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

Errors

InvalidArgumentException:
An argument that you specified is invalid.
EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

DescribeCustomRoutingListener

$result = $client->describeCustomRoutingListener([/* ... */]);
$promise = $client->describeCustomRoutingListenerAsync([/* ... */]);

The description of a listener for a custom routing accelerator.

Parameter Syntax

$result = $client->describeCustomRoutingListener([
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ListenerArn

Required: Yes
Type: string

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

Result Syntax

[
    'Listener' => [
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

Listener

Type: CustomRoutingListener structure

The description of a listener for a custom routing accelerator.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
ListenerNotFoundException:
The listener that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

DescribeEndpointGroup

$result = $client->describeEndpointGroup([/* ... */]);
$promise = $client->describeEndpointGroupAsync([/* ... */]);

Describe an endpoint group.

Parameter Syntax

$result = $client->describeEndpointGroup([
    'EndpointGroupArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

EndpointGroupArn

Required: Yes
Type: string

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

Result Syntax

[
    'EndpointGroup' => [
        'EndpointDescriptions' => [
            [
                'ClientIPPreservationEnabled' => true || false,
                'EndpointId' => '<string>',
                'HealthReason' => '<string>',
                'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
                'Weight' => <integer>,
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
        'HealthCheckIntervalSeconds' => <integer>,
        'HealthCheckPath' => '<string>',
        'HealthCheckPort' => <integer>,
        'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
        'PortOverrides' => [
            [
                'EndpointPort' => <integer>,
                'ListenerPort' => <integer>,
            ],
            // ...
        ],
        'ThresholdCount' => <integer>,
        'TrafficDialPercentage' => <float>,
    ],
]

Result Details

Members

EndpointGroup

Type: EndpointGroup structure

The description of an endpoint group.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

DescribeListener

$result = $client->describeListener([/* ... */]);
$promise = $client->describeListenerAsync([/* ... */]);

Describe a listener.

Parameter Syntax

$result = $client->describeListener([
    'ListenerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ListenerArn

Required: Yes
Type: string

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

Result Syntax

[
    'Listener' => [
        'ClientAffinity' => 'NONE|SOURCE_IP',
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'Protocol' => 'TCP|UDP',
    ],
]

Result Details

Members

Listener

Type: Listener structure

The description of a listener.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
ListenerNotFoundException:
The listener that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListAccelerators

$result = $client->listAccelerators([/* ... */]);
$promise = $client->listAcceleratorsAsync([/* ... */]);

List the accelerators for an Amazon Web Services account.

Parameter Syntax

$result = $client->listAccelerators([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'Accelerators' => [
        [
            'AcceleratorArn' => '<string>',
            'CreatedTime' => <DateTime>,
            'DnsName' => '<string>',
            'DualStackDnsName' => '<string>',
            'Enabled' => true || false,
            'Events' => [
                [
                    'Message' => '<string>',
                    'Timestamp' => <DateTime>,
                ],
                // ...
            ],
            'IpAddressType' => 'IPV4|DUAL_STACK',
            'IpSets' => [
                [
                    'IpAddressFamily' => 'IPv4|IPv6',
                    'IpAddresses' => ['<string>', ...],
                    'IpFamily' => '<string>',
                ],
                // ...
            ],
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'DEPLOYED|IN_PROGRESS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Accelerators

Type: Array of Accelerator structures

The list of accelerators for a customer account.

NextToken

Type: string

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

Errors

InvalidArgumentException:
An argument that you specified is invalid.
InvalidNextTokenException:
There isn't another item to return.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListByoipCidrs

$result = $client->listByoipCidrs([/* ... */]);
$promise = $client->listByoipCidrsAsync([/* ... */]);

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.

Parameter Syntax

$result = $client->listByoipCidrs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

NextToken

Type: string

The token for the next page of results.

Result Syntax

[
    'ByoipCidrs' => [
        [
            'Cidr' => '<string>',
            'Events' => [
                [
                    'Message' => '<string>',
                    'Timestamp' => <DateTime>,
                ],
                // ...
            ],
            'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

ByoipCidrs

Type: Array of ByoipCidr structures

Information about your address ranges.

NextToken

Type: string

The token for the next page of results.

Errors

InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
AccessDeniedException:
You don't have access permission.
InvalidNextTokenException:
There isn't another item to return.

ListCustomRoutingAccelerators

$result = $client->listCustomRoutingAccelerators([/* ... */]);
$promise = $client->listCustomRoutingAcceleratorsAsync([/* ... */]);

List the custom routing accelerators for an Amazon Web Services account.

Parameter Syntax

$result = $client->listCustomRoutingAccelerators([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'Accelerators' => [
        [
            'AcceleratorArn' => '<string>',
            'CreatedTime' => <DateTime>,
            'DnsName' => '<string>',
            'Enabled' => true || false,
            'IpAddressType' => 'IPV4|DUAL_STACK',
            'IpSets' => [
                [
                    'IpAddressFamily' => 'IPv4|IPv6',
                    'IpAddresses' => ['<string>', ...],
                    'IpFamily' => '<string>',
                ],
                // ...
            ],
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Status' => 'DEPLOYED|IN_PROGRESS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Accelerators

Type: Array of CustomRoutingAccelerator structures

The list of custom routing accelerators for a customer account.

NextToken

Type: string

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

Errors

InvalidArgumentException:
An argument that you specified is invalid.
InvalidNextTokenException:
There isn't another item to return.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListCustomRoutingEndpointGroups

$result = $client->listCustomRoutingEndpointGroups([/* ... */]);
$promise = $client->listCustomRoutingEndpointGroupsAsync([/* ... */]);

List the endpoint groups that are associated with a listener for a custom routing accelerator.

Parameter Syntax

$result = $client->listCustomRoutingEndpointGroups([
    'ListenerArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ListenerArn

Required: Yes
Type: string

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

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'EndpointGroups' => [
        [
            'DestinationDescriptions' => [
                [
                    'FromPort' => <integer>,
                    'Protocols' => ['<string>', ...],
                    'ToPort' => <integer>,
                ],
                // ...
            ],
            'EndpointDescriptions' => [
                [
                    'EndpointId' => '<string>',
                ],
                // ...
            ],
            'EndpointGroupArn' => '<string>',
            'EndpointGroupRegion' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EndpointGroups

Type: Array of CustomRoutingEndpointGroup structures

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

NextToken

Type: string

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

Errors

ListenerNotFoundException:
The listener that you specified doesn't exist.
InvalidNextTokenException:
There isn't another item to return.
InvalidArgumentException:
An argument that you specified is invalid.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListCustomRoutingListeners

$result = $client->listCustomRoutingListeners([/* ... */]);
$promise = $client->listCustomRoutingListenersAsync([/* ... */]);

List the listeners for a custom routing accelerator.

Parameter Syntax

$result = $client->listCustomRoutingListeners([
    'AcceleratorArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'Listeners' => [
        [
            'ListenerArn' => '<string>',
            'PortRanges' => [
                [
                    'FromPort' => <integer>,
                    'ToPort' => <integer>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Listeners

Type: Array of CustomRoutingListener structures

The list of listeners for a custom routing accelerator.

NextToken

Type: string

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

Errors

InvalidArgumentException:
An argument that you specified is invalid.
AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InvalidNextTokenException:
There isn't another item to return.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListCustomRoutingPortMappings

$result = $client->listCustomRoutingPortMappings([/* ... */]);
$promise = $client->listCustomRoutingPortMappingsAsync([/* ... */]);

Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.

If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.

The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.

Parameter Syntax

$result = $client->listCustomRoutingPortMappings([
    'AcceleratorArn' => '<string>', // REQUIRED
    'EndpointGroupArn' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

EndpointGroupArn

Type: string

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

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'PortMappings' => [
        [
            'AcceleratorPort' => <integer>,
            'DestinationSocketAddress' => [
                'IpAddress' => '<string>',
                'Port' => <integer>,
            ],
            'DestinationTrafficState' => 'ALLOW|DENY',
            'EndpointGroupArn' => '<string>',
            'EndpointId' => '<string>',
            'Protocols' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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

PortMappings

Type: Array of PortMapping structures

The port mappings for a custom routing accelerator.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
InvalidNextTokenException:
There isn't another item to return.
EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListCustomRoutingPortMappingsByDestination

$result = $client->listCustomRoutingPortMappingsByDestination([/* ... */]);
$promise = $client->listCustomRoutingPortMappingsByDestinationAsync([/* ... */]);

List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.

Parameter Syntax

$result = $client->listCustomRoutingPortMappingsByDestination([
    'DestinationAddress' => '<string>', // REQUIRED
    'EndpointId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DestinationAddress

Required: Yes
Type: string

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

EndpointId

Required: Yes
Type: string

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

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'DestinationPortMappings' => [
        [
            'AcceleratorArn' => '<string>',
            'AcceleratorSocketAddresses' => [
                [
                    'IpAddress' => '<string>',
                    'Port' => <integer>,
                ],
                // ...
            ],
            'DestinationSocketAddress' => [
                'IpAddress' => '<string>',
                'Port' => <integer>,
            ],
            'DestinationTrafficState' => 'ALLOW|DENY',
            'EndpointGroupArn' => '<string>',
            'EndpointGroupRegion' => '<string>',
            'EndpointId' => '<string>',
            'IpAddressType' => 'IPV4|DUAL_STACK',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DestinationPortMappings

Type: Array of DestinationPortMapping structures

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

NextToken

Type: string

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

Errors

InvalidArgumentException:
An argument that you specified is invalid.
InvalidNextTokenException:
There isn't another item to return.
EndpointNotFoundException:
The endpoint that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListEndpointGroups

$result = $client->listEndpointGroups([/* ... */]);
$promise = $client->listEndpointGroupsAsync([/* ... */]);

List the endpoint groups that are associated with a listener.

Parameter Syntax

$result = $client->listEndpointGroups([
    'ListenerArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

ListenerArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the listener.

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'EndpointGroups' => [
        [
            'EndpointDescriptions' => [
                [
                    'ClientIPPreservationEnabled' => true || false,
                    'EndpointId' => '<string>',
                    'HealthReason' => '<string>',
                    'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
                    'Weight' => <integer>,
                ],
                // ...
            ],
            'EndpointGroupArn' => '<string>',
            'EndpointGroupRegion' => '<string>',
            'HealthCheckIntervalSeconds' => <integer>,
            'HealthCheckPath' => '<string>',
            'HealthCheckPort' => <integer>,
            'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
            'PortOverrides' => [
                [
                    'EndpointPort' => <integer>,
                    'ListenerPort' => <integer>,
                ],
                // ...
            ],
            'ThresholdCount' => <integer>,
            'TrafficDialPercentage' => <float>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

EndpointGroups

Type: Array of EndpointGroup structures

The list of the endpoint groups associated with a listener.

NextToken

Type: string

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

Errors

ListenerNotFoundException:
The listener that you specified doesn't exist.
InvalidNextTokenException:
There isn't another item to return.
InvalidArgumentException:
An argument that you specified is invalid.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListListeners

$result = $client->listListeners([/* ... */]);
$promise = $client->listListenersAsync([/* ... */]);

List the listeners for an accelerator.

Parameter Syntax

$result = $client->listListeners([
    'AcceleratorArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

MaxResults

Type: int

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

NextToken

Type: string

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

Result Syntax

[
    'Listeners' => [
        [
            'ClientAffinity' => 'NONE|SOURCE_IP',
            'ListenerArn' => '<string>',
            'PortRanges' => [
                [
                    'FromPort' => <integer>,
                    'ToPort' => <integer>,
                ],
                // ...
            ],
            'Protocol' => 'TCP|UDP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Listeners

Type: Array of Listener structures

The list of listeners for an accelerator.

NextToken

Type: string

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

Errors

InvalidArgumentException:
An argument that you specified is invalid.
AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InvalidNextTokenException:
There isn't another item to return.
InternalServiceErrorException:
There was an internal error for Global Accelerator.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List all tags for an accelerator.

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

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Tags

Type: Array of Tag structures

Root level tag for the Tags parameters.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

ProvisionByoipCidr

$result = $client->provisionByoipCidr([/* ... */]);
$promise = $client->provisionByoipCidrAsync([/* ... */]);

Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

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

Parameter Syntax

$result = $client->provisionByoipCidr([
    'Cidr' => '<string>', // REQUIRED
    'CidrAuthorizationContext' => [ // REQUIRED
        'Message' => '<string>', // REQUIRED
        'Signature' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Cidr

Required: Yes
Type: string

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

Required: Yes
Type: CidrAuthorizationContext structure

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

Result Syntax

[
    'ByoipCidr' => [
        'Cidr' => '<string>',
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
    ],
]

Result Details

Members

ByoipCidr

Type: ByoipCidr structure

Information about the address range.

Errors

InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.
AccessDeniedException:
You don't have access permission.
IncorrectCidrStateException:
The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

RemoveCustomRoutingEndpoints

$result = $client->removeCustomRoutingEndpoints([/* ... */]);
$promise = $client->removeCustomRoutingEndpointsAsync([/* ... */]);

Remove endpoints from a custom routing accelerator.

Parameter Syntax

$result = $client->removeCustomRoutingEndpoints([
    'EndpointGroupArn' => '<string>', // REQUIRED
    'EndpointIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

EndpointGroupArn

Required: Yes
Type: string

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

EndpointIds

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
EndpointNotFoundException:
The endpoint that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
AccessDeniedException:
You don't have access permission.
ConflictException:
You can't use both of those options.

RemoveEndpoints

$result = $client->removeEndpoints([/* ... */]);
$promise = $client->removeEndpointsAsync([/* ... */]);

Remove endpoints from an endpoint group.

The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead:

It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group.
It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.

Parameter Syntax

$result = $client->removeEndpoints([
    'EndpointGroupArn' => '<string>', // REQUIRED
    'EndpointIdentifiers' => [ // REQUIRED
        [
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

EndpointGroupArn

Required: Yes
Type: string

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

EndpointIdentifiers

Required: Yes
Type: Array of EndpointIdentifier structures

The identifiers of the endpoints that you want to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
AccessDeniedException:
You don't have access permission.
TransactionInProgressException:
There's already a transaction in progress. Another transaction can't be processed.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Add tags to an accelerator resource.

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

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

Tags

Required: Yes
Type: Array of Tag structures

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.

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

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

TagKeys

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

UpdateAccelerator

$result = $client->updateAccelerator([/* ... */]);
$promise = $client->updateAcceleratorAsync([/* ... */]);

Update an accelerator.

Parameter Syntax

$result = $client->updateAccelerator([
    'AcceleratorArn' => '<string>', // REQUIRED
    'Enabled' => true || false,
    'IpAddressType' => 'IPV4|DUAL_STACK',
    'Name' => '<string>',
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

Enabled

Type: boolean

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.

IpAddressType

Type: string

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

Name

Type: string

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.

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'DualStackDnsName' => '<string>',
        'Enabled' => true || false,
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Members

Accelerator

Type: Accelerator structure

Information about the updated accelerator.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
AccessDeniedException:
You don't have access permission.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

UpdateAcceleratorAttributes

$result = $client->updateAcceleratorAttributes([/* ... */]);
$promise = $client->updateAcceleratorAttributesAsync([/* ... */]);

Update the attributes for an accelerator.

Parameter Syntax

$result = $client->updateAcceleratorAttributes([
    'AcceleratorArn' => '<string>', // REQUIRED
    'FlowLogsEnabled' => true || false,
    'FlowLogsS3Bucket' => '<string>',
    'FlowLogsS3Prefix' => '<string>',
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

FlowLogsEnabled

Type: boolean

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.

FlowLogsS3Bucket

Type: string

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.

FlowLogsS3Prefix

Type: string

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

Result Syntax

[
    'AcceleratorAttributes' => [
        'FlowLogsEnabled' => true || false,
        'FlowLogsS3Bucket' => '<string>',
        'FlowLogsS3Prefix' => '<string>',
    ],
]

Result Details

Members

AcceleratorAttributes

Type: AcceleratorAttributes structure

Updated attributes for the accelerator.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
AccessDeniedException:
You don't have access permission.

UpdateCustomRoutingAccelerator

$result = $client->updateCustomRoutingAccelerator([/* ... */]);
$promise = $client->updateCustomRoutingAcceleratorAsync([/* ... */]);

Update a custom routing accelerator.

Parameter Syntax

$result = $client->updateCustomRoutingAccelerator([
    'AcceleratorArn' => '<string>', // REQUIRED
    'Enabled' => true || false,
    'IpAddressType' => 'IPV4|DUAL_STACK',
    'Name' => '<string>',
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

Enabled

Type: boolean

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.

IpAddressType

Type: string

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

Name

Type: string

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.

Result Syntax

[
    'Accelerator' => [
        'AcceleratorArn' => '<string>',
        'CreatedTime' => <DateTime>,
        'DnsName' => '<string>',
        'Enabled' => true || false,
        'IpAddressType' => 'IPV4|DUAL_STACK',
        'IpSets' => [
            [
                'IpAddressFamily' => 'IPv4|IPv6',
                'IpAddresses' => ['<string>', ...],
                'IpFamily' => '<string>',
            ],
            // ...
        ],
        'LastModifiedTime' => <DateTime>,
        'Name' => '<string>',
        'Status' => 'DEPLOYED|IN_PROGRESS',
    ],
]

Result Details

Members

Accelerator

Type: CustomRoutingAccelerator structure

Information about the updated custom routing accelerator.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.

UpdateCustomRoutingAcceleratorAttributes

$result = $client->updateCustomRoutingAcceleratorAttributes([/* ... */]);
$promise = $client->updateCustomRoutingAcceleratorAttributesAsync([/* ... */]);

Update the attributes for a custom routing accelerator.

Parameter Syntax

$result = $client->updateCustomRoutingAcceleratorAttributes([
    'AcceleratorArn' => '<string>', // REQUIRED
    'FlowLogsEnabled' => true || false,
    'FlowLogsS3Bucket' => '<string>',
    'FlowLogsS3Prefix' => '<string>',
]);

Parameter Details

Members

AcceleratorArn

Required: Yes
Type: string

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

FlowLogsEnabled

Type: boolean

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.

FlowLogsS3Bucket

Type: string

FlowLogsS3Prefix

Type: string

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

Result Syntax

[
    'AcceleratorAttributes' => [
        'FlowLogsEnabled' => true || false,
        'FlowLogsS3Bucket' => '<string>',
        'FlowLogsS3Prefix' => '<string>',
    ],
]

Result Details

Members

AcceleratorAttributes

Type: CustomRoutingAcceleratorAttributes structure

Updated custom routing accelerator.

Errors

AcceleratorNotFoundException:
The accelerator that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
AccessDeniedException:
You don't have access permission.

UpdateCustomRoutingListener

$result = $client->updateCustomRoutingListener([/* ... */]);
$promise = $client->updateCustomRoutingListenerAsync([/* ... */]);

Update a listener for a custom routing accelerator.

Parameter Syntax

$result = $client->updateCustomRoutingListener([
    'ListenerArn' => '<string>', // REQUIRED
    'PortRanges' => [ // REQUIRED
        [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Members

ListenerArn

Required: Yes
Type: string

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

PortRanges

Required: Yes
Type: Array of PortRange structures

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.

Result Syntax

[
    'Listener' => [
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

Listener

Type: CustomRoutingListener structure

Information for the updated listener for a custom routing accelerator.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
InvalidPortRangeException:
The port numbers that you specified are not valid numbers or are not unique for this accelerator.
ListenerNotFoundException:
The listener that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.

UpdateEndpointGroup

$result = $client->updateEndpointGroup([/* ... */]);
$promise = $client->updateEndpointGroupAsync([/* ... */]);

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

Parameter Syntax

$result = $client->updateEndpointGroup([
    'EndpointConfigurations' => [
        [
            'ClientIPPreservationEnabled' => true || false,
            'EndpointId' => '<string>',
            'Weight' => <integer>,
        ],
        // ...
    ],
    'EndpointGroupArn' => '<string>', // REQUIRED
    'HealthCheckIntervalSeconds' => <integer>,
    'HealthCheckPath' => '<string>',
    'HealthCheckPort' => <integer>,
    'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
    'PortOverrides' => [
        [
            'EndpointPort' => <integer>,
            'ListenerPort' => <integer>,
        ],
        // ...
    ],
    'ThresholdCount' => <integer>,
    'TrafficDialPercentage' => <float>,
]);

Parameter Details

Members

EndpointConfigurations

Type: Array of EndpointConfiguration structures

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

EndpointGroupArn

Required: Yes
Type: string

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

HealthCheckIntervalSeconds

Type: int

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

HealthCheckPath

Type: string

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

HealthCheckPort

Type: int

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.

HealthCheckProtocol

Type: string

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

PortOverrides

Type: Array of PortOverride structures

For more information, see Overriding listener ports in the Global Accelerator Developer Guide.

ThresholdCount

Type: int

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.

TrafficDialPercentage

Type: float

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

The default value is 100.

Result Syntax

[
    'EndpointGroup' => [
        'EndpointDescriptions' => [
            [
                'ClientIPPreservationEnabled' => true || false,
                'EndpointId' => '<string>',
                'HealthReason' => '<string>',
                'HealthState' => 'INITIAL|HEALTHY|UNHEALTHY',
                'Weight' => <integer>,
            ],
            // ...
        ],
        'EndpointGroupArn' => '<string>',
        'EndpointGroupRegion' => '<string>',
        'HealthCheckIntervalSeconds' => <integer>,
        'HealthCheckPath' => '<string>',
        'HealthCheckPort' => <integer>,
        'HealthCheckProtocol' => 'TCP|HTTP|HTTPS',
        'PortOverrides' => [
            [
                'EndpointPort' => <integer>,
                'ListenerPort' => <integer>,
            ],
            // ...
        ],
        'ThresholdCount' => <integer>,
        'TrafficDialPercentage' => <float>,
    ],
]

Result Details

Members

EndpointGroup

Type: EndpointGroup structure

The information about the endpoint group that was updated.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
EndpointGroupNotFoundException:
The endpoint group that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.
AccessDeniedException:
You don't have access permission.

UpdateListener

$result = $client->updateListener([/* ... */]);
$promise = $client->updateListenerAsync([/* ... */]);

Update a listener.

Parameter Syntax

$result = $client->updateListener([
    'ClientAffinity' => 'NONE|SOURCE_IP',
    'ListenerArn' => '<string>', // REQUIRED
    'PortRanges' => [
        [
            'FromPort' => <integer>,
            'ToPort' => <integer>,
        ],
        // ...
    ],
    'Protocol' => 'TCP|UDP',
]);

Parameter Details

Members

ClientAffinity

Type: string

The default value is NONE.

ListenerArn

Required: Yes
Type: string

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

PortRanges

Type: Array of PortRange structures

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

Protocol

Type: string

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

Result Syntax

[
    'Listener' => [
        'ClientAffinity' => 'NONE|SOURCE_IP',
        'ListenerArn' => '<string>',
        'PortRanges' => [
            [
                'FromPort' => <integer>,
                'ToPort' => <integer>,
            ],
            // ...
        ],
        'Protocol' => 'TCP|UDP',
    ],
]

Result Details

Members

Listener

Type: Listener structure

Information for the updated listener.

Errors

InvalidArgumentException:
An argument that you specified is invalid.
InvalidPortRangeException:
The port numbers that you specified are not valid numbers or are not unique for this accelerator.
ListenerNotFoundException:
The listener that you specified doesn't exist.
InternalServiceErrorException:
There was an internal error for Global Accelerator.
LimitExceededException:
Processing your request would cause you to exceed an Global Accelerator limit.

WithdrawByoipCidr

$result = $client->withdrawByoipCidr([/* ... */]);
$promise = $client->withdrawByoipCidrAsync([/* ... */]);

Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays.

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

Parameter Syntax

$result = $client->withdrawByoipCidr([
    'Cidr' => '<string>', // REQUIRED
]);

Parameter Details

Members

Cidr

Required: Yes
Type: string

The address range, in CIDR notation.

Result Syntax

[
    'ByoipCidr' => [
        'Cidr' => '<string>',
        'Events' => [
            [
                'Message' => '<string>',
                'Timestamp' => <DateTime>,
            ],
            // ...
        ],
        'State' => 'PENDING_PROVISIONING|READY|PENDING_ADVERTISING|ADVERTISING|PENDING_WITHDRAWING|PENDING_DEPROVISIONING|DEPROVISIONED|FAILED_PROVISION|FAILED_ADVERTISING|FAILED_WITHDRAW|FAILED_DEPROVISION',
    ],
]

Result Details

Members

ByoipCidr

Type: ByoipCidr structure

Information about the address pool.

Errors

InternalServiceErrorException:
There was an internal error for Global Accelerator.
InvalidArgumentException:
An argument that you specified is invalid.
AccessDeniedException:
You don't have access permission.
ByoipCidrNotFoundException:
The CIDR that you specified was not found or is incorrect.
IncorrectCidrStateException:
The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

Shapes

Accelerator

Description

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.

Members

AcceleratorArn

Type: string

The Amazon Resource Name (ARN) of the accelerator.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the accelerator was created.

DnsName

Type: string

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.

DualStackDnsName

Type: string

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.

Enabled

Type: boolean

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.

Events

Type: Array of AcceleratorEvent structures

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

IpAddressType

Type: string

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

IpSets

Type: Array of IpSet structures

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

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the accelerator was last modified.

Name

Type: string

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

Status

Type: string

Describes the deployment status of the accelerator.

AcceleratorAttributes

Description

Attributes of an accelerator.

Members

FlowLogsEnabled

Type: boolean

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.

FlowLogsS3Bucket

Type: string

FlowLogsS3Prefix

Type: string

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

Description

A complex type that contains a Timestamp value and Message for changes that you make to an accelerator in Global Accelerator. Messages stored here provide progress or error information when you update an accelerator from IPv4 to dual-stack, or from dual-stack to IPv4. Global Accelerator stores a maximum of ten event messages.

Members

Message

Type: string

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.

Timestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

Type: string

ByoipCidr

Description

Information about an IP address range that is provisioned for use with your Amazon Web Services 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 Global Accelerator.
READY — The address range is provisioned with Global Accelerator and can be advertised.
PENDING_ADVERTISING — You’ve submitted a request for Global Accelerator to advertise an address range but it is not yet being advertised.
ADVERTISING — The address range is being advertised by Global Accelerator.
PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by Global Accelerator.
PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from Global Accelerator but it is still provisioned.
DEPROVISIONED — The address range is deprovisioned from Global Accelerator.
FAILED_PROVISION — The request to provision the address range from 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 Amazon Web Services support.
FAILED_ADVERTISING — The request for 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 Amazon Web Services support.
FAILED_WITHDRAW — The request to withdraw the address range from advertising by 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 Amazon Web Services support.
FAILED_DEPROVISION — The request to deprovision the address range from 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 Amazon Web Services support.

Members

Cidr

Type: string

The address range, in CIDR notation.

Events

Type: Array of ByoipCidrEvent structures

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

State

Type: string

The state of the address pool.

ByoipCidrEvent

Description

A complex type that contains a Message and a Timestamp value for 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).

Members

Message

Type: string

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

Timestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ByoipCidrNotFoundException

Description

The CIDR that you specified was not found or is incorrect.

Members

Message

Type: string

CidrAuthorizationContext

Description

Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP).

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

Members

Message

Required: Yes
Type: string

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

Signature

Required: Yes
Type: string

The signed authorization message for the prefix and account.

ConflictException

Description

You can't use both of those options.

Members

Message

Type: string

CustomRoutingAccelerator

Description

Attributes of a custom routing accelerator.

Members

AcceleratorArn

Type: string

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

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the accelerator was created.

DnsName

Type: string

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.

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

Enabled

Type: boolean

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.

IpAddressType

Type: string

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

IpSets

Type: Array of IpSet structures

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

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the accelerator was last modified.

Name

Type: string

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

Status

Type: string

Describes the deployment status of the accelerator.

CustomRoutingAcceleratorAttributes

Description

Attributes of a custom routing accelerator.

Members

FlowLogsEnabled

Type: boolean

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.

FlowLogsS3Bucket

Type: string

FlowLogsS3Prefix

Type: string

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

DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id

CustomRoutingDestinationConfiguration

Description

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

Members

FromPort

Required: Yes
Type: int

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

Protocols

Required: Yes
Type: Array of strings

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

ToPort

Required: Yes
Type: int

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

CustomRoutingDestinationDescription

Description

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.

Members

FromPort

Type: int

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

Protocols

Type: Array of strings

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

ToPort

Type: int

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

CustomRoutingEndpointConfiguration

Description

The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.

Members

EndpointId

Type: string

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

CustomRoutingEndpointDescription

Description

A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.

Members

EndpointId

Type: string

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

CustomRoutingEndpointGroup

Description

A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener.

Members

DestinationDescriptions

Type: Array of CustomRoutingDestinationDescription structures

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.

EndpointDescriptions

Type: Array of CustomRoutingEndpointDescription structures

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

EndpointGroupArn

Type: string

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

EndpointGroupRegion

Type: string

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

CustomRoutingListener

Description

A complex type for a listener for a custom routing accelerator.

Members

ListenerArn

Type: string

The Amazon Resource Name (ARN) of the listener.

PortRanges

Type: Array of PortRange structures

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

Description

The port mappings for a specified endpoint IP address (destination).

Members

AcceleratorArn

Type: string

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

AcceleratorSocketAddresses

Type: Array of SocketAddress structures

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

DestinationSocketAddress

Type: SocketAddress structure

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

DestinationTrafficState

Type: string

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.

EndpointGroupArn

Type: string

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

EndpointGroupRegion

Type: string

The Amazon Web Services Region for the endpoint group.

EndpointId

Type: string

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

IpAddressType

Type: string

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

EndpointAlreadyExistsException

Description

The endpoint that you specified doesn't exist.

Members

Message

Type: string

EndpointConfiguration

Description

A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.

Members

ClientIPPreservationEnabled

Type: boolean

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.

EndpointId

Type: string

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.

Weight

Type: int

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

Description

A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

Members

ClientIPPreservationEnabled

Type: boolean

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.

EndpointId

Type: string

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

HealthReason

Type: string

Returns a null result.

HealthState

Type: string

The health status of the endpoint.

Weight

Type: int

EndpointGroup

Description

A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener.

Members

EndpointDescriptions

Type: Array of EndpointDescription structures

The list of endpoint objects.

EndpointGroupArn

Type: string

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

EndpointGroupRegion

Type: string

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

HealthCheckIntervalSeconds

Type: int

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

HealthCheckPath

Type: string

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 (/).

HealthCheckPort

Type: int

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.

HealthCheckProtocol

Type: string

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

PortOverrides

Type: Array of PortOverride structures

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.

ThresholdCount

Type: int

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.

TrafficDialPercentage

Type: float

ClientIPPreservationEnabled

Type: boolean

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.

EndpointId

Required: Yes
Type: string

Type: string

The types of IP addresses included in this IP set.

IpAddresses

Type: Array of strings

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

IpFamily

Type: string

IpFamily is deprecated and has been replaced by IpAddressFamily.

LimitExceededException

Description

Processing your request would cause you to exceed an Global Accelerator limit.

Members

Message

Type: string

Listener

Description

A complex type for a listener.

Members

ClientAffinity

Type: string

The default value is NONE.

ListenerArn

Type: string

The Amazon Resource Name (ARN) of the listener.

PortRanges

Type: Array of PortRange structures

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

Protocol

Type: string

The protocol for the connections from clients to the accelerator.

ListenerNotFoundException

Description

The listener that you specified doesn't exist.

Members

Message

Type: string

PortMapping

Description

Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets.

Members

AcceleratorPort

Type: int

The accelerator port.

DestinationSocketAddress

Type: SocketAddress structure

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

DestinationTrafficState

Type: string

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.

EndpointGroupArn

Type: string

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

EndpointId

Type: string

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

Protocols

Type: Array of strings

The protocols supported by the endpoint group.

PortOverride

Description

Override specific listener ports used to route traffic to endpoints that are part of an 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.

Members

EndpointPort

Type: int

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.

ListenerPort

Type: int

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

Description

A complex type for a range of ports for a listener.

Members

FromPort

Type: int

The first port in the range of ports, inclusive.

ToPort

Type: int

The last port in the range of ports, inclusive.

SocketAddress

Description

An IP address/port combination.

Members

IpAddress

Type: string

The IP address for the socket address.

Port

Type: int

The port for the socket address.

TransactionInProgressException

Description

There's already a transaction in progress. Another transaction can't be processed.

Members

Message

Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Global Accelerator 2018-08-08

Operation Summary

Paginators

Operations

AddCustomRoutingEndpoints

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AddEndpoints

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AdvertiseByoipCidr

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AllowCustomRoutingTraffic

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateAccelerator

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCustomRoutingAccelerator

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCustomRoutingEndpointGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCustomRoutingListener

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateEndpointGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members