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

#include <DescribeDBClusterSnapshotsRequest.h>

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

Public Member Functions

 DescribeDBClusterSnapshotsRequest ()
 
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)
 
DescribeDBClusterSnapshotsRequestWithDBClusterIdentifier (const Aws::String &value)
 
DescribeDBClusterSnapshotsRequestWithDBClusterIdentifier (Aws::String &&value)
 
DescribeDBClusterSnapshotsRequestWithDBClusterIdentifier (const char *value)
 
const Aws::StringGetDBClusterSnapshotIdentifier () const
 
bool DBClusterSnapshotIdentifierHasBeenSet () const
 
void SetDBClusterSnapshotIdentifier (const Aws::String &value)
 
void SetDBClusterSnapshotIdentifier (Aws::String &&value)
 
void SetDBClusterSnapshotIdentifier (const char *value)
 
DescribeDBClusterSnapshotsRequestWithDBClusterSnapshotIdentifier (const Aws::String &value)
 
DescribeDBClusterSnapshotsRequestWithDBClusterSnapshotIdentifier (Aws::String &&value)
 
DescribeDBClusterSnapshotsRequestWithDBClusterSnapshotIdentifier (const char *value)
 
const Aws::StringGetSnapshotType () const
 
bool SnapshotTypeHasBeenSet () const
 
void SetSnapshotType (const Aws::String &value)
 
void SetSnapshotType (Aws::String &&value)
 
void SetSnapshotType (const char *value)
 
DescribeDBClusterSnapshotsRequestWithSnapshotType (const Aws::String &value)
 
DescribeDBClusterSnapshotsRequestWithSnapshotType (Aws::String &&value)
 
DescribeDBClusterSnapshotsRequestWithSnapshotType (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)
 
DescribeDBClusterSnapshotsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeDBClusterSnapshotsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeDBClusterSnapshotsRequestAddFilters (const Filter &value)
 
