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

#include <DescribeDBClustersRequest.h>

+ Inheritance diagram for Aws::RDS::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)
 
bool GetIncludeShared () const
 
bool IncludeSharedHasBeenSet () const
 
void SetIncludeShared (bool value)
 
DescribeDBClustersRequestWithIncludeShared (bool value)
 
- Public Member Functions inherited from Aws::RDS::RDSRequest
virtual ~RDSRequest ()
 
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::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 26 of file DescribeDBClustersRequest.h.

Constructor & Destructor Documentation

◆ DescribeDBClustersRequest()

Aws::RDS::Model::DescribeDBClustersRequest::DescribeDBClustersRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Definition at line 170 of file DescribeDBClustersRequest.h.

◆ AddFilters() [2/2]

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

A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Definition at line 179 of file DescribeDBClustersRequest.h.

◆ DBClusterIdentifierHasBeenSet()

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

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Definition at line 58 of file DescribeDBClustersRequest.h.

◆ DumpBodyToUrl()

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

A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Definition at line 125 of file DescribeDBClustersRequest.h.

◆ GetDBClusterIdentifier()

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

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Definition at line 50 of file DescribeDBClustersRequest.h.

◆ GetFilters()

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

A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Definition at line 116 of file DescribeDBClustersRequest.h.

◆ GetIncludeShared()

bool Aws::RDS::Model::DescribeDBClustersRequest::GetIncludeShared ( ) const
inline

Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.

Definition at line 284 of file DescribeDBClustersRequest.h.

◆ GetMarker()

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

An optional pagination token provided by a previous DescribeDBClusters 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::RDS::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 called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 188 of file DescribeDBClustersRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeDBClustersRequest.h.

◆ IncludeSharedHasBeenSet()

bool Aws::RDS::Model::DescribeDBClustersRequest::IncludeSharedHasBeenSet ( ) const
inline

Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.

Definition at line 290 of file DescribeDBClustersRequest.h.

◆ MarkerHasBeenSet()

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

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

Definition at line 229 of file DescribeDBClustersRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::RDS::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 called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 196 of file DescribeDBClustersRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBClusterIdentifier() [1/3]

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

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Definition at line 66 of file DescribeDBClustersRequest.h.

◆ SetDBClusterIdentifier() [2/3]

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

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Definition at line 74 of file DescribeDBClustersRequest.h.

◆ SetDBClusterIdentifier() [3/3]

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

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Definition at line 82 of file DescribeDBClustersRequest.h.

◆ SetFilters() [1/2]

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

A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Definition at line 134 of file DescribeDBClustersRequest.h.

◆ SetFilters() [2/2]

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

A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Definition at line 143 of file DescribeDBClustersRequest.h.

◆ SetIncludeShared()

void Aws::RDS::Model::DescribeDBClustersRequest::SetIncludeShared ( bool  value)
inline

Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.

Definition at line 296 of file DescribeDBClustersRequest.h.

◆ SetMarker() [1/3]

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

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

Definition at line 237 of file DescribeDBClustersRequest.h.

◆ SetMarker() [2/3]

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

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

Definition at line 245 of file DescribeDBClustersRequest.h.

◆ SetMarker() [3/3]

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

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

Definition at line 253 of file DescribeDBClustersRequest.h.

◆ SetMaxRecords()

void Aws::RDS::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 called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 204 of file DescribeDBClustersRequest.h.

◆ WithDBClusterIdentifier() [1/3]

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

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Definition at line 90 of file DescribeDBClustersRequest.h.

◆ WithDBClusterIdentifier() [2/3]

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

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Definition at line 98 of file DescribeDBClustersRequest.h.

◆ WithDBClusterIdentifier() [3/3]

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

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

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Definition at line 106 of file DescribeDBClustersRequest.h.

◆ WithFilters() [1/2]

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

A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Definition at line 152 of file DescribeDBClustersRequest.h.

◆ WithFilters() [2/2]

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

A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Definition at line 161 of file DescribeDBClustersRequest.h.

◆ WithIncludeShared()

DescribeDBClustersRequest& Aws::RDS::Model::DescribeDBClustersRequest::WithIncludeShared ( bool  value)
inline

Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.

Definition at line 302 of file DescribeDBClustersRequest.h.

◆ WithMarker() [1/3]

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

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

Definition at line 261 of file DescribeDBClustersRequest.h.

◆ WithMarker() [2/3]

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

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

Definition at line 269 of file DescribeDBClustersRequest.h.

◆ WithMarker() [3/3]

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

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

Definition at line 277 of file DescribeDBClustersRequest.h.

◆ WithMaxRecords()

DescribeDBClustersRequest& Aws::RDS::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 called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 212 of file DescribeDBClustersRequest.h.


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