AWS SDK for C++  1.8.79
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::DocDB::Model::DescribeDBClustersRequest Class Reference

#include <DescribeDBClustersRequest.h>

+ Inheritance diagram for Aws::DocDB::Model::DescribeDBClustersRequest:

Public Member Functions

 DescribeDBClustersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
DescribeDBClustersRequestWithDBClusterIdentifier (const Aws::String &value)
 
DescribeDBClustersRequestWithDBClusterIdentifier (Aws::String &&value)
 
DescribeDBClustersRequestWithDBClusterIdentifier (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)
 
DescribeDBClustersRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeDBClustersRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeDBClustersRequestAddFilters (const Filter &value)
 
DescribeDBClustersRequestAddFilters (Filter &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeDBClustersRequestWithMaxRecords (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeDBClustersRequestWithMarker (const Aws::String &value)
 
DescribeDBClustersRequestWithMarker (Aws::String &&value)
 
DescribeDBClustersRequestWithMarker (const char *value)
 
- Public Member Functions inherited from Aws::DocDB::DocDBRequest
virtual ~DocDBRequest ()
 
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::DocDB::DocDBRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Represents the input to DescribeDBClusters.

See Also:

AWS API Reference

Definition at line 27 of file DescribeDBClustersRequest.h.

Constructor & Destructor Documentation

◆ DescribeDBClustersRequest()

Aws::DocDB::Model::DescribeDBClustersRequest::DescribeDBClustersRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::AddFilters ( const Filter value)
inline

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Definition at line 171 of file DescribeDBClustersRequest.h.

◆ AddFilters() [2/2]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::AddFilters ( Filter &&  value)
inline

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Definition at line 180 of file DescribeDBClustersRequest.h.

◆ DBClusterIdentifierHasBeenSet()

bool Aws::DocDB::Model::DescribeDBClustersRequest::DBClusterIdentifierHasBeenSet ( ) const
inline

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Definition at line 59 of file DescribeDBClustersRequest.h.

◆ DumpBodyToUrl()

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

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Definition at line 126 of file DescribeDBClustersRequest.h.

◆ GetDBClusterIdentifier()

const Aws::String& Aws::DocDB::Model::DescribeDBClustersRequest::GetDBClusterIdentifier ( ) const
inline

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Definition at line 51 of file DescribeDBClustersRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::DocDB::Model::DescribeDBClustersRequest::GetFilters ( ) const
inline

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Definition at line 117 of file DescribeDBClustersRequest.h.

◆ GetMarker()

const Aws::String& Aws::DocDB::Model::DescribeDBClustersRequest::GetMarker ( ) const
inline

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 221 of file DescribeDBClustersRequest.h.

◆ GetMaxRecords()

int Aws::DocDB::Model::DescribeDBClustersRequest::GetMaxRecords ( ) const
inline

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 189 of file DescribeDBClustersRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DocDB::Model::DescribeDBClustersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DescribeDBClustersRequest.h.

◆ MarkerHasBeenSet()

bool Aws::DocDB::Model::DescribeDBClustersRequest::MarkerHasBeenSet ( ) const
inline

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 228 of file DescribeDBClustersRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::DocDB::Model::DescribeDBClustersRequest::MaxRecordsHasBeenSet ( ) const
inline

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 197 of file DescribeDBClustersRequest.h.

◆ SerializePayload()

Aws::String Aws::DocDB::Model::DescribeDBClustersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBClusterIdentifier() [1/3]

void Aws::DocDB::Model::DescribeDBClustersRequest::SetDBClusterIdentifier ( const Aws::String value)
inline

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Definition at line 67 of file DescribeDBClustersRequest.h.

◆ SetDBClusterIdentifier() [2/3]

void Aws::DocDB::Model::DescribeDBClustersRequest::SetDBClusterIdentifier ( Aws::String &&  value)
inline

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Definition at line 75 of file DescribeDBClustersRequest.h.

◆ SetDBClusterIdentifier() [3/3]

void Aws::DocDB::Model::DescribeDBClustersRequest::SetDBClusterIdentifier ( const char *  value)
inline

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Definition at line 83 of file DescribeDBClustersRequest.h.

◆ SetFilters() [1/2]

void Aws::DocDB::Model::DescribeDBClustersRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Definition at line 135 of file DescribeDBClustersRequest.h.

◆ SetFilters() [2/2]

void Aws::DocDB::Model::DescribeDBClustersRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Definition at line 144 of file DescribeDBClustersRequest.h.

◆ SetMarker() [1/3]

void Aws::DocDB::Model::DescribeDBClustersRequest::SetMarker ( const Aws::String value)
inline

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 235 of file DescribeDBClustersRequest.h.

◆ SetMarker() [2/3]

void Aws::DocDB::Model::DescribeDBClustersRequest::SetMarker ( Aws::String &&  value)
inline

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 242 of file DescribeDBClustersRequest.h.

◆ SetMarker() [3/3]

void Aws::DocDB::Model::DescribeDBClustersRequest::SetMarker ( const char *  value)
inline

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 249 of file DescribeDBClustersRequest.h.

◆ SetMaxRecords()

void Aws::DocDB::Model::DescribeDBClustersRequest::SetMaxRecords ( int  value)
inline

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 205 of file DescribeDBClustersRequest.h.

◆ WithDBClusterIdentifier() [1/3]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithDBClusterIdentifier ( const Aws::String value)
inline

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Definition at line 91 of file DescribeDBClustersRequest.h.

◆ WithDBClusterIdentifier() [2/3]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithDBClusterIdentifier ( Aws::String &&  value)
inline

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Definition at line 99 of file DescribeDBClustersRequest.h.

◆ WithDBClusterIdentifier() [3/3]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithDBClusterIdentifier ( const char *  value)
inline

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

Definition at line 107 of file DescribeDBClustersRequest.h.

◆ WithFilters() [1/2]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Definition at line 153 of file DescribeDBClustersRequest.h.

◆ WithFilters() [2/2]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Definition at line 162 of file DescribeDBClustersRequest.h.

◆ WithMarker() [1/3]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithMarker ( const Aws::String value)
inline

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 256 of file DescribeDBClustersRequest.h.

◆ WithMarker() [2/3]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithMarker ( Aws::String &&  value)
inline

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 263 of file DescribeDBClustersRequest.h.

◆ WithMarker() [3/3]

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithMarker ( const char *  value)
inline

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Definition at line 270 of file DescribeDBClustersRequest.h.

◆ WithMaxRecords()

DescribeDBClustersRequest& Aws::DocDB::Model::DescribeDBClustersRequest::WithMaxRecords ( int  value)
inline

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 213 of file DescribeDBClustersRequest.h.


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