Class DescribeVpnGatewaysRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeVpnGatewaysRequest>
,Serializable
,Cloneable
public class DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeVpnGatewaysRequest>
Contains the parameters for DescribeVpnGateways.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeVpnGatewaysRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeVpnGatewaysRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Request<DescribeVpnGatewaysRequest>
getDryRunRequest()
This method is intended for internal use only.List<Filter>
getFilters()
One or more filters.List<String>
getVpnGatewayIds()
One or more virtual private gateway IDs.int
hashCode()
void
setFilters(Collection<Filter> filters)
One or more filters.void
setVpnGatewayIds(Collection<String> vpnGatewayIds)
One or more virtual private gateway IDs.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeVpnGatewaysRequest
withFilters(Filter... filters)
One or more filters.DescribeVpnGatewaysRequest
withFilters(Collection<Filter> filters)
One or more filters.DescribeVpnGatewaysRequest
withVpnGatewayIds(String... vpnGatewayIds)
One or more virtual private gateway IDs.DescribeVpnGatewaysRequest
withVpnGatewayIds(Collection<String> vpnGatewayIds)
One or more virtual private gateway IDs.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
-
-
-
Method Detail
-
getVpnGatewayIds
public List<String> getVpnGatewayIds()
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
- Returns:
- One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
-
setVpnGatewayIds
public void setVpnGatewayIds(Collection<String> vpnGatewayIds)
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
- Parameters:
vpnGatewayIds
- One or more virtual private gateway IDs.Default: Describes all your virtual private gateways.
-
withVpnGatewayIds
public DescribeVpnGatewaysRequest withVpnGatewayIds(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)
orwithVpnGatewayIds(java.util.Collection)
if you want to override the existing values.- Parameters:
vpnGatewayIds
- One or more virtual private gateway IDs.Default: Describes all your virtual private gateways.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVpnGatewayIds
public DescribeVpnGatewaysRequest withVpnGatewayIds(Collection<String> vpnGatewayIds)
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
- Parameters:
vpnGatewayIds
- One or more virtual private gateway IDs.Default: Describes all your virtual private gateways.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getFilters
public 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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.1
. -
vpn-gateway-id
- The ID of the virtual private gateway.
- Returns:
- 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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.1
. -
vpn-gateway-id
- The ID of the virtual private gateway.
-
-
-
setFilters
public void setFilters(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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.1
. -
vpn-gateway-id
- The ID of the virtual private gateway.
- Parameters:
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.1
. -
vpn-gateway-id
- The ID of the virtual private gateway.
-
-
-
withFilters
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.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)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.1
. -
vpn-gateway-id
- The ID of the virtual private gateway.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
withFilters
public DescribeVpnGatewaysRequest withFilters(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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.1
. -
vpn-gateway-id
- The ID of the virtual private gateway.
- Parameters:
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
type
- The type of virtual private gateway. Currently the only supported type isipsec.1
. -
vpn-gateway-id
- The ID of the virtual private gateway.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
getDryRunRequest
public Request<DescribeVpnGatewaysRequest> getDryRunRequest()
This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.- Specified by:
getDryRunRequest
in interfaceDryRunSupportedRequest<DescribeVpnGatewaysRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeVpnGatewaysRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-