software.amazon.awscdk.services.ec2

Class CfnTransitGateway

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

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.345Z")
 @Stability(value=Stable)
public class CfnTransitGateway
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::TransitGateway`.

Specifies a transit gateway.

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.

To attach your VPCs, use AWS::EC2::TransitGatewayAttachment .

To attach a VPN connection, use AWS::EC2::CustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to AWS::EC2::VPNConnection .

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use AWS::EC2::TransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use AWS::EC2::TransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AWS::EC2::TransitGatewayRouteTableAssociation to associate a resource attachment with a transit gateway route table.

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.*;
 CfnTransitGateway cfnTransitGateway = CfnTransitGateway.Builder.create(this, "MyCfnTransitGateway")
         .amazonSideAsn(123)
         .associationDefaultRouteTableId("associationDefaultRouteTableId")
         .autoAcceptSharedAttachments("autoAcceptSharedAttachments")
         .defaultRouteTableAssociation("defaultRouteTableAssociation")
         .defaultRouteTablePropagation("defaultRouteTablePropagation")
         .description("description")
         .dnsSupport("dnsSupport")
         .multicastSupport("multicastSupport")
         .propagationDefaultRouteTableId("propagationDefaultRouteTableId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transitGatewayCidrBlocks(List.of("transitGatewayCidrBlocks"))
         .vpnEcmpSupport("vpnEcmpSupport")
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnTransitGateway(software.constructs.Construct scope, String id) Create a new `AWS::EC2::TransitGateway`.
	CfnTransitGateway(software.constructs.Construct scope, String id, CfnTransitGatewayProps props) Create a new `AWS::EC2::TransitGateway`.
protected	CfnTransitGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTransitGateway(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Number	getAmazonSideAsn() A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
String	getAssociationDefaultRouteTableId() The ID of the default association route table.
String	getAttrId() The ID of the transit gateway.
String	getAutoAcceptSharedAttachments() Enable or disable automatic acceptance of attachment requests.
protected Map<String,Object>	getCfnProperties()
String	getDefaultRouteTableAssociation() Enable or disable automatic association with the default association route table.
String	getDefaultRouteTablePropagation() Enable or disable automatic propagation of routes to the default propagation route table.
String	getDescription() The description of the transit gateway.
String	getDnsSupport() Enable or disable DNS support.
String	getMulticastSupport() Indicates whether multicast is enabled on the transit gateway.
String	getPropagationDefaultRouteTableId() The ID of the default propagation route table.
TagManager	getTags() The tags for the transit gateway.
List<String>	getTransitGatewayCidrBlocks() The transit gateway CIDR blocks.
String	getVpnEcmpSupport() Enable or disable Equal Cost Multipath Protocol support.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAmazonSideAsn(Number value) A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
void	setAssociationDefaultRouteTableId(String value) The ID of the default association route table.
void	setAutoAcceptSharedAttachments(String value) Enable or disable automatic acceptance of attachment requests.
void	setDefaultRouteTableAssociation(String value) Enable or disable automatic association with the default association route table.
void	setDefaultRouteTablePropagation(String value) Enable or disable automatic propagation of routes to the default propagation route table.
void	setDescription(String value) The description of the transit gateway.
void	setDnsSupport(String value) Enable or disable DNS support.
void	setMulticastSupport(String value) Indicates whether multicast is enabled on the transit gateway.
void	setPropagationDefaultRouteTableId(String value) The ID of the default propagation route table.
void	setTransitGatewayCidrBlocks(List<String> value) The transit gateway CIDR blocks.
void	setVpnEcmpSupport(String value) Enable or disable Equal Cost Multipath Protocol support.

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

CfnTransitGateway

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

CfnTransitGateway

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

CfnTransitGateway

@Stability(value=Stable)
public CfnTransitGateway(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @Nullable
                                                  CfnTransitGatewayProps props)

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

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.

CfnTransitGateway

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

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

Parameters:

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

id - - scoped id of the resource. 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.

getAttrId

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

The ID of the transit gateway.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

The tags for the transit gateway.

getAmazonSideAsn

@Stability(value=Stable)
 @Nullable
public Number getAmazonSideAsn()

A private Autonomous System Number (ASN) for the Amazon side of a BGP session.

The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.

setAmazonSideAsn

@Stability(value=Stable)
public void setAmazonSideAsn(@Nullable
                                                      Number value)

A private Autonomous System Number (ASN) for the Amazon side of a BGP session.

The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.

getAssociationDefaultRouteTableId

@Stability(value=Stable)
 @Nullable
public String getAssociationDefaultRouteTableId()

The ID of the default association route table.

setAssociationDefaultRouteTableId

@Stability(value=Stable)
public void setAssociationDefaultRouteTableId(@Nullable
                                                                       String value)

The ID of the default association route table.

getAutoAcceptSharedAttachments

@Stability(value=Stable)
 @Nullable
public String getAutoAcceptSharedAttachments()

Enable or disable automatic acceptance of attachment requests.

Disabled by default.

setAutoAcceptSharedAttachments

@Stability(value=Stable)
public void setAutoAcceptSharedAttachments(@Nullable
                                                                    String value)

Enable or disable automatic acceptance of attachment requests.

Disabled by default.

getDefaultRouteTableAssociation

@Stability(value=Stable)
 @Nullable
public String getDefaultRouteTableAssociation()

Enable or disable automatic association with the default association route table.

Enabled by default.

setDefaultRouteTableAssociation

@Stability(value=Stable)
public void setDefaultRouteTableAssociation(@Nullable
                                                                     String value)

Enable or disable automatic association with the default association route table.

Enabled by default.

getDefaultRouteTablePropagation

@Stability(value=Stable)
 @Nullable
public String getDefaultRouteTablePropagation()

Enable or disable automatic propagation of routes to the default propagation route table.

Enabled by default.

setDefaultRouteTablePropagation

@Stability(value=Stable)
public void setDefaultRouteTablePropagation(@Nullable
                                                                     String value)

Enable or disable automatic propagation of routes to the default propagation route table.

Enabled by default.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the transit gateway.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the transit gateway.

getDnsSupport

@Stability(value=Stable)
 @Nullable
public String getDnsSupport()

Enable or disable DNS support.

Enabled by default.

setDnsSupport

@Stability(value=Stable)
public void setDnsSupport(@Nullable
                                                   String value)

Enable or disable DNS support.

Enabled by default.

getMulticastSupport

@Stability(value=Stable)
 @Nullable
public String getMulticastSupport()

Indicates whether multicast is enabled on the transit gateway.

setMulticastSupport

@Stability(value=Stable)
public void setMulticastSupport(@Nullable
                                                         String value)

Indicates whether multicast is enabled on the transit gateway.

getPropagationDefaultRouteTableId

@Stability(value=Stable)
 @Nullable
public String getPropagationDefaultRouteTableId()

The ID of the default propagation route table.

setPropagationDefaultRouteTableId

@Stability(value=Stable)
public void setPropagationDefaultRouteTableId(@Nullable
                                                                       String value)

The ID of the default propagation route table.

getTransitGatewayCidrBlocks

@Stability(value=Stable)
 @Nullable
public List<String> getTransitGatewayCidrBlocks()

The transit gateway CIDR blocks.

setTransitGatewayCidrBlocks

@Stability(value=Stable)
public void setTransitGatewayCidrBlocks(@Nullable
                                                                 List<String> value)

The transit gateway CIDR blocks.

getVpnEcmpSupport

@Stability(value=Stable)
 @Nullable
public String getVpnEcmpSupport()

Enable or disable Equal Cost Multipath Protocol support.

Enabled by default.

setVpnEcmpSupport

@Stability(value=Stable)
public void setVpnEcmpSupport(@Nullable
                                                       String value)

Enable or disable Equal Cost Multipath Protocol support.

Enabled by default.