aws-cdk-lib.aws_globalaccelerator.IAccelerator

IAccelerator Interface

The interface of the Accelerator.

IAccelerator

extends

• IResource,
• IAcceleratorRef

implemented by

• Accelerator

Source

aws-globalaccelerator/lib/accelerator.ts

Type last changed

v2.234.0 · 8 Jan 2026

Properties

acceleratorArnstringaccelerator_arnstracceleratorArnStringAcceleratorArnstringAcceleratorArn*string#

The ARN of the accelerator.

acceleratorRefAcceleratorReferenceaccelerator_refAcceleratorReferenceacceleratorRefAcceleratorReferenceAcceleratorRefAcceleratorReferenceAcceleratorRefAcceleratorReference#

A reference to a Accelerator resource.

dnsNamestringdns_namestrdnsNameStringDnsNamestringDnsName*string#

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

dualStackDnsName?may be undefinedstringdual_stack_dns_name?may be undefinedstrdualStackDnsName?may be undefinedStringDualStackDnsName?may be undefinedstringDualStackDnsName?may be undefined*string#

The DNS name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

ipv4Addresses?may be undefinedstring[]ipv4_addresses?may be undefinedtyping.List[str]ipv4Addresses?may be undefinedList<String>Ipv4Addresses?may be undefinedstring[]Ipv4Addresses?may be undefined*[]*string#

The array of IPv4 addresses in the IP address set.

An IP address set can have a maximum of two IP addresses.

ipv6Addresses?may be undefinedstring[]ipv6_addresses?may be undefinedtyping.List[str]ipv6Addresses?may be undefinedList<String>Ipv6Addresses?may be undefinedstring[]Ipv6Addresses?may be undefined*[]*string#

The array of IPv6 addresses in the IP address set.

An IP address set can have a maximum of two IP addresses.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining