You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Types::DescribeCustomerGatewaysRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::DescribeCustomerGatewaysRequest
- Defined in:
- (unknown)
Overview
When passing DescribeCustomerGatewaysRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
customer_gateway_ids: ["CustomerGatewayId"],
filters: [
{
name: "String",
values: ["String"],
},
],
dry_run: false,
}
Contains the parameters for DescribeCustomerGateways.
Instance Attribute Summary collapse
-
#customer_gateway_ids ⇒ Array<String>
One or more customer gateway IDs.
-
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
-
#filters ⇒ Array<Types::Filter>
One or more filters.
Instance Attribute Details
#customer_gateway_ids ⇒ Array<String>
One or more customer gateway IDs.
Default: Describes all your customer gateways.
#dry_run ⇒ Boolean
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 ⇒ Array<Types::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 isipsec.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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.