« blib/lib/Paws/EC2/DescribeBundleTasksResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeCustomerGatewaysResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeCustomerGateways; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has CustomerGatewayIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'CustomerGatewayId' ); | |
| 5 | 1 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 6 | 1 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | |
| 7 | |||
| 8 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 9 | |||
| 10 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCustomerGateways'); | |
| 11 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeCustomerGatewaysResult'); | |
| 12 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 13 | 1 | 1; | |
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::EC2::DescribeCustomerGateways - Arguments for method DescribeCustomerGateways on L<Paws::EC2> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeCustomerGateways on the | ||
| 24 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeCustomerGateways. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCustomerGateways. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ec2 = Paws->service('EC2'); | ||
| 32 | # To describe a customer gateway | ||
| 33 | # This example describes the specified customer gateway. | ||
| 34 | my $DescribeCustomerGatewaysResult = $ec2->DescribeCustomerGateways( | ||
| 35 | 'CustomerGatewayIds' => ['cgw-0e11f167'] ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $CustomerGateways = $DescribeCustomerGatewaysResult->CustomerGateways; | ||
| 39 | |||
| 40 | # Returns a L<Paws::EC2::DescribeCustomerGatewaysResult> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeCustomerGateways> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 CustomerGatewayIds => ArrayRef[Str|Undef] | ||
| 49 | |||
| 50 | One or more customer gateway IDs. | ||
| 51 | |||
| 52 | Default: Describes all your customer gateways. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 DryRun => Bool | ||
| 57 | |||
| 58 | Checks whether you have the required permissions for the action, | ||
| 59 | without actually making the request, and provides an error response. If | ||
| 60 | you have the required permissions, the error response is | ||
| 61 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 66 | |||
| 67 | One or more filters. | ||
| 68 | |||
| 69 | =over | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<bgp-asn> - The customer gateway's Border Gateway Protocol (BGP) | ||
| 74 | Autonomous System Number (ASN). | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<customer-gateway-id> - The ID of the customer gateway. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<ip-address> - The IP address of the customer gateway's | ||
| 83 | Internet-routable external interface. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<state> - The state of the customer gateway (C<pending> | C<available> | ||
| 88 | | C<deleting> | C<deleted>). | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<type> - The type of customer gateway. Currently, the only supported | ||
| 93 | type is C<ipsec.1>. | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 98 | the resource. Use the tag key in the filter name and the tag value as | ||
| 99 | the filter value. For example, to find all resources that have a tag | ||
| 100 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 101 | the filter name and C<TeamA> for the filter value. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 106 | to find all resources assigned a tag with a specific key, regardless of | ||
| 107 | the tag value. | ||
| 108 | |||
| 109 | =back | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, documenting arguments for method DescribeCustomerGateways in L<Paws::EC2> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 | |||