Package software.amazon.awscdk.services.ec2

Class CfnVPCGatewayAttachment

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:03.835Z")
@Stability(Stable)
public class CfnVPCGatewayAttachment
extends CfnResource
implements IInspectable, IVPCGatewayAttachmentRef

Attaches an internet gateway, or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC.

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.*;
 CfnVPCGatewayAttachment cfnVPCGatewayAttachment = CfnVPCGatewayAttachment.Builder.create(this, "MyCfnVPCGatewayAttachment")
         .vpcId("vpcId")
         // the properties below are optional
         .internetGatewayId("internetGatewayId")
         .vpnGatewayId("vpnGatewayId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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.services.ec2.IVPCGatewayAttachmentRef

IVPCGatewayAttachmentRef.Jsii$Default, IVPCGatewayAttachmentRef.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	CfnVPCGatewayAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVPCGatewayAttachment(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVPCGatewayAttachment(software.constructs.Construct scope, String id, CfnVPCGatewayAttachmentProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAttachmentType()	Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment.
protected Map<String,Object>	getCfnProperties()
String	getInternetGatewayId()	The ID of the internet gateway.
VPCGatewayAttachmentReference	getVpcGatewayAttachmentRef()	A reference to a VPCGatewayAttachment resource.
String	getVpcId()	The ID of the VPC.
String	getVpnGatewayId()	The ID of the virtual private gateway.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInternetGatewayId(String value)	The ID of the internet gateway.
void	setVpcId(String value)	The ID of the VPC.
void	setVpnGatewayId(String value)	The ID of the virtual private gateway.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

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

CfnVPCGatewayAttachment

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

CfnVPCGatewayAttachment

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

CfnVPCGatewayAttachment

@Stability(Stable)
public CfnVPCGatewayAttachment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnVPCGatewayAttachmentProps 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.

getAttrAttachmentType

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

Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getVpcGatewayAttachmentRef

@Stability(Stable)
@NotNull
public VPCGatewayAttachmentReference getVpcGatewayAttachmentRef()

A reference to a VPCGatewayAttachment resource.

Specified by:

getVpcGatewayAttachmentRef in interface IVPCGatewayAttachmentRef

getVpcId

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

The ID of the VPC.

setVpcId

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

The ID of the VPC.

getInternetGatewayId

@Stability(Stable)
@Nullable
public String getInternetGatewayId()

The ID of the internet gateway.

setInternetGatewayId

@Stability(Stable)
public void setInternetGatewayId(@Nullable
 String value)

The ID of the internet gateway.

getVpnGatewayId

@Stability(Stable)
@Nullable
public String getVpnGatewayId()

The ID of the virtual private gateway.

setVpnGatewayId

@Stability(Stable)
public void setVpnGatewayId(@Nullable
 String value)

The ID of the virtual private gateway.