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

#include <DescribeDBInstancesRequest.h>

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

Public Member Functions

 DescribeDBInstancesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDBInstanceIdentifier () const
 
bool DBInstanceIdentifierHasBeenSet () const
 
void SetDBInstanceIdentifier (const Aws::String &value)
 
void SetDBInstanceIdentifier (Aws::String &&value)
 
void SetDBInstanceIdentifier (const char *value)
 
DescribeDBInstancesRequestWithDBInstanceIdentifier (const Aws::String &value)
 
DescribeDBInstancesRequestWithDBInstanceIdentifier (Aws::String &&value)
 
DescribeDBInstancesRequestWithDBInstanceIdentifier (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)
 
DescribeDBInstancesRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeDBInstancesRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeDBInstancesRequestAddFilters (const Filter &value)
 
DescribeDBInstancesRequestAddFilters (Filter &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeDBInstancesRequestWithMaxRecords (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)
 
DescribeDBInstancesRequestWithMarker (const Aws::String &value)
 
DescribeDBInstancesRequestWithMarker (Aws::String &&value)
 
DescribeDBInstancesRequestWithMarker (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 DescribeDBInstances.

See Also:

AWS API Reference

Definition at line 27 of file DescribeDBInstancesRequest.h.

Constructor & Destructor Documentation

◆ DescribeDBInstancesRequest()

Aws::DocDB::Model::DescribeDBInstancesRequest::DescribeDBInstancesRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

A filter that specifies one or more instances to describe.

Supported filters:

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

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Definition at line 192 of file DescribeDBInstancesRequest.h.

◆ AddFilters() [2/2]

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

A filter that specifies one or more instances to describe.

Supported filters:

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

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Definition at line 204 of file DescribeDBInstancesRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

bool Aws::DocDB::Model::DescribeDBInstancesRequest::DBInstanceIdentifierHasBeenSet ( ) const
inline

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

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

Definition at line 59 of file DescribeDBInstancesRequest.h.

◆ DumpBodyToUrl()

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

A filter that specifies one or more instances to describe.

Supported filters:

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

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Definition at line 132 of file DescribeDBInstancesRequest.h.

◆ GetDBInstanceIdentifier()

const Aws::String& Aws::DocDB::Model::DescribeDBInstancesRequest::GetDBInstanceIdentifier ( ) const
inline

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

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

Definition at line 51 of file DescribeDBInstancesRequest.h.

◆ GetFilters()

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

A filter that specifies one or more instances to describe.

Supported filters:

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

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Definition at line 120 of file DescribeDBInstancesRequest.h.

◆ GetMarker()

const Aws::String& Aws::DocDB::Model::DescribeDBInstancesRequest::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 245 of file DescribeDBInstancesRequest.h.

◆ GetMaxRecords()

int Aws::DocDB::Model::DescribeDBInstancesRequest::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 213 of file DescribeDBInstancesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DescribeDBInstancesRequest.h.

◆ MarkerHasBeenSet()

bool Aws::DocDB::Model::DescribeDBInstancesRequest::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 252 of file DescribeDBInstancesRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::DocDB::Model::DescribeDBInstancesRequest::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 221 of file DescribeDBInstancesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBInstanceIdentifier() [1/3]

void Aws::DocDB::Model::DescribeDBInstancesRequest::SetDBInstanceIdentifier ( const Aws::String value)
inline

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

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

Definition at line 67 of file DescribeDBInstancesRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

void Aws::DocDB::Model::DescribeDBInstancesRequest::SetDBInstanceIdentifier ( Aws::String &&  value)
inline

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

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

Definition at line 75 of file DescribeDBInstancesRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

void Aws::DocDB::Model::DescribeDBInstancesRequest::SetDBInstanceIdentifier ( const char *  value)
inline

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

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

Definition at line 83 of file DescribeDBInstancesRequest.h.

◆ SetFilters() [1/2]

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

A filter that specifies one or more instances to describe.

Supported filters:

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

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Definition at line 144 of file DescribeDBInstancesRequest.h.

◆ SetFilters() [2/2]

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

A filter that specifies one or more instances to describe.

Supported filters:

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

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Definition at line 156 of file DescribeDBInstancesRequest.h.

◆ SetMarker() [1/3]

void Aws::DocDB::Model::DescribeDBInstancesRequest::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 259 of file DescribeDBInstancesRequest.h.

◆ SetMarker() [2/3]

void Aws::DocDB::Model::DescribeDBInstancesRequest::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 266 of file DescribeDBInstancesRequest.h.

◆ SetMarker() [3/3]

void Aws::DocDB::Model::DescribeDBInstancesRequest::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 273 of file DescribeDBInstancesRequest.h.

◆ SetMaxRecords()

void Aws::DocDB::Model::DescribeDBInstancesRequest::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 229 of file DescribeDBInstancesRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

DescribeDBInstancesRequest& Aws::DocDB::Model::DescribeDBInstancesRequest::WithDBInstanceIdentifier ( const Aws::String value)
inline

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

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

Definition at line 91 of file DescribeDBInstancesRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

DescribeDBInstancesRequest& Aws::DocDB::Model::DescribeDBInstancesRequest::WithDBInstanceIdentifier ( Aws::String &&  value)
inline

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

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

Definition at line 99 of file DescribeDBInstancesRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

DescribeDBInstancesRequest& Aws::DocDB::Model::DescribeDBInstancesRequest::WithDBInstanceIdentifier ( const char *  value)
inline

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

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

Definition at line 107 of file DescribeDBInstancesRequest.h.

◆ WithFilters() [1/2]

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

A filter that specifies one or more instances to describe.

Supported filters:

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

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Definition at line 168 of file DescribeDBInstancesRequest.h.

◆ WithFilters() [2/2]

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

A filter that specifies one or more instances to describe.

Supported filters:

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

  • db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.

Definition at line 180 of file DescribeDBInstancesRequest.h.

◆ WithMarker() [1/3]

DescribeDBInstancesRequest& Aws::DocDB::Model::DescribeDBInstancesRequest::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 280 of file DescribeDBInstancesRequest.h.

◆ WithMarker() [2/3]

DescribeDBInstancesRequest& Aws::DocDB::Model::DescribeDBInstancesRequest::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 287 of file DescribeDBInstancesRequest.h.

◆ WithMarker() [3/3]

DescribeDBInstancesRequest& Aws::DocDB::Model::DescribeDBInstancesRequest::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 294 of file DescribeDBInstancesRequest.h.

◆ WithMaxRecords()

DescribeDBInstancesRequest& Aws::DocDB::Model::DescribeDBInstancesRequest::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 237 of file DescribeDBInstancesRequest.h.


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