Package software.amazon.awscdk.services.globalaccelerator

Interface CfnAcceleratorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAcceleratorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:59.042Z")
@Stability(Stable)
public interface CfnAcceleratorProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.globalaccelerator.*;
 CfnAcceleratorProps cfnAcceleratorProps = CfnAcceleratorProps.builder()
         .name("name")
         // the properties below are optional
         .enabled(false)
         .ipAddresses(List.of("ipAddresses"))
         .ipAddressType("ipAddressType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAcceleratorProps.Builder	A builder for CfnAcceleratorProps
static final class	CfnAcceleratorProps.Jsii$Proxy	An implementation for CfnAcceleratorProps

Method Summary

Modifier and Type	Method	Description
static CfnAcceleratorProps.Builder	builder()
default Object	getEnabled()	Indicates whether the accelerator is enabled.
default List<String>	getIpAddresses()	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.
default String	getIpAddressType()	The IP address type that an accelerator supports.
String	getName()	The name of the accelerator.
default List<CfnTag>	getTags()	Create tags for an accelerator.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the accelerator.

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

See Also:

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

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

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.

Default: - true

See Also:

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

getIpAddresses

@Stability(Stable)
@Nullable
default List<String> getIpAddresses()

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 .

See Also:

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

getIpAddressType

@Stability(Stable)
@Nullable
default String getIpAddressType()

The IP address type that an accelerator supports.

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

Default: - "IPV4"

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Create tags for an accelerator.

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

See Also:

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

builder

@Stability(Stable)
static CfnAcceleratorProps.Builder builder()

Returns:

a CfnAcceleratorProps.Builder of CfnAcceleratorProps