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
Fields
db_cluster_identifier: Option<String>
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.
db_cluster_snapshot_identifier: Option<String>
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.
filters: Option<Vec<Filter>>
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.
include_public: Option<bool>
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.
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.
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 you can retrieve the remaining results.
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 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
.
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