[ aws . ec2 ]

modify-transit-gateway-vpc-attachment

Description

Modifies the specified VPC attachment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  modify-transit-gateway-vpc-attachment
--transit-gateway-attachment-id <value>
[--add-subnet-ids <value>]
[--remove-subnet-ids <value>]
[--options <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--transit-gateway-attachment-id (string)

The ID of the attachment.

--add-subnet-ids (list)

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

(string)

Syntax:

"string" "string" ...

--remove-subnet-ids (list)

The IDs of one or more subnets to remove.

(string)

Syntax:

"string" "string" ...

--options (structure)

The new VPC attachment options.

Note

You cannot modify the IPv6 options.

DnsSupport -> (string)

Enable or disable DNS support. The default is enable .

Ipv6Support -> (string)

Enable or disable IPv6 support. The default is enable .

Shorthand Syntax:

DnsSupport=string,Ipv6Support=string

JSON Syntax:

{
  "DnsSupport": "enable"|"disable",
  "Ipv6Support": "enable"|"disable"
}

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To modify a transit gateway VPC attachment

The following modify-transit-gateway-vpc-attachment example adds a subnet to the specified transit gateway VPC attachment.

aws ec2 modify-transit-gateway-vpc-attachment \
    --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE \
    --add-subnet-ids subnet-0e51f45802EXAMPLE

Output:

{
    "TransitGatewayVpcAttachment": {
        "TransitGatewayAttachmentId": "tgw-attach-09fbd47ddfEXAMPLE",
        "TransitGatewayId": "tgw-0560315ccfEXAMPLE",
        "VpcId": "vpc-5eccc927",
        "VpcOwnerId": "111122223333",
        "State": "modifying",
        "SubnetIds": [
            "subnet-0e51f45802EXAMPLE",
            "subnet-1EXAMPLE"
        ],
        "CreationTime": "2019-08-08T16:47:38.000Z",
        "Options": {
            "DnsSupport": "enable",
            "Ipv6Support": "disable"
        }
    }
}

For more information, see Transit Gateway Attachments to a VPC in the AWS Transit Gateways Guide.

Output

TransitGatewayVpcAttachment -> (structure)

Information about the modified attachment.

TransitGatewayAttachmentId -> (string)

The ID of the attachment.

TransitGatewayId -> (string)

The ID of the transit gateway.

VpcId -> (string)

The ID of the VPC.

VpcOwnerId -> (string)

The ID of the AWS account that owns the VPC.

State -> (string)

The state of the VPC attachment.

SubnetIds -> (list)

The IDs of the subnets.

(string)

CreationTime -> (timestamp)

The creation time.

Options -> (structure)

The VPC attachment options.

DnsSupport -> (string)

Indicates whether DNS support is enabled.

Ipv6Support -> (string)

Indicates whether IPv6 support is disabled.

Tags -> (list)

The tags for the VPC attachment.

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

Value -> (string)

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.