CfnAcceleratorProps

class aws_cdk.aws_globalaccelerator.CfnAcceleratorProps(*, name, enabled=None, ip_addresses=None, ip_address_type=None, tags=None)

Bases: object

Properties for defining a CfnAccelerator.

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

  • enabled (Union[bool, IResolvable, None]) – 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.

  • ip_addresses (Optional[Sequence[str]]) – 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. For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide .

  • ip_address_type (Optional[str]) – The value for the address type must be IPv4.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Create tags for an accelerator. For more information, see Tagging in the AWS Global Accelerator Developer Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_globalaccelerator as globalaccelerator

cfn_accelerator_props = globalaccelerator.CfnAcceleratorProps(
    name="name",

    # the properties below are optional
    enabled=False,
    ip_addresses=["ipAddresses"],
    ip_address_type="ipAddressType",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

enabled

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

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-enabled

Return type

Union[bool, IResolvable, None]

ip_address_type

The value for the address type must be IPv4.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-ipaddresstype

Return type

Optional[str]

ip_addresses

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.

For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-ipaddresses

Return type

Optional[List[str]]

name

The name of the accelerator.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-name

Return type

str

tags

Create tags for an accelerator.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-globalaccelerator-accelerator.html#cfn-globalaccelerator-accelerator-tags

Return type

Optional[List[CfnTag]]