docdbelastic/aws.sdk.kotlin.services.docdbelastic.model/Cluster

Cluster

class Cluster

Returns information about a specific Elastic DocumentDB cluster.

Types

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

Properties

Link copied to clipboard
val adminUserName: String

The name of the Elastic DocumentDB cluster administrator.

Link copied to clipboard
val authType: Auth

The authentication type for the Elastic DocumentDB cluster.

Link copied to clipboard
val clusterArn: String

The arn of the Elastic DocumentDB cluster.

Link copied to clipboard
val clusterEndpoint: String

The URL used to connect to the Elastic DocumentDB cluster.

Link copied to clipboard
val clusterName: String

The name of the Elastic DocumentDB cluster.

Link copied to clipboard
val createTime: String

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

Link copied to clipboard
val kmsKeyId: String

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

Link copied to clipboard
val preferredMaintenanceWindow: String

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

Link copied to clipboard
val shardCapacity: Int

The capacity of each shard in the Elastic DocumentDB cluster.

Link copied to clipboard
val shardCount: Int

The number of shards in the Elastic DocumentDB cluster.

Link copied to clipboard
val status: Status

The status of the Elastic DocumentDB cluster.

Link copied to clipboard
val subnetIds: List<String>

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

Link copied to clipboard
val vpcSecurityGroupIds: List<String>

A list of EC2 VPC security groups associated with this 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