Cluster

class Cluster

Returns information about a specific elastic cluster.

Types

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

Properties

Link copied to clipboard

The name of the elastic cluster administrator.

Link copied to clipboard

The authentication type for the elastic cluster.

Link copied to clipboard

The number of days for which automatic snapshots are retained.

Link copied to clipboard

The ARN identifier of the elastic cluster.

Link copied to clipboard

The URL used to connect to the elastic cluster.

Link copied to clipboard

The name of the elastic cluster.

Link copied to clipboard

The time when the elastic cluster was created in Universal Coordinated Time (UTC).

Link copied to clipboard

The KMS key identifier to use to encrypt the elastic cluster.

Link copied to clipboard

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

Link copied to clipboard

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Link copied to clipboard

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Link copied to clipboard

The number of shards assigned to the elastic cluster. Maximum is 32.

Link copied to clipboard

The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Link copied to clipboard

The total number of shards in the cluster.

Link copied to clipboard

The status of the elastic cluster.

Link copied to clipboard

The Amazon EC2 subnet IDs for the elastic cluster.

Link copied to clipboard

A list of EC2 VPC security groups associated with thie elastic cluster.

Functions

Link copied to clipboard
inline fun copy(block: Cluster.Builder.() -> Unit = {}): Cluster
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