/**
* 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 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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.
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.
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.
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.
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.
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.
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.
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.
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.
*/ 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 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 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 you can retrieve the remaining
* results.
Default: 100
Constraints: Minimum 20, maximum 100.
*/ inline DescribeDBClusterSnapshotsRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** *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
.
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
.
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
.
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
.
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
.
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
.
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
.
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
.
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.
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.
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.
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.
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.
*/ 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 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.
*/ 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 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.
*/ 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 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.
*/ inline DescribeDBClusterSnapshotsRequest& WithIncludePublic(bool value) { SetIncludePublic(value); return *this;} private: Aws::String m_dBClusterIdentifier; bool m_dBClusterIdentifierHasBeenSet = false; Aws::String m_dBClusterSnapshotIdentifier; bool m_dBClusterSnapshotIdentifierHasBeenSet = false; Aws::String m_snapshotType; bool m_snapshotTypeHasBeenSet = false; Aws::Vector