CreateTransitGatewayMulticastDomain - Amazon Elastic Compute Cloud
Request ParametersResponse ElementsErrorsExamplesSee Also

CreateTransitGatewayMulticastDomain

Creates a multicast domain using the specified transit gateway.

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

Options

The options for the transit gateway multicast domain.

Type: CreateTransitGatewayMulticastDomainRequestOptions object

Required: No

TagSpecification.N

The tags for the transit gateway multicast domain.

Type: Array of TagSpecification objects

Required: No

TransitGatewayId

The ID of the transit gateway.

Type: String

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

transitGatewayMulticastDomain

Information about the transit gateway multicast domain.

Type: TransitGatewayMulticastDomain object

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example 1

This example creates a multicast domain for the specified transit gateway.

Sample Request

https://ec2.amazonaws.com/?Action=CreateTransitMulticastDomain
&TransitGatewayId=tgw-0d88d2d0d5EXAMPLE
&AUTHPARAMS

Sample Response

<CreateTransitGatewayMulticastDomainResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
    <requestId>763fb04b-258f-4710-8f91-b202aEXAMPLE</requestId>
    <transitGatewayMulticastDomain>
        <creationTime>2019-11-20T22:02:03.000Z</creationTime>
        <state>pending</state>
        <transitGatewayId>tgw-0d88d2d0d5EXAMPLE</transitGatewayId>
        <transitGatewayMulticastDomainId>tgw-mcast-domain-02bb79002EXAMPLE</transitGatewayMulticastDomainId>
    </transitGatewayMulticastDomain>
</CreateTransitGatewayMulticastDomainResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: