CreateDbClusterRequest

Types

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

Properties

Link copied to clipboard

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

Link copied to clipboard

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

Link copied to clipboard

A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.

Link copied to clipboard

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Link copied to clipboard

The number of days for which automated backups are retained.

Link copied to clipboard

The CA certificate identifier to use for the DB cluster's server certificate.

Link copied to clipboard

The name of the character set (CharacterSet) to associate the DB cluster with.

Link copied to clipboard

Specifies the scalability mode of the Aurora DB cluster. When set to limitless, the cluster operates as an Aurora Limitless Database. When set to standard (the default), the cluster uses normal DB instance creation.

Link copied to clipboard

Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Link copied to clipboard

The mode of Database Insights to enable for the DB cluster.

Link copied to clipboard

The name for your database of up to 64 alphanumeric characters. A database named postgres is always created. If this parameter is specified, an additional database with this name is created.

Link copied to clipboard

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

Link copied to clipboard

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

Link copied to clipboard

The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

Link copied to clipboard

A DB subnet group to associate with this DB cluster.

Link copied to clipboard

Reserved for future use.

Link copied to clipboard

Specifies whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

Link copied to clipboard

The Active Directory directory ID to create the DB cluster in.

Link copied to clipboard

The name of the IAM role to use when making API calls to the Directory Service.

Link copied to clipboard

The list of log types that need to be enabled for exporting to CloudWatch Logs.

Link copied to clipboard

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

Link copied to clipboard

Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.

Link copied to clipboard

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

Link copied to clipboard

Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.

Link copied to clipboard

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

Link copied to clipboard

Specifies whether to turn on Performance Insights for the DB cluster.

Link copied to clipboard

The database engine to use for this DB cluster.

Link copied to clipboard

The life cycle type for this DB cluster.

Link copied to clipboard

The DB engine mode of the DB cluster, either provisioned or serverless.

Link copied to clipboard

The version number of the database engine to use.

Link copied to clipboard

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Link copied to clipboard
val iops: Int?

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

Link copied to clipboard

The Amazon Web Services KMS key identifier for an encrypted DB 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 DB cluster.

Link copied to clipboard

The password for the master database user.

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.

Link copied to clipboard

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0.

Link copied to clipboard

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide.

Link copied to clipboard

The network type of the DB cluster.

Link copied to clipboard

The option group to associate the DB cluster with.

Link copied to clipboard

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

Link copied to clipboard

The number of days to retain Performance Insights data.

Link copied to clipboard
val port: Int?

The port number on which the instances in the DB 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.

Link copied to clipboard

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

Link copied to clipboard

Specifies whether the DB cluster is publicly accessible.

Link copied to clipboard
Link copied to clipboard

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Link copied to clipboard

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Link copied to clipboard

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

Link copied to clipboard

Specifies whether the DB cluster is encrypted.

Link copied to clipboard

The storage type to associate with the DB cluster.

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

Tags to assign to the DB cluster.

Link copied to clipboard

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

Functions

Link copied to clipboard
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