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

Class: Aws::ElastiCache::Types::CacheCluster

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

Overview

Contains all of the attributes of a specific cluster.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) —

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

#at_rest_encryption_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#auth_token_enabled ⇒ Boolean

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

Default: false

Returns:

  • (Boolean) —

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

#auth_token_last_modified_date ⇒ Time

The date the auth token was last modified

Returns:

  • (Time) —

    The date the auth token was last modified.

#auto_minor_version_upgrade ⇒ Boolean

This parameter is currently disabled.

Returns:

  • (Boolean) —

    This parameter is currently disabled.

#cache_cluster_create_time ⇒ Time

The date and time when the cluster was created.

Returns:

  • (Time) —

    The date and time when the cluster was created.

#cache_cluster_id ⇒ String

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

Returns:

  • (String) —

    The user-supplied identifier of the cluster.

#cache_cluster_status ⇒ 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.

Returns:

  • (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.

#cache_node_type ⇒ 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

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

#cache_nodes ⇒ Array<Types::CacheNode>

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

Returns:

  • (Array<Types::CacheNode>) —

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

#cache_parameter_group ⇒ Types::CacheParameterGroupStatus

Status of the cache parameter group.

Returns:

#cache_security_groups ⇒ Array<Types::CacheSecurityGroupMembership>

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

Returns:

#cache_subnet_group_name ⇒ String

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

Returns:

  • (String) —

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

#client_download_landing_page ⇒ String

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

Returns:

  • (String) —

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

#configuration_endpoint ⇒ Types::Endpoint

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

Returns:

  • (Types::Endpoint) —

    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.

#engine ⇒ String

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

Returns:

  • (String) —

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

#engine_version ⇒ String

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

Returns:

  • (String) —

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

#notification_configuration ⇒ Types::NotificationConfiguration

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

Returns:

#num_cache_nodes ⇒ Integer

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

Returns:

  • (Integer) —

    The number of cache nodes in the cluster.

#pending_modified_values ⇒ Types::PendingModifiedValues

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

Returns:

  • (Types::PendingModifiedValues) —

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

    .

#preferred_availability_zone ⇒ 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.

Returns:

  • (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.

#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 outpost ARN in which the cache cluster is created.

Returns:

  • (String) —

    The outpost ARN in which the cache cluster is created.

#replication_group_id ⇒ String

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

Returns:

  • (String) —

    The replication group to which this cluster belongs.

#security_groups ⇒ Array<Types::SecurityGroupMembership>

A list of VPC Security Groups associated with the cluster.

Returns:

#snapshot_retention_limit ⇒ Integer

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.

Returns:

  • (Integer) —

    The number of days for which ElastiCache retains automatic cluster snapshots before deleting them.

#snapshot_window ⇒ String

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

Example: 05:00-09:00

Returns:

  • (String) —

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

#transit_encryption_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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