AWS::DSQL::Cluster - AWS CloudFormation (original) (raw)

Creates a cluster in Amazon Aurora DSQL.

Syntax

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

JSON

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

YAML

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

Properties

DeletionProtectionEnabled

Whether deletion protection is enabled on this cluster.

Required: No

Type: Boolean

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.

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.

The AWS::DSQL::Cluster resource only creates single-Region clusters. It’s equivalent to calling CreateClusters not CreateMultiRegionClusters.

Multi-Region cluster imports are not supported.

If you attempt to import an existing multi-Region cluster into your stack of resources as an AWS::DSQL::Cluster, the changeset to import will fail.

You will return a message similar to the following Operations on multi-region cluster muabt5rq24otlvno3gqyqpcm7m are not supported, where muabt5rq24otlvno3gqyqpcm7m is the multi-Region cluster that failed to import.

Single-Region cluster imports are supported.