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

#include <DescribeNatGatewaysRequest.h>

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

Public Member Functions

 DescribeNatGatewaysRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Filter > & GetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Aws::Vector< Filter > &value)
 
void SetFilter (Aws::Vector< Filter > &&value)
 
DescribeNatGatewaysRequestWithFilter (const Aws::Vector< Filter > &value)
 
DescribeNatGatewaysRequestWithFilter (Aws::Vector< Filter > &&value)
 
DescribeNatGatewaysRequestAddFilter (const Filter &value)
 
DescribeNatGatewaysRequestAddFilter (Filter &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeNatGatewaysRequestWithMaxResults (int value)
 
const Aws::Vector< Aws::String > & GetNatGatewayIds () const
 
bool NatGatewayIdsHasBeenSet () const
 
void SetNatGatewayIds (const Aws::Vector< Aws::String > &value)
 
void SetNatGatewayIds (Aws::Vector< Aws::String > &&value)
 
DescribeNatGatewaysRequestWithNatGatewayIds (const Aws::Vector< Aws::String > &value)
 
DescribeNatGatewaysRequestWithNatGatewayIds (Aws::Vector< Aws::String > &&value)
 
DescribeNatGatewaysRequestAddNatGatewayIds (const Aws::String &value)
 
DescribeNatGatewaysRequestAddNatGatewayIds (Aws::String &&value)
 
DescribeNatGatewaysRequestAddNatGatewayIds (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeNatGatewaysRequestWithNextToken (const Aws::String &value)
 
DescribeNatGatewaysRequestWithNextToken (Aws::String &&value)
 
DescribeNatGatewaysRequestWithNextToken (const char *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

Definition at line 33 of file DescribeNatGatewaysRequest.h.

Constructor & Destructor Documentation

◆ DescribeNatGatewaysRequest()

Aws::EC2::Model::DescribeNatGatewaysRequest::DescribeNatGatewaysRequest ( )

Member Function Documentation

◆ AddFilter() [1/2]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::AddFilter ( const Filter value)
inline

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

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

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Definition at line 182 of file DescribeNatGatewaysRequest.h.

◆ AddFilter() [2/2]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::AddFilter ( Filter &&  value)
inline

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

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

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Definition at line 201 of file DescribeNatGatewaysRequest.h.

◆ AddNatGatewayIds() [1/3]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::AddNatGatewayIds ( const Aws::String value)
inline

One or more NAT gateway IDs.

Definition at line 266 of file DescribeNatGatewaysRequest.h.

◆ AddNatGatewayIds() [2/3]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::AddNatGatewayIds ( Aws::String &&  value)
inline

One or more NAT gateway IDs.

Definition at line 271 of file DescribeNatGatewaysRequest.h.

◆ AddNatGatewayIds() [3/3]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::AddNatGatewayIds ( const char *  value)
inline

One or more NAT gateway IDs.

Definition at line 276 of file DescribeNatGatewaysRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeNatGatewaysRequest::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.

◆ FilterHasBeenSet()

bool Aws::EC2::Model::DescribeNatGatewaysRequest::FilterHasBeenSet ( ) const
inline

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

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

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Definition at line 87 of file DescribeNatGatewaysRequest.h.

◆ GetFilter()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribeNatGatewaysRequest::GetFilter ( ) const
inline

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

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

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Definition at line 68 of file DescribeNatGatewaysRequest.h.

◆ GetMaxResults()

int Aws::EC2::Model::DescribeNatGatewaysRequest::GetMaxResults ( ) const
inline

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Definition at line 209 of file DescribeNatGatewaysRequest.h.

◆ GetNatGatewayIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeNatGatewaysRequest::GetNatGatewayIds ( ) const
inline

One or more NAT gateway IDs.

Definition at line 236 of file DescribeNatGatewaysRequest.h.

◆ GetNextToken()

const Aws::String& Aws::EC2::Model::DescribeNatGatewaysRequest::GetNextToken ( ) const
inline

The token for the next page of results.

Definition at line 282 of file DescribeNatGatewaysRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file DescribeNatGatewaysRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::EC2::Model::DescribeNatGatewaysRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Definition at line 216 of file DescribeNatGatewaysRequest.h.

◆ NatGatewayIdsHasBeenSet()

bool Aws::EC2::Model::DescribeNatGatewaysRequest::NatGatewayIdsHasBeenSet ( ) const
inline

One or more NAT gateway IDs.

Definition at line 241 of file DescribeNatGatewaysRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::EC2::Model::DescribeNatGatewaysRequest::NextTokenHasBeenSet ( ) const
inline

The token for the next page of results.

Definition at line 287 of file DescribeNatGatewaysRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilter() [1/2]

void Aws::EC2::Model::DescribeNatGatewaysRequest::SetFilter ( const Aws::Vector< Filter > &  value)
inline

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

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

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Definition at line 106 of file DescribeNatGatewaysRequest.h.

◆ SetFilter() [2/2]

void Aws::EC2::Model::DescribeNatGatewaysRequest::SetFilter ( Aws::Vector< Filter > &&  value)
inline

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

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

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Definition at line 125 of file DescribeNatGatewaysRequest.h.

◆ SetMaxResults()

void Aws::EC2::Model::DescribeNatGatewaysRequest::SetMaxResults ( int  value)
inline

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Definition at line 223 of file DescribeNatGatewaysRequest.h.

◆ SetNatGatewayIds() [1/2]

void Aws::EC2::Model::DescribeNatGatewaysRequest::SetNatGatewayIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more NAT gateway IDs.

Definition at line 246 of file DescribeNatGatewaysRequest.h.

◆ SetNatGatewayIds() [2/2]

void Aws::EC2::Model::DescribeNatGatewaysRequest::SetNatGatewayIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more NAT gateway IDs.

Definition at line 251 of file DescribeNatGatewaysRequest.h.

◆ SetNextToken() [1/3]

void Aws::EC2::Model::DescribeNatGatewaysRequest::SetNextToken ( const Aws::String value)
inline

The token for the next page of results.

Definition at line 292 of file DescribeNatGatewaysRequest.h.

◆ SetNextToken() [2/3]

void Aws::EC2::Model::DescribeNatGatewaysRequest::SetNextToken ( Aws::String &&  value)
inline

The token for the next page of results.

Definition at line 297 of file DescribeNatGatewaysRequest.h.

◆ SetNextToken() [3/3]

void Aws::EC2::Model::DescribeNatGatewaysRequest::SetNextToken ( const char *  value)
inline

The token for the next page of results.

Definition at line 302 of file DescribeNatGatewaysRequest.h.

◆ WithFilter() [1/2]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::WithFilter ( const Aws::Vector< Filter > &  value)
inline

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

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

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Definition at line 144 of file DescribeNatGatewaysRequest.h.

◆ WithFilter() [2/2]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::WithFilter ( Aws::Vector< Filter > &&  value)
inline

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

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

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

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

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

Definition at line 163 of file DescribeNatGatewaysRequest.h.

◆ WithMaxResults()

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::WithMaxResults ( int  value)
inline

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Definition at line 230 of file DescribeNatGatewaysRequest.h.

◆ WithNatGatewayIds() [1/2]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::WithNatGatewayIds ( const Aws::Vector< Aws::String > &  value)
inline

One or more NAT gateway IDs.

Definition at line 256 of file DescribeNatGatewaysRequest.h.

◆ WithNatGatewayIds() [2/2]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::WithNatGatewayIds ( Aws::Vector< Aws::String > &&  value)
inline

One or more NAT gateway IDs.

Definition at line 261 of file DescribeNatGatewaysRequest.h.

◆ WithNextToken() [1/3]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::WithNextToken ( const Aws::String value)
inline

The token for the next page of results.

Definition at line 307 of file DescribeNatGatewaysRequest.h.

◆ WithNextToken() [2/3]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::WithNextToken ( Aws::String &&  value)
inline

The token for the next page of results.

Definition at line 312 of file DescribeNatGatewaysRequest.h.

◆ WithNextToken() [3/3]

DescribeNatGatewaysRequest& Aws::EC2::Model::DescribeNatGatewaysRequest::WithNextToken ( const char *  value)
inline

The token for the next page of results.

Definition at line 317 of file DescribeNatGatewaysRequest.h.


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