NAME

Paws::EC2::DescribeCustomerGateways - Arguments for method DescribeCustomerGateways on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method DescribeCustomerGateways on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method DescribeCustomerGateways.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCustomerGateways.

SYNOPSIS

my $ec2 = Paws->service('EC2');
# To describe a customer gateway
# This example describes the specified customer gateway.
my $DescribeCustomerGatewaysResult = $ec2->DescribeCustomerGateways(
  'CustomerGatewayIds' => ['cgw-0e11f167'] );

# Results:
my $CustomerGateways = $DescribeCustomerGatewaysResult->CustomerGateways;

# Returns a L<Paws::EC2::DescribeCustomerGatewaysResult> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeCustomerGateways

ATTRIBUTES

CustomerGatewayIds => ArrayRef[Str|Undef]

One or more customer gateway IDs.

Default: Describes all your customer gateways.

DryRun => Bool

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.

Filters => ArrayRef[Paws::EC2::Filter]

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeCustomerGateways in Paws::EC2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues