Class DescribeVpnConnectionsRequest
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeVpnConnectionsRequest>
,Serializable
,Cloneable
Contains the parameters for DescribeVpnConnections.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
This method is intended for internal use only.One or more filters.One or more VPN connection IDs.int
hashCode()
void
setFilters
(Collection<Filter> filters) One or more filters.void
setVpnConnectionIds
(Collection<String> vpnConnectionIds) One or more VPN connection IDs.toString()
Returns a string representation of this object; useful for testing and debugging.withFilters
(Filter... filters) One or more filters.withFilters
(Collection<Filter> filters) One or more filters.withVpnConnectionIds
(String... vpnConnectionIds) One or more VPN connection IDs.withVpnConnectionIds
(Collection<String> vpnConnectionIds) One or more VPN connection 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
-
Constructor Details
-
DescribeVpnConnectionsRequest
public DescribeVpnConnectionsRequest()
-
-
Method Details
-
getVpnConnectionIds
One or more VPN connection IDs.
Default: Describes your VPN connections.
- Returns:
- One or more VPN connection IDs.
Default: Describes your VPN connections.
-
setVpnConnectionIds
One or more VPN connection IDs.
Default: Describes your VPN connections.
- Parameters:
vpnConnectionIds
- One or more VPN connection IDs.Default: Describes your VPN connections.
-
withVpnConnectionIds
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)
orwithVpnConnectionIds(java.util.Collection)
if you want to override the existing values.- Parameters:
vpnConnectionIds
- One or more VPN connection IDs.Default: Describes your VPN connections.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVpnConnectionIds
One or more VPN connection IDs.
Default: Describes your VPN connections.
- Parameters:
vpnConnectionIds
- One or more VPN connection IDs.Default: Describes your VPN connections.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 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 VPN connection. Currently the only supported type isipsec.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.
- Returns:
- 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 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 VPN connection. Currently the only supported type isipsec.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.
-
-
-
setFilters
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 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 VPN connection. Currently the only supported type isipsec.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.
- Parameters:
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 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 VPN connection. Currently the only supported type isipsec.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.
-
-
-
withFilters
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 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 VPN connection. Currently the only supported type isipsec.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)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
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 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 VPN connection. Currently the only supported type isipsec.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
withFilters
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 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 VPN connection. Currently the only supported type isipsec.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.
- Parameters:
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 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 VPN connection. Currently the only supported type isipsec.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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<DescribeVpnConnectionsRequest>
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-