pulumi-aws-native-kotlin/com.pulumi.awsnative.docdbelastic.kotlin/Cluster

Cluster

class Cluster : KotlinCustomResource

The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster

Properties

adminUserName

val adminUserName: Output<String>

The name of the Amazon DocumentDB elastic clusters administrator. Constraints :

adminUserPassword

val adminUserPassword: Output<String>?

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters. Constraints :

authType

val authType: Output<String>

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN .

backupRetentionPeriod

val backupRetentionPeriod: Output<Int>?

The number of days for which automatic snapshots are retained.

clusterArn

val clusterArn: Output<String>

clusterEndpoint

val clusterEndpoint: Output<String>

The URL used to connect to the elastic cluster.

clusterName

val clusterName: Output<String>

The name of the new elastic cluster. This parameter is stored as a lowercase string. Constraints :

val id: Output<String>

kmsKeyId

val kmsKeyId: Output<String>?

The KMS key identifier to use to encrypt the new elastic cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

preferredBackupWindow

val preferredBackupWindow: Output<String>?

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

preferredMaintenanceWindow

val preferredMaintenanceWindow: Output<String>?

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format : ddd:hh24:mi-ddd:hh24:mi Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week. Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints : Minimum 30-minute window.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

shardCapacity

val shardCapacity: Output<Int>

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

shardCount

val shardCount: Output<Int>

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

shardInstanceCount

val shardInstanceCount: Output<Int>?

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.

subnetIds

val subnetIds: Output<List<String>>?

The Amazon EC2 subnet IDs for the new elastic cluster.