software.amazon.awscdk.services.ec2

Class CfnCustomerGateway

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnCustomerGateway

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.136Z")
 @Stability(value=Stable)
public class CfnCustomerGateway
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::CustomerGateway`.

Specifies a customer gateway.

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.*;
 CfnCustomerGateway cfnCustomerGateway = CfnCustomerGateway.Builder.create(this, "MyCfnCustomerGateway")
         .bgpAsn(123)
         .ipAddress("ipAddress")
         .type("type")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCustomerGateway.Builder A fluent builder for CfnCustomerGateway.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCustomerGateway(software.constructs.Construct scope, String id, CfnCustomerGatewayProps props) Create a new `AWS::EC2::CustomerGateway`.
protected	CfnCustomerGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCustomerGateway(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCustomerGatewayId()
Number	getBgpAsn() For devices that support BGP, the customer gateway's BGP ASN.
protected Map<String,Object>	getCfnProperties()
String	getIpAddress() The Internet-routable IP address for the customer gateway's outside interface.
TagManager	getTags() One or more tags for the customer gateway.
String	getType() The type of VPN connection that this customer gateway supports ( `ipsec.1` ).
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBgpAsn(Number value) For devices that support BGP, the customer gateway's BGP ASN.
void	setIpAddress(String value) The Internet-routable IP address for the customer gateway's outside interface.
void	setType(String value) The type of VPN connection that this customer gateway supports ( `ipsec.1` ).

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCustomerGateway

protected CfnCustomerGateway(software.amazon.jsii.JsiiObjectRef objRef)

CfnCustomerGateway

protected CfnCustomerGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCustomerGateway

@Stability(value=Stable)
public CfnCustomerGateway(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnCustomerGatewayProps props)

Create a new `AWS::EC2::CustomerGateway`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCustomerGatewayId

@Stability(value=Stable)
 @NotNull
public String getAttrCustomerGatewayId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

One or more tags for the customer gateway.

getBgpAsn

@Stability(value=Stable)
 @NotNull
public Number getBgpAsn()

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

Default: 65000

setBgpAsn

@Stability(value=Stable)
public void setBgpAsn(@NotNull
                                               Number value)

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

Default: 65000

getIpAddress

@Stability(value=Stable)
 @NotNull
public String getIpAddress()

The Internet-routable IP address for the customer gateway's outside interface.

The address must be static.

setIpAddress

@Stability(value=Stable)
public void setIpAddress(@NotNull
                                                  String value)

The Internet-routable IP address for the customer gateway's outside interface.

The address must be static.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

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

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

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