AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DSQL::Cluster

CfnCluster

The `AWS::DSQL::Cluster` resource specifies an cluster. You can use this resource to create, modify, and manage clusters. This resource supports both single-Region clusters and multi-Region clusters through the `MultiRegionProperties` parameter. > Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters. > - The witness Region specified in `multiRegionProperties.witnessRegion` cannot be the same as the cluster's Region. *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)

Import

import { CfnCluster } from 'aws-cdk-lib/aws-dsql';

Or use the module namespace:

import * as dsql from 'aws-cdk-lib/aws-dsql';
// dsql.CfnCluster

Properties

Configuration passed to the constructor as CfnClusterProps.

deletionProtectionEnabledOptional
boolean | IResolvable

Whether deletion protection is enabled on this cluster.

kmsEncryptionKeyOptional
string

The KMS key that encrypts data on the cluster.

multiRegionPropertiesOptional
IResolvable | MultiRegionPropertiesProperty

Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.

policyDocumentOptional
string

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

tagsOptional
CfnTag[]

A map of key and value pairs this cluster is tagged with.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::DSQL::ClusterView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-dsql
CFN TypeAWS::DSQL::Cluster
Properties5

Explore This Service

External Links