Struct rusoto_rds::DescribeDBClusterSnapshotsMessage
[−]
[src]
pub struct DescribeDBClusterSnapshotsMessage { pub db_cluster_identifier: Option<String>, pub db_cluster_snapshot_identifier: Option<String>, pub filters: Option<Vec<Filter>>, pub include_public: Option<bool>, pub include_shared: Option<bool>, pub marker: Option<String>, pub max_records: Option<i64>, pub snapshot_type: Option<String>, }
Fields
db_cluster_identifier: Option<String>
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier
parameter. This parameter is not case-sensitive.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens
-
First character must be a letter
-
Cannot end with a hyphen or contain two consecutive hyphens
db_cluster_snapshot_identifier: Option<String>
A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
-
Must be 1 to 255 alphanumeric characters
-
First character must be a letter
-
Cannot end with a hyphen or contain two consecutive hyphens
-
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
filters: Option<Vec<Filter>>
This parameter is not currently supported.
include_public: Option<bool>
Set this value to true
to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false
. The default is false
. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
Set this value to true
to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false
. The default is false
.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
marker: Option<String>
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
.
max_records: Option<i64>
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 the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
snapshot_type: Option<String>
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 setting the IncludeShared
parameter to true
. You can include public DB cluster snapshots with these results by setting the IncludePublic
parameter to true
.
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
.
Trait Implementations
impl Default for DescribeDBClusterSnapshotsMessage
[src]
fn default() -> DescribeDBClusterSnapshotsMessage
[src]
Returns the "default value" for a type. Read more
impl Debug for DescribeDBClusterSnapshotsMessage
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Clone for DescribeDBClusterSnapshotsMessage
[src]
fn clone(&self) -> DescribeDBClusterSnapshotsMessage
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more