This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
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.
Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters.
-
The witness Region specified in
multiRegionProperties.witnessRegioncannot be the same as the cluster's Region.
Required permissions
To create a cluster, you need the following IAM permissions. Some are required only when you specify the related property.
- 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) - kms:CreateGrant
-
When specifying
KmsEncryptionKey, permission to create grants on the AWS Key Management Service (AWS KMS) key.Resources: ARN of the specified KMS key
- kms:DescribeKey
-
When specifying
KmsEncryptionKey, permission to retrieve detailed information about the KMS key.Resources: ARN of the specified KMS key
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::DSQL::Cluster", "Properties" : { "DeletionProtectionEnabled" :Boolean, "KmsEncryptionKey" :String, "MetricGroups" :[ MetricGroup, ... ], "MultiRegionProperties" :MultiRegionProperties, "PolicyDocument" :String, "Tags" :[ Tag, ... ]} }
YAML
Type: AWS::DSQL::Cluster Properties: DeletionProtectionEnabled:BooleanKmsEncryptionKey:StringMetricGroups:- MetricGroupMultiRegionProperties:MultiRegionPropertiesPolicyDocument:StringTags:- Tag
Properties
DeletionProtectionEnabled-
Whether deletion protection is enabled on this cluster.
Required: No
Type: Boolean
Update requires: No interruption
KmsEncryptionKey-
The identifier of the AWS Key Management Service (AWS KMS) key to use for encrypting the cluster. You can specify the KMS key using any of the following:
-
Key ID: A unique identifier for the key (for example,
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111) -
Key ARN: The Amazon Resource Name (ARN) of the key (for example,
arn:aws:kms:aa-example-1:111122223333:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111) -
Alias name: A display name for the key (for example,
alias/my-key) -
Alias ARN: The ARN of the key alias (for example,
arn:aws:kms:aa-example-1:111122223333:alias/my-key)
If you don't specify a value, the service uses
AWS_OWNED_KEYby default.Required: No
Type: String
Update requires: No interruption
-
MetricGroups-
The advanced monitoring metric groups to enable on the cluster.
Required: No
Type: Array of MetricGroup
Maximum:
20Update 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
PolicyDocument-
A resource-based policy document in JSON format. Length constraints: Minimum length of 1. Maximum length of 20480 characters (approximately 20KB).
Required: No
Type: String
Update requires: No interruption
-
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.
The following attributes are available for the AWS::DSQL::Cluster resource:
- EncryptionDetails
-
The encryption configuration details for the cluster.
- EncryptionStatus
-
The status of encryption for the cluster.
- EncryptionType
-
The type of encryption that protects data in the cluster.
- KmsKeyArn
-
The Amazon Resource Name (ARN) of the KMS key that encrypts data in the cluster.
CreationTime-
The time when Aurora DSQL created the cluster.
Endpoint-
The connection endpoint for the created cluster.
Identifier-
The unique identifier assigned to the cluster upon creation.
PolicyVersionProperty description not available.
ResourceArn-
The Amazon Resource Name (ARN) of the cluster.
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 configuredPENDING_DELETE—Indicates the cluster is being deletedNote: These status values only appear for multi-Region cluster operations.
VpcEndpointProperty description not available.
VpcEndpointServiceName-
The name of the virtual private cloud (VPC) endpoint service that provides access to your cluster. Use this endpoint to establish a private connection between your VPC and the cluster.
See also
See API reference for a full list of API operations to manage your resources in Aurora DSQL.
See MultiRegionProperties for the data structure used for multi-Region clusters.
See Configuring multi-Region clusters using CloudFormation to create multi-Region clusters using this CloudFormation resource.
For more information about encryption options and using customer managed KMS keys, see Data encryption for Amazon Aurora DSQL.