GetClusterResult

data class GetClusterResult(val aclName: String? = null, val arn: String? = null, val autoMinorVersionUpgrade: Boolean? = null, val clusterEndpoint: ClusterEndpoint? = null, val description: String? = null, val engineVersion: String? = null, val maintenanceWindow: String? = null, val nodeType: String? = null, val numReplicasPerShard: Int? = null, val numShards: Int? = null, val parameterGroupName: String? = null, val parameterGroupStatus: String? = null, val securityGroupIds: List<String>? = null, val snapshotRetentionLimit: Int? = null, val snapshotWindow: String? = null, val snsTopicArn: String? = null, val snsTopicStatus: String? = null, val status: String? = null, val tags: List<Tag>? = null)

Constructors

Link copied to clipboard
constructor(aclName: String? = null, arn: String? = null, autoMinorVersionUpgrade: Boolean? = null, clusterEndpoint: ClusterEndpoint? = null, description: String? = null, engineVersion: String? = null, maintenanceWindow: String? = null, nodeType: String? = null, numReplicasPerShard: Int? = null, numShards: Int? = null, parameterGroupName: String? = null, parameterGroupStatus: String? = null, securityGroupIds: List<String>? = null, snapshotRetentionLimit: Int? = null, snapshotWindow: String? = null, snsTopicArn: String? = null, snsTopicStatus: String? = null, status: String? = null, tags: List<Tag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val aclName: String? = null

The name of the Access Control List to associate with the cluster.

Link copied to clipboard
val arn: String? = null

The Amazon Resource Name (ARN) of the cluster.

Link copied to clipboard

A flag that enables automatic minor version upgrade when set to true. You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.

Link copied to clipboard

The cluster endpoint.

Link copied to clipboard
val description: String? = null

An optional description of the cluster.

Link copied to clipboard
val engineVersion: String? = null

The Redis engine version used by the cluster.

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
val nodeType: String? = null

The compute and memory capacity of the nodes in the cluster.

Link copied to clipboard

The number of replicas to apply to each shard. The limit is 5.

Link copied to clipboard
val numShards: Int? = null

The number of shards the cluster will contain.

Link copied to clipboard

The name of the parameter group associated with the cluster.

Link copied to clipboard

The status of the parameter group used by the cluster.

Link copied to clipboard

One or more Amazon VPC security groups associated with this cluster.

Link copied to clipboard

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.

Link copied to clipboard
val snapshotWindow: String? = null

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

Link copied to clipboard
val snsTopicArn: String? = null

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

Link copied to clipboard
val snsTopicStatus: String? = null

The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.

Link copied to clipboard
val status: String? = null

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

Link copied to clipboard
val tags: List<Tag>? = null

An array of key-value pairs to apply to this cluster.