CreateDBCluster

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

Constraints:

Example: my-cluster

Type: String

Required: Yes

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

Valid values: docdb

Type: String

Required: Yes

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

Type: Array of strings

Required: No

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

Default: 1

Constraints:

Type: Integer

Required: No

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

Type: String

Required: No

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

Type: String

Required: No

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.

Type: Boolean

Required: No

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.

Type: Array of strings

Required: No

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.

Type: String

Required: No

The cluster identifier of the new global cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Required: No

The AWS KMS key identifier for an encrypted cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Regions.

Type: String

Required: No

The name of the master user for the cluster.

Constraints:

Type: String

Required: No

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

Constraints: Must contain from 8 to 100 characters.

Type: String

Required: No

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

Type: Integer

Required: No

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

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

Type: String

Required: No

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is 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.

Type: String

Required: No

Not currently supported.

Type: String

Required: No

Specifies whether the cluster is encrypted.

Type: Boolean

Required: No

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard

Type: String

Required: No

The tags to be assigned to the cluster.

Type: Array of Tag objects

Required: No

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

Type: Array of strings

Required: No

Detailed information about a cluster.

Type: DBCluster object

You already have a cluster with the given identifier.

HTTP Status Code: 400

DBClusterIdentifier doesn't refer to an existing cluster.

HTTP Status Code: 404

DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

HTTP Status Code: 404

The cluster can't be created because you have reached the maximum allowed quota of clusters.

HTTP Status Code: 403

DBInstanceIdentifier doesn't refer to an existing instance.

HTTP Status Code: 404

Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

HTTP Status Code: 400

DBSubnetGroupName doesn't refer to an existing subnet group.

HTTP Status Code: 404

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

HTTP Status Code: 404

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

HTTP Status Code: 400

The cluster isn't in a valid state.

HTTP Status Code: 400

The specified instance isn't in the available state.

HTTP Status Code: 400

The subnet group can't be deleted because it's in use.

HTTP Status Code: 400

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

HTTP Status Code: 400

The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

HTTP Status Code: 400

An error occurred when accessing an AWS KMS key.

HTTP Status Code: 400

The request would cause you to exceed the allowed amount of storage available across all instances.

HTTP Status Code: 400