public class DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable, DryRunSupportedRequest<DescribeVpnGatewaysRequest>
Contains the parameters for DescribeVpnGateways.
Modifier and Type | Field and Description |
---|---|
private SdkInternalList<Filter> |
filters
One or more filters.
|
private SdkInternalList<java.lang.String> |
vpnGatewayIds
One or more virtual private gateway IDs.
|
NOOP
Constructor and Description |
---|
DescribeVpnGatewaysRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeVpnGatewaysRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
Request<DescribeVpnGatewaysRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
java.util.List<Filter> |
getFilters()
One or more filters.
|
java.util.List<java.lang.String> |
getVpnGatewayIds()
One or more virtual private gateway IDs.
|
int |
hashCode() |
void |
setFilters(java.util.Collection<Filter> filters)
One or more filters.
|
void |
setVpnGatewayIds(java.util.Collection<java.lang.String> vpnGatewayIds)
One or more virtual private gateway IDs.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeVpnGatewaysRequest |
withFilters(java.util.Collection<Filter> filters)
One or more filters.
|
DescribeVpnGatewaysRequest |
withFilters(Filter... filters)
One or more filters.
|
DescribeVpnGatewaysRequest |
withVpnGatewayIds(java.util.Collection<java.lang.String> vpnGatewayIds)
One or more virtual private gateway IDs.
|
DescribeVpnGatewaysRequest |
withVpnGatewayIds(java.lang.String... vpnGatewayIds)
One or more virtual private gateway IDs.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private SdkInternalList<java.lang.String> vpnGatewayIds
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
private SdkInternalList<Filter> filters
One or more filters.
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=value - The key/value combination of a
tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This
filter is independent of the tag-value
filter. For example,
if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X (regardless
of what the tag's key is). If you want to list only resources where
Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource.
This filter is independent of the tag-key
filter.
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 java.util.List<java.lang.String> getVpnGatewayIds()
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
Default: Describes all your virtual private gateways.
public void setVpnGatewayIds(java.util.Collection<java.lang.String> vpnGatewayIds)
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
vpnGatewayIds
- One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
public DescribeVpnGatewaysRequest withVpnGatewayIds(java.lang.String... vpnGatewayIds)
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
NOTE: This method appends the values to the existing list (if
any). Use setVpnGatewayIds(java.util.Collection)
or
withVpnGatewayIds(java.util.Collection)
if you want to override
the existing values.
vpnGatewayIds
- One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
public DescribeVpnGatewaysRequest withVpnGatewayIds(java.util.Collection<java.lang.String> vpnGatewayIds)
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
vpnGatewayIds
- One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
public java.util.List<Filter> getFilters()
One or more filters.
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=value - The key/value combination of a
tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This
filter is independent of the tag-value
filter. For example,
if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X (regardless
of what the tag's key is). If you want to list only resources where
Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource.
This filter is independent of the tag-key
filter.
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.
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=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter.
For example, if you use both the filter "tag-key=Purpose" and the
filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag
value X (regardless of what the tag's key is). If you want to
list only resources where Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
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 void setFilters(java.util.Collection<Filter> filters)
One or more filters.
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=value - The key/value combination of a
tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This
filter is independent of the tag-value
filter. For example,
if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X (regardless
of what the tag's key is). If you want to list only resources where
Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource.
This filter is independent of the tag-key
filter.
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.
filters
- One or more filters.
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=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter.
For example, if you use both the filter "tag-key=Purpose" and the
filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag
value X (regardless of what the tag's key is). If you want to list
only resources where Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
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 DescribeVpnGatewaysRequest withFilters(Filter... filters)
One or more filters.
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=value - The key/value combination of a
tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This
filter is independent of the tag-value
filter. For example,
if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X (regardless
of what the tag's key is). If you want to list only resources where
Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource.
This filter is independent of the tag-key
filter.
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.
NOTE: This method appends the values to the existing list (if
any). Use setFilters(java.util.Collection)
or
withFilters(java.util.Collection)
if you want to override the
existing values.
filters
- One or more filters.
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=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter.
For example, if you use both the filter "tag-key=Purpose" and the
filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag
value X (regardless of what the tag's key is). If you want to list
only resources where Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
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 DescribeVpnGatewaysRequest withFilters(java.util.Collection<Filter> filters)
One or more filters.
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=value - The key/value combination of a
tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource. This
filter is independent of the tag-value
filter. For example,
if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X (regardless
of what the tag's key is). If you want to list only resources where
Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource.
This filter is independent of the tag-key
filter.
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.
filters
- One or more filters.
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=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value
filter.
For example, if you use both the filter "tag-key=Purpose" and the
filter "tag-value=X", you get any resources assigned both the tag
key Purpose (regardless of what the tag's value is), and the tag
value X (regardless of what the tag's key is). If you want to list
only resources where Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
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 Request<DescribeVpnGatewaysRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<DescribeVpnGatewaysRequest>
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DescribeVpnGatewaysRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()