Struct aws_sdk_docdb::types::DbClusterSnapshot
source · #[non_exhaustive]pub struct DbClusterSnapshot {Show 18 fields
pub availability_zones: Option<Vec<String>>,
pub db_cluster_snapshot_identifier: Option<String>,
pub db_cluster_identifier: Option<String>,
pub snapshot_create_time: Option<DateTime>,
pub engine: Option<String>,
pub status: Option<String>,
pub port: Option<i32>,
pub vpc_id: Option<String>,
pub cluster_create_time: Option<DateTime>,
pub master_username: Option<String>,
pub engine_version: Option<String>,
pub snapshot_type: Option<String>,
pub percent_progress: Option<i32>,
pub storage_encrypted: Option<bool>,
pub kms_key_id: Option<String>,
pub db_cluster_snapshot_arn: Option<String>,
pub source_db_cluster_snapshot_arn: Option<String>,
pub storage_type: Option<String>,
}
Expand description
Detailed information about a cluster snapshot.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.availability_zones: Option<Vec<String>>
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
db_cluster_snapshot_identifier: Option<String>
Specifies the identifier for the cluster snapshot.
db_cluster_identifier: Option<String>
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
snapshot_create_time: Option<DateTime>
Provides the time when the snapshot was taken, in UTC.
engine: Option<String>
Specifies the name of the database engine.
status: Option<String>
Specifies the status of this cluster snapshot.
port: Option<i32>
Specifies the port that the cluster was listening on at the time of the snapshot.
vpc_id: Option<String>
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
cluster_create_time: Option<DateTime>
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
master_username: Option<String>
Provides the master user name for the cluster snapshot.
engine_version: Option<String>
Provides the version of the database engine for this cluster snapshot.
snapshot_type: Option<String>
Provides the type of the cluster snapshot.
percent_progress: Option<i32>
Specifies the percentage of the estimated data that has been transferred.
storage_encrypted: Option<bool>
Specifies whether the cluster snapshot is encrypted.
kms_key_id: Option<String>
If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster snapshot.
db_cluster_snapshot_arn: Option<String>
The Amazon Resource Name (ARN) for the cluster snapshot.
source_db_cluster_snapshot_arn: Option<String>
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
storage_type: Option<String>
Storage type associated with your cluster snapshot
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
Implementations§
source§impl DbClusterSnapshot
impl DbClusterSnapshot
sourcepub fn availability_zones(&self) -> &[String]
pub fn availability_zones(&self) -> &[String]
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .availability_zones.is_none()
.
sourcepub fn db_cluster_snapshot_identifier(&self) -> Option<&str>
pub fn db_cluster_snapshot_identifier(&self) -> Option<&str>
Specifies the identifier for the cluster snapshot.
sourcepub fn db_cluster_identifier(&self) -> Option<&str>
pub fn db_cluster_identifier(&self) -> Option<&str>
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
sourcepub fn snapshot_create_time(&self) -> Option<&DateTime>
pub fn snapshot_create_time(&self) -> Option<&DateTime>
Provides the time when the snapshot was taken, in UTC.
sourcepub fn port(&self) -> Option<i32>
pub fn port(&self) -> Option<i32>
Specifies the port that the cluster was listening on at the time of the snapshot.
sourcepub fn vpc_id(&self) -> Option<&str>
pub fn vpc_id(&self) -> Option<&str>
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
sourcepub fn cluster_create_time(&self) -> Option<&DateTime>
pub fn cluster_create_time(&self) -> Option<&DateTime>
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
Provides the master user name for the cluster snapshot.
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
Provides the version of the database engine for this cluster snapshot.
sourcepub fn snapshot_type(&self) -> Option<&str>
pub fn snapshot_type(&self) -> Option<&str>
Provides the type of the cluster snapshot.
sourcepub fn percent_progress(&self) -> Option<i32>
pub fn percent_progress(&self) -> Option<i32>
Specifies the percentage of the estimated data that has been transferred.
sourcepub fn storage_encrypted(&self) -> Option<bool>
pub fn storage_encrypted(&self) -> Option<bool>
Specifies whether the cluster snapshot is encrypted.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
If StorageEncrypted
is true
, the KMS key identifier for the encrypted cluster snapshot.
sourcepub fn db_cluster_snapshot_arn(&self) -> Option<&str>
pub fn db_cluster_snapshot_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the cluster snapshot.
sourcepub fn source_db_cluster_snapshot_arn(&self) -> Option<&str>
pub fn source_db_cluster_snapshot_arn(&self) -> Option<&str>
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.
sourcepub fn storage_type(&self) -> Option<&str>
pub fn storage_type(&self) -> Option<&str>
Storage type associated with your cluster snapshot
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
source§impl DbClusterSnapshot
impl DbClusterSnapshot
sourcepub fn builder() -> DbClusterSnapshotBuilder
pub fn builder() -> DbClusterSnapshotBuilder
Creates a new builder-style object to manufacture DbClusterSnapshot
.
Trait Implementations§
source§impl Clone for DbClusterSnapshot
impl Clone for DbClusterSnapshot
source§fn clone(&self) -> DbClusterSnapshot
fn clone(&self) -> DbClusterSnapshot
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DbClusterSnapshot
impl Debug for DbClusterSnapshot
source§impl PartialEq for DbClusterSnapshot
impl PartialEq for DbClusterSnapshot
source§fn eq(&self, other: &DbClusterSnapshot) -> bool
fn eq(&self, other: &DbClusterSnapshot) -> bool
self
and other
values to be equal, and is used
by ==
.