AWS::EC2::TransitGatewayVpcAttachment - Amazon CloudFormation
SyntaxPropertiesReturn values
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::TransitGatewayVpcAttachment

Specifies a VPC attachment.

Syntax

To declare this entity in your Amazon 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: List of String

Update requires: No interruption

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

RemoveSubnetIds

The IDs of one or more subnets to remove.

Required: No

Type: List of String

Update requires: No interruption

SubnetIds

The IDs of the subnets.

Required: Yes

Type: List of String

Update requires: Replacement

Tags

The tags for the VPC 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.