Builder

class Builder

Properties

Link copied to clipboard

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Link copied to clipboard

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Link copied to clipboard

The cluster identifier. This parameter is stored as a lowercase string.

Link copied to clipboard

The name of the cluster parameter group to associate with this cluster.

Link copied to clipboard

A subnet group to associate with this cluster.

Link copied to clipboard

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

Link copied to clipboard

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

Link copied to clipboard

The name of the database engine to be used for this cluster.

Link copied to clipboard

The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

Link copied to clipboard

The cluster identifier of the new global cluster.

Link copied to clipboard

The KMS key identifier for an encrypted cluster.

Link copied to clipboard

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

Link copied to clipboard

The name of the master user for the cluster.

Link copied to clipboard

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Link copied to clipboard

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.

Link copied to clipboard
var port: Int?

The port number on which the instances in the cluster accept connections.

Link copied to clipboard

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

Link copied to clipboard

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

Link copied to clipboard

Not currently supported.

Link copied to clipboard

Specifies whether the cluster is encrypted.

Link copied to clipboard

The storage type to associate with the DB cluster.

Link copied to clipboard
var tags: List<Tag>?

The tags to be assigned to the cluster.

Link copied to clipboard

A list of EC2 VPC security groups to associate with this cluster.