ClusterArgs

data class ClusterArgs(val adminUserName: Output<String>? = null, val adminUserPassword: Output<String>? = null, val authType: Output<String>? = null, val backupRetentionPeriod: Output<Int>? = null, val clusterName: Output<String>? = null, val kmsKeyId: Output<String>? = null, val preferredBackupWindow: Output<String>? = null, val preferredMaintenanceWindow: Output<String>? = null, val shardCapacity: Output<Int>? = null, val shardCount: Output<Int>? = null, val shardInstanceCount: Output<Int>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<List<TagArgs>>? = null, val vpcSecurityGroupIds: Output<List<String>>? = null) : ConvertibleToJava<ClusterArgs>

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

Constructors

Link copied to clipboard
constructor(adminUserName: Output<String>? = null, adminUserPassword: Output<String>? = null, authType: Output<String>? = null, backupRetentionPeriod: Output<Int>? = null, clusterName: Output<String>? = null, kmsKeyId: Output<String>? = null, preferredBackupWindow: Output<String>? = null, preferredMaintenanceWindow: Output<String>? = null, shardCapacity: Output<Int>? = null, shardCount: Output<Int>? = null, shardInstanceCount: Output<Int>? = null, subnetIds: Output<List<String>>? = null, tags: Output<List<TagArgs>>? = null, vpcSecurityGroupIds: Output<List<String>>? = null)

Properties

Link copied to clipboard
val adminUserName: Output<String>? = null

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

Link copied to clipboard
val adminUserPassword: Output<String>? = null

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

Link copied to clipboard
val authType: Output<String>? = null

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 .

Link copied to clipboard
val backupRetentionPeriod: Output<Int>? = null

The number of days for which automatic snapshots are retained.

Link copied to clipboard
val clusterName: Output<String>? = null

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

Link copied to clipboard
val kmsKeyId: Output<String>? = null

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.

Link copied to clipboard
val preferredBackupWindow: Output<String>? = null

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

Link copied to clipboard
val preferredMaintenanceWindow: Output<String>? = null

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.

Link copied to clipboard
val shardCapacity: Output<Int>? = null

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
val shardCount: Output<Int>? = null

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

Link copied to clipboard
val shardInstanceCount: Output<Int>? = null

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
val subnetIds: Output<List<String>>? = null

The Amazon EC2 subnet IDs for the new elastic cluster.

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

The tags to be assigned to the new elastic cluster.

Link copied to clipboard
val vpcSecurityGroupIds: Output<List<String>>? = null

A list of EC2 VPC security groups to associate with the new elastic cluster.

Functions

Link copied to clipboard
open override fun toJava(): ClusterArgs