Package software.amazon.awscdk.services.globalaccelerator

Class CfnAccelerator.Builder

java.lang.Object

software.amazon.awscdk.services.globalaccelerator.CfnAccelerator.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAccelerator>

Enclosing class:

CfnAccelerator

@Stability(Stable)
public static final class CfnAccelerator.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAccelerator>

A fluent builder for CfnAccelerator.

Method Summary

Modifier and Type	Method	Description
CfnAccelerator	build()
static CfnAccelerator.Builder	create(software.constructs.Construct scope, String id)
CfnAccelerator.Builder	enabled(Boolean enabled)	Indicates whether the accelerator is enabled.
CfnAccelerator.Builder	enabled(IResolvable enabled)	Indicates whether the accelerator is enabled.
CfnAccelerator.Builder	ipAddresses(List<String> 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.
CfnAccelerator.Builder	ipAddressType(String ipAddressType)	The IP address type that an accelerator supports.
CfnAccelerator.Builder	name(String name)	The name of the accelerator.
CfnAccelerator.Builder	tags(List<? extends CfnTag> tags)	Create tags for an accelerator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnAccelerator.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnAccelerator.Builder.

name

@Stability(Stable)
public CfnAccelerator.Builder name(String name)

The name of the accelerator.

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

Parameters:

name - The name of the accelerator. This parameter is required.

Returns:

this

See Also:

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

enabled

@Stability(Stable)
public CfnAccelerator.Builder enabled(Boolean enabled)

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

Parameters:

enabled - Indicates whether the accelerator is enabled. The value is true or false. The default value is true. This parameter is required.

Returns:

this

See Also:

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

enabled

@Stability(Stable)
public CfnAccelerator.Builder enabled(IResolvable enabled)

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

Parameters:

enabled - Indicates whether the accelerator is enabled. The value is true or false. The default value is true. This parameter is required.

Returns:

this

See Also:

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

ipAddresses

@Stability(Stable)
public CfnAccelerator.Builder ipAddresses(List<String> 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.

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 .

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

ipAddressType

@Stability(Stable)
public CfnAccelerator.Builder ipAddressType(String ipAddressType)

The IP address type that an accelerator supports.

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

Default: - "IPV4"

Parameters:

ipAddressType - The IP address type that an accelerator supports. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnAccelerator.Builder tags(List<? extends CfnTag> tags)

Create tags for an accelerator.

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

Parameters:

tags - Create tags for an accelerator. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAccelerator build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnAccelerator>

Returns:

a newly built instance of CfnAccelerator.