aws-cdk-lib.aws_globalaccelerator.CfnAcceleratorProps

interface CfnAcceleratorProps

LanguageType name
.NETAmazon.CDK.AWS.GlobalAccelerator.CfnAcceleratorProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsglobalaccelerator#CfnAcceleratorProps
Javasoftware.amazon.awscdk.services.globalaccelerator.CfnAcceleratorProps
Pythonaws_cdk.aws_globalaccelerator.CfnAcceleratorProps
TypeScript aws-cdk-lib » aws_globalaccelerator » CfnAcceleratorProps

Properties for defining a CfnAccelerator.

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,
  ipAddresses: ['ipAddresses'],
  ipAddressType: 'ipAddressType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namestringThe name of the accelerator.
enabled?boolean | IResolvableIndicates whether the accelerator is enabled. The value is true or false. The default value is true.
ipAddressType?stringThe IP address type that an accelerator supports.
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.
tags?CfnTag[]Create tags for an accelerator.

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.


enabled?

Type: boolean | IResolvable (optional)

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 (optional)

The IP address type that an accelerator supports.

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


ipAddresses?

Type: string[] (optional)

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 .


tags?

Type: CfnTag[] (optional)

Create tags for an accelerator.

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