[ aws . ec2 ]

deregister-transit-gateway-multicast-group-members

Description

Deregisters the specified members (network interfaces) from the transit gateway multicast group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  deregister-transit-gateway-multicast-group-members
[--transit-gateway-multicast-domain-id <value>]
[--group-ip-address <value>]
[--network-interface-ids <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

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

The ID of the transit gateway multicast domain.

--group-ip-address (string)

The IP address assigned to the transit gateway multicast group.

--network-interface-ids (list)

The IDs of the group members’ network interfaces.

(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 | --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 deregister group members from a multicast group

This example deregisters the specified network interface group member from the transit gateway multicast group.

aws ec2 deregister-transit-gateway-multicast-group-members \
    --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE \
    --group-ip-address 224.0.1.0 \
    --network-interface-ids eni-0e246d3269EXAMPLE

Output:

{
    "DeregisteredMulticastGroupMembers": {
        "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef7EXAMPLE",
        "RegisteredNetworkInterfaceIds": [
            "eni-0e246d3269EXAMPLE"
        ],
        "GroupIpAddress": "224.0.1.0"
    }
}

For more information, see Deregister Members from a Multicast Group in the AWS Transit Gateways Users Guide.

Output

DeregisteredMulticastGroupMembers -> (structure)

Information about the deregistered members.

TransitGatewayMulticastDomainId -> (string)

The ID of the transit gateway multicast domain.

DeregisteredNetworkInterfaceIds -> (list)

The network interface IDs of the deregistered members.

(string)

GroupIpAddress -> (string)

The IP address assigned to the transit gateway multicast group.