Interface ICfnAcceleratorProps
Properties for defining a CfnAccelerator
.
Namespace: Amazon.CDK.AWS.GlobalAccelerator
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnAcceleratorProps
Syntax (vb)
Public Interface ICfnAcceleratorProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GlobalAccelerator;
var cfnAcceleratorProps = new CfnAcceleratorProps {
Name = "name",
// the properties below are optional
Enabled = false,
IpAddresses = new [] { "ipAddresses" },
IpAddressType = "ipAddressType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
Enabled | Indicates whether the accelerator is enabled. The value is true or false. The default value is true. |
IpAddresses | 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. |
IpAddressType | The IP address type that an accelerator supports. |
Name | The name of the accelerator. |
Tags | Create tags for an accelerator. |
Properties
Enabled
Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
virtual object Enabled { get; }
Property Value
System.Object
Remarks
If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
Default: - true
IpAddresses
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.
virtual string[] IpAddresses { get; }
Property Value
System.String[]
Remarks
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 .
IpAddressType
The IP address type that an accelerator supports.
virtual string IpAddressType { get; }
Property Value
System.String
Remarks
For a standard accelerator, the value can be IPV4 or DUAL_STACK.
Default: - "IPV4"
Name
The name of the accelerator.
string Name { get; }
Property Value
System.String
Remarks
The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.