Package software.amazon.awscdk.services.ec2

Interface CfnCustomerGatewayProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomerGatewayProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:02.852Z")
@Stability(Stable)
public interface CfnCustomerGatewayProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCustomerGateway.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnCustomerGatewayProps cfnCustomerGatewayProps = CfnCustomerGatewayProps.builder()
         .ipAddress("ipAddress")
         .type("type")
         // the properties below are optional
         .bgpAsn(123)
         .bgpAsnExtended(123)
         .certificateArn("certificateArn")
         .deviceName("deviceName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCustomerGatewayProps.Builder	builder()
default Number	getBgpAsn()	For customer gateway devices that support BGP, specify the device's ASN.
default Number	getBgpAsnExtended()	For customer gateway devices that support BGP, specify the device's ASN.
default String	getCertificateArn()	The Amazon Resource Name (ARN) for the customer gateway certificate.
default String	getDeviceName()	The name of customer gateway device.
String	getIpAddress()	The IP address for the customer gateway device's outside interface.
default List<CfnTag>	getTags()	One or more tags for the customer gateway.
String	getType()	The type of VPN connection that this customer gateway supports ( ipsec.1 ).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpAddress

@Stability(Stable)
@NotNull
String getIpAddress()

The IP 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 Ipv6 , you can use an IPv6 address.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

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

See Also:

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

getBgpAsn

@Stability(Stable)
@Nullable
default Number getBgpAsn()

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

See Also:

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

getBgpAsnExtended

@Stability(Stable)
@Nullable
default Number getBgpAsnExtended()

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

See Also:

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

getCertificateArn

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

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

See Also:

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

getDeviceName

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

The name of customer gateway device.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

One or more tags for the customer gateway.

See Also:

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

builder

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

Returns:

a CfnCustomerGatewayProps.Builder of CfnCustomerGatewayProps