Class: Aws::EC2::Types::SearchTransitGatewayMulticastGroupsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass SearchTransitGatewayMulticastGroupsRequest data as a hash:

{
  transit_gateway_multicast_domain_id: "TransitGatewayMulticastDomainId",
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)


44363
44364
44365
44366
44367
44368
44369
44370
44371
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 44363

class SearchTransitGatewayMulticastGroupsRequest < Struct.new(
  :transit_gateway_multicast_domain_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

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.

  • state - The state of the subnet association. Valid values are associated | associated | disassociated | disassociating.

  • subnet-id - The ID of the subnet.

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

Returns:



44363
44364
44365
44366
44367
44368
44369
44370
44371
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 44363

class SearchTransitGatewayMulticastGroupsRequest < Struct.new(
  :transit_gateway_multicast_domain_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


44363
44364
44365
44366
44367
44368
44369
44370
44371
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 44363

class SearchTransitGatewayMulticastGroupsRequest < Struct.new(
  :transit_gateway_multicast_domain_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


44363
44364
44365
44366
44367
44368
44369
44370
44371
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 44363

class SearchTransitGatewayMulticastGroupsRequest < Struct.new(
  :transit_gateway_multicast_domain_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#transit_gateway_multicast_domain_idString

The ID of the transit gateway multicast domain.

Returns:

  • (String)


44363
44364
44365
44366
44367
44368
44369
44370
44371
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 44363

class SearchTransitGatewayMulticastGroupsRequest < Struct.new(
  :transit_gateway_multicast_domain_id,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end