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

#include <DescribeDBSnapshotsRequest.h>

+ Inheritance diagram for Aws::RDS::Model::DescribeDBSnapshotsRequest:

Public Member Functions

 DescribeDBSnapshotsRequest ()
 
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)
 
DescribeDBSnapshotsRequestWithDBInstanceIdentifier (const Aws::String &value)
 
DescribeDBSnapshotsRequestWithDBInstanceIdentifier (Aws::String &&value)
 
DescribeDBSnapshotsRequestWithDBInstanceIdentifier (const char *value)
 
const Aws::StringGetDBSnapshotIdentifier () const
 
bool DBSnapshotIdentifierHasBeenSet () const
 
void SetDBSnapshotIdentifier (const Aws::String &value)
 
void SetDBSnapshotIdentifier (Aws::String &&value)
 
void SetDBSnapshotIdentifier (const char *value)
 
DescribeDBSnapshotsRequestWithDBSnapshotIdentifier (const Aws::String &value)
 
DescribeDBSnapshotsRequestWithDBSnapshotIdentifier (Aws::String &&value)
 
DescribeDBSnapshotsRequestWithDBSnapshotIdentifier (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)
 
DescribeDBSnapshotsRequestWithSnapshotType (const Aws::String &value)
 
DescribeDBSnapshotsRequestWithSnapshotType (Aws::String &&value)
 
DescribeDBSnapshotsRequestWithSnapshotType (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)
 
DescribeDBSnapshotsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribeDBSnapshotsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribeDBSnapshotsRequestAddFilters (const Filter &value)
 
