software.amazon.awscdk.services.globalaccelerator

Interface CfnAcceleratorProps

All Known Implementing Classes:

CfnAcceleratorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:33.849Z")
public interface 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 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getName

java.lang.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.

getEnabled

default java.lang.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.

getIpAddresses

default java.util.List<java.lang.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 .

getIpAddressType

default java.lang.String getIpAddressType()

The IP address type that an accelerator supports.

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

getTags

default java.util.List<CfnTag> getTags()

Create tags for an accelerator.

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

builder

static CfnAcceleratorProps.Builder builder()

Returns:

a CfnAcceleratorProps.Builder of CfnAcceleratorProps