Struct rusoto_rds::DescribeDBSnapshotsMessage
source · [−]pub struct DescribeDBSnapshotsMessage {
pub db_instance_identifier: Option<String>,
pub db_snapshot_identifier: Option<String>,
pub dbi_resource_id: 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_instance_identifier: Option<String>
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier
. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match the identifier of an existing DBInstance.
db_snapshot_identifier: Option<String>
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier
. This value is stored as a lowercase string.
Constraints:
-
If supplied, must match the identifier of an existing DBSnapshot.
-
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
dbi_resource_id: Option<String>
A specific DB resource ID to describe.
filters: Option<Vec<Filter>>
A filter that specifies one or more DB snapshots to describe.
Supported filters:
-
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). -
db-snapshot-id
- Accepts DB snapshot identifiers. -
dbi-resource-id
- Accepts identifiers of source DB instances. -
snapshot-type
- Accepts types of DB 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 snapshot as public by using the ModifyDBSnapshotAttribute API.
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 snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute
API action.
marker: Option<String>
An optional pagination token provided by a previous DescribeDBSnapshots
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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
snapshot_type: Option<String>
The type of snapshots to be returned. You can specify one of the following values:
-
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. -
manual
- Return all DB snapshots that have been taken by my Amazon Web Services account. -
shared
- Return all manual DB snapshots that have been shared to my Amazon Web Services account. -
public
- Return all DB snapshots that have been marked as public. -
awsbackup
- Return the DB snapshots managed by the Amazon Web Services Backup service.For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The
awsbackup
type does not apply to Aurora.
If you don't specify a SnapshotType
value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared
parameter. You can include public 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 DescribeDBSnapshotsMessage
impl Clone for DescribeDBSnapshotsMessage
sourcefn clone(&self) -> DescribeDBSnapshotsMessage
fn clone(&self) -> DescribeDBSnapshotsMessage
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 Debug for DescribeDBSnapshotsMessage
impl Debug for DescribeDBSnapshotsMessage
sourceimpl Default for DescribeDBSnapshotsMessage
impl Default for DescribeDBSnapshotsMessage
sourcefn default() -> DescribeDBSnapshotsMessage
fn default() -> DescribeDBSnapshotsMessage
Returns the “default value” for a type. Read more
sourceimpl PartialEq<DescribeDBSnapshotsMessage> for DescribeDBSnapshotsMessage
impl PartialEq<DescribeDBSnapshotsMessage> for DescribeDBSnapshotsMessage
sourcefn eq(&self, other: &DescribeDBSnapshotsMessage) -> bool
fn eq(&self, other: &DescribeDBSnapshotsMessage) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DescribeDBSnapshotsMessage) -> bool
fn ne(&self, other: &DescribeDBSnapshotsMessage) -> bool
This method tests for !=
.
impl StructuralPartialEq for DescribeDBSnapshotsMessage
Auto Trait Implementations
impl RefUnwindSafe for DescribeDBSnapshotsMessage
impl Send for DescribeDBSnapshotsMessage
impl Sync for DescribeDBSnapshotsMessage
impl Unpin for DescribeDBSnapshotsMessage
impl UnwindSafe for DescribeDBSnapshotsMessage
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