AWS SDK for C++
1.9.1
AWS SDK for C++
|
#include <DescribeDBClusterSnapshotsRequest.h>
Protected Member Functions | |
void | DumpBodyToUrl (Aws::Http::URI &uri) const override |
![]() | |
virtual Aws::Http::HeaderValueCollection | GetRequestSpecificHeaders () const |
Aws::RDS::Model::DescribeDBClusterSnapshotsRequest::DescribeDBClusterSnapshotsRequest | ( | ) |
|
inline |
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Definition at line 458 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Definition at line 469 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Definition at line 60 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
Definition at line 135 of file DescribeDBClusterSnapshotsRequest.h.
|
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.
|
inline |
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Definition at line 403 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Definition at line 51 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
Definition at line 125 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Definition at line 392 of file DescribeDBClusterSnapshotsRequest.h.
|
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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
Definition at line 614 of file DescribeDBClusterSnapshotsRequest.h.
|
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 cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute
API action.
Definition at line 577 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Definition at line 511 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The maximum number of records to include in the response. If more records exist than the specified MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Definition at line 478 of file DescribeDBClusterSnapshotsRequest.h.
|
inlineoverridevirtual |
Implements Aws::AmazonWebServiceRequest.
Definition at line 35 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
Definition at line 219 of file DescribeDBClusterSnapshotsRequest.h.
|
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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
Definition at line 623 of file DescribeDBClusterSnapshotsRequest.h.
|
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 cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute
API action.
Definition at line 586 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Definition at line 519 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The maximum number of records to include in the response. If more records exist than the specified MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Definition at line 486 of file DescribeDBClusterSnapshotsRequest.h.
|
overridevirtual |
Convert payload into String.
Implements Aws::AmazonSerializableWebServiceRequest.
|
inline |
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Definition at line 78 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Definition at line 69 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Definition at line 87 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
Definition at line 155 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
Definition at line 145 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
Definition at line 165 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Definition at line 425 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Definition at line 414 of file DescribeDBClusterSnapshotsRequest.h.
|
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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
Definition at line 632 of file DescribeDBClusterSnapshotsRequest.h.
|
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 cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute
API action.
Definition at line 595 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Definition at line 535 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Definition at line 527 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Definition at line 543 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The maximum number of records to include in the response. If more records exist than the specified MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Definition at line 494 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
Definition at line 288 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
Definition at line 265 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
Definition at line 311 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
Definition at line 242 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Definition at line 105 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Definition at line 96 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
Definition at line 114 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
Definition at line 185 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
Definition at line 175 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBClusterSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be specified.
Definition at line 195 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Definition at line 447 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers.
snapshot-type
- Accepts types of DB cluster snapshots.
engine
- Accepts names of database engines.
Definition at line 436 of file DescribeDBClusterSnapshotsRequest.h.
|
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 cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
Definition at line 641 of file DescribeDBClusterSnapshotsRequest.h.
|
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 cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute
API action.
Definition at line 604 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Definition at line 559 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Definition at line 551 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
An optional pagination token provided by a previous DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords
.
Definition at line 567 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The maximum number of records to include in the response. If more records exist than the specified MaxRecords
value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Definition at line 502 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
Definition at line 357 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
Definition at line 334 of file DescribeDBClusterSnapshotsRequest.h.
|
inline |
The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS account.
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic
parameter.
The IncludeShared
and IncludePublic
parameters don't apply for SnapshotType
values of manual
or automated
. The IncludePublic
parameter doesn't apply when SnapshotType
is set to shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is set to public
.
Definition at line 380 of file DescribeDBClusterSnapshotsRequest.h.