Skip to content

Describes one or more transit gateway multicast domains

Description

Describes one or more transit gateway multicast domains.

Usage

ec2_describe_transit_gateway_multicast_domains(
  TransitGatewayMulticastDomainIds, Filters, MaxResults, NextToken,
  DryRun)

Arguments

  • TransitGatewayMulticastDomainIds

    The ID of the transit gateway multicast domain.

  • Filters

    One or more filters. The possible values are:

    • state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
    • transit-gateway-id - The ID of the transit gateway.
    • transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.

  • MaxResults

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • NextToken

    The token for the next page of results.

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

Value

A list with the following syntax:

list(
  TransitGatewayMulticastDomains = list(
    list(
      TransitGatewayMulticastDomainId = "string",
      TransitGatewayId = "string",
      TransitGatewayMulticastDomainArn = "string",
      OwnerId = "string",
      Options = list(
        Igmpv2Support = "enable"|"disable",
        StaticSourcesSupport = "enable"|"disable",
        AutoAcceptSharedAssociations = "enable"|"disable"
      ),
      State = "pending"|"available"|"deleting"|"deleted",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_transit_gateway_multicast_domains(
  TransitGatewayMulticastDomainIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)