AWS Fundamentals Logo
AWS Fundamentals
AWS::Redshift::Cluster

Redshift Cluster

An example resource schema demonstrating some basic constructs and validation rules.

Properties

52 configurable properties. 4 required. Click a row to see details.

Filter:
PropertyTypeFlags
ClusterType
string
Required
DBName
string
RequiredCreate-only
MasterUsername
string
RequiredCreate-only
NodeType
string
Required
AllowVersionUpgrade
boolean
AquaConfigurationStatus
string
AutomatedSnapshotRetentionPeriod
integer
AvailabilityZone
string
AvailabilityZoneRelocation
boolean
AvailabilityZoneRelocationStatus
string
Classic
boolean
Write-only
ClusterIdentifier
string
Create-only
ClusterParameterGroupName
string
ClusterSecurityGroups
Array<Any | Any>
ClusterSubnetGroupName
string
Create-only
ClusterVersion
string
DeferMaintenance
boolean
Write-only
DeferMaintenanceDuration
integer
Write-only
DeferMaintenanceEndTime
string
DeferMaintenanceStartTime
string
DestinationRegion
string
ElasticIp
string
Encrypted
boolean
Endpoint
Endpoint
EnhancedVpcRouting
boolean
HsmClientCertificateIdentifier
string
HsmConfigurationIdentifier
string
IamRoles
Array<string>
KmsKeyId
Any | Any
LoggingProperties
LoggingProperties
MaintenanceTrackName
string
ManageMasterPassword
boolean
Write-only
ManualSnapshotRetentionPeriod
integer
MasterPasswordSecretKmsKeyId
Any | Any
MasterUserPassword
string
Write-only
MultiAZ
boolean
NamespaceResourcePolicy
object
NumberOfNodes
integer
OwnerAccount
string
Create-only
Port
integer
PreferredMaintenanceWindow
string
PubliclyAccessible
boolean
ResourceAction
string
RevisionTarget
string
RotateEncryptionKey
boolean
SnapshotClusterIdentifier
string
Create-only
SnapshotCopyGrantName
string
SnapshotCopyManual
boolean
SnapshotCopyRetentionPeriod
integer
SnapshotIdentifier
string
Create-onlyWrite-only
Tags
Array<Tag>
VpcSecurityGroupIds
Array<string>

Return Values

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

AttributeTypeDescription
ClusterNamespaceArnstringThe Amazon Resource Name (ARN) of the cluster namespace.
DeferMaintenanceIdentifierstringA unique identifier for the deferred maintenance window.
MasterPasswordSecretArnstringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Redshift::Cluster

Resources:
  MyResource:
    Type: AWS::Redshift::Cluster
    Properties:
      NodeType: "value"
      MasterUsername: "my-masterusername"
      DBName: "my-dbname"
      ClusterType: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

read

redshift:DescribeClustersredshift:DescribeLoggingStatusredshift:DescribeSnapshotCopyGrantredshift:DescribeClusterDbRevisionsredshift:DescribeTagsredshift:GetResourcePolicy

create

iam:PassRoleiam:CreateServiceLinkedRoleredshift:DescribeClustersredshift:CreateClusterredshift:RestoreFromClusterSnapshotredshift:EnableLoggingredshift:DescribeLoggingStatusredshift:CreateTags

update

iam:PassRoleredshift:DescribeClustersredshift:ModifyClusterredshift:ModifyClusterIamRolesredshift:EnableLoggingredshift:CreateTagsredshift:DeleteTagsredshift:DescribeTags

list

redshift:DescribeTagsredshift:DescribeClusters

delete

redshift:DescribeTagsredshift:DescribeClustersredshift:DeleteCluster

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

ServiceRedshift
Properties55
Required4
TaggingSupported
Primary IDClusterIdentifier

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ClusterIdentifierOwnerAccountSnapshotIdentifierDBNameSnapshotClusterIdentifierClusterSubnetGroupNameMasterUsername

Related Resources

External Links