AWS SDK for C++  1.9.2
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::DescribeCustomerGatewaysRequest Class Reference

#include <DescribeCustomerGatewaysRequest.h>

+ Inheritance diagram for Aws::EC2::Model::DescribeCustomerGatewaysRequest:

Public Member Functions

 DescribeCustomerGatewaysRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetCustomerGatewayIds () const
 
bool CustomerGatewayIdsHasBeenSet () const
 
void SetCustomerGatewayIds (const Aws::Vector< Aws::String > &value)
 
void SetCustomerGatewayIds (Aws::Vector< Aws::String > &&value)
 
DescribeCustomerGatewaysRequestWithCustomerGatewayIds (const Aws::Vector< Aws::String > &value)
 
DescribeCustomerGatewaysRequestWithCustomerGatewayIds (Aws::Vector< Aws::String > &&value)
 
DescribeCustomerGatewaysRequestAddCustomerGatewayIds (const Aws::String &value)
 
DescribeCustomerGatewaysRequestAddCustomerGatewayIds (Aws::String &&value)
 
DescribeCustomerGatewaysRequestAddCustomerGatewayIds (const char *value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeCustomerGatewaysRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeCustomerGatewaysRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeCustomerGatewaysRequestAddFilters (const Filter &value)
 
DescribeCustomerGatewaysRequestAddFilters (Filter &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeCustomerGatewaysRequestWithDryRun (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::IOStreamGetBody () 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 RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () 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 DescribeCustomerGateways.

See Also:

AWS API Reference

Definition at line 27 of file DescribeCustomerGatewaysRequest.h.

Constructor & Destructor Documentation

◆ DescribeCustomerGatewaysRequest()

Aws::EC2::Model::DescribeCustomerGatewaysRequest::DescribeCustomerGatewaysRequest ( )

Member Function Documentation

◆ AddCustomerGatewayIds() [1/3]

DescribeCustomerGatewaysRequest& Aws::EC2::Model::DescribeCustomerGatewaysRequest::AddCustomerGatewayIds ( Aws::String &&  value)
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 91 of file DescribeCustomerGatewaysRequest.h.

◆ AddCustomerGatewayIds() [2/3]

DescribeCustomerGatewaysRequest& Aws::EC2::Model::DescribeCustomerGatewaysRequest::AddCustomerGatewayIds ( const Aws::String value)
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 85 of file DescribeCustomerGatewaysRequest.h.

◆ AddCustomerGatewayIds() [3/3]

DescribeCustomerGatewaysRequest& Aws::EC2::Model::DescribeCustomerGatewaysRequest::AddCustomerGatewayIds ( const char *  value)
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 97 of file DescribeCustomerGatewaysRequest.h.

◆ AddFilters() [1/2]

DescribeCustomerGatewaysRequest& Aws::EC2::Model::DescribeCustomerGatewaysRequest::AddFilters ( const Filter value)
inline

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

Definition at line 245 of file DescribeCustomerGatewaysRequest.h.

◆ AddFilters() [2/2]

DescribeCustomerGatewaysRequest& Aws::EC2::Model::DescribeCustomerGatewaysRequest::AddFilters ( Filter &&  value)
inline

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

Definition at line 266 of file DescribeCustomerGatewaysRequest.h.

◆ CustomerGatewayIdsHasBeenSet()

bool Aws::EC2::Model::DescribeCustomerGatewaysRequest::CustomerGatewayIdsHasBeenSet ( ) const
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 55 of file DescribeCustomerGatewaysRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeCustomerGatewaysRequest::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 283 of file DescribeCustomerGatewaysRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeCustomerGatewaysRequest::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::DescribeCustomerGatewaysRequest::FiltersHasBeenSet ( ) const
inline

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

Definition at line 140 of file DescribeCustomerGatewaysRequest.h.

◆ GetCustomerGatewayIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeCustomerGatewaysRequest::GetCustomerGatewayIds ( ) const
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 49 of file DescribeCustomerGatewaysRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeCustomerGatewaysRequest::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 275 of file DescribeCustomerGatewaysRequest.h.

◆ GetFilters()

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

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

Definition at line 119 of file DescribeCustomerGatewaysRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribeCustomerGatewaysRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DescribeCustomerGatewaysRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::DescribeCustomerGatewaysRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCustomerGatewayIds() [1/2]

void Aws::EC2::Model::DescribeCustomerGatewaysRequest::SetCustomerGatewayIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 67 of file DescribeCustomerGatewaysRequest.h.

◆ SetCustomerGatewayIds() [2/2]

void Aws::EC2::Model::DescribeCustomerGatewaysRequest::SetCustomerGatewayIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 61 of file DescribeCustomerGatewaysRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::DescribeCustomerGatewaysRequest::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 291 of file DescribeCustomerGatewaysRequest.h.

◆ SetFilters() [1/2]

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

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

Definition at line 182 of file DescribeCustomerGatewaysRequest.h.

◆ SetFilters() [2/2]

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

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

Definition at line 161 of file DescribeCustomerGatewaysRequest.h.

◆ WithCustomerGatewayIds() [1/2]

DescribeCustomerGatewaysRequest& Aws::EC2::Model::DescribeCustomerGatewaysRequest::WithCustomerGatewayIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 79 of file DescribeCustomerGatewaysRequest.h.

◆ WithCustomerGatewayIds() [2/2]

DescribeCustomerGatewaysRequest& Aws::EC2::Model::DescribeCustomerGatewaysRequest::WithCustomerGatewayIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more customer gateway IDs.

Default: Describes all your customer gateways.

Definition at line 73 of file DescribeCustomerGatewaysRequest.h.

◆ WithDryRun()

DescribeCustomerGatewaysRequest& Aws::EC2::Model::DescribeCustomerGatewaysRequest::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 299 of file DescribeCustomerGatewaysRequest.h.

◆ WithFilters() [1/2]

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

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

Definition at line 224 of file DescribeCustomerGatewaysRequest.h.

◆ WithFilters() [2/2]

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

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

Definition at line 203 of file DescribeCustomerGatewaysRequest.h.


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