Package software.amazon.awscdk.services.ec2

Class CfnCarrierGateway

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:07.458Z")
@Stability(Stable)
public class CfnCarrierGateway
extends CfnResource
implements IInspectable, ITaggable

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnCarrierGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCarrierGateway(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCarrierGateway(software.constructs.Construct scope, String id, CfnCarrierGatewayProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCarrierGatewayId()	The ID of the carrier gateway.
String	getAttrOwnerId()	The AWS account ID of the owner of the carrier gateway.
String	getAttrState()	The state of the carrier gateway.
protected Map<String,Object>	getCfnProperties()
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags assigned to the carrier gateway.
String	getVpcId()	The ID of the VPC associated with the carrier gateway.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setTagsRaw(List<CfnTag> value)	The tags assigned to the carrier gateway.
void	setVpcId(String value)	The ID of the VPC associated with the carrier gateway.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnCarrierGateway

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

CfnCarrierGateway

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

CfnCarrierGateway

@Stability(Stable)
public CfnCarrierGateway(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnCarrierGatewayProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCarrierGatewayId

@Stability(Stable)
@NotNull
public String getAttrCarrierGatewayId()

The ID of the carrier gateway.

getAttrOwnerId

@Stability(Stable)
@NotNull
public String getAttrOwnerId()

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

getAttrState

@Stability(Stable)
@NotNull
public String getAttrState()

The state of the carrier gateway.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getVpcId

@Stability(Stable)
@NotNull
public String getVpcId()

The ID of the VPC associated with the carrier gateway.

setVpcId

@Stability(Stable)
public void setVpcId(@NotNull
 String value)

The ID of the VPC associated with the carrier gateway.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tags assigned to the carrier gateway.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tags assigned to the carrier gateway.