com.amazonaws.services.ec2.model
Class DescribeVpnGatewaysRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVpnGatewaysRequest>, java.io.Serializable

public class DescribeVpnGatewaysRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeVpnGatewaysRequest>

Container for the parameters to the DescribeVpnGateways operation.

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide .

See Also:

AmazonEC2.describeVpnGateways(DescribeVpnGatewaysRequest), Serialized Form

Constructor Summary

DescribeVpnGatewaysRequest()

Method Summary

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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVpnGatewaysRequest

public DescribeVpnGatewaysRequest()

Method Detail

getVpnGatewayIds

public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.String... vpnGatewayIds)

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vpnGatewayIds - One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Returns:

A reference to this updated object so that method calls can be chained together.

withVpnGatewayIds

public DescribeVpnGatewaysRequest withVpnGatewayIds(java.util.Collection<java.lang.String> vpnGatewayIds)

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Returns a reference to this object so that method calls can be chained together.

Parameters:

vpnGatewayIds - One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

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.

• 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.

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.

• 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.

setFilters

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.

• 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.

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.

• 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.

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.

• 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.

Returns a reference to this object so that method calls can be chained together.

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.

• 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.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

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.

• 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.

Returns a reference to this object so that method calls can be chained together.

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.

• 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.

Returns:

A reference to this updated 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 interface DryRunSupportedRequest<DescribeVpnGatewaysRequest>

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object