You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElastiCache::Types::Snapshot

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN (Amazon Resource Name) of the snapshot.

Returns:

  • (String) —

    The ARN (Amazon Resource Name) of the snapshot.

#auto_minor_version_upgrade ⇒ Boolean

This parameter is currently disabled.

Returns:

  • (Boolean) —

    This parameter is currently disabled.

#automatic_failover ⇒ String

Indicates the status of automatic failover for the source Redis replication group.

Possible values:

  • enabled
  • disabled
  • enabling
  • disabling

Returns:

  • (String) —

    Indicates the status of automatic failover for the source Redis replication group.

#cache_cluster_create_time ⇒ Time

The date and time when the source cluster was created.

Returns:

  • (Time) —

    The date and time when the source cluster was created.

#cache_cluster_id ⇒ String

The user-supplied identifier of the source cluster.

Returns:

  • (String) —

    The user-supplied identifier of the source cluster.

#cache_node_type ⇒ String

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.16xlarge

      At this time, M6g node types are available in the following regions: us-east-1, us-west-2, us-east-2, eu-central-1, eu-west-1 and ap-northeast-1.

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      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.16xlarge

      At this time, R6g node types are available in the following regions: us-east-1, us-west-2, us-east-2, eu-central-1, eu-west-1 and ap-northeast-1.

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 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 appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

Returns:

  • (String) —

    The name of the compute and memory capacity node type for the source cluster.

#cache_parameter_group_name ⇒ String

The cache parameter group that is associated with the source cluster.

Returns:

  • (String) —

    The cache parameter group that is associated with the source cluster.

#cache_subnet_group_name ⇒ String

The name of the cache subnet group associated with the source cluster.

Returns:

  • (String) —

    The name of the cache subnet group associated with the source cluster.

#engine ⇒ String

The name of the cache engine (memcached or redis) used by the source cluster.

Returns:

  • (String) —

    The name of the cache engine (memcached or redis) used by the source cluster.

#engine_version ⇒ String

The version of the cache engine version that is used by the source cluster.

Returns:

  • (String) —

    The version of the cache engine version that is used by the source cluster.

#kms_key_id ⇒ String

The ID of the KMS key used to encrypt the snapshot.

Returns:

  • (String) —

    The ID of the KMS key used to encrypt the snapshot.

#node_snapshots ⇒ Array<Types::NodeSnapshot>

A list of the cache nodes in the source cluster.

Returns:

#num_cache_nodes ⇒ Integer

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 20.

Returns:

  • (Integer) —

    The number of cache nodes in the source cluster.

#num_node_groups ⇒ Integer

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.

Returns:

  • (Integer) —

    The number of node groups (shards) in this snapshot.

#port ⇒ Integer

The port number used by each cache nodes in the source cluster.

Returns:

  • (Integer) —

    The port number used by each cache nodes in the source cluster.

#preferred_availability_zone ⇒ String

The name of the Availability Zone in which the source cluster is located.

Returns:

  • (String) —

    The name of the Availability Zone in which the source cluster is located.

#preferred_maintenance_window ⇒ String

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

Returns:

  • (String) —

    Specifies the weekly time range during which maintenance on the cluster is performed.

#preferred_outpost_arn ⇒ String

The ARN (Amazon Resource Name) of the preferred outpost.

Returns:

  • (String) —

    The ARN (Amazon Resource Name) of the preferred outpost.

#replication_group_description ⇒ String

A description of the source replication group.

Returns:

  • (String) —

    A description of the source replication group.

#replication_group_id ⇒ String

The unique identifier of the source replication group.

Returns:

  • (String) —

    The unique identifier of the source replication group.

#snapshot_name ⇒ String

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

Returns:

  • (String) —

    The name of a snapshot.

#snapshot_retention_limit ⇒ Integer

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.

Returns:

  • (Integer) —

    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

#snapshot_source ⇒ String

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

Returns:

  • (String) —

    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

#snapshot_status ⇒ String

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

Returns:

  • (String) —

    The status of the snapshot.

#snapshot_window ⇒ String

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

Returns:

  • (String) —

    The daily time range during which ElastiCache takes daily snapshots of the source cluster.

#topic_arn ⇒ String

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

#vpc_id ⇒ String

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

Returns:

  • (String) —

    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.