Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CacheCluster

Contains all of the attributes of a specific cluster.

Hierarchy

  • CacheCluster

Index

Properties

Optional ARN

ARN: undefined | string

The ARN (Amazon Resource Name) of the cache cluster.

Optional AtRestEncryptionEnabled

AtRestEncryptionEnabled: undefined | false | true

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

Optional AuthTokenEnabled

AuthTokenEnabled: undefined | false | true

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

Optional AuthTokenLastModifiedDate

AuthTokenLastModifiedDate: Date

The date the auth token was last modified

Optional AutoMinorVersionUpgrade

AutoMinorVersionUpgrade: undefined | false | true

 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.

Optional CacheClusterCreateTime

CacheClusterCreateTime: Date

The date and time when the cluster was created.

Optional CacheClusterId

CacheClusterId: undefined | string

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

Optional CacheClusterStatus

CacheClusterStatus: undefined | string

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

Optional CacheNodeType

CacheNodeType: undefined | string

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

      For 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.24xlarge

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

      T4g 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.medium

      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. Existing clusters are still supported but creation of new clusters is not supported for these types.)

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

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

Optional CacheNodes

CacheNodes: CacheNode[]

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

Optional CacheParameterGroup

CacheParameterGroup: CacheParameterGroupStatus

Status of the cache parameter group.

Optional CacheSecurityGroups

CacheSecurityGroups: CacheSecurityGroupMembership[]

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

Optional CacheSubnetGroupName

CacheSubnetGroupName: undefined | string

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

Optional ClientDownloadLandingPage

ClientDownloadLandingPage: undefined | string

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

Optional ConfigurationEndpoint

ConfigurationEndpoint: Endpoint

Represents a Memcached cluster endpoint which 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

Optional Engine

Engine: undefined | string

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

Optional EngineVersion

EngineVersion: undefined | string

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

Optional IpDiscovery

IpDiscovery: IpDiscovery | string

The network type associated with the cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

Optional LogDeliveryConfigurations

LogDeliveryConfigurations: LogDeliveryConfiguration[]

Returns the destination, format and type of the logs.

Optional NetworkType

NetworkType: NetworkType | string

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

Optional NotificationConfiguration

NotificationConfiguration: NotificationConfiguration

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

Optional NumCacheNodes

NumCacheNodes: undefined | number

The number of cache nodes in the cluster.

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

Optional PendingModifiedValues

PendingModifiedValues: PendingModifiedValues

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

Optional PreferredAvailabilityZone

PreferredAvailabilityZone: undefined | string

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

Optional PreferredMaintenanceWindow

PreferredMaintenanceWindow: undefined | 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

Optional PreferredOutpostArn

PreferredOutpostArn: undefined | string

The outpost ARN in which the cache cluster is created.

Optional ReplicationGroupId

ReplicationGroupId: undefined | string

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

Optional ReplicationGroupLogDeliveryEnabled

ReplicationGroupLogDeliveryEnabled: undefined | false | true

A boolean value indicating whether log delivery is enabled for the replication group.

Optional SecurityGroups

SecurityGroups: SecurityGroupMembership[]

A list of VPC Security Groups associated with the cluster.

Optional SnapshotRetentionLimit

SnapshotRetentionLimit: undefined | number

The number of days for which ElastiCache retains automatic 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.

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

Optional SnapshotWindow

SnapshotWindow: undefined | string

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

Example: 05:00-09:00

Optional TransitEncryptionEnabled

TransitEncryptionEnabled: undefined | false | true

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false