aws-cdk-lib.aws_globalaccelerator.CfnAcceleratorProps

CfnAcceleratorProps Struct

Properties for defining a CfnAccelerator.

CfnAcceleratorProps

used as props by

• CfnAccelerator

Source

Generated code

Type last changed

v2.251.0 · 24 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_globalaccelerator as globalaccelerator } from 'aws-cdk-lib';
const cfnAcceleratorProps: globalaccelerator.CfnAcceleratorProps = {
  name: 'name',

  // the properties below are optional
  enabled: false,
  flowLogsEnabled: false,
  flowLogsS3Bucket: 'flowLogsS3Bucket',
  flowLogsS3Prefix: 'flowLogsS3Prefix',
  ipAddresses: ['ipAddresses'],
  ipAddressType: 'ipAddressType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

enabledboolean | IResolvableenabledtyping.Union[bool, IResolvable]enabledBooleanEnabledboolEnabledinterface{}= true#

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.

flowLogsEnabledboolean | IResolvableflow_logs_enabledtyping.Union[bool, IResolvable]flowLogsEnabledBooleanFlowLogsEnabledboolFlowLogsEnabledinterface{}= false#

Indicates whether flow logs are enabled for the accelerator.

flowLogsS3Bucketstringflow_logs_s3_bucketstrflowLogsS3BucketStringFlowLogsS3BucketstringFlowLogsS3Bucket*string#

The name of the Amazon S3 bucket for the flow logs.

flowLogsS3Prefixstringflow_logs_s3_prefixstrflowLogsS3PrefixStringFlowLogsS3PrefixstringFlowLogsS3Prefix*string#

The prefix for the location in the Amazon S3 bucket for the flow logs.

ipAddressesstring[]ip_addressestyping.List[str]ipAddressesList<String>IpAddressesstring[]IpAddresses*[]*string#

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.

notes

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 .

ipAddressTypestringip_address_typestripAddressTypeStringIpAddressTypestringIpAddressType*string= "IPV4"#

The IP address type that an accelerator supports.

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

namestringnamestrnameStringNamestringName*stringrequired#

The name of the accelerator.

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

Create tags for an accelerator.

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