AWS::DSQL::Cluster

DSQL Cluster

Resource Type definition for AWS::DSQL::Cluster

Properties

5 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`DeletionProtectionEnabled`	`boolean`
`KmsEncryptionKey`	`string`	Write-only
`MultiRegionProperties`	`object`
`PolicyDocument`	`string`
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreationTime`	`string`	The time of when the cluster was created in ISO-8601 format.
`EncryptionDetails`	`object`	The encryption configuration details for the cluster.
`Endpoint`	`string`	The DSQL cluster endpoint.
`Identifier`	`string`	The ID of the created cluster.
`PolicyVersion`	`string`	The version number of the cluster's resource based policy
`ResourceArn`	`string`	The Amazon Resource Name (ARN) for the cluster.
`Status`	`string`	The status of the cluster.
`VpcEndpoint`	`string`	The DSQL cluster VPC endpoint.
`VpcEndpointServiceName`	`string`	The VPC endpoint service name.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DSQL::Cluster

Resources:
  MyResource:
    Type: AWS::DSQL::Cluster
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

dsql:CreateClusterdsql:UpdateClusterdsql:GetClusterdsql:GetClusterPolicydsql:TagResourcedsql:GetVpcEndpointServiceNamedsql:ListTagsForResourceiam:CreateServiceLinkedRole

read

dsql:GetClusterdsql:GetClusterPolicydsql:GetVpcEndpointServiceNamedsql:ListTagsForResource

update

dsql:UpdateClusterdsql:GetClusterdsql:GetClusterPolicydsql:UntagResourcedsql:TagResourcedsql:GetVpcEndpointServiceNamedsql:ListTagsForResourcedsql:PutClusterPolicy

delete

dsql:DeleteClusterdsql:GetClusterdsql:ListTagsForResource

list

dsql:ListClustersdsql:ListTagsForResource

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

ServiceDSQL

Properties14

Required0

TaggingSupported

Primary IDIdentifier

Supported Operations

CreateReadUpdateDeleteList

External Links

AWS Documentation