AcceleratorProps

class aws_cdk.aws_globalaccelerator.AcceleratorProps(*, accelerator_name=None, enabled=None, ip_addresses=None, ip_address_type=None)

Bases: object

Construct properties of the Accelerator.

Parameters:
  • accelerator_name (Optional[str]) – The name of the accelerator. Default: - resource ID

  • enabled (Optional[bool]) – Indicates whether the accelerator is enabled. Default: true

  • ip_addresses (Optional[Sequence[str]]) – IP addresses associated with the accelerator. 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 comma. 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. Default: - undefined. IP addresses will be from Amazon’s pool of IP addresses.

  • ip_address_type (Optional[IpAddressType]) – The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK. Default: - “IPV4”

ExampleMetadata:

infused

Example:

accelerator = globalaccelerator.Accelerator(self, "Accelerator",
    ip_addresses=["1.1.1.1", "2.2.2.2"
    ],
    ip_address_type=globalaccelerator.IpAddressType.IPV4
)

Attributes

accelerator_name

The name of the accelerator.

Default:
  • resource ID

enabled

Indicates whether the accelerator is enabled.

Default:

true

ip_address_type

The IP address type that an accelerator supports.

For a standard accelerator, the value can be IPV4 or DUAL_STACK.

Default:
  • “IPV4”

ip_addresses

IP addresses associated with the accelerator.

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

Default:
  • undefined. IP addresses will be from Amazon’s pool of IP addresses.