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

Instance Attribute Summary collapse

Instance Attribute Details

#at_rest_encryption_enabledBoolean

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.

Default: false

Returns:

  • (Boolean)

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

#auth_token_enabledBoolean

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.

#auto_minor_version_upgradeBoolean

This parameter is currently disabled.

Returns:

  • (Boolean)

    This parameter is currently disabled.

#cache_cluster_create_timeTime

The date and time when the cluster was created.

Returns:

  • (Time)

    The date and time when the cluster was created.

#cache_cluster_idString

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_statusString

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_typeString

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:

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

#cache_nodesArray<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_groupTypes::CacheParameterGroupStatus

Status of the cache parameter group.

Returns:

#cache_security_groupsArray<Types::CacheSecurityGroupMembership>

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

Returns:

#cache_subnet_group_nameString

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_pageString

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_endpointTypes::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.

#engineString

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_versionString

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_configurationTypes::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_nodesInteger

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_valuesTypes::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_zoneString

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_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_idString

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_groupsArray<Types::SecurityGroupMembership>

A list of VPC Security Groups associated with the cluster.

Returns:

#snapshot_retention_limitInteger

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_windowString

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_enabledBoolean

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.

Default: false

Returns:

  • (Boolean)

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