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

#include <DescribeTransitGatewaysRequest.h>

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

Public Member Functions

 DescribeTransitGatewaysRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Aws::String > & GetTransitGatewayIds () const
 
bool TransitGatewayIdsHasBeenSet () const
 
void SetTransitGatewayIds (const Aws::Vector< Aws::String > &value)
 
void SetTransitGatewayIds (Aws::Vector< Aws::String > &&value)
 
DescribeTransitGatewaysRequestWithTransitGatewayIds (const Aws::Vector< Aws::String > &value)
 
DescribeTransitGatewaysRequestWithTransitGatewayIds (Aws::Vector< Aws::String > &&value)
 
DescribeTransitGatewaysRequestAddTransitGatewayIds (const Aws::String &value)
 
DescribeTransitGatewaysRequestAddTransitGatewayIds (Aws::String &&value)
 
DescribeTransitGatewaysRequestAddTransitGatewayIds (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)
 
DescribeTransitGatewaysRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeTransitGatewaysRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeTransitGatewaysRequestAddFilters (const Filter &value)
 
DescribeTransitGatewaysRequestAddFilters (Filter &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeTransitGatewaysRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeTransitGatewaysRequestWithNextToken (const Aws::String &value)
 
DescribeTransitGatewaysRequestWithNextToken (Aws::String &&value)
 
DescribeTransitGatewaysRequestWithNextToken (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeTransitGatewaysRequestWithDryRun (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

Definition at line 23 of file DescribeTransitGatewaysRequest.h.

Constructor & Destructor Documentation

◆ DescribeTransitGatewaysRequest()

Aws::EC2::Model::DescribeTransitGatewaysRequest::DescribeTransitGatewaysRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn

    • The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

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

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

Definition at line 288 of file DescribeTransitGatewaysRequest.h.

◆ AddFilters() [2/2]

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

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn

    • The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

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

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

Definition at line 317 of file DescribeTransitGatewaysRequest.h.

◆ AddTransitGatewayIds() [1/3]

DescribeTransitGatewaysRequest& Aws::EC2::Model::DescribeTransitGatewaysRequest::AddTransitGatewayIds ( const Aws::String value)
inline

The IDs of the transit gateways.

Definition at line 74 of file DescribeTransitGatewaysRequest.h.

◆ AddTransitGatewayIds() [2/3]

DescribeTransitGatewaysRequest& Aws::EC2::Model::DescribeTransitGatewaysRequest::AddTransitGatewayIds ( Aws::String &&  value)
inline

The IDs of the transit gateways.

Definition at line 79 of file DescribeTransitGatewaysRequest.h.

◆ AddTransitGatewayIds() [3/3]

DescribeTransitGatewaysRequest& Aws::EC2::Model::DescribeTransitGatewaysRequest::AddTransitGatewayIds ( const char *  value)
inline

The IDs of the transit gateways.

Definition at line 84 of file DescribeTransitGatewaysRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn

    • The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

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

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

Definition at line 143 of file DescribeTransitGatewaysRequest.h.

◆ GetDryRun()

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

◆ GetFilters()

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

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn

    • The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

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

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

Definition at line 114 of file DescribeTransitGatewaysRequest.h.

◆ GetMaxResults()

int Aws::EC2::Model::DescribeTransitGatewaysRequest::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 325 of file DescribeTransitGatewaysRequest.h.

◆ GetNextToken()

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

The token for the next page of results.

Definition at line 352 of file DescribeTransitGatewaysRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeTransitGatewaysRequest.h.

◆ GetTransitGatewayIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeTransitGatewaysRequest::GetTransitGatewayIds ( ) const
inline

The IDs of the transit gateways.

Definition at line 44 of file DescribeTransitGatewaysRequest.h.

◆ MaxResultsHasBeenSet()

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

◆ NextTokenHasBeenSet()

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

The token for the next page of results.

Definition at line 357 of file DescribeTransitGatewaysRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

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

◆ SetFilters() [1/2]

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

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn

    • The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

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

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

Definition at line 172 of file DescribeTransitGatewaysRequest.h.

◆ SetFilters() [2/2]

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

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn

    • The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

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

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

Definition at line 201 of file DescribeTransitGatewaysRequest.h.

◆ SetMaxResults()

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

◆ SetNextToken() [1/3]

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

The token for the next page of results.

Definition at line 362 of file DescribeTransitGatewaysRequest.h.

◆ SetNextToken() [2/3]

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

The token for the next page of results.

Definition at line 367 of file DescribeTransitGatewaysRequest.h.

◆ SetNextToken() [3/3]

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

The token for the next page of results.

Definition at line 372 of file DescribeTransitGatewaysRequest.h.

◆ SetTransitGatewayIds() [1/2]

void Aws::EC2::Model::DescribeTransitGatewaysRequest::SetTransitGatewayIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the transit gateways.

Definition at line 54 of file DescribeTransitGatewaysRequest.h.

◆ SetTransitGatewayIds() [2/2]

void Aws::EC2::Model::DescribeTransitGatewaysRequest::SetTransitGatewayIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the transit gateways.

Definition at line 59 of file DescribeTransitGatewaysRequest.h.

◆ TransitGatewayIdsHasBeenSet()

bool Aws::EC2::Model::DescribeTransitGatewaysRequest::TransitGatewayIdsHasBeenSet ( ) const
inline

The IDs of the transit gateways.

Definition at line 49 of file DescribeTransitGatewaysRequest.h.

◆ WithDryRun()

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

◆ WithFilters() [1/2]

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

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn

    • The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

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

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

Definition at line 230 of file DescribeTransitGatewaysRequest.h.

◆ WithFilters() [2/2]

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

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn

    • The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

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

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

Definition at line 259 of file DescribeTransitGatewaysRequest.h.

◆ WithMaxResults()

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

◆ WithNextToken() [1/3]

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

The token for the next page of results.

Definition at line 377 of file DescribeTransitGatewaysRequest.h.

◆ WithNextToken() [2/3]

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

The token for the next page of results.

Definition at line 382 of file DescribeTransitGatewaysRequest.h.

◆ WithNextToken() [3/3]

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

The token for the next page of results.

Definition at line 387 of file DescribeTransitGatewaysRequest.h.

◆ WithTransitGatewayIds() [1/2]

DescribeTransitGatewaysRequest& Aws::EC2::Model::DescribeTransitGatewaysRequest::WithTransitGatewayIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the transit gateways.

Definition at line 64 of file DescribeTransitGatewaysRequest.h.

◆ WithTransitGatewayIds() [2/2]

DescribeTransitGatewaysRequest& Aws::EC2::Model::DescribeTransitGatewaysRequest::WithTransitGatewayIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the transit gateways.

Definition at line 69 of file DescribeTransitGatewaysRequest.h.


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