AWS::EC2::TransitGatewayVpcAttachment - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::EC2::TransitGatewayVpcAttachment

Specifies a VPC attachment.

Syntax

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

JSON

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

YAML

Type: AWS::EC2::TransitGatewayVpcAttachment
Properties:
  AddSubnetIds: 
    - String
  Options: 
    Options
  RemoveSubnetIds: 
    - String
  SubnetIds: 
    - String
  Tags: 
    - Tag
  TransitGatewayId: String
  VpcId: String

Properties

AddSubnetIds

The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.

Required: No

Type: Array of String

Update requires: No interruption

Options

The VPC attachment options.

Required: No

Type: Options

Update requires: No interruption

RemoveSubnetIds

The IDs of one or more subnets to remove.

Required: No

Type: Array of String

Update requires: No interruption

SubnetIds

The IDs of the subnets.

Required: Yes

Type: Array of String

Update requires: Replacement

Tags

The tags for the VPC attachment.

Required: No

Type: Array 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 Ref function, Ref returns the ID of the attachment.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic 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::GetAtt intrinsic function, see Fn::GetAtt.

Id

The ID of the attachment.