Aws::RDS::Model::DescribeDBClusterSnapshotsRequest Class Reference

#include <DescribeDBClusterSnapshotsRequest.h>

Inheritance diagram for Aws::RDS::Model::DescribeDBClusterSnapshotsRequest:

Public Member Functions
	DescribeDBClusterSnapshotsRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
const Aws::String &	GetDBClusterIdentifier () const
bool	DBClusterIdentifierHasBeenSet () const
void	SetDBClusterIdentifier (const Aws::String &value)
void	SetDBClusterIdentifier (Aws::String &&value)
void	SetDBClusterIdentifier (const char *value)
DescribeDBClusterSnapshotsRequest &	WithDBClusterIdentifier (const Aws::String &value)
DescribeDBClusterSnapshotsRequest &	WithDBClusterIdentifier (Aws::String &&value)
DescribeDBClusterSnapshotsRequest &	WithDBClusterIdentifier (const char *value)
const Aws::String &	GetDBClusterSnapshotIdentifier () const
bool	DBClusterSnapshotIdentifierHasBeenSet () const
void	SetDBClusterSnapshotIdentifier (const Aws::String &value)
void	SetDBClusterSnapshotIdentifier (Aws::String &&value)
void	SetDBClusterSnapshotIdentifier (const char *value)
DescribeDBClusterSnapshotsRequest &	WithDBClusterSnapshotIdentifier (const Aws::String &value)
DescribeDBClusterSnapshotsRequest &	WithDBClusterSnapshotIdentifier (Aws::String &&value)
DescribeDBClusterSnapshotsRequest &	WithDBClusterSnapshotIdentifier (const char *value)
const Aws::String &	GetSnapshotType () const
bool	SnapshotTypeHasBeenSet () const
void	SetSnapshotType (const Aws::String &value)
void	SetSnapshotType (Aws::String &&value)
void	SetSnapshotType (const char *value)
DescribeDBClusterSnapshotsRequest &	WithSnapshotType (const Aws::String &value)
DescribeDBClusterSnapshotsRequest &	WithSnapshotType (Aws::String &&value)
DescribeDBClusterSnapshotsRequest &	WithSnapshotType (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)
DescribeDBClusterSnapshotsRequest &	WithFilters (const Aws::Vector< Filter > &value)
DescribeDBClusterSnapshotsRequest &	WithFilters (Aws::Vector< Filter > &&value)
DescribeDBClusterSnapshotsRequest &	AddFilters (const Filter &value)
DescribeDBClusterSnapshotsRequest &	AddFilters (Filter &&value)
int	GetMaxRecords () const
bool	MaxRecordsHasBeenSet () const
void	SetMaxRecords (int value)
DescribeDBClusterSnapshotsRequest &	WithMaxRecords (int value)
const Aws::String &	GetMarker () const
bool	MarkerHasBeenSet () const
void	SetMarker (const Aws::String &value)
void	SetMarker (Aws::String &&value)
void	SetMarker (const char *value)
DescribeDBClusterSnapshotsRequest &	WithMarker (const Aws::String &value)
DescribeDBClusterSnapshotsRequest &	WithMarker (Aws::String &&value)
DescribeDBClusterSnapshotsRequest &	WithMarker (const char *value)
bool	GetIncludeShared () const
bool	IncludeSharedHasBeenSet () const
void	SetIncludeShared (bool value)
DescribeDBClusterSnapshotsRequest &	WithIncludeShared (bool value)
bool	GetIncludePublic () const
bool	IncludePublicHasBeenSet () const
void	SetIncludePublic (bool value)
DescribeDBClusterSnapshotsRequest &	WithIncludePublic (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 DescribeDBClusterSnapshotsRequest.h.

Constructor & Destructor Documentation

DescribeDBClusterSnapshotsRequest()

Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::DescribeDBClusterSnapshotsRequest

(

)

Member Function Documentation

AddFilters() [1/2]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::AddFilters ( const Filter &  value )

inline

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

Definition at line 458 of file DescribeDBClusterSnapshotsRequest.h.

AddFilters() [2/2]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::AddFilters ( Filter &&  value )

inline

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

Definition at line 469 of file DescribeDBClusterSnapshotsRequest.h.

DBClusterIdentifierHasBeenSet()

bool Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::DBClusterIdentifierHasBeenSet ( ) const

inline

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

Definition at line 60 of file DescribeDBClusterSnapshotsRequest.h.

DBClusterSnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::DBClusterSnapshotIdentifierHasBeenSet ( ) const

inline

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

Constraints:

• If supplied, 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 135 of file DescribeDBClusterSnapshotsRequest.h.

DumpBodyToUrl()

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

inline

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

Definition at line 403 of file DescribeDBClusterSnapshotsRequest.h.

GetDBClusterIdentifier()

const Aws::String& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::GetDBClusterIdentifier ( ) const

inline

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

Definition at line 51 of file DescribeDBClusterSnapshotsRequest.h.

GetDBClusterSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::GetDBClusterSnapshotIdentifier ( ) const

inline

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

Constraints:

• If supplied, 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 125 of file DescribeDBClusterSnapshotsRequest.h.

GetFilters()

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

inline

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

Definition at line 392 of file DescribeDBClusterSnapshotsRequest.h.

GetIncludePublic()

bool Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::GetIncludePublic ( ) const

inline

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Definition at line 618 of file DescribeDBClusterSnapshotsRequest.h.

GetIncludeShared()

bool Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::GetIncludeShared ( ) const

inline

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

Definition at line 578 of file DescribeDBClusterSnapshotsRequest.h.

GetMarker()

const Aws::String& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::GetMarker ( ) const

inline

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

Definition at line 511 of file DescribeDBClusterSnapshotsRequest.h.

GetMaxRecords()

int Aws::RDS::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 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 478 of file DescribeDBClusterSnapshotsRequest.h.

GetServiceRequestName()

virtual const char* Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeDBClusterSnapshotsRequest.h.

GetSnapshotType()

const Aws::String& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::GetSnapshotType ( ) const

inline

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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 219 of file DescribeDBClusterSnapshotsRequest.h.

IncludePublicHasBeenSet()

bool Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::IncludePublicHasBeenSet ( ) const

inline

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Definition at line 627 of file DescribeDBClusterSnapshotsRequest.h.

IncludeSharedHasBeenSet()

bool Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::IncludeSharedHasBeenSet ( ) const

inline

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

Definition at line 588 of file DescribeDBClusterSnapshotsRequest.h.

MarkerHasBeenSet()

bool Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::MarkerHasBeenSet ( ) const

inline

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

Definition at line 519 of file DescribeDBClusterSnapshotsRequest.h.

MaxRecordsHasBeenSet()

bool Aws::RDS::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 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 486 of file DescribeDBClusterSnapshotsRequest.h.

SerializePayload()

Aws::String Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetDBClusterIdentifier() [1/3]

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetDBClusterIdentifier ( Aws::String &&  value )

inline

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

Definition at line 78 of file DescribeDBClusterSnapshotsRequest.h.

SetDBClusterIdentifier() [2/3]

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetDBClusterIdentifier ( const Aws::String &  value )

inline

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

Definition at line 69 of file DescribeDBClusterSnapshotsRequest.h.

SetDBClusterIdentifier() [3/3]

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

inline

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

Definition at line 87 of file DescribeDBClusterSnapshotsRequest.h.

SetDBClusterSnapshotIdentifier() [1/3]

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetDBClusterSnapshotIdentifier ( Aws::String &&  value )

inline

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

Constraints:

• If supplied, 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 155 of file DescribeDBClusterSnapshotsRequest.h.

SetDBClusterSnapshotIdentifier() [2/3]

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetDBClusterSnapshotIdentifier ( const Aws::String &  value )

inline

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

Constraints:

• If supplied, 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 145 of file DescribeDBClusterSnapshotsRequest.h.

SetDBClusterSnapshotIdentifier() [3/3]

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

inline

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

Constraints:

• If supplied, 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 165 of file DescribeDBClusterSnapshotsRequest.h.

SetFilters() [1/2]

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

inline

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

Definition at line 425 of file DescribeDBClusterSnapshotsRequest.h.

SetFilters() [2/2]

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

inline

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

Definition at line 414 of file DescribeDBClusterSnapshotsRequest.h.

SetIncludePublic()

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetIncludePublic ( bool  value )

inline

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Definition at line 636 of file DescribeDBClusterSnapshotsRequest.h.

SetIncludeShared()

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetIncludeShared ( bool  value )

inline

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

Definition at line 598 of file DescribeDBClusterSnapshotsRequest.h.

SetMarker() [1/3]

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetMarker ( Aws::String &&  value )

inline

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

Definition at line 535 of file DescribeDBClusterSnapshotsRequest.h.

SetMarker() [2/3]

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetMarker ( const Aws::String &  value )

inline

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

Definition at line 527 of file DescribeDBClusterSnapshotsRequest.h.

SetMarker() [3/3]

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

inline

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

Definition at line 543 of file DescribeDBClusterSnapshotsRequest.h.

SetMaxRecords()

void Aws::RDS::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 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 494 of file DescribeDBClusterSnapshotsRequest.h.

SetSnapshotType() [1/3]

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetSnapshotType ( Aws::String &&  value )

inline

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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 288 of file DescribeDBClusterSnapshotsRequest.h.

SetSnapshotType() [2/3]

void Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SetSnapshotType ( const Aws::String &  value )

inline

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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 265 of file DescribeDBClusterSnapshotsRequest.h.

SetSnapshotType() [3/3]

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

inline

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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 311 of file DescribeDBClusterSnapshotsRequest.h.

SnapshotTypeHasBeenSet()

bool Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::SnapshotTypeHasBeenSet ( ) const

inline

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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 242 of file DescribeDBClusterSnapshotsRequest.h.

WithDBClusterIdentifier() [1/3]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithDBClusterIdentifier ( Aws::String &&  value )

inline

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

Definition at line 105 of file DescribeDBClusterSnapshotsRequest.h.

WithDBClusterIdentifier() [2/3]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithDBClusterIdentifier ( const Aws::String &  value )

inline

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

Definition at line 96 of file DescribeDBClusterSnapshotsRequest.h.

WithDBClusterIdentifier() [3/3]

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

inline

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

Definition at line 114 of file DescribeDBClusterSnapshotsRequest.h.

WithDBClusterSnapshotIdentifier() [1/3]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithDBClusterSnapshotIdentifier ( Aws::String &&  value )

inline

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

Constraints:

• If supplied, 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 185 of file DescribeDBClusterSnapshotsRequest.h.

WithDBClusterSnapshotIdentifier() [2/3]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithDBClusterSnapshotIdentifier ( const Aws::String &  value )

inline

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

Constraints:

• If supplied, 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 175 of file DescribeDBClusterSnapshotsRequest.h.

WithDBClusterSnapshotIdentifier() [3/3]

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

inline

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

Constraints:

• If supplied, 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 195 of file DescribeDBClusterSnapshotsRequest.h.

WithFilters() [1/2]

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

inline

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

Definition at line 447 of file DescribeDBClusterSnapshotsRequest.h.

WithFilters() [2/2]

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

inline

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

• db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

• snapshot-type - Accepts types of DB cluster snapshots.

• engine - Accepts names of database engines.

Definition at line 436 of file DescribeDBClusterSnapshotsRequest.h.

WithIncludePublic()

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithIncludePublic ( bool  value )

inline

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

Definition at line 645 of file DescribeDBClusterSnapshotsRequest.h.

WithIncludeShared()

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithIncludeShared ( bool  value )

inline

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

Definition at line 608 of file DescribeDBClusterSnapshotsRequest.h.

WithMarker() [1/3]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithMarker ( Aws::String &&  value )

inline

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

Definition at line 559 of file DescribeDBClusterSnapshotsRequest.h.

WithMarker() [2/3]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithMarker ( const Aws::String &  value )

inline

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

Definition at line 551 of file DescribeDBClusterSnapshotsRequest.h.

WithMarker() [3/3]

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

inline

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

Definition at line 567 of file DescribeDBClusterSnapshotsRequest.h.

WithMaxRecords()

DescribeDBClusterSnapshotsRequest& Aws::RDS::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 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 502 of file DescribeDBClusterSnapshotsRequest.h.

WithSnapshotType() [1/3]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithSnapshotType ( Aws::String &&  value )

inline

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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 357 of file DescribeDBClusterSnapshotsRequest.h.

WithSnapshotType() [2/3]

DescribeDBClusterSnapshotsRequest& Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::WithSnapshotType ( const Aws::String &  value )

inline

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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 334 of file DescribeDBClusterSnapshotsRequest.h.

WithSnapshotType() [3/3]

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

inline

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.

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

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

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 380 of file DescribeDBClusterSnapshotsRequest.h.

---

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

• aws-cpp-sdk-rds/include/aws/rds/model/DescribeDBClusterSnapshotsRequest.h