AWS Global Accelerator

{'IpAddresses': ['string']}

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.

See also: AWS API Documentation

Request Syntax

client.create_custom_routing_accelerator(
    Name='string',
    IpAddressType='IPV4',
    IpAddresses=[
        'string',
    ],
    Enabled=True|False,
    IdempotencyToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name:

string

param Name:

[REQUIRED]

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.

type IpAddressType:

string

param IpAddressType:

The value for the address type must be IPv4.

type IpAddresses:

list

param IpAddresses:

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

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

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

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

• (string) --

type Enabled:

boolean

param Enabled:

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

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

type IdempotencyToken:

string

param IdempotencyToken:

[REQUIRED]

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

This field is autopopulated if not provided.

type Tags:

list

param Tags:

Create tags for an accelerator.

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

• (dict) --

  A complex type that contains a Tag key and Tag value.

  • Key (string) -- [REQUIRED]

    A string that contains a Tag key.

  • Value (string) -- [REQUIRED]

    A string that contains a Tag value.

rtype:

dict

returns:

Response Syntax

{
    'Accelerator': {
        'AcceleratorArn': 'string',
        'Name': 'string',
        'IpAddressType': 'IPV4',
        'Enabled': True|False,
        'IpSets': [
            {
                'IpFamily': 'string',
                'IpAddresses': [
                    'string',
                ]
            },
        ],
        'DnsName': 'string',
        'Status': 'DEPLOYED'|'IN_PROGRESS',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • Accelerator (dict) --

    The accelerator that is created.

    • AcceleratorArn (string) --

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

    • Name (string) --

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

    • IpAddressType (string) --

      The value for the address type must be IPv4.

    • Enabled (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.

    • IpSets (list) --

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

      • (dict) --

        A complex type for the set of IP addresses for an accelerator.

        • IpFamily (string) --

          The types of IP addresses included in this IP set.

        • IpAddresses (list) --

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

          • (string) --

    • DnsName (string) --

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

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

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

    • Status (string) --

      Describes the deployment status of the accelerator.

    • CreatedTime (datetime) --

      The date and time that the accelerator was created.

    • LastModifiedTime (datetime) --

      The date and time that the accelerator was last modified.