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

#include <DescribeDBInstancesRequest.h>

+ Inheritance diagram for Aws::RDS::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::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 DescribeDBInstancesRequest.h.

Constructor & Destructor Documentation

◆ DescribeDBInstancesRequest()

Aws::RDS::Model::DescribeDBInstancesRequest::DescribeDBInstancesRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs.

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

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

Definition at line 240 of file DescribeDBInstancesRequest.h.

◆ AddFilters() [2/2]

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

A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs.

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

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

Definition at line 259 of file DescribeDBInstancesRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

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

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

Constraints:

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

Definition at line 58 of file DescribeDBInstancesRequest.h.

◆ DumpBodyToUrl()

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

A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs.

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

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

Definition at line 145 of file DescribeDBInstancesRequest.h.

◆ GetDBInstanceIdentifier()

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

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

Constraints:

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

Definition at line 50 of file DescribeDBInstancesRequest.h.

◆ GetFilters()

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

A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs.

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

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

Definition at line 126 of file DescribeDBInstancesRequest.h.

◆ GetMarker()

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

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

Definition at line 305 of file DescribeDBInstancesRequest.h.

◆ GetMaxRecords()

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

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 269 of file DescribeDBInstancesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeDBInstancesRequest.h.

◆ MarkerHasBeenSet()

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

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

Definition at line 313 of file DescribeDBInstancesRequest.h.

◆ MaxRecordsHasBeenSet()

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

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 278 of file DescribeDBInstancesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBInstanceIdentifier() [1/3]

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

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

Constraints:

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

Definition at line 74 of file DescribeDBInstancesRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

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

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

Constraints:

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

Definition at line 66 of file DescribeDBInstancesRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

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

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

Constraints:

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

Definition at line 82 of file DescribeDBInstancesRequest.h.

◆ SetFilters() [1/2]

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

A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs.

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

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

Definition at line 183 of file DescribeDBInstancesRequest.h.

◆ SetFilters() [2/2]

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

A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs.

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

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

Definition at line 164 of file DescribeDBInstancesRequest.h.

◆ SetMarker() [1/3]

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

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

Definition at line 329 of file DescribeDBInstancesRequest.h.

◆ SetMarker() [2/3]

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

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

Definition at line 321 of file DescribeDBInstancesRequest.h.

◆ SetMarker() [3/3]

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

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

Definition at line 337 of file DescribeDBInstancesRequest.h.

◆ SetMaxRecords()

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

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 287 of file DescribeDBInstancesRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

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

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

Constraints:

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

Definition at line 98 of file DescribeDBInstancesRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

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

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

Constraints:

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

Definition at line 90 of file DescribeDBInstancesRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

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

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

Constraints:

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

Definition at line 106 of file DescribeDBInstancesRequest.h.

◆ WithFilters() [1/2]

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

A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs.

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

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

Definition at line 221 of file DescribeDBInstancesRequest.h.

◆ WithFilters() [2/2]

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

A filter that specifies one or more DB instances 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 instances associated with the DB clusters identified by these ARNs.

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

  • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

  • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

Definition at line 202 of file DescribeDBInstancesRequest.h.

◆ WithMarker() [1/3]

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

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

Definition at line 353 of file DescribeDBInstancesRequest.h.

◆ WithMarker() [2/3]

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

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

Definition at line 345 of file DescribeDBInstancesRequest.h.

◆ WithMarker() [3/3]

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

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

Definition at line 361 of file DescribeDBInstancesRequest.h.

◆ WithMaxRecords()

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

Default: 100

Constraints: Minimum 20, maximum 100.

Definition at line 296 of file DescribeDBInstancesRequest.h.


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