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.97.0 (build 729de35)",
           date="2024-04-18T17:54:15.544Z")
@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()
         .bgpAsn(123)
         .ipAddress("ipAddress")
         .type("type")
         // the properties below are optional
         .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()
Number	getBgpAsn()	For devices that support BGP, the customer gateway's BGP 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()	IPv4 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

getBgpAsn

@Stability(Stable)
@NotNull
Number getBgpAsn()

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

Default: 65000

Default: - 65000

See Also:

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

getIpAddress

@Stability(Stable)
@NotNull
String getIpAddress()

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

The address must be static.

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

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