Struct aws_sdk_redshift::model::Snapshot
source · #[non_exhaustive]pub struct Snapshot { /* private fields */ }Expand description
Describes a snapshot.
Implementations§
source§impl Snapshot
impl Snapshot
sourcepub fn snapshot_identifier(&self) -> Option<&str>
pub fn snapshot_identifier(&self) -> Option<&str>
The snapshot identifier that is provided in the request.
sourcepub fn cluster_identifier(&self) -> Option<&str>
pub fn cluster_identifier(&self) -> Option<&str>
The identifier of the cluster for which the snapshot was taken.
sourcepub fn snapshot_create_time(&self) -> Option<&DateTime>
pub fn snapshot_create_time(&self) -> Option<&DateTime>
The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
sourcepub fn status(&self) -> Option<&str>
pub fn status(&self) -> Option<&str>
The snapshot status. The value of the status depends on the API operation used:
-
CreateClusterSnapshotandCopyClusterSnapshotreturns status as "creating". -
DescribeClusterSnapshotsreturns status as "creating", "available", "final snapshot", or "failed". -
DeleteClusterSnapshotreturns status as "deleted".
sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
The Availability Zone in which the cluster was created.
sourcepub fn cluster_create_time(&self) -> Option<&DateTime>
pub fn cluster_create_time(&self) -> Option<&DateTime>
The time (UTC) when the cluster was originally created.
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
The admin user name for the cluster.
sourcepub fn cluster_version(&self) -> Option<&str>
pub fn cluster_version(&self) -> Option<&str>
The version ID of the Amazon Redshift engine that is running on the cluster.
sourcepub fn engine_full_version(&self) -> Option<&str>
pub fn engine_full_version(&self) -> Option<&str>
The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
sourcepub fn snapshot_type(&self) -> Option<&str>
pub fn snapshot_type(&self) -> Option<&str>
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".
sourcepub fn number_of_nodes(&self) -> i32
pub fn number_of_nodes(&self) -> i32
The number of nodes in the cluster.
sourcepub fn db_name(&self) -> Option<&str>
pub fn db_name(&self) -> Option<&str>
The name of the database that was created when the cluster was created.
sourcepub fn vpc_id(&self) -> Option<&str>
pub fn vpc_id(&self) -> Option<&str>
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
sourcepub fn encrypted_with_hsm(&self) -> bool
pub fn encrypted_with_hsm(&self) -> bool
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
sourcepub fn accounts_with_restore_access(
&self
) -> Option<&[AccountWithRestoreAccess]>
pub fn accounts_with_restore_access(
&self
) -> Option<&[AccountWithRestoreAccess]>
A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
sourcepub fn owner_account(&self) -> Option<&str>
pub fn owner_account(&self) -> Option<&str>
For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
sourcepub fn total_backup_size_in_mega_bytes(&self) -> f64
pub fn total_backup_size_in_mega_bytes(&self) -> f64
The size of the complete set of backup data that would be used to restore the cluster.
sourcepub fn actual_incremental_backup_size_in_mega_bytes(&self) -> f64
pub fn actual_incremental_backup_size_in_mega_bytes(&self) -> f64
The size of the incremental backup.
sourcepub fn backup_progress_in_mega_bytes(&self) -> f64
pub fn backup_progress_in_mega_bytes(&self) -> f64
The number of megabytes that have been transferred to the snapshot backup.
sourcepub fn current_backup_rate_in_mega_bytes_per_second(&self) -> f64
pub fn current_backup_rate_in_mega_bytes_per_second(&self) -> f64
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
sourcepub fn estimated_seconds_to_completion(&self) -> i64
pub fn estimated_seconds_to_completion(&self) -> i64
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
sourcepub fn elapsed_time_in_seconds(&self) -> i64
pub fn elapsed_time_in_seconds(&self) -> i64
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
sourcepub fn source_region(&self) -> Option<&str>
pub fn source_region(&self) -> Option<&str>
The source region from which the snapshot was copied.
The list of tags for the cluster snapshot.
sourcepub fn restorable_node_types(&self) -> Option<&[String]>
pub fn restorable_node_types(&self) -> Option<&[String]>
The list of node types that this cluster snapshot is able to restore into.
sourcepub fn enhanced_vpc_routing(&self) -> bool
pub fn enhanced_vpc_routing(&self) -> bool
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
sourcepub fn maintenance_track_name(&self) -> Option<&str>
pub fn maintenance_track_name(&self) -> Option<&str>
The name of the maintenance track for the snapshot.
sourcepub fn manual_snapshot_retention_period(&self) -> Option<i32>
pub fn manual_snapshot_retention_period(&self) -> Option<i32>
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
sourcepub fn manual_snapshot_remaining_days(&self) -> Option<i32>
pub fn manual_snapshot_remaining_days(&self) -> Option<i32>
The number of days until a manual snapshot will pass its retention period.
sourcepub fn snapshot_retention_start_time(&self) -> Option<&DateTime>
pub fn snapshot_retention_start_time(&self) -> Option<&DateTime>
A timestamp representing the start of the retention period for the snapshot.