« blib/lib/Paws/EC2/SearchTransitGatewayMulticastGroupsResult.pm
↑ Summary
blib/lib/Paws/EC2/SearchTransitGatewayRoutesResult.pm »
| 1 | |||
| 2 | package Paws::EC2::SearchTransitGatewayRoutes; | ||
| 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' , required => 1); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has TransitGatewayRouteTableId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchTransitGatewayRoutes'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::SearchTransitGatewayRoutesResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::EC2::SearchTransitGatewayRoutes - Arguments for method SearchTransitGatewayRoutes on L<Paws::EC2> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method SearchTransitGatewayRoutes on the | ||
| 25 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 26 | as arguments to method SearchTransitGatewayRoutes. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchTransitGatewayRoutes. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ec2 = Paws->service('EC2'); | ||
| 33 | my $SearchTransitGatewayRoutesResult = $ec2->SearchTransitGatewayRoutes( | ||
| 34 | Filters => [ | ||
| 35 | { | ||
| 36 | Name => 'MyString', # OPTIONAL | ||
| 37 | Values => [ | ||
| 38 | 'MyString', ... # OPTIONAL | ||
| 39 | ], # OPTIONAL | ||
| 40 | }, | ||
| 41 | ... | ||
| 42 | ], | ||
| 43 | TransitGatewayRouteTableId => 'MyTransitGatewayRouteTableId', | ||
| 44 | DryRun => 1, # OPTIONAL | ||
| 45 | MaxResults => 1, # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $AdditionalRoutesAvailable = | ||
| 50 | $SearchTransitGatewayRoutesResult->AdditionalRoutesAvailable; | ||
| 51 | my $Routes = $SearchTransitGatewayRoutesResult->Routes; | ||
| 52 | |||
| 53 | # Returns a L<Paws::EC2::SearchTransitGatewayRoutesResult> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/SearchTransitGatewayRoutes> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 DryRun => Bool | ||
| 62 | |||
| 63 | Checks whether you have the required permissions for the action, | ||
| 64 | without actually making the request, and provides an error response. If | ||
| 65 | you have the required permissions, the error response is | ||
| 66 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 71 | |||
| 72 | One or more filters. The possible values are: | ||
| 73 | |||
| 74 | =over | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<attachment.transit-gateway-attachment-id>- The id of the transit | ||
| 79 | gateway attachment. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<attachment.resource-id> - The resource id of the transit gateway | ||
| 84 | attachment. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<attachment.resource-type> - The attachment resource type. Valid | ||
| 89 | values are C<vpc> | C<vpn> | C<direct-connect-gateway> | C<peering> | | ||
| 90 | C<connect>. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<prefix-list-id> - The ID of the prefix list. | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<route-search.exact-match> - The exact match of the specified filter. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | C<route-search.longest-prefix-match> - The longest prefix that matches | ||
| 103 | the route. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<route-search.subnet-of-match> - The routes with a subnet that match | ||
| 108 | the specified CIDR filter. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | C<route-search.supernet-of-match> - The routes with a CIDR that | ||
| 113 | encompass the CIDR filter. For example, if you have 10.0.1.0/29 and | ||
| 114 | 10.0.1.0/31 routes in your route table and you specify | ||
| 115 | supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<state> - The state of the route (C<active> | C<blackhole>). | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<type> - The type of route (C<propagated> | C<static>). | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 MaxResults => Int | ||
| 131 | |||
| 132 | The maximum number of routes to return. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> TransitGatewayRouteTableId => Str | ||
| 137 | |||
| 138 | The ID of the transit gateway route table. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head1 SEE ALSO | ||
| 144 | |||
| 145 | This class forms part of L<Paws>, documenting arguments for method SearchTransitGatewayRoutes in L<Paws::EC2> | ||
| 146 | |||
| 147 | =head1 BUGS and CONTRIBUTIONS | ||
| 148 | |||
| 149 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 150 | |||
| 151 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 152 | |||
| 153 | =cut | ||
| 154 |