/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include See Also:
AWS
* API Reference
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
*/ inline int GetMaxRecords() const{ return m_maxRecords; } /** * 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.
*/ inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } /** * 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.
*/ inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } /** * 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.
*/ inline DescribeDBSnapshotsRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** * 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
*/ inline bool GetIncludePublic() const{ return m_includePublic; } /** *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.
*/ inline bool IncludePublicHasBeenSet() const { return m_includePublicHasBeenSet; } /** *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.
*/ inline void SetIncludePublic(bool value) { m_includePublicHasBeenSet = true; m_includePublic = value; } /** *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.
*/ inline DescribeDBSnapshotsRequest& WithIncludePublic(bool value) { SetIncludePublic(value); return *this;} /** *A specific DB resource ID to describe.
*/ inline const Aws::String& GetDbiResourceId() const{ return m_dbiResourceId; } /** *A specific DB resource ID to describe.
*/ inline bool DbiResourceIdHasBeenSet() const { return m_dbiResourceIdHasBeenSet; } /** *A specific DB resource ID to describe.
*/ inline void SetDbiResourceId(const Aws::String& value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId = value; } /** *A specific DB resource ID to describe.
*/ inline void SetDbiResourceId(Aws::String&& value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId = std::move(value); } /** *A specific DB resource ID to describe.
*/ inline void SetDbiResourceId(const char* value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId.assign(value); } /** *A specific DB resource ID to describe.
*/ inline DescribeDBSnapshotsRequest& WithDbiResourceId(const Aws::String& value) { SetDbiResourceId(value); return *this;} /** *A specific DB resource ID to describe.
*/ inline DescribeDBSnapshotsRequest& WithDbiResourceId(Aws::String&& value) { SetDbiResourceId(std::move(value)); return *this;} /** *A specific DB resource ID to describe.
*/ inline DescribeDBSnapshotsRequest& WithDbiResourceId(const char* value) { SetDbiResourceId(value); return *this;} private: Aws::String m_dBInstanceIdentifier; bool m_dBInstanceIdentifierHasBeenSet; Aws::String m_dBSnapshotIdentifier; bool m_dBSnapshotIdentifierHasBeenSet; Aws::String m_snapshotType; bool m_snapshotTypeHasBeenSet; Aws::Vector