DescribeDBSnapshotsRequestAddFilters (Filter &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeDBSnapshotsRequestWithMaxRecords (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)
 
DescribeDBSnapshotsRequestWithMarker (const Aws::String &value)
 
DescribeDBSnapshotsRequestWithMarker (Aws::String &&value)
 
DescribeDBSnapshotsRequestWithMarker (const char *value)
 
bool GetIncludeShared () const
 
bool IncludeSharedHasBeenSet () const
 
void SetIncludeShared (bool value)
 
DescribeDBSnapshotsRequestWithIncludeShared (bool value)
 
bool GetIncludePublic () const
 
bool IncludePublicHasBeenSet () const
 
void SetIncludePublic (bool value)
 
DescribeDBSnapshotsRequestWithIncludePublic (bool value)
 
const Aws::StringGetDbiResourceId () const
 
bool DbiResourceIdHasBeenSet () const
 
void SetDbiResourceId (const Aws::String &value)
 
void SetDbiResourceId (Aws::String &&value)
 
void SetDbiResourceId (const char *value)
 
DescribeDBSnapshotsRequestWithDbiResourceId (const Aws::String &value)
 
DescribeDBSnapshotsRequestWithDbiResourceId (Aws::String &&value)
 
DescribeDBSnapshotsRequestWithDbiResourceId (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 DescribeDBSnapshotsRequest.h.

Constructor & Destructor Documentation

◆ DescribeDBSnapshotsRequest()

Aws::RDS::Model::DescribeDBSnapshotsRequest::DescribeDBSnapshotsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

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

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

Supported filters:

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

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

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

Definition at line 489 of file DescribeDBSnapshotsRequest.h.

◆ AddFilters() [2/2]

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

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

Supported filters:

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

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

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

Definition at line 501 of file DescribeDBSnapshotsRequest.h.

◆ DBInstanceIdentifierHasBeenSet()

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

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

Constraints:

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

Definition at line 58 of file DescribeDBSnapshotsRequest.h.

◆ DbiResourceIdHasBeenSet()

bool Aws::RDS::Model::DescribeDBSnapshotsRequest::DbiResourceIdHasBeenSet ( ) const
inline

A specific DB resource ID to describe.

Definition at line 684 of file DescribeDBSnapshotsRequest.h.

◆ DBSnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::DescribeDBSnapshotsRequest::DBSnapshotIdentifierHasBeenSet ( ) const
inline

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

Constraints:

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

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

Definition at line 127 of file DescribeDBSnapshotsRequest.h.

◆ DumpBodyToUrl()

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

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

Supported filters:

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

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

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

Definition at line 429 of file DescribeDBSnapshotsRequest.h.

◆ GetDBInstanceIdentifier()

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

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

Constraints:

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

Definition at line 50 of file DescribeDBSnapshotsRequest.h.

◆ GetDbiResourceId()

const Aws::String& Aws::RDS::Model::DescribeDBSnapshotsRequest::GetDbiResourceId ( ) const
inline

A specific DB resource ID to describe.

Definition at line 679 of file DescribeDBSnapshotsRequest.h.

◆ GetDBSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::DescribeDBSnapshotsRequest::GetDBSnapshotIdentifier ( ) const
inline

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

Constraints:

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

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

Definition at line 117 of file DescribeDBSnapshotsRequest.h.

◆ GetFilters()

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

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

Supported filters:

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

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

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

Definition at line 417 of file DescribeDBSnapshotsRequest.h.

◆ GetIncludePublic()

bool Aws::RDS::Model::DescribeDBSnapshotsRequest::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 AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Definition at line 649 of file DescribeDBSnapshotsRequest.h.

◆ GetIncludeShared()

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

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

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Definition at line 613 of file DescribeDBSnapshotsRequest.h.

◆ GetMarker()

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

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

Definition at line 547 of file DescribeDBSnapshotsRequest.h.

◆ GetMaxRecords()

int Aws::RDS::Model::DescribeDBSnapshotsRequest::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 511 of file DescribeDBSnapshotsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeDBSnapshotsRequest.h.

◆ GetSnapshotType()

const Aws::String& Aws::RDS::Model::DescribeDBSnapshotsRequest::GetSnapshotType ( ) const
inline

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

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

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public

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

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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 215 of file DescribeDBSnapshotsRequest.h.

◆ IncludePublicHasBeenSet()

bool Aws::RDS::Model::DescribeDBSnapshotsRequest::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 AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Definition at line 657 of file DescribeDBSnapshotsRequest.h.

◆ IncludeSharedHasBeenSet()

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

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

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Definition at line 622 of file DescribeDBSnapshotsRequest.h.

◆ MarkerHasBeenSet()

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

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

Definition at line 555 of file DescribeDBSnapshotsRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::RDS::Model::DescribeDBSnapshotsRequest::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 520 of file DescribeDBSnapshotsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDBInstanceIdentifier() [1/3]

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

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

Constraints:

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

Definition at line 74 of file DescribeDBSnapshotsRequest.h.

◆ SetDBInstanceIdentifier() [2/3]

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

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

Constraints:

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

Definition at line 66 of file DescribeDBSnapshotsRequest.h.

◆ SetDBInstanceIdentifier() [3/3]

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

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

Constraints:

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

Definition at line 82 of file DescribeDBSnapshotsRequest.h.

◆ SetDbiResourceId() [1/3]

void Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDbiResourceId ( Aws::String &&  value)
inline

A specific DB resource ID to describe.

Definition at line 694 of file DescribeDBSnapshotsRequest.h.

◆ SetDbiResourceId() [2/3]

void Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDbiResourceId ( const Aws::String value)
inline

A specific DB resource ID to describe.

Definition at line 689 of file DescribeDBSnapshotsRequest.h.

◆ SetDbiResourceId() [3/3]

void Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDbiResourceId ( const char *  value)
inline

A specific DB resource ID to describe.

Definition at line 699 of file DescribeDBSnapshotsRequest.h.

◆ SetDBSnapshotIdentifier() [1/3]

void Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBSnapshotIdentifier ( Aws::String &&  value)
inline

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

Constraints:

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

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

Definition at line 147 of file DescribeDBSnapshotsRequest.h.

◆ SetDBSnapshotIdentifier() [2/3]

void Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBSnapshotIdentifier ( const Aws::String value)
inline

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

Constraints:

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

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

Definition at line 137 of file DescribeDBSnapshotsRequest.h.

◆ SetDBSnapshotIdentifier() [3/3]

void Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBSnapshotIdentifier ( const char *  value)
inline

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

Constraints:

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

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

Definition at line 157 of file DescribeDBSnapshotsRequest.h.

◆ SetFilters() [1/2]

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

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

Supported filters:

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

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

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

Definition at line 453 of file DescribeDBSnapshotsRequest.h.

◆ SetFilters() [2/2]

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

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

Supported filters:

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

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

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

Definition at line 441 of file DescribeDBSnapshotsRequest.h.

◆ SetIncludePublic()

void Aws::RDS::Model::DescribeDBSnapshotsRequest::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 AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Definition at line 665 of file DescribeDBSnapshotsRequest.h.

◆ SetIncludeShared()

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

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

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Definition at line 631 of file DescribeDBSnapshotsRequest.h.

◆ SetMarker() [1/3]

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

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

Definition at line 571 of file DescribeDBSnapshotsRequest.h.

◆ SetMarker() [2/3]

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

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

Definition at line 563 of file DescribeDBSnapshotsRequest.h.

◆ SetMarker() [3/3]

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

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

Definition at line 579 of file DescribeDBSnapshotsRequest.h.

◆ SetMaxRecords()

void Aws::RDS::Model::DescribeDBSnapshotsRequest::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 529 of file DescribeDBSnapshotsRequest.h.

◆ SetSnapshotType() [1/3]

void Aws::RDS::Model::DescribeDBSnapshotsRequest::SetSnapshotType ( Aws::String &&  value)
inline

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

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

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public

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

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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 296 of file DescribeDBSnapshotsRequest.h.

◆ SetSnapshotType() [2/3]

void Aws::RDS::Model::DescribeDBSnapshotsRequest::SetSnapshotType ( const Aws::String value)
inline

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

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

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public

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

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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 269 of file DescribeDBSnapshotsRequest.h.

◆ SetSnapshotType() [3/3]

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

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

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

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public

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

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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 323 of file DescribeDBSnapshotsRequest.h.

◆ SnapshotTypeHasBeenSet()

bool Aws::RDS::Model::DescribeDBSnapshotsRequest::SnapshotTypeHasBeenSet ( ) const
inline

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

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

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public

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

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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 DescribeDBSnapshotsRequest.h.

◆ WithDBInstanceIdentifier() [1/3]

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

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

Constraints:

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

Definition at line 98 of file DescribeDBSnapshotsRequest.h.

◆ WithDBInstanceIdentifier() [2/3]

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

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

Constraints:

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

Definition at line 90 of file DescribeDBSnapshotsRequest.h.

◆ WithDBInstanceIdentifier() [3/3]

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

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

Constraints:

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

Definition at line 106 of file DescribeDBSnapshotsRequest.h.

◆ WithDbiResourceId() [1/3]

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDbiResourceId ( Aws::String &&  value)
inline

A specific DB resource ID to describe.

Definition at line 709 of file DescribeDBSnapshotsRequest.h.

◆ WithDbiResourceId() [2/3]

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDbiResourceId ( const Aws::String value)
inline

A specific DB resource ID to describe.

Definition at line 704 of file DescribeDBSnapshotsRequest.h.

◆ WithDbiResourceId() [3/3]

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDbiResourceId ( const char *  value)
inline

A specific DB resource ID to describe.

Definition at line 714 of file DescribeDBSnapshotsRequest.h.

◆ WithDBSnapshotIdentifier() [1/3]

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBSnapshotIdentifier ( Aws::String &&  value)
inline

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

Constraints:

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

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

Definition at line 177 of file DescribeDBSnapshotsRequest.h.

◆ WithDBSnapshotIdentifier() [2/3]

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBSnapshotIdentifier ( const Aws::String value)
inline

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

Constraints:

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

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

Definition at line 167 of file DescribeDBSnapshotsRequest.h.

◆ WithDBSnapshotIdentifier() [3/3]

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBSnapshotIdentifier ( const char *  value)
inline

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

Constraints:

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

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

Definition at line 187 of file DescribeDBSnapshotsRequest.h.

◆ WithFilters() [1/2]

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

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

Supported filters:

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

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

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

Definition at line 477 of file DescribeDBSnapshotsRequest.h.

◆ WithFilters() [2/2]

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

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

Supported filters:

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

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

  • dbi-resource-id - Accepts identifiers of source DB instances.

  • snapshot-type - Accepts types of DB snapshots.

  • engine - Accepts names of database engines.

Definition at line 465 of file DescribeDBSnapshotsRequest.h.

◆ WithIncludePublic()

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::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 AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

Definition at line 673 of file DescribeDBSnapshotsRequest.h.

◆ WithIncludeShared()

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

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

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

Definition at line 640 of file DescribeDBSnapshotsRequest.h.

◆ WithMarker() [1/3]

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

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

Definition at line 595 of file DescribeDBSnapshotsRequest.h.

◆ WithMarker() [2/3]

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

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

Definition at line 587 of file DescribeDBSnapshotsRequest.h.

◆ WithMarker() [3/3]

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

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

Definition at line 603 of file DescribeDBSnapshotsRequest.h.

◆ WithMaxRecords()

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::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 538 of file DescribeDBSnapshotsRequest.h.

◆ WithSnapshotType() [1/3]

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::WithSnapshotType ( Aws::String &&  value)
inline

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

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

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public

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

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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 377 of file DescribeDBSnapshotsRequest.h.

◆ WithSnapshotType() [2/3]

DescribeDBSnapshotsRequest& Aws::RDS::Model::DescribeDBSnapshotsRequest::WithSnapshotType ( const Aws::String value)
inline

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

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

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public

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

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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 350 of file DescribeDBSnapshotsRequest.h.

◆ WithSnapshotType() [3/3]

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

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

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

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public

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

  • awsbackup - Return the DB snapshots managed by the AWS Backup service.

    For information about AWS Backup, see the AWS Backup Developer Guide.

    The awsbackup type does not apply to Aurora.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public 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 404 of file DescribeDBSnapshotsRequest.h.


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