Documentation

Contains all of the attributes of a specific cluster.

See: newCluster smart constructor.

Create a value of Cluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aCLName:Cluster', cluster_aCLName - The name of the Access Control List associated with this cluster.

$sel:arn:Cluster', cluster_arn - The Amazon Resource Name (ARN) of the cluster.

$sel:autoMinorVersionUpgrade:Cluster', cluster_autoMinorVersionUpgrade - When set to true, the cluster will automatically receive minor engine version upgrades after launch.

$sel:availabilityMode:Cluster', cluster_availabilityMode - Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

$sel:clusterEndpoint:Cluster', cluster_clusterEndpoint - The cluster's configuration endpoint

$sel:dataTiering:Cluster', cluster_dataTiering - Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

$sel:description:Cluster', cluster_description - A description of the cluster

$sel:enginePatchVersion:Cluster', cluster_enginePatchVersion - The Redis engine patch version used by the cluster

$sel:engineVersion:Cluster', cluster_engineVersion - The Redis engine version used by the cluster

$sel:kmsKeyId:Cluster', cluster_kmsKeyId - The ID of the KMS key used to encrypt the cluster

$sel:maintenanceWindow:Cluster', cluster_maintenanceWindow - 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.

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

$sel:nodeType:Cluster', cluster_nodeType - The cluster's node type

$sel:numberOfShards:Cluster', cluster_numberOfShards - The number of shards in the cluster

$sel:parameterGroupName:Cluster', cluster_parameterGroupName - The name of the parameter group used by the cluster

$sel:parameterGroupStatus:Cluster', cluster_parameterGroupStatus - The status of the parameter group used by the cluster, for example 'active' or 'applying'.

$sel:pendingUpdates:Cluster', cluster_pendingUpdates - A group of settings that are currently being applied.

$sel:securityGroups:Cluster', cluster_securityGroups - A list of security groups used by the cluster

$sel:shards:Cluster', cluster_shards - A list of shards that are members of the cluster.

$sel:snapshotRetentionLimit:Cluster', cluster_snapshotRetentionLimit - The number of days for which MemoryDB retains automatic 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.

$sel:snapshotWindow:Cluster', cluster_snapshotWindow - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

$sel:snsTopicArn:Cluster', cluster_snsTopicArn - The Amazon Resource Name (ARN) of the SNS notification topic

$sel:snsTopicStatus:Cluster', cluster_snsTopicStatus - The SNS topic must be in Active status to receive notifications

Cluster, cluster_status - The status of the cluster. For example, Available, Updating, Creating.

$sel:subnetGroupName:Cluster', cluster_subnetGroupName - The name of the subnet group used by the cluster

$sel:tLSEnabled:Cluster', cluster_tLSEnabled - A flag to indicate if In-transit encryption is enabled

The name of the Access Control List associated with this cluster.

The Amazon Resource Name (ARN) of the cluster.

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

The cluster's configuration endpoint

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

A description of the cluster

The Redis engine patch version used by the cluster

The Redis engine version used by the cluster

The ID of the KMS key used to encrypt the cluster

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.

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

The cluster's node type

The number of shards in the cluster

The name of the parameter group used by the cluster

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

A group of settings that are currently being applied.

A list of security groups used by the cluster

A list of shards that are members of the cluster.

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

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

The Amazon Resource Name (ARN) of the SNS notification topic

The SNS topic must be in Active status to receive notifications

The status of the cluster. For example, Available, Updating, Creating.

The name of the subnet group used by the cluster

A flag to indicate if In-transit encryption is enabled