Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14168671.3 KB

The CreateCluster API allows you to create both single-Region clusters and multi-Region clusters. With the addition of the multiRegionProperties parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.

Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the Required permissions section below.

Required permissions

dsql:CreateCluster

Required to create a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:TagResource

Permission to add tags to a resource.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:AddPeerCluster

When specifying multiRegionProperties.clusters, permission to add peer clusters.

Resources:

  • Local cluster: arn:aws:dsql:region:account-id:cluster/*

  • Each peer cluster: exact ARN of each specified peer cluster

dsql:PutWitnessRegion

When specifying multiRegionProperties.witnessRegion, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/*

Condition Keys: dsql:WitnessRegion (matching the specified witness region)

  • The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.
post/cluster

Request body

deletionProtectionEnabledboolean

Indicates whether deletion protection is enabled for a cluster.

kmsEncryptionKeystring

The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.

tagsobject

Map of tags.

clientTokenstring

Idempotency token so a request is only processed once.

policystring

A resource-based policy document in JSON format. Length constraints: Minimum length of 1. Maximum length of 20480 characters (approximately 20KB).

bypassPolicyLockoutSafetyCheckboolean

An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.

Response

Success

identifierstring required

The ID of the created cluster.

arnstring required

The ARN of the created cluster.

status'CREATING' | 'ACTIVE' | 'IDLE' | 'INACTIVE' | 'UPDATING' | 'DELETING' | 'DELETED' | 'FAILED' | 'PENDING_SETUP' | 'PENDING_DELETE' required

The status of the created cluster.

creationTimestring date-time required

The time of when created the cluster.

deletionProtectionEnabledboolean required

Whether deletion protection is enabled on this cluster.

endpointstring

The connection endpoint for the created cluster.