Skip to content

Search Transit Gateway Multicast Groups

ec2_search_transit_gateway_multicast_groups R Documentation

Searches one or more transit gateway multicast groups and returns the group membership information

Description

Searches one or more transit gateway multicast groups and returns the group membership information.

Usage

ec2_search_transit_gateway_multicast_groups(
  TransitGatewayMulticastDomainId, Filters, MaxResults, NextToken, DryRun)

Arguments

TransitGatewayMulticastDomainId

[required] The ID of the transit gateway multicast domain.

Filters

One or more filters. The possible values are:

  • group-ip-address - The IP address of the transit gateway multicast group.

  • is-group-member - The resource is a group member. Valid values are true | false.

  • is-group-source - The resource is a group source. Valid values are true | false.

  • member-type - The member type. Valid values are igmp | static.

  • resource-id - The ID of the resource.

  • resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.

  • source-type - The source type. Valid values are igmp | static.

  • subnet-id - The ID of the subnet.

  • transit-gateway-attachment-id - The id of the transit gateway attachment.

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(
  MulticastGroups = list(
    list(
      GroupIpAddress = "string",
      TransitGatewayAttachmentId = "string",
      SubnetId = "string",
      ResourceId = "string",
      ResourceType = "vpc"|"vpn"|"direct-connect-gateway"|"connect"|"peering"|"tgw-peering",
      ResourceOwnerId = "string",
      NetworkInterfaceId = "string",
      GroupMember = TRUE|FALSE,
      GroupSource = TRUE|FALSE,
      MemberType = "static"|"igmp",
      SourceType = "static"|"igmp"
    )
  ),
  NextToken = "string"
)

Request syntax

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