Package software.amazon.awscdk.services.ec2

Class CfnCustomerGateway.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnCustomerGateway.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCustomerGateway>

Enclosing class:

CfnCustomerGateway

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

A fluent builder for CfnCustomerGateway.

Method Summary

Modifier and Type	Method	Description
CfnCustomerGateway.Builder	bgpAsn(Number bgpAsn)	For customer gateway devices that support BGP, specify the device's ASN.
CfnCustomerGateway.Builder	bgpAsnExtended(Number bgpAsnExtended)	For customer gateway devices that support BGP, specify the device's ASN.
CfnCustomerGateway	build()
CfnCustomerGateway.Builder	certificateArn(String certificateArn)	The Amazon Resource Name (ARN) for the customer gateway certificate.
static CfnCustomerGateway.Builder	create(software.constructs.Construct scope, String id)
CfnCustomerGateway.Builder	deviceName(String deviceName)	The name of customer gateway device.
CfnCustomerGateway.Builder	ipAddress(String ipAddress)	IPv4 address for the customer gateway device's outside interface.
CfnCustomerGateway.Builder	tags(List<? extends CfnTag> tags)	One or more tags for the customer gateway.
CfnCustomerGateway.Builder	type(String type)	The type of VPN connection that this customer gateway supports ( ipsec.1 ).

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 CfnCustomerGateway.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 CfnCustomerGateway.Builder.

ipAddress

@Stability(Stable)
public CfnCustomerGateway.Builder ipAddress(String ipAddress)

IPv4 address for the customer gateway device's outside interface.

The address must be static. If OutsideIpAddressType in your VPN connection options is set to PrivateIpv4 , you can use an RFC6598 or RFC1918 private IPv4 address. If OutsideIpAddressType is set to PublicIpv4 , you can use a public IPv4 address.

Parameters:

ipAddress - IPv4 address for the customer gateway device's outside interface. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-ipaddress

type

@Stability(Stable)
public CfnCustomerGateway.Builder type(String type)

The type of VPN connection that this customer gateway supports ( ipsec.1 ).

Parameters:

type - The type of VPN connection that this customer gateway supports ( ipsec.1 ). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-type

bgpAsn

@Stability(Stable)
public CfnCustomerGateway.Builder bgpAsn(Number bgpAsn)

For customer gateway devices that support BGP, specify the device's ASN.

You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647 , you must use BgpAsnExtended .

Default: 65000

Valid values: 1 to 2,147,483,647

Default: - 65000

Parameters:

bgpAsn - For customer gateway devices that support BGP, specify the device's ASN. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasn

bgpAsnExtended

@Stability(Stable)
public CfnCustomerGateway.Builder bgpAsnExtended(Number bgpAsnExtended)

For customer gateway devices that support BGP, specify the device's ASN.

You must specify either BgpAsn or BgpAsnExtended when creating the customer gateway. If the ASN is larger than 2,147,483,647 , you must use BgpAsnExtended .

Valid values: 2,147,483,648 to 4,294,967,295

Parameters:

bgpAsnExtended - For customer gateway devices that support BGP, specify the device's ASN. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-bgpasnextended

certificateArn

@Stability(Stable)
public CfnCustomerGateway.Builder certificateArn(String certificateArn)

The Amazon Resource Name (ARN) for the customer gateway certificate.

Parameters:

certificateArn - The Amazon Resource Name (ARN) for the customer gateway certificate. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-certificatearn

deviceName

@Stability(Stable)
public CfnCustomerGateway.Builder deviceName(String deviceName)

The name of customer gateway device.

Parameters:

deviceName - The name of customer gateway device. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-customergateway.html#cfn-ec2-customergateway-devicename

tags

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

One or more tags for the customer gateway.

Parameters:

tags - One or more tags for the customer gateway. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnCustomerGateway build()

Specified by:

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

Returns:

a newly built instance of CfnCustomerGateway.