Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ec2 ]

disassociate-transit-gateway-multicast-domain

Description

Disassociates the specified subnets from the transit gateway multicast domain.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  disassociate-transit-gateway-multicast-domain
[--transit-gateway-multicast-domain-id <value>]
[--transit-gateway-attachment-id <value>]
[--subnet-ids <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--transit-gateway-multicast-domain-id (string)

The ID of the transit gateway multicast domain.

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

The ID of the attachment.

--subnet-ids (list)

The IDs of the subnets;

(string)

Syntax:

"string" "string" ...

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 disassociate subnets from a multicast domain

This example disassociates a subnet from the specified multicast domain.

aws ec2 disassociate-transit-gateway-multicast-domain \
    --transit-gateway-attachment-id tgw-attach-070e571cd1EXAMPLE \
    --subnet-id subnet-000de86e3bEXAMPLE \
    --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE

Output:

{
    "Associations": {
        "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef7EXAMPLE",
        "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE",
        "ResourceId": "vpc-7EXAMPLE",
        "ResourceType": "vpc",
        "Subnets": [
            {
                "SubnetId": "subnet-000de86e3bEXAMPLE",
                "State": "disassociating"
            }
        ]
    }
}

For more information, see 'Disassociate Subnets from a Transit Gateway Multicast Domain<https://docs.aws.amazon.com/vpc/latest/tgw/working-with-multicast.html#remove-subnet-association>'__ in the AWS Transit Gateways User Guide'.

Output

Associations -> (structure)

Information about the association.

TransitGatewayMulticastDomainId -> (string)

The ID of the transit gateway multicast domain.

TransitGatewayAttachmentId -> (string)

The ID of the transit gateway attachment.

ResourceId -> (string)

The ID of the resource.

ResourceType -> (string)

The type of resource, for example a VPC attachment.

Subnets -> (list)

The subnets associated with the multicast domain.

(structure)

Describes the subnet association with the transit gateway multicast domain.

SubnetId -> (string)

The ID of the subnet.

State -> (string)

The state of the subnet association.