Struct aws_sdk_elasticache::model::Snapshot
source · #[non_exhaustive]pub struct Snapshot { /* private fields */ }Expand description
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
Implementations§
source§impl Snapshot
impl Snapshot
sourcepub fn snapshot_name(&self) -> Option<&str>
pub fn snapshot_name(&self) -> Option<&str>
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.
sourcepub fn replication_group_id(&self) -> Option<&str>
pub fn replication_group_id(&self) -> Option<&str>
The unique identifier of the source replication group.
sourcepub fn replication_group_description(&self) -> Option<&str>
pub fn replication_group_description(&self) -> Option<&str>
A description of the source replication group.
sourcepub fn cache_cluster_id(&self) -> Option<&str>
pub fn cache_cluster_id(&self) -> Option<&str>
The user-supplied identifier of the source cluster.
sourcepub fn snapshot_status(&self) -> Option<&str>
pub fn snapshot_status(&self) -> Option<&str>
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
sourcepub fn snapshot_source(&self) -> Option<&str>
pub fn snapshot_source(&self) -> Option<&str>
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
sourcepub fn cache_node_type(&self) -> Option<&str>
pub fn cache_node_type(&self) -> Option<&str>
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
-
General purpose:
-
Current generation:
M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.m6g.large,cache.m6g.xlarge,cache.m6g.2xlarge,cache.m6g.4xlarge,cache.m6g.8xlarge,cache.m6g.12xlarge,cache.m6g.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):
cache.t4g.micro,cache.t4g.small,cache.t4g.mediumT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.medium -
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
-
-
Compute optimized:
-
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
C1 node types:
cache.c1.xlarge
-
-
Memory optimized:
-
Current generation:
R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward).
cache.r6g.large,cache.r6g.xlarge,cache.r6g.2xlarge,cache.r6g.4xlarge,cache.r6g.8xlarge,cache.r6g.12xlarge,cache.r6g.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlarge -
Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 node types:
cache.r3.large,cache.r3.xlarge,cache.r3.2xlarge,cache.r3.4xlarge,cache.r3.8xlarge
-
Additional node type info
-
All current generation instance types are created in Amazon VPC by default.
-
Redis append-only files (AOF) are not supported for T1 or T2 instances.
-
Redis Multi-AZ with automatic failover is not supported on T1 instances.
-
Redis configuration variables
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
sourcepub fn engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
The name of the cache engine (memcached or redis) used by the source cluster.
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
The version of the cache engine version that is used by the source cluster.
sourcepub fn num_cache_nodes(&self) -> Option<i32>
pub fn num_cache_nodes(&self) -> Option<i32>
The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
sourcepub fn preferred_availability_zone(&self) -> Option<&str>
pub fn preferred_availability_zone(&self) -> Option<&str>
The name of the Availability Zone in which the source cluster is located.
sourcepub fn preferred_outpost_arn(&self) -> Option<&str>
pub fn preferred_outpost_arn(&self) -> Option<&str>
The ARN (Amazon Resource Name) of the preferred outpost.
sourcepub fn cache_cluster_create_time(&self) -> Option<&DateTime>
pub fn cache_cluster_create_time(&self) -> Option<&DateTime>
The date and time when the source cluster was created.
sourcepub fn preferred_maintenance_window(&self) -> Option<&str>
pub fn preferred_maintenance_window(&self) -> Option<&str>
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
-
sun -
mon -
tue -
wed -
thu -
fri -
sat
Example: sun:23:00-mon:01:30
sourcepub fn topic_arn(&self) -> Option<&str>
pub fn topic_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
sourcepub fn port(&self) -> Option<i32>
pub fn port(&self) -> Option<i32>
The port number used by each cache nodes in the source cluster.
sourcepub fn cache_parameter_group_name(&self) -> Option<&str>
pub fn cache_parameter_group_name(&self) -> Option<&str>
The cache parameter group that is associated with the source cluster.
sourcepub fn cache_subnet_group_name(&self) -> Option<&str>
pub fn cache_subnet_group_name(&self) -> Option<&str>
The name of the cache subnet group associated with the source cluster.
sourcepub fn vpc_id(&self) -> Option<&str>
pub fn vpc_id(&self) -> Option<&str>
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
sourcepub fn auto_minor_version_upgrade(&self) -> bool
pub fn auto_minor_version_upgrade(&self) -> bool
If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.
sourcepub fn snapshot_retention_limit(&self) -> Option<i32>
pub fn snapshot_retention_limit(&self) -> Option<i32>
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
sourcepub fn snapshot_window(&self) -> Option<&str>
pub fn snapshot_window(&self) -> Option<&str>
The daily time range during which ElastiCache takes daily snapshots of the source cluster.
sourcepub fn num_node_groups(&self) -> Option<i32>
pub fn num_node_groups(&self) -> Option<i32>
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.
sourcepub fn automatic_failover(&self) -> Option<&AutomaticFailoverStatus>
pub fn automatic_failover(&self) -> Option<&AutomaticFailoverStatus>
Indicates the status of automatic failover for the source Redis replication group.
sourcepub fn node_snapshots(&self) -> Option<&[NodeSnapshot]>
pub fn node_snapshots(&self) -> Option<&[NodeSnapshot]>
A list of the cache nodes in the source cluster.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The ID of the KMS key used to encrypt the snapshot.
sourcepub fn data_tiering(&self) -> Option<&DataTieringStatus>
pub fn data_tiering(&self) -> Option<&DataTieringStatus>
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.