[ aws . ec2 ]

disable-transit-gateway-route-table-propagation

Description

Disables the specified resource attachment from propagating routes to the specified propagation route table.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  disable-transit-gateway-route-table-propagation
--transit-gateway-route-table-id <value>
--transit-gateway-attachment-id <value>
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--transit-gateway-route-table-id (string)

The ID of the propagation route table.

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

The ID of the attachment.

--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.

See ‘aws help’ for descriptions of global parameters.

Examples

To disable a transit gateway attachment to propagate routes to the specified propagation route table

The following disable-transit-gateway-route-table-propagation example disables the specified attachment to propagate routes to the specified propagation route table.

aws ec2 disable-transit-gateway-route-table-propagation \
    --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \
    --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE

Output:

{
    "Propagation": {
        "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE",
        "ResourceId": "vpc-4d7de228",
        "ResourceType": "vpc",
        "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE",
        "State": "disabled"
    }
}

For more information, see Disable Route Table Propagation in the AWS Transit Gateways Guide.

Output

Propagation -> (structure)

Information about route propagation.

TransitGatewayAttachmentId -> (string)

The ID of the attachment.

ResourceId -> (string)

The ID of the resource.

ResourceType -> (string)

The resource type. Note that the tgw-peering resource type has been deprecated.

TransitGatewayRouteTableId -> (string)

The ID of the transit gateway route table.

State -> (string)

The state.