Menu
Amazon ElastiCache
API Reference (API Version 2015-02-02)

CacheCluster

Contains all of the attributes of a specific cache cluster.

Contents

Note

In the following list, the required parameters are described first.

AutoMinorVersionUpgrade

This parameter is currently disabled.

Type: Boolean

Required: No

CacheClusterCreateTime

The date and time when the cache cluster was created.

Type: Timestamp

Required: No

CacheClusterId

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

Type: String

Required: No

CacheClusterStatus

The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

Type: String

Required: No

CacheNodes.CacheNode.N

A list of cache nodes that are members of the cache cluster.

Type: Array of CacheNode objects

Required: No

CacheNodeType

The name of the compute and memory capacity node type for the cache 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.

Supported node types are available in all regions except as noted in the following table.

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.

Type: String

Required: No

CacheParameterGroup

Status of the cache parameter group.

Type: CacheParameterGroupStatus object

Required: No

CacheSecurityGroups.CacheSecurityGroup.N

A list of cache security group elements, composed of name and status sub-elements.

Type: Array of CacheSecurityGroupMembership objects

Required: No

CacheSubnetGroupName

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

Type: String

Required: No

ClientDownloadLandingPage

The URL of the web page where you can download the latest ElastiCache client library.

Type: String

Required: No

ConfigurationEndpoint

Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

Type: Endpoint object

Required: No

Engine

The name of the cache engine (memcached or redis) to be used for this cache cluster.

Type: String

Required: No

EngineVersion

The version of the cache engine that is used in this cache cluster.

Type: String

Required: No

NotificationConfiguration

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

Type: NotificationConfiguration object

Required: No

NumCacheNodes

The number of cache nodes in the cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Type: Integer

Required: No

PendingModifiedValues

A group of settings that are applied to the cache cluster in the future, or that are currently being applied.

Type: PendingModifiedValues object

Required: No

PreferredAvailabilityZone

The name of the Availability Zone in which the cache cluster is located or "Multiple" if the cache nodes are located in different Availability Zones.

Type: String

Required: No

PreferredMaintenanceWindow

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

Type: String

Required: No

ReplicationGroupId

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

Type: String

Required: No

SecurityGroups.member.N

A list of VPC Security Groups associated with the cache cluster.

Type: Array of SecurityGroupMembership objects

Required: No

SnapshotRetentionLimit

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Important

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

Type: Integer

Required: No

SnapshotWindow

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.

Example: 05:00-09:00

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: