Package software.amazon.awscdk.services.globalaccelerator

Interface AcceleratorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AcceleratorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:17.673Z")
@Stability(Stable)
public interface AcceleratorProps
extends software.amazon.jsii.JsiiSerializable

Construct properties of the Accelerator.

Example:

 Accelerator accelerator = Accelerator.Builder.create(this, "Accelerator")
         .ipAddresses(List.of("1.1.1.1", "2.2.2.2"))
         .ipAddressType(IpAddressType.IPV4)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AcceleratorProps.Builder	builder()
default String	getAcceleratorName()	The name of the accelerator.
default Boolean	getEnabled()	Indicates whether the accelerator is enabled.
default List<String>	getIpAddresses()	IP addresses associated with the accelerator.
default IpAddressType	getIpAddressType()	The IP address type that an accelerator supports.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAcceleratorName

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

The name of the accelerator.

Default: - resource ID

getEnabled

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

Indicates whether the accelerator is enabled.

Default: true

getIpAddresses

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

IP addresses associated with the accelerator.

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.

Default: - undefined. IP addresses will be from Amazon's pool of IP addresses.

getIpAddressType

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

The IP address type that an accelerator supports.

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

Default: - "IPV4"

builder

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

Returns:

a AcceleratorProps.Builder of AcceleratorProps