CreateDBCluster - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateDBCluster

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Request Parameters

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

AllocatedStorage

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

This setting is required to create a Multi-AZ DB cluster.

Valid for: Multi-AZ DB clusters only

Type: Integer

Required: No

AutoMinorVersionUpgrade

A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.

Valid for: Multi-AZ DB clusters only

Type: Boolean

Required: No

AvailabilityZones.AvailabilityZone.N

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Type: Array of strings

Required: No

BacktrackWindow

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

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

Type: Long

Required: No

BackupRetentionPeriod

The number of days for which automated backups are retained.

Default: 1

Constraints:

  • Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Integer

Required: No

CharacterSetName

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

Valid for: Aurora DB clusters only

Type: String

Required: No

CopyTagsToSnapshot

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Boolean

Required: No

DatabaseName

The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

DBClusterIdentifier

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

Constraints:

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

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: Yes

DBClusterInstanceClass

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.

For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.

This setting is required to create a Multi-AZ DB cluster.

Valid for: Multi-AZ DB clusters only

Type: String

Required: No

DBClusterParameterGroupName

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

Constraints:

  • If supplied, must match the name of an existing DB cluster parameter group.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

DBSubnetGroupName

A DB subnet group to associate with this DB cluster.

This setting is required to create a Multi-AZ DB cluster.

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

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

DeletionProtection

A value that indicates 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Boolean

Required: No

Domain

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

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

For more information, see Kerberos authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Type: String

Required: No

DomainIAMRoleName

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

Type: String

Required: No

EnableCloudwatchLogsExports.member.N

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Array of strings

Required: No

EnableGlobalWriteForwarding

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

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Valid for: Aurora DB clusters only

Type: Boolean

Required: No

EnableHttpEndpoint

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Type: Boolean

Required: No

EnableIAMDatabaseAuthentication

A value that indicates whether to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Type: Boolean

Required: No

EnablePerformanceInsights

A value that indicates whether to turn on Performance Insights for the DB cluster.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

Type: Boolean

Required: No

Engine

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

Valid Values:

  • aurora (for MySQL 5.6-compatible Aurora)

  • aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

  • aurora-postgresql

  • mysql

  • postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: Yes

EngineMode

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

The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.

The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.

The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.

Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:

Valid for: Aurora DB clusters only

Type: String

Required: No

EngineVersion

The version number of the database engine to use.

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

For information, see MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.

Aurora PostgreSQL

For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

MySQL

For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

GlobalClusterIdentifier

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

Valid for: Aurora DB clusters only

Type: String

Required: No

Iops

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

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

This setting is required to create a Multi-AZ DB cluster.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

Valid for: Multi-AZ DB clusters only

Type: Integer

Required: No

KmsKeyId

The Amazon KMS key identifier for an encrypted DB cluster.

The Amazon KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

When a KMS key isn't specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.

  • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

MasterUsername

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

MasterUserPassword

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

MonitoringInterval

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

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Valid for: Multi-AZ DB clusters only

Type: Integer

Required: No

MonitoringRoleArn

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.

If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.

Valid for: Multi-AZ DB clusters only

Type: String

Required: No

NetworkType

The network type of the DB cluster.

Valid values:

  • IPV4

  • DUAL

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Type: String

Required: No

OptionGroupName

A value that indicates that the DB cluster should be associated with the specified option group.

DB clusters are associated with a default option group that can't be modified.

Type: String

Required: No

PerformanceInsightsKMSKeyId

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

The Amazon KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you don't specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Valid for: Multi-AZ DB clusters only

Type: String

Required: No

PerformanceInsightsRetentionPeriod

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

  • 7

  • month * 31, where month is a number of months from 1-23

  • 731

For example, the following values are valid:

  • 93 (3 months * 31)

  • 341 (11 months * 31)

  • 589 (19 months * 31)

  • 731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

Valid for: Multi-AZ DB clusters only

Type: Integer

Required: No

Port

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

RDS for MySQL and Aurora MySQL

Default: 3306

Valid values: 1150-65535

RDS for PostgreSQL and Aurora PostgreSQL

Default: 5432

Valid values: 1150-65535

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Integer

Required: No

PreferredBackupWindow

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 Amazon Web Services Region. To view the time blocks available, see Backup window in the Amazon Aurora User Guide.

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.

  • Must be at least 30 minutes.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

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 Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: String

Required: No

PreSignedUrl

When you are replicating a DB cluster from one Amazon 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.

The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.

The presigned URL request must contain the following parameter values:

  • KmsKeyId - The Amazon KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

  • DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.

  • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Signature Version 4) and Signature Version 4 Signing Process.

Note

