Syntax Properties Return values See also

AWS::DSQL::Cluster

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.

Note

Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters.

Important

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)

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::DSQL::Cluster",
  "Properties" : {
      "DeletionProtectionEnabled" : Boolean,
      "MultiRegionProperties" : MultiRegionProperties,
      "Tags" : [ Tag, ... ]
    }
}

YAML


Type: AWS::DSQL::Cluster
Properties:
  DeletionProtectionEnabled: Boolean
  MultiRegionProperties: 
    MultiRegionProperties
  Tags: 
    - Tag

Properties

DeletionProtectionEnabled

Whether deletion protection is enabled on this cluster.

Required: No

Type: Boolean

Update requires: No interruption

MultiRegionProperties

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

Required: No

Type: MultiRegionProperties

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the cluster identifier.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreationTime

The timestamp when the cluster was created, in ISO 8601 format.

Identifier

The unique identifier assigned to the cluster upon creation.

ResourceArn

The Amazon Resource Name (ARN) of the cluster. Used for IAM permissions and resource identification.

Status

The current status of the cluster. Possible values include: CREATING, ACTIVE, DELETING, FAILED.

The cluster can have two additional status values when working with multi-Region clusters:

PENDING_SETUP—Indicates the cluster is being configured

PENDING_DELETE—Indicates the cluster is being deleted

Note: These status values only appear for multi-Region cluster operations.

VpcEndpointServiceName

The VPC Endpoint Service name for the cluster. This can be used to create a VPC endpoint to connect to the cluster from within a VPC.