DescribeDBClusterSnapshotsRequestAddFilters (Filter &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeDBClusterSnapshotsRequestWithMaxRecords (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)
 
DescribeDBClusterSnapshotsRequestWithMarker (const Aws::String &value)
 
DescribeDBClusterSnapshotsRequestWithMarker (Aws::String &&value)
 
DescribeDBClusterSnapshotsRequestWithMarker (const char *value)
 
bool GetIncludeShared () const
 
bool IncludeSharedHasBeenSet () const
 
void SetIncludeShared (bool value)
 
DescribeDBClusterSnapshotsRequestWithIncludeShared (bool value)
 
bool GetIncludePublic () const
 
bool IncludePublicHasBeenSet () const
 
void SetIncludePublic (bool value)
 
DescribeDBClusterSnapshotsRequestWithIncludePublic (bool 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 DescribeDBClusterSnapshots.

See Also:

AWS API Reference

Definition at line 27 of file DescribeDBClusterSnapshotsRequest.h.

Constructor & Destructor Documentation

◆ DescribeDBClusterSnapshotsRequest()

Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::DescribeDBClusterSnapshotsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

This parameter is not currently supported.

Definition at line 417 of file DescribeDBClusterSnapshotsRequest.h.

◆ AddFilters() [2/2]

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

This parameter is not currently supported.

Definition at line 422 of file DescribeDBClusterSnapshotsRequest.h.

◆ DBClusterIdentifierHasBeenSet()

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

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

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

Definition at line 61 of file DescribeDBClusterSnapshotsRequest.h.

◆ DBClusterSnapshotIdentifierHasBeenSet()

bool Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::DBClusterSnapshotIdentifierHasBeenSet ( ) const
inline

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Definition at line 136 of file DescribeDBClusterSnapshotsRequest.h.

◆ DumpBodyToUrl()

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

This parameter is not currently supported.

Definition at line 392 of file DescribeDBClusterSnapshotsRequest.h.

◆ GetDBClusterIdentifier()

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

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

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

Definition at line 52 of file DescribeDBClusterSnapshotsRequest.h.

◆ GetDBClusterSnapshotIdentifier()

const Aws::String& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::GetDBClusterSnapshotIdentifier ( ) const
inline

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Definition at line 126 of file DescribeDBClusterSnapshotsRequest.h.

◆ GetFilters()

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

This parameter is not currently supported.

Definition at line 387 of file DescribeDBClusterSnapshotsRequest.h.

◆ GetIncludePublic()

bool Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::GetIncludePublic ( ) const
inline

Set to true to include manual cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

Definition at line 553 of file DescribeDBClusterSnapshotsRequest.h.

◆ GetIncludeShared()

bool Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::GetIncludeShared ( ) const
inline

Set to true to include shared manual cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

Definition at line 521 of file DescribeDBClusterSnapshotsRequest.h.

◆ GetMarker()

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

◆ GetMaxRecords()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DescribeDBClusterSnapshotsRequest.h.

◆ GetSnapshotType()

const Aws::String& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::GetSnapshotType ( ) const
inline

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual cluster snapshots that have been shared to your AWS account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Definition at line 220 of file DescribeDBClusterSnapshotsRequest.h.

◆ IncludePublicHasBeenSet()

bool Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::IncludePublicHasBeenSet ( ) const
inline

Set to true to include manual cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

Definition at line 560 of file DescribeDBClusterSnapshotsRequest.h.

◆ IncludeSharedHasBeenSet()

bool Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::IncludeSharedHasBeenSet ( ) const
inline

Set to true to include shared manual cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

Definition at line 529 of file DescribeDBClusterSnapshotsRequest.h.

◆ MarkerHasBeenSet()

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

◆ MaxRecordsHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBClusterIdentifier() [1/3]

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

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

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

Definition at line 70 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetDBClusterIdentifier() [2/3]

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

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

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

Definition at line 79 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetDBClusterIdentifier() [3/3]

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

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

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

Definition at line 88 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetDBClusterSnapshotIdentifier() [1/3]

void Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SetDBClusterSnapshotIdentifier ( const Aws::String value)
inline

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Definition at line 146 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetDBClusterSnapshotIdentifier() [2/3]

void Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SetDBClusterSnapshotIdentifier ( Aws::String &&  value)
inline

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Definition at line 156 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetDBClusterSnapshotIdentifier() [3/3]

void Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SetDBClusterSnapshotIdentifier ( const char *  value)
inline

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Definition at line 166 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetFilters() [1/2]

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

This parameter is not currently supported.

Definition at line 397 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetFilters() [2/2]

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

This parameter is not currently supported.

Definition at line 402 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetIncludePublic()

void Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SetIncludePublic ( bool  value)
inline

Set to true to include manual cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

Definition at line 567 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetIncludeShared()

void Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SetIncludeShared ( bool  value)
inline

Set to true to include shared manual cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

Definition at line 537 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetMarker() [1/3]

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

◆ SetMarker() [2/3]

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

◆ SetMarker() [3/3]

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

◆ SetMaxRecords()

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

◆ SetSnapshotType() [1/3]

void Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SetSnapshotType ( const Aws::String value)
inline

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual cluster snapshots that have been shared to your AWS account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Definition at line 266 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetSnapshotType() [2/3]

void Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SetSnapshotType ( Aws::String &&  value)
inline

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual cluster snapshots that have been shared to your AWS account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Definition at line 289 of file DescribeDBClusterSnapshotsRequest.h.

◆ SetSnapshotType() [3/3]

void Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SetSnapshotType ( const char *  value)
inline

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual cluster snapshots that have been shared to your AWS account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Definition at line 312 of file DescribeDBClusterSnapshotsRequest.h.

◆ SnapshotTypeHasBeenSet()

bool Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::SnapshotTypeHasBeenSet ( ) const
inline

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual cluster snapshots that have been shared to your AWS account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Definition at line 243 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithDBClusterIdentifier() [1/3]

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

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

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

Definition at line 97 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithDBClusterIdentifier() [2/3]

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

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

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

Definition at line 106 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithDBClusterIdentifier() [3/3]

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

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

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

Definition at line 115 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithDBClusterSnapshotIdentifier() [1/3]

DescribeDBClusterSnapshotsRequest& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::WithDBClusterSnapshotIdentifier ( const Aws::String value)
inline

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Definition at line 176 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithDBClusterSnapshotIdentifier() [2/3]

DescribeDBClusterSnapshotsRequest& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::WithDBClusterSnapshotIdentifier ( Aws::String &&  value)
inline

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Definition at line 186 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithDBClusterSnapshotIdentifier() [3/3]

DescribeDBClusterSnapshotsRequest& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::WithDBClusterSnapshotIdentifier ( const char *  value)
inline

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

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

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

Definition at line 196 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithFilters() [1/2]

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

This parameter is not currently supported.

Definition at line 407 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithFilters() [2/2]

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

This parameter is not currently supported.

Definition at line 412 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithIncludePublic()

DescribeDBClusterSnapshotsRequest& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::WithIncludePublic ( bool  value)
inline

Set to true to include manual cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

Definition at line 574 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithIncludeShared()

DescribeDBClusterSnapshotsRequest& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::WithIncludeShared ( bool  value)
inline

Set to true to include shared manual cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

Definition at line 545 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithMarker() [1/3]

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

◆ WithMarker() [2/3]

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

◆ WithMarker() [3/3]

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

◆ WithMaxRecords()

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

◆ WithSnapshotType() [1/3]

DescribeDBClusterSnapshotsRequest& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::WithSnapshotType ( const Aws::String value)
inline

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual cluster snapshots that have been shared to your AWS account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Definition at line 335 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithSnapshotType() [2/3]

DescribeDBClusterSnapshotsRequest& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::WithSnapshotType ( Aws::String &&  value)
inline

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual cluster snapshots that have been shared to your AWS account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Definition at line 358 of file DescribeDBClusterSnapshotsRequest.h.

◆ WithSnapshotType() [3/3]

DescribeDBClusterSnapshotsRequest& Aws::DocDB::Model::DescribeDBClusterSnapshotsRequest::WithSnapshotType ( const char *  value)
inline

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual cluster snapshots that have been shared to your AWS account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Definition at line 381 of file DescribeDBClusterSnapshotsRequest.h.


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