AWS::EC2::TransitGatewayAttachment - Amazon CloudFormation
SyntaxPropertiesReturn valuesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::EC2::TransitGatewayAttachment

Attaches a VPC to a transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using AWS::EC2::Route.

To update tags for a VPC attachment after creation without replacing the attachment, use AWS::EC2::TransitGatewayVpcAttachment instead.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::TransitGatewayAttachment",
  "Properties" : {
      "Options" : Options,
      "SubnetIds" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "TransitGatewayId" : String,
      "VpcId" : String
    }
}

YAML

Type: AWS::EC2::TransitGatewayAttachment
Properties: 
  Options: 
    Options
  SubnetIds: 
    - String
  Tags: 
    - Tag
  TransitGatewayId: String
  VpcId: String

Properties

Options

The VPC attachment options, in JSON or YAML.

  • ApplianceModeSupport - Set to enable or disable. The default is disable.

  • DnsSupport - Set to enable or disable. The default is enable.

  • Ipv6Support - Set to enable or disable. The default is disable.

Required: No

Type: Options

Update requires: No interruption

SubnetIds

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.

Required: Yes

Type: List of String

Update requires: No interruption

Tags

The tags for the attachment.

Required: No

Type: List of Tag

Update requires: No interruption

TransitGatewayId

The ID of the transit gateway.

Required: Yes

Type: String

Update requires: Replacement

VpcId

The ID of the VPC.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the ID of the attachment.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAttintrinsic function, see Fn::GetAtt.

Id

The ID of the attachment.

See also