Aws::EC2::Model::DescribeVpnConnectionsRequest Class Reference

#include <DescribeVpnConnectionsRequest.h>

Inheritance diagram for Aws::EC2::Model::DescribeVpnConnectionsRequest:

Public Member Functions
	DescribeVpnConnectionsRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
const Aws::Vector< Filter > &	GetFilters () const
bool	FiltersHasBeenSet () const
void	SetFilters (const Aws::Vector< Filter > &value)
void	SetFilters (Aws::Vector< Filter > &&value)
DescribeVpnConnectionsRequest &	WithFilters (const Aws::Vector< Filter > &value)
DescribeVpnConnectionsRequest &	WithFilters (Aws::Vector< Filter > &&value)
DescribeVpnConnectionsRequest &	AddFilters (const Filter &value)
DescribeVpnConnectionsRequest &	AddFilters (Filter &&value)
const Aws::Vector< Aws::String > &	GetVpnConnectionIds () const
bool	VpnConnectionIdsHasBeenSet () const
void	SetVpnConnectionIds (const Aws::Vector< Aws::String > &value)
void	SetVpnConnectionIds (Aws::Vector< Aws::String > &&value)
DescribeVpnConnectionsRequest &	WithVpnConnectionIds (const Aws::Vector< Aws::String > &value)
DescribeVpnConnectionsRequest &	WithVpnConnectionIds (Aws::Vector< Aws::String > &&value)
DescribeVpnConnectionsRequest &	AddVpnConnectionIds (const Aws::String &value)
DescribeVpnConnectionsRequest &	AddVpnConnectionIds (Aws::String &&value)
DescribeVpnConnectionsRequest &	AddVpnConnectionIds (const char *value)
bool	GetDryRun () const
bool	DryRunHasBeenSet () const
void	SetDryRun (bool value)
DescribeVpnConnectionsRequest &	WithDryRun (bool value)
Public Member Functions inherited from Aws::EC2::EC2Request
virtual	~EC2Request ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Protected Member Functions
void	DumpBodyToUrl (Aws::Http::URI &uri) const override
Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const

Detailed Description

Contains the parameters for DescribeVpnConnections.

See Also:

AWS API Reference

Definition at line 27 of file DescribeVpnConnectionsRequest.h.

Constructor & Destructor Documentation

DescribeVpnConnectionsRequest()

Aws::EC2::Model::DescribeVpnConnectionsRequest::DescribeVpnConnectionsRequest

(

)

Member Function Documentation

AddFilters() [1/2]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::AddFilters ( const Filter &  value )

inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key

  • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

Definition at line 253 of file DescribeVpnConnectionsRequest.h.

AddFilters() [2/2]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::AddFilters ( Filter &&  value )

inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key

  • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

Definition at line 283 of file DescribeVpnConnectionsRequest.h.

AddVpnConnectionIds() [1/3]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::AddVpnConnectionIds ( Aws::String &&  value )

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 332 of file DescribeVpnConnectionsRequest.h.

AddVpnConnectionIds() [2/3]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::AddVpnConnectionIds ( const Aws::String &  value )

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 326 of file DescribeVpnConnectionsRequest.h.

AddVpnConnectionIds() [3/3]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::AddVpnConnectionIds ( const char *  value )

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 338 of file DescribeVpnConnectionsRequest.h.

DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeVpnConnectionsRequest::DryRunHasBeenSet ( ) const

inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 355 of file DescribeVpnConnectionsRequest.h.

DumpBodyToUrl()

void Aws::EC2::Model::DescribeVpnConnectionsRequest::DumpBodyToUrl ( Aws::Http::URI &  uri ) const

overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

FiltersHasBeenSet()

bool Aws::EC2::Model::DescribeVpnConnectionsRequest::FiltersHasBeenSet ( ) const

inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key

  • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

Definition at line 103 of file DescribeVpnConnectionsRequest.h.

GetDryRun()

bool Aws::EC2::Model::DescribeVpnConnectionsRequest::GetDryRun ( ) const

inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 347 of file DescribeVpnConnectionsRequest.h.

GetFilters()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribeVpnConnectionsRequest::GetFilters ( ) const

inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key

  • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

Definition at line 73 of file DescribeVpnConnectionsRequest.h.

GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribeVpnConnectionsRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DescribeVpnConnectionsRequest.h.

GetVpnConnectionIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeVpnConnectionsRequest::GetVpnConnectionIds ( ) const

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 290 of file DescribeVpnConnectionsRequest.h.

SerializePayload()

Aws::String Aws::EC2::Model::DescribeVpnConnectionsRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetDryRun()

void Aws::EC2::Model::DescribeVpnConnectionsRequest::SetDryRun ( bool  value )

inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 363 of file DescribeVpnConnectionsRequest.h.

SetFilters() [1/2]

void Aws::EC2::Model::DescribeVpnConnectionsRequest::SetFilters ( Aws::Vector< Filter > &&  value )

inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key

  • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

Definition at line 163 of file DescribeVpnConnectionsRequest.h.

SetFilters() [2/2]

void Aws::EC2::Model::DescribeVpnConnectionsRequest::SetFilters ( const Aws::Vector< Filter > &  value )

inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key

  • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

Definition at line 133 of file DescribeVpnConnectionsRequest.h.

SetVpnConnectionIds() [1/2]

void Aws::EC2::Model::DescribeVpnConnectionsRequest::SetVpnConnectionIds ( Aws::Vector< Aws::String > &&  value )

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 308 of file DescribeVpnConnectionsRequest.h.

SetVpnConnectionIds() [2/2]

void Aws::EC2::Model::DescribeVpnConnectionsRequest::SetVpnConnectionIds ( const Aws::Vector< Aws::String > &  value )

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 302 of file DescribeVpnConnectionsRequest.h.

VpnConnectionIdsHasBeenSet()

bool Aws::EC2::Model::DescribeVpnConnectionsRequest::VpnConnectionIdsHasBeenSet ( ) const

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 296 of file DescribeVpnConnectionsRequest.h.

WithDryRun()

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::WithDryRun ( bool  value )

inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 371 of file DescribeVpnConnectionsRequest.h.

WithFilters() [1/2]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::WithFilters ( Aws::Vector< Filter > &&  value )

inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key

  • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

Definition at line 223 of file DescribeVpnConnectionsRequest.h.

WithFilters() [2/2]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::WithFilters ( const Aws::Vector< Filter > &  value )

inline

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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key

  • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

• transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

Definition at line 193 of file DescribeVpnConnectionsRequest.h.

WithVpnConnectionIds() [1/2]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::WithVpnConnectionIds ( Aws::Vector< Aws::String > &&  value )

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 320 of file DescribeVpnConnectionsRequest.h.

WithVpnConnectionIds() [2/2]

DescribeVpnConnectionsRequest& Aws::EC2::Model::DescribeVpnConnectionsRequest::WithVpnConnectionIds ( const Aws::Vector< Aws::String > &  value )

inline

One or more VPN connection IDs.

Default: Describes your VPN connections.

Definition at line 314 of file DescribeVpnConnectionsRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-ec2/include/aws/ec2/model/DescribeVpnConnectionsRequest.h