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>,
}
Expand description
Represents the input to DescribeDBClusterSnapshots.
Fields
db_cluster_identifier: Option<String>
The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier
parameter. This parameter is not case sensitive.
Constraints:
-
If provided, must match the identifier of an existing
DBCluster
.
db_cluster_snapshot_identifier: Option<String>
A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
-
If provided, must match the identifier of an existing
DBClusterSnapshot
. -
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 to true
to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwise false
. The default is false
.
Set to true
to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwise false
. The default is false
.
marker: Option<String>
An optional pagination token provided by a previous 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 (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 cluster snapshots to be returned. You can specify one of the following values:
-
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your account. -
manual
- Return all cluster snapshots that you have manually created for your account. -
shared
- Return all manual cluster snapshots that have been shared to your account. -
public
- Return all cluster snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared
parameter to true
. You can include public cluster snapshots with these results by setting theIncludePublic
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
sourceimpl Clone for DescribeDBClusterSnapshotsMessage
impl Clone for DescribeDBClusterSnapshotsMessage
sourcefn clone(&self) -> DescribeDBClusterSnapshotsMessage
fn clone(&self) -> DescribeDBClusterSnapshotsMessage
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Default for DescribeDBClusterSnapshotsMessage
impl Default for DescribeDBClusterSnapshotsMessage
sourcefn default() -> DescribeDBClusterSnapshotsMessage
fn default() -> DescribeDBClusterSnapshotsMessage
Returns the “default value” for a type. Read more
sourceimpl PartialEq<DescribeDBClusterSnapshotsMessage> for DescribeDBClusterSnapshotsMessage
impl PartialEq<DescribeDBClusterSnapshotsMessage> for DescribeDBClusterSnapshotsMessage
sourcefn eq(&self, other: &DescribeDBClusterSnapshotsMessage) -> bool
fn eq(&self, other: &DescribeDBClusterSnapshotsMessage) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DescribeDBClusterSnapshotsMessage) -> bool
fn ne(&self, other: &DescribeDBClusterSnapshotsMessage) -> bool
This method tests for !=
.
impl StructuralPartialEq for DescribeDBClusterSnapshotsMessage
Auto Trait Implementations
impl RefUnwindSafe for DescribeDBClusterSnapshotsMessage
impl Send for DescribeDBClusterSnapshotsMessage
impl Sync for DescribeDBClusterSnapshotsMessage
impl Unpin for DescribeDBClusterSnapshotsMessage
impl UnwindSafe for DescribeDBClusterSnapshotsMessage
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more