If you are using an Amazon SDK tool or the Amazon CLI, you can specify SourceRegion (or --source-region for the Amazon CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

Valid for: Aurora DB clusters only

Type: String

Required: No

PubliclyAccessible

A value that indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

  • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Multi-AZ DB clusters only

Type: Boolean

Required: No

ReplicationSourceIdentifier

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

Valid for: Aurora DB clusters only

Type: String

Required: No

ScalingConfiguration

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

Valid for: Aurora DB clusters only

Type: ScalingConfiguration object

Required: No

ServerlessV2ScalingConfiguration

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

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

Type: ServerlessV2ScalingConfiguration object

Required: No

StorageEncrypted

A value that indicates whether the DB cluster is encrypted.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Boolean

Required: No

StorageType

Specifies the storage type to be associated with the DB cluster.

This setting is required to create a Multi-AZ DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Multi-AZ DB clusters only

Type: String

Required: No

Tags.Tag.N

Tags to assign to the DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Array of Tag objects

Required: No

VpcSecurityGroupIds.VpcSecurityGroupId.N

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

DBCluster

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Type: DBCluster object

Errors

For information about the errors that are common to all actions, see Common Errors.

DBClusterAlreadyExistsFault

The user already has a DB cluster with the given identifier.

HTTP Status Code: 400

DBClusterNotFoundFault

DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404

DBClusterParameterGroupNotFound

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

HTTP Status Code: 404

DBClusterQuotaExceededFault

The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

HTTP Status Code: 403

DBInstanceNotFound

DBInstanceIdentifier doesn't refer to an existing DB instance.

HTTP Status Code: 404

DBSubnetGroupDoesNotCoverEnoughAZs

Subnets in the DB 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 DB subnet group.

HTTP Status Code: 404

DomainNotFoundFault

Domain doesn't refer to an existing Active Directory domain.

HTTP Status Code: 404

GlobalClusterNotFoundFault

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

HTTP Status Code: 404

InsufficientStorageClusterCapacity

There is insufficient 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 requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

InvalidDBInstanceState

The DB instance isn't in a valid state.

HTTP Status Code: 400

InvalidDBSubnetGroupStateFault

The DB subnet group cannot be deleted because it's in use.

HTTP Status Code: 400

InvalidGlobalClusterStateFault

The global cluster is in an invalid state and can't perform the requested operation.

HTTP Status Code: 400

InvalidSubnet

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

HTTP Status Code: 400

InvalidVPCNetworkStateFault

The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

An error occurred accessing an Amazon KMS key.

HTTP Status Code: 400

StorageQuotaExceeded

The request would result in the user exceeding the allowed amount of storage available across all DB instances.

HTTP Status Code: 400

Examples

Creating an Aurora DB cluster

This example illustrates one usage of CreateDBCluster.

Sample Request

https://rds.us-east-1.amazonaws.com/ ?Action=CreateDBCluster &DBClusterIdentifier=sample-cluster &Engine=aurora &MasterUserPassword=<password> &MasterUsername=myawsuser &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20150927/us-east-1/rds/aws4_request &X-Amz-Date=20150927T164851Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=6a8f4bd6a98f649c75ea04a6b3929ecc75ac09739588391cd7250f5280e716db

Sample Response

<CreateDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <CreateDBClusterResult> <DBCluster> <Port>3306</Port> <Engine>aurora</Engine> <Status>creating</Status> <BackupRetentionPeriod>1</BackupRetentionPeriod> <VpcSecurityGroups> <VpcSecurityGroupMembership> <Status>active</Status> <VpcSecurityGroupId>sg-2103dc23</VpcSecurityGroupId> </VpcSecurityGroupMembership> </VpcSecurityGroups> <DBSubnetGroup>default</DBSubnetGroup> <EngineVersion>5.6.10a</EngineVersion> <Endpoint>sample-cluster.cluster-ctrayan0rynq.us-east-1.rds.amazonaws.com</Endpoint> <DBClusterParameterGroup>default.aurora5.6</DBClusterParameterGroup> <AvailabilityZones> <AvailabilityZone>us-east-1a</AvailabilityZone> <AvailabilityZone>us-east-1c</AvailabilityZone> <AvailabilityZone>us-east-1e</AvailabilityZone> </AvailabilityZones> <DBClusterIdentifier>sample-cluster</DBClusterIdentifier> <PreferredBackupWindow>04:22-04:52</PreferredBackupWindow> <PreferredMaintenanceWindow>fri:06:44-fri:07:14</PreferredMaintenanceWindow> <DBClusterMembers/> <AllocatedStorage>1</AllocatedStorage> <MasterUsername>myawsuser</MasterUsername> </DBCluster> </CreateDBClusterResult> <ResponseMetadata> <RequestId>46d2b228-7681-11e5-3e8b-9b2c0d5d51a9</RequestId> </ResponseMetadata> </CreateDBClusterResponse>

Creating a Multi-AZ DB cluster

This example illustrates one usage of CreateDBCluster.

Sample Request

https://rds.us-west-2.amazonaws.com/ ?Action=CreateDBCluster &AvailabilityZones.AvailabilityZone.1=us-west-2a &BackupRetentionPeriod=2 &DatabaseName=mydb &DBClusterIdentifier=my-multi-az-cluster &DBClusterParameterGroupName=my-multi-az-cpg &VpcSecurityGroupIds.VpcSecurityGroupId.1=sg-6921cc28 &DBSubnetGroupName=mysubnet1 &Engine=mysql &EngineVersion=8.0.26 &Port=3306 &MasterUsername=admin &MasterUserPassword=<password> &PreferredBackupWindow=11:34-12:04 &PreferredMaintenanceWindow=sat:07:05-sat:07:35 &StorageEncrypted=true &KmsKeyId=123EXAMPLE-abcd-4567-efgEXAMPLE &EngineMode=provisioned &DeletionProtection=false &EnableHttpEndpoint=false &CopyTagsToSnapshot=true &DBClusterInstanceClass=db.r6gd.large &AllocatedStorage=100 &StorageType=io1 &Iops=1000 &PubliclyAccessible=true &AutoMinorVersionUpgrade=true &MonitoringInterval=30 &MonitoringRoleArn=arn:aws:iam:123456789012:role/enhance-monitoring-role &EnablePerformanceInsights=true &PerformanceInsightsKMSKeyId=123EXAMPLE-abcd-4567-efgEXAMPLE &PerformanceInsightsRetentionPeriod=7 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20211026/us-west-2/rds/aws4_request &X-Amz-Date=20211026T203712Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=6a8f4bd6a98f649c75ea04a6b3929ecc75ac09739588391cd7250f5280e716db

Sample Response

<CreateDBClusterResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <CreateDBClusterResult> <DBCluster> <CrossAccountClone>false</CrossAccountClone> <AllocatedStorage>100</AllocatedStorage> <DatabaseName>mydb</DatabaseName> <AssociatedRoles /> <AvailabilityZones> <AvailabilityZone>us-west-2a</AvailabilityZone> <AvailabilityZone>us-west-2b</AvailabilityZone> <AvailabilityZone>us-west-2c</AvailabilityZone> </AvailabilityZones> <ReadReplicaIdentifiers /> <Iops>1000</Iops> <PerformanceInsightsKMSKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</PerformanceInsightsKMSKeyId> <PerformanceInsightsRetentionPeriod>7</PerformanceInsightsRetentionPeriod> <EngineVersion>8.0.26</EngineVersion> <MasterUsername>admin</MasterUsername> <DBClusterMembers> <DBClusterMember> <DBInstanceIdentifier>my-multi-az-cluster-3</DBInstanceIdentifier> <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> <PromotionTier>1</PromotionTier> <IsClusterWriter>false</IsClusterWriter> </DBClusterMember> <DBClusterMember> <DBInstanceIdentifier>my-multi-az-cluster-instance-2</DBInstanceIdentifier> <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> <PromotionTier>1</PromotionTier> <IsClusterWriter>false</IsClusterWriter> </DBClusterMember> <DBClusterMember> <DBInstanceIdentifier>my-multi-az-cluster-instance-1</DBInstanceIdentifier> <DBClusterParameterGroupStatus>in-sync</DBClusterParameterGroupStatus> <PromotionTier>1</PromotionTier> <IsClusterWriter>false</IsClusterWriter> </DBClusterMember> </DBClusterMembers> <HttpEndpointEnabled>false</HttpEndpointEnabled> <Port>3306</Port> <MonitoringInterval>30</MonitoringInterval> <BackupRetentionPeriod>2</BackupRetentionPeriod> <KmsKeyId>arn:aws:kms:us-west-2:123456789012:key/123EXAMPLE-abcd-4567-efgEXAMPLE</KmsKeyId> <DBClusterIdentifier>my-multi-az-cluster</DBClusterIdentifier> <DbClusterResourceId>cluster-RCPGZXFNIHCTBQLDRJX6CP62VQ</DbClusterResourceId> <Status>creating</Status> <PreferredBackupWindow>11:34-12:04</PreferredBackupWindow> <DeletionProtection>false</DeletionProtection> <Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</Endpoint> <EngineMode>provisioned</EngineMode> <Engine>mysql</Engine> <ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint> <PubliclyAccessible>true</PubliclyAccessible> <IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled> <ClusterCreateTime>2021-10-20T00:12:00.867Z</ClusterCreateTime> <PerformanceInsightsEnabled>true</PerformanceInsightsEnabled> <MultiAZ>true</MultiAZ> <DomainMemberships /> <MonitoringRoleArn>arn:aws:iam::123456789012:role/enhance-monitoring-role</MonitoringRoleArn> <StorageEncrypted>true</StorageEncrypted> <DBSubnetGroup>mysubnet1</DBSubnetGroup> <VpcSecurityGroups> <VpcSecurityGroupMembership> <VpcSecurityGroupId>sg-6921cc28</VpcSecurityGroupId> <Status>active</Status> </VpcSecurityGroupMembership> </VpcSecurityGroups> <TagList /> <HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId> <PreferredMaintenanceWindow>sat:07:05-sat:07:35</PreferredMaintenanceWindow> <DBClusterParameterGroup>my-multi-az-cpg</DBClusterParameterGroup> <StorageType>io1</StorageType> <DBClusterInstanceClass>db.r6gd.large</DBClusterInstanceClass> <CopyTagsToSnapshot>false</CopyTagsToSnapshot> <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> <DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</DBClusterArn> </DBCluster> </CreateDBClusterResult> <ResponseMetadata> <RequestId>4c11cdec-1dbb-452c-bfc0-7580e4ba91ce</RequestId> </ResponseMetadata> </CreateDBClusterResponse>

See Also

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