software.amazon.awscdk.services.ec2

Class CfnCustomerGateway

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ec2.CfnCustomerGateway

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.661Z")
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
         .deviceName("deviceName")
         .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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCustomerGateway(Construct scope, java.lang.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
java.lang.String	getAttrCustomerGatewayId() The ID of the customer gateway.
java.lang.Number	getBgpAsn() For devices that support BGP, the customer gateway's BGP ASN.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDeviceName() The name of customer gateway device.
java.lang.String	getIpAddress() IPv4 address for the customer gateway device's outside interface.
TagManager	getTags() One or more tags for the customer gateway.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setBgpAsn(java.lang.Number value) For devices that support BGP, the customer gateway's BGP ASN.
void	setDeviceName(java.lang.String value) The name of customer gateway device.
void	setIpAddress(java.lang.String value) IPv4 address for the customer gateway device's outside interface.
void	setType(java.lang.String value) The type of VPN connection that this customer gateway supports ( `ipsec.1` ).

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnCustomerGateway(Construct scope,
                          java.lang.String id,
                          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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCustomerGatewayId

public java.lang.String getAttrCustomerGatewayId()

The ID of the customer gateway.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

One or more tags for the customer gateway.

getBgpAsn

public java.lang.Number getBgpAsn()

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

Default: 65000

setBgpAsn

public void setBgpAsn(java.lang.Number value)

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

Default: 65000

getIpAddress

public java.lang.String getIpAddress()

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

The address must be static.

setIpAddress

public void setIpAddress(java.lang.String value)

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

The address must be static.

getType

public java.lang.String getType()

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

setType

public void setType(java.lang.String value)

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

getDeviceName

public java.lang.String getDeviceName()

The name of customer gateway device.

setDeviceName

public void setDeviceName(java.lang.String value)

The name of customer gateway device.