« blib/lib/Paws/EC2/SearchLocalGatewayRoutesResult.pm
↑ Summary
blib/lib/Paws/EC2/SearchTransitGatewayMulticastGroupsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::SearchTransitGatewayMulticastGroups; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has TransitGatewayMulticastDomainId => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchTransitGatewayMulticastGroups'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::SearchTransitGatewayMulticastGroupsResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::SearchTransitGatewayMulticastGroups - Arguments for method SearchTransitGatewayMulticastGroups on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SearchTransitGatewayMulticastGroups on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method SearchTransitGatewayMulticastGroups. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchTransitGatewayMulticastGroups. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | my $SearchTransitGatewayMulticastGroupsResult = | ||
| 35 | $ec2->SearchTransitGatewayMulticastGroups( | ||
| 36 | DryRun => 1, # OPTIONAL | ||
| 37 | Filters => [ | ||
| 38 | { | ||
| 39 | Name => 'MyString', # OPTIONAL | ||
| 40 | Values => [ | ||
| 41 | 'MyString', ... # OPTIONAL | ||
| 42 | ], # OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | NextToken => 'MyString', # OPTIONAL | ||
| 48 | TransitGatewayMulticastDomainId => | ||
| 49 | 'MyTransitGatewayMulticastDomainId', # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $MulticastGroups = | ||
| 54 | $SearchTransitGatewayMulticastGroupsResult->MulticastGroups; | ||
| 55 | my $NextToken = $SearchTransitGatewayMulticastGroupsResult->NextToken; | ||
| 56 | |||
| 57 | # Returns a L<Paws::EC2::SearchTransitGatewayMulticastGroupsResult> object. | ||
| 58 | |||
| 59 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/SearchTransitGatewayMulticastGroups> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DryRun => Bool | ||
| 66 | |||
| 67 | Checks whether you have the required permissions for the action, | ||
| 68 | without actually making the request, and provides an error response. If | ||
| 69 | you have the required permissions, the error response is | ||
| 70 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 75 | |||
| 76 | One or more filters. The possible values are: | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<group-ip-address> - The IP address of the transit gateway multicast | ||
| 83 | group. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<is-group-member> - The resource is a group member. Valid values are | ||
| 88 | C<true> | C<false>. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<is-group-source> - The resource is a group source. Valid values are | ||
| 93 | C<true> | C<false>. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<member-type> - The member type. Valid values are C<igmp> | C<static>. | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<resource-id> - The ID of the resource. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<resource-type> - The type of resource. Valid values are C<vpc> | | ||
| 106 | C<vpn> | C<direct-connect-gateway> | C<tgw-peering>. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<source-type> - The source type. Valid values are C<igmp> | C<static>. | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<state> - The state of the subnet association. Valid values are | ||
| 115 | C<associated> | C<associated> | C<disassociated> | C<disassociating>. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<subnet-id> - The ID of the subnet. | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<transit-gateway-attachment-id> - The id of the transit gateway | ||
| 124 | attachment. | ||
| 125 | |||
| 126 | =back | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head2 MaxResults => Int | ||
| 132 | |||
| 133 | The maximum number of results to return with a single call. To retrieve | ||
| 134 | the remaining results, make another call with the returned C<nextToken> | ||
| 135 | value. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 NextToken => Str | ||
| 140 | |||
| 141 | The token for the next page of results. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 TransitGatewayMulticastDomainId => Str | ||
| 146 | |||
| 147 | The ID of the transit gateway multicast domain. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, documenting arguments for method SearchTransitGatewayMulticastGroups in L<Paws::EC2> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |