CacheCluster

Contains all of the attributes of a specific cluster.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String?

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The date the auth token was last modified

Link copied to clipboard

If you are running Valkey or Redis OSS 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.

Link copied to clipboard

The date and time when the cluster was created.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Status of the cache parameter group.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns the destination, format and type of the logs.

Link copied to clipboard

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 7.1 or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

Link copied to clipboard

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

Link copied to clipboard

The number of cache nodes in the cluster.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The outpost ARN in which the cache cluster is created.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A list of VPC Security Groups associated with the cluster.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

Functions

Link copied to clipboard
inline fun copy(block: CacheCluster.Builder.() -> Unit = {}): CacheCluster
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String