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.
Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For more information about supported instances, see Multicast on transit gateways in the Amazon Web Services Transit Gateways Guide .
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
See also: AWS API Documentation
register-transit-gateway-multicast-group-sources
--transit-gateway-multicast-domain-id <value>
[--group-ip-address <value>]
--network-interface-ids <value>
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--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 group sources' network interface IDs to register with the transit gateway multicast group.
(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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.
--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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To register a source with a transit gateway multicast group.
The following register-transit-gateway-multicast-group-sources
example registers the specified network interface group source with a multicast group.
aws ec2 register-transit-gateway-multicast-group-sources \
--transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef79d6e597 \
--group-ip-address 224.0.1.0 \
--network-interface-ids eni-07f290fc3c090cbae
Output:
{
"RegisteredMulticastGroupSources": {
"TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597",
"RegisteredNetworkInterfaceIds": [
"eni-07f290fc3c090cbae"
],
"GroupIpAddress": "224.0.1.0"
}
}
For more information, see Managing multicast domains in the Transit Gateways Guide.
RegisteredMulticastGroupSources -> (structure)
Information about the transit gateway multicast group sources.
TransitGatewayMulticastDomainId -> (string)
The ID of the transit gateway multicast domain.RegisteredNetworkInterfaceIds -> (list)
The IDs of the network interfaces members registered with the transit gateway multicast group.
(string)
GroupIpAddress -> (string)
The IP address assigned to the transit gateway multicast group.