Interface IAcceleratorProps

Construct properties of the Accelerator.

Namespace: Amazon.CDK.AWS.GlobalAccelerator

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IAcceleratorProps

Syntax (vb)

Public Interface IAcceleratorProps

Remarks

ExampleMetadata: infused

Examples

var accelerator = new Accelerator(this, "Accelerator", new AcceleratorProps {
    IpAddresses = new [] { "1.1.1.1", "2.2.2.2" },
    IpAddressType = IpAddressType.IPV4
});

Synopsis

Properties

AcceleratorName	The name of the accelerator.
Enabled	Indicates whether the accelerator is enabled.
IpAddresses	IP addresses associated with the accelerator.
IpAddressType	The IP address type that an accelerator supports.

Properties

AcceleratorName

The name of the accelerator.

virtual string AcceleratorName { get; }

Property Value

System.String

Remarks

Default: - resource ID

Enabled

Indicates whether the accelerator is enabled.

virtual Nullable<bool> Enabled { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: true

IpAddresses

IP addresses associated with the accelerator.

virtual string[] IpAddresses { get; }

Property Value

System.String[]

Remarks

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.

IpAddressType

The IP address type that an accelerator supports.

virtual Nullable<IpAddressType> IpAddressType { get; }

Property Value

System.Nullable<IpAddressType>

Remarks

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

Default: - "IPV4"