CreateDBCluster

    For information about the parameters that are common to all actions, see Common Parameters.

    DBClusterIdentifier

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

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example:

    Type: String

    Required: Yes

    Engine

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

    Valid values: docdb

    Type: String

    Required: Yes

    MasterUsername

    The name of the master user for the cluster.

    Constraints:

    • The first character must be a letter.

    • Cannot be a reserved word for the chosen database engine.

    Type: String

    Required: Yes

    MasterUserPassword

    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: Yes

    AvailabilityZones.AvailabilityZone.N

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

    Type: Array of strings

    Required: No

    BackupRetentionPeriod

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

    Default: 1

    Constraints:

    • Must be a value from 1 to 35.

    Type: Integer

    Required: No

    DBClusterParameterGroupName

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

    Type: String

    Required: No

    DBSubnetGroupName

    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

    DeletionProtection

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

    Type: Boolean

    Required: No

    EnableCloudwatchLogsExports.member.N

    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 and Profiling Amazon DocumentDB Operations.

    Required: No

    EngineVersion

    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

    KmsKeyId

    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:

    • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

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

    Type: String

    Required: No

    Port

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

    Type: Integer

    Required: No

    PreferredBackupWindow

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

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

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    Type: String

    Required: No

    PreferredMaintenanceWindow

    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

    PreSignedUrl

    Not currently supported.

    Type: String

    Required: No

    StorageEncrypted

    Specifies whether the cluster is encrypted.

    Type: Boolean

    Required: No

    Tags.Tag.N

    The tags to be assigned to the cluster.

    Type: Array of objects

    Required: No

    VpcSecurityGroupIds.VpcSecurityGroupId.N

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

    Type: Array of strings

    Required: No

    The following element is returned by the service.

    DBCluster

    Detailed information about a cluster.

    Type: DBCluster object

    DBClusterAlreadyExistsFault

    You already have a cluster with the given identifier.

    HTTP Status Code: 400

    DBClusterNotFoundFault

    DBClusterIdentifier doesn’t refer to an existing cluster.

    HTTP Status Code: 404

    DBClusterParameterGroupNotFound

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

    HTTP Status Code: 404

    DBClusterQuotaExceededFault

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

    HTTP Status Code: 403

    DBInstanceNotFound

    doesn’t refer to an existing instance.

    HTTP Status Code: 404

    DBSubnetGroupDoesNotCoverEnoughAZs

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

    HTTP Status Code: 400

    DBSubnetGroupNotFoundFault

    DBSubnetGroupName doesn’t refer to an existing subnet group.

    HTTP Status Code: 404

    InsufficientStorageClusterCapacity

    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

    InvalidDBClusterStateFault

    The cluster isn’t in a valid state.

    HTTP Status Code: 400

    InvalidDBInstanceState

    The specified instance isn’t in the available state.

    HTTP Status Code: 400

    InvalidDBSubnetGroupStateFault

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

    HTTP Status Code: 400

    InvalidSubnet

    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

    InvalidVPCNetworkStateFault

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

    HTTP Status Code: 400

    KMSKeyNotAccessibleFault

    An error occurred when accessing an AWS KMS key.

    HTTP Status Code: 400

    StorageQuotaExceeded

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

    HTTP Status Code: 400

    For more information about using this API in one of the language-specific AWS SDKs, see the following: