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:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgradeBoolean

This parameter is currently disabled.

Returns:

  • (Boolean)

    This parameter is currently disabled.

#automatic_failoverString

Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 and T2 cache node types.

  • Redis (cluster mode enabled): T1 node types.

    Possible values:

    • enabled
    • disabled
    • enabling
    • disabling

Returns:

  • (String)

    Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.

#cache_cluster_create_timeTime

The date and time when the source cluster was created.

Returns:

  • (Time)

    The date and time when the source cluster was created.

#cache_cluster_idString

The user-supplied identifier of the source cluster.

Returns:

  • (String)

    The user-supplied identifier of the source cluster.

#cache_node_typeString

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:

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

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

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

    • 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

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: (not recommended)

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

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.

  • Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

Returns:

  • (String)

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

#cache_parameter_group_nameString

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_nameString

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.

#engineString

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_versionString

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.

#node_snapshotsArray<Types::NodeSnapshot>

A list of the cache nodes in the source cluster.

Returns:

#num_cache_nodesInteger

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_groupsInteger

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.

#portInteger

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_zoneString

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_windowString

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.

#replication_group_descriptionString

A description of the source replication group.

Returns:

  • (String)

    A description of the source replication group.

#replication_group_idString

The unique identifier of the source replication group.

Returns:

  • (String)

    The unique identifier of the source replication group.

#snapshot_nameString

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_limitInteger

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_sourceString

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_statusString

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

Returns:

  • (String)

    The status of the snapshot.

#snapshot_windowString

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_arnString

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_idString

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.