Class CfnTransitGateway
Specifies a transit gateway.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTransitGateway : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnTransitGateway
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgateway.html
CloudformationResource: AWS::EC2::TransitGateway
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnTransitGateway = new CfnTransitGateway(this, "MyCfnTransitGateway", new CfnTransitGatewayProps {
AmazonSideAsn = 123,
AssociationDefaultRouteTableId = "associationDefaultRouteTableId",
AutoAcceptSharedAttachments = "autoAcceptSharedAttachments",
DefaultRouteTableAssociation = "defaultRouteTableAssociation",
DefaultRouteTablePropagation = "defaultRouteTablePropagation",
Description = "description",
DnsSupport = "dnsSupport",
MulticastSupport = "multicastSupport",
PropagationDefaultRouteTableId = "propagationDefaultRouteTableId",
SecurityGroupReferencingSupport = "securityGroupReferencingSupport",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TransitGatewayCidrBlocks = new [] { "transitGatewayCidrBlocks" },
VpnEcmpSupport = "vpnEcmpSupport"
});
Synopsis
Constructors
CfnTransitGateway(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTransitGateway(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnTransitGateway(Construct, String, ICfnTransitGatewayProps) |
Properties
AmazonSideAsn | A private Autonomous System Number (ASN) for the Amazon side of a BGP session. |
AssociationDefaultRouteTableId | The ID of the default association route table. |
AttrId | The ID of the transit gateway. |
AttrTransitGatewayArn | |
AutoAcceptSharedAttachments | Enable or disable automatic acceptance of attachment requests. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DefaultRouteTableAssociation | Enable or disable automatic association with the default association route table. |
DefaultRouteTablePropagation | Enable or disable automatic propagation of routes to the default propagation route table. |
Description | The description of the transit gateway. |
DnsSupport | Enable or disable DNS support. |
MulticastSupport | Indicates whether multicast is enabled on the transit gateway. |
PropagationDefaultRouteTableId | The ID of the default propagation route table. |
SecurityGroupReferencingSupport | Enables you to reference a security group across VPCs attached to a transit gateway (TGW). |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags for the transit gateway. |
TransitGatewayCidrBlocks | The transit gateway CIDR blocks. |
VpnEcmpSupport | Enable or disable Equal Cost Multipath Protocol support. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTransitGateway(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTransitGateway(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTransitGateway(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTransitGateway(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnTransitGateway(Construct, String, ICfnTransitGatewayProps)
public CfnTransitGateway(Construct scope, string id, ICfnTransitGatewayProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnTransitGatewayProps
Resource properties.
Properties
AmazonSideAsn
A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
public virtual Nullable<double> AmazonSideAsn { get; set; }
Property Value
System.Nullable<System.Double>
AssociationDefaultRouteTableId
The ID of the default association route table.
public virtual string AssociationDefaultRouteTableId { get; set; }
Property Value
System.String
AttrId
The ID of the transit gateway.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrTransitGatewayArn
public virtual string AttrTransitGatewayArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: TransitGatewayArn
AutoAcceptSharedAttachments
Enable or disable automatic acceptance of attachment requests.
public virtual string AutoAcceptSharedAttachments { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DefaultRouteTableAssociation
Enable or disable automatic association with the default association route table.
public virtual string DefaultRouteTableAssociation { get; set; }
Property Value
System.String
DefaultRouteTablePropagation
Enable or disable automatic propagation of routes to the default propagation route table.
public virtual string DefaultRouteTablePropagation { get; set; }
Property Value
System.String
Description
The description of the transit gateway.
public virtual string Description { get; set; }
Property Value
System.String
DnsSupport
Enable or disable DNS support.
public virtual string DnsSupport { get; set; }
Property Value
System.String
MulticastSupport
Indicates whether multicast is enabled on the transit gateway.
public virtual string MulticastSupport { get; set; }
Property Value
System.String
PropagationDefaultRouteTableId
The ID of the default propagation route table.
public virtual string PropagationDefaultRouteTableId { get; set; }
Property Value
System.String
SecurityGroupReferencingSupport
Enables you to reference a security group across VPCs attached to a transit gateway (TGW).
public virtual string SecurityGroupReferencingSupport { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags for the transit gateway.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TransitGatewayCidrBlocks
The transit gateway CIDR blocks.
public virtual string[] TransitGatewayCidrBlocks { get; set; }
Property Value
System.String[]
VpnEcmpSupport
Enable or disable Equal Cost Multipath Protocol support.
public virtual string VpnEcmpSupport { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>