@Generated(value="software.amazon.awssdk:codegen") public final class DescribeVpnGatewaysRequest extends Ec2Request implements ToCopyableBuilder<DescribeVpnGatewaysRequest.Builder,DescribeVpnGatewaysRequest>
Contains the parameters for DescribeVpnGateways.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeVpnGatewaysRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeVpnGatewaysRequest.Builder |
builder() |
boolean |
equals(Object obj) |
List<Filter> |
filters()
One or more filters.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeVpnGatewaysRequest.Builder> |
serializableBuilderClass() |
DescribeVpnGatewaysRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<String> |
vpnGatewayIds()
One or more virtual private gateway IDs.
|
overrideConfiguration
copy
public List<Filter> filters()
One or more filters.
amazon-side-asn
- The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state
- The current state of the attachment between the gateway and the VPC (
attaching
| attached
| detaching
| detached
).
attachment.vpc-id
- The ID of an attached VPC.
availability-zone
- The Availability Zone for the virtual private gateway (if applicable).
state
- The state of the virtual private gateway (pending
| available
|
deleting
| deleted
).
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.
type
- The type of virtual private gateway. Currently the only supported type is
ipsec.1
.
vpn-gateway-id
- The ID of the virtual private gateway.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
amazon-side-asn
- The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state
- The current state of the attachment between the gateway and the VPC (
attaching
| attached
| detaching
| detached
).
attachment.vpc-id
- The ID of an attached VPC.
availability-zone
- The Availability Zone for the virtual private gateway (if applicable).
state
- The state of the virtual private gateway (pending
|
available
| deleting
| deleted
).
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.
type
- The type of virtual private gateway. Currently the only supported type is
ipsec.1
.
vpn-gateway-id
- The ID of the virtual private gateway.
public List<String> vpnGatewayIds()
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Default: Describes all your virtual private gateways.
public DescribeVpnGatewaysRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeVpnGatewaysRequest.Builder,DescribeVpnGatewaysRequest>
toBuilder
in class Ec2Request
public static DescribeVpnGatewaysRequest.Builder builder()
public static Class<? extends DescribeVpnGatewaysRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.