software.amazon.awscdk.services.ec2

Class CfnCarrierGateway

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.CfnCarrierGateway

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.294Z")
public class CfnCarrierGateway
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::CarrierGateway`.

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer Guide .

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.*;
 CfnCarrierGateway cfnCarrierGateway = CfnCarrierGateway.Builder.create(this, "MyCfnCarrierGateway")
         .vpcId("vpcId")
         // 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	CfnCarrierGateway.Builder A fluent builder for CfnCarrierGateway.

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
	CfnCarrierGateway(Construct scope, java.lang.String id, CfnCarrierGatewayProps props) Create a new `AWS::EC2::CarrierGateway`.
protected	CfnCarrierGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCarrierGateway(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrCarrierGatewayId() The ID of the carrier gateway.
java.lang.String	getAttrOwnerId() The AWS account ID of the owner of the carrier gateway.
java.lang.String	getAttrState() The state of the carrier gateway.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
TagManager	getTags() The tags assigned to the carrier gateway.
java.lang.String	getVpcId() The ID of the VPC associated with the carrier gateway.
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	setVpcId(java.lang.String value) The ID of the VPC associated with the carrier gateway.

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

CfnCarrierGateway

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

CfnCarrierGateway

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

CfnCarrierGateway

public CfnCarrierGateway(Construct scope,
                         java.lang.String id,
                         CfnCarrierGatewayProps props)

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

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.

getAttrCarrierGatewayId

public java.lang.String getAttrCarrierGatewayId()

The ID of the carrier gateway.

getAttrOwnerId

public java.lang.String getAttrOwnerId()

The AWS account ID of the owner of the carrier gateway.

getAttrState

public java.lang.String getAttrState()

The state of the carrier gateway.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags assigned to the carrier gateway.

getVpcId

public java.lang.String getVpcId()

The ID of the VPC associated with the carrier gateway.

setVpcId

public void setVpcId(java.lang.String value)

The ID of the VPC associated with the carrier gateway.