public class DescribeVpnConnectionsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable, DryRunSupportedRequest<DescribeVpnConnectionsRequest>
Contains the parameters for DescribeVpnConnections.
Modifier and Type | Field and Description |
---|---|
private SdkInternalList<Filter> |
filters
One or more filters.
|
private SdkInternalList<java.lang.String> |
vpnConnectionIds
One or more VPN connection IDs.
|
NOOP
Constructor and Description |
---|
DescribeVpnConnectionsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeVpnConnectionsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
Request<DescribeVpnConnectionsRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
java.util.List<Filter> |
getFilters()
One or more filters.
|
java.util.List<java.lang.String> |
getVpnConnectionIds()
One or more VPN connection IDs.
|
int |
hashCode() |
void |
setFilters(java.util.Collection<Filter> filters)
One or more filters.
|
void |
setVpnConnectionIds(java.util.Collection<java.lang.String> vpnConnectionIds)
One or more VPN connection IDs.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeVpnConnectionsRequest |
withFilters(java.util.Collection<Filter> filters)
One or more filters.
|
DescribeVpnConnectionsRequest |
withFilters(Filter... filters)
One or more filters.
|
DescribeVpnConnectionsRequest |
withVpnConnectionIds(java.util.Collection<java.lang.String> vpnConnectionIds)
One or more VPN connection IDs.
|
DescribeVpnConnectionsRequest |
withVpnConnectionIds(java.lang.String... vpnConnectionIds)
One or more VPN connection 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> vpnConnectionIds
One or more VPN connection IDs.
Default: Describes your VPN connections.
private SdkInternalList<Filter> filters
One or more filters.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
| deleting
|
deleted
).
option.static-routes-only
- Indicates whether the connection
has static routes only. Used for devices that do not support Border
Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR block.
This corresponds to the subnet used in a customer data center.
bgp-asn
- The BGP Autonomous System Number (ASN) associated
with a BGP device.
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 VPN connection. Currently the only
supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
public java.util.List<java.lang.String> getVpnConnectionIds()
One or more VPN connection IDs.
Default: Describes your VPN connections.
Default: Describes your VPN connections.
public void setVpnConnectionIds(java.util.Collection<java.lang.String> vpnConnectionIds)
One or more VPN connection IDs.
Default: Describes your VPN connections.
vpnConnectionIds
- One or more VPN connection IDs.
Default: Describes your VPN connections.
public DescribeVpnConnectionsRequest withVpnConnectionIds(java.lang.String... vpnConnectionIds)
One or more VPN connection IDs.
Default: Describes your VPN connections.
NOTE: This method appends the values to the existing list (if
any). Use setVpnConnectionIds(java.util.Collection)
or
withVpnConnectionIds(java.util.Collection)
if you want to
override the existing values.
vpnConnectionIds
- One or more VPN connection IDs.
Default: Describes your VPN connections.
public DescribeVpnConnectionsRequest withVpnConnectionIds(java.util.Collection<java.lang.String> vpnConnectionIds)
One or more VPN connection IDs.
Default: Describes your VPN connections.
vpnConnectionIds
- One or more VPN connection IDs.
Default: Describes your VPN connections.
public java.util.List<Filter> getFilters()
One or more filters.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
| deleting
|
deleted
).
option.static-routes-only
- Indicates whether the connection
has static routes only. Used for devices that do not support Border
Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR block.
This corresponds to the subnet used in a customer data center.
bgp-asn
- The BGP Autonomous System Number (ASN) associated
with a BGP device.
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 VPN connection. Currently the only
supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
|
deleting
| deleted
).
option.static-routes-only
- Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR
block. This corresponds to the subnet used in a customer data
center.
bgp-asn
- The BGP Autonomous System Number (ASN)
associated with a BGP device.
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 VPN connection. Currently the
only supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
public void setFilters(java.util.Collection<Filter> filters)
One or more filters.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
| deleting
|
deleted
).
option.static-routes-only
- Indicates whether the connection
has static routes only. Used for devices that do not support Border
Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR block.
This corresponds to the subnet used in a customer data center.
bgp-asn
- The BGP Autonomous System Number (ASN) associated
with a BGP device.
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 VPN connection. Currently the only
supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
filters
- One or more filters.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
|
deleting
| deleted
).
option.static-routes-only
- Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR
block. This corresponds to the subnet used in a customer data
center.
bgp-asn
- The BGP Autonomous System Number (ASN)
associated with a BGP device.
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 VPN connection. Currently the only
supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
public DescribeVpnConnectionsRequest withFilters(Filter... filters)
One or more filters.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
| deleting
|
deleted
).
option.static-routes-only
- Indicates whether the connection
has static routes only. Used for devices that do not support Border
Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR block.
This corresponds to the subnet used in a customer data center.
bgp-asn
- The BGP Autonomous System Number (ASN) associated
with a BGP device.
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 VPN connection. Currently the only
supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
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.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
|
deleting
| deleted
).
option.static-routes-only
- Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR
block. This corresponds to the subnet used in a customer data
center.
bgp-asn
- The BGP Autonomous System Number (ASN)
associated with a BGP device.
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 VPN connection. Currently the only
supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
public DescribeVpnConnectionsRequest withFilters(java.util.Collection<Filter> filters)
One or more filters.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
| deleting
|
deleted
).
option.static-routes-only
- Indicates whether the connection
has static routes only. Used for devices that do not support Border
Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR block.
This corresponds to the subnet used in a customer data center.
bgp-asn
- The BGP Autonomous System Number (ASN) associated
with a BGP device.
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 VPN connection. Currently the only
supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
filters
- One or more filters.
customer-gateway-configuration
- The configuration
information for the customer gateway.
customer-gateway-id
- The ID of a customer gateway
associated with the VPN connection.
state
- The state of the VPN connection (
pending
| available
|
deleting
| deleted
).
option.static-routes-only
- Indicates whether the
connection has static routes only. Used for devices that do not
support Border Gateway Protocol (BGP).
route.destination-cidr-block
- The destination CIDR
block. This corresponds to the subnet used in a customer data
center.
bgp-asn
- The BGP Autonomous System Number (ASN)
associated with a BGP device.
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 VPN connection. Currently the only
supported type is ipsec.1
.
vpn-connection-id
- The ID of the VPN connection.
vpn-gateway-id
- The ID of a virtual private gateway
associated with the VPN connection.
public Request<DescribeVpnConnectionsRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<DescribeVpnConnectionsRequest>
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 DescribeVpnConnectionsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()