# AWS::Redshift::Cluster An example resource schema demonstrating some basic constructs and validation rules. ## Syntax To declare this entity in your AWS CloudFormation template, use the following syntax: ### JSON
{
    "Type" : "AWS::Redshift::Cluster",
    "Properties" : {
        "ClusterIdentifier" : String,
        "MasterUsername" : String,
        "MasterUserPassword" : String,
        "NodeType" : String,
        "AllowVersionUpgrade" : Boolean,
        "AutomatedSnapshotRetentionPeriod" : Integer,
        "AvailabilityZone" : String,
        "ClusterParameterGroupName" : String,
        "ClusterType" : String,
        "ClusterVersion" : String,
        "ClusterSubnetGroupName" : String,
        "DBName" : String,
        "ElasticIp" : String,
        "Encrypted" : Boolean,
        "HsmClientCertificateIdentifier" : String,
        "HsmConfigurationIdentifier" : String,
        "KmsKeyId" : String,
        "NumberOfNodes" : Integer,
        "Port" : Integer,
        "PreferredMaintenanceWindow" : String,
        "PubliclyAccessible" : Boolean,
        "ClusterSecurityGroups" : [ String, ... ],
        "IamRoles" : [ String, ... ],
        "Tags" : [ Tag, ... ],
        "VpcSecurityGroupIds" : [ String, ... ],
        "SnapshotClusterIdentifier" : String,
        "SnapshotIdentifier" : String,
        "OwnerAccount" : String,
        "LoggingProperties" : LoggingProperties,
        "Endpoint" : Endpoint,
        "DestinationRegion" : String,
        "SnapshotCopyRetentionPeriod" : Integer,
        "SnapshotCopyGrantName" : String,
        "ManualSnapshotRetentionPeriod" : Integer,
        "SnapshotCopyManual" : Boolean,
        "AvailabilityZoneRelocation" : Boolean,
        "AvailabilityZoneRelocationStatus" : String,
        "AquaConfigurationStatus" : String,
        "Classic" : Boolean,
        "EnhancedVpcRouting" : Boolean,
        "MaintenanceTrackName" : String,
        "DeferMaintenance" : Boolean,
        "DeferMaintenanceStartTime" : String,
        "DeferMaintenanceEndTime" : String,
        "DeferMaintenanceDuration" : Integer,
        "RevisionTarget" : String,
        "ResourceAction" : String,
        "RotateEncryptionKey" : Boolean
    }
}
### YAML
Type: AWS::Redshift::Cluster
Properties:
    ClusterIdentifier: String
    MasterUsername: String
    MasterUserPassword: String
    NodeType: String
    AllowVersionUpgrade: Boolean
    AutomatedSnapshotRetentionPeriod: Integer
    AvailabilityZone: String
    ClusterParameterGroupName: String
    ClusterType: String
    ClusterVersion: String
    ClusterSubnetGroupName: String
    DBName: String
    ElasticIp: String
    Encrypted: Boolean
    HsmClientCertificateIdentifier: String
    HsmConfigurationIdentifier: String
    KmsKeyId: String
    NumberOfNodes: Integer
    Port: Integer
    PreferredMaintenanceWindow: String
    PubliclyAccessible: Boolean
    ClusterSecurityGroups: 
      - String
    IamRoles: 
      - String
    Tags: 
      - Tag
    VpcSecurityGroupIds: 
      - String
    SnapshotClusterIdentifier: String
    SnapshotIdentifier: String
    OwnerAccount: String
    LoggingProperties: LoggingProperties
    Endpoint: Endpoint
    DestinationRegion: String
    SnapshotCopyRetentionPeriod: Integer
    SnapshotCopyGrantName: String
    ManualSnapshotRetentionPeriod: Integer
    SnapshotCopyManual: Boolean
    AvailabilityZoneRelocation: Boolean
    AvailabilityZoneRelocationStatus: String
    AquaConfigurationStatus: String
    Classic: Boolean
    EnhancedVpcRouting: Boolean
    MaintenanceTrackName: String
    DeferMaintenance: Boolean
    DeferMaintenanceStartTime: String
    DeferMaintenanceEndTime: String
    DeferMaintenanceDuration: Integer
    RevisionTarget: String
    ResourceAction: String
    RotateEncryptionKey: Boolean
## Properties #### ClusterIdentifier A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account _Required_: No _Type_: String _Maximum Length_: 63 _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) #### MasterUsername The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. _Required_: Yes _Type_: String _Maximum Length_: 128 _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) #### MasterUserPassword The password associated with the master user account for the cluster that is being created. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. _Required_: Yes _Type_: String _Maximum Length_: 64 _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### NodeType The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge _Required_: Yes _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### AllowVersionUpgrade Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### AutomatedSnapshotRetentionPeriod The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 _Required_: No _Type_: Integer _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### AvailabilityZone The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### ClusterParameterGroupName The name of the parameter group to be associated with this cluster. _Required_: No _Type_: String _Maximum Length_: 255 _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### ClusterType The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required _Required_: Yes _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### ClusterVersion The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### ClusterSubnetGroupName The name of a cluster subnet group to be associated with this cluster. _Required_: No _Type_: String _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) #### DBName The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. _Required_: Yes _Type_: String _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) #### ElasticIp The Elastic IP (EIP) address for the cluster. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### Encrypted If true, the data in the cluster is encrypted at rest. _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### HsmClientCertificateIdentifier Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### HsmConfigurationIdentifier Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### KmsKeyId The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### NumberOfNodes The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. _Required_: No _Type_: Integer _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### Port The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings _Required_: No _Type_: Integer _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### PreferredMaintenanceWindow The weekly time range (in UTC) during which automated cluster maintenance can occur. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### PubliclyAccessible If true, the cluster can be accessed from a public network. _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### ClusterSecurityGroups A list of security groups to be associated with this cluster. _Required_: No _Type_: List of String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### IamRoles A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request _Required_: No _Type_: List of String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### Tags The list of tags for the cluster parameter group. _Required_: No _Type_: List of Tag _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### VpcSecurityGroupIds A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. _Required_: No _Type_: List of String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### SnapshotClusterIdentifier The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. _Required_: No _Type_: String _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) #### SnapshotIdentifier The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. _Required_: No _Type_: String _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) #### OwnerAccount _Required_: No _Type_: String _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) #### LoggingProperties _Required_: No _Type_: LoggingProperties _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### Endpoint _Required_: No _Type_: Endpoint _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### DestinationRegion The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### SnapshotCopyRetentionPeriod The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default is 7. Constraints: Must be at least 1 and no more than 35. _Required_: No _Type_: Integer _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### SnapshotCopyGrantName The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### ManualSnapshotRetentionPeriod The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. _Required_: No _Type_: Integer _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### SnapshotCopyManual Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### AvailabilityZoneRelocation The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### AvailabilityZoneRelocationStatus The availability zone relocation status of the cluster _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### AquaConfigurationStatus The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following. enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type. disabled - Don't use AQUA. auto - Amazon Redshift determines whether to use AQUA. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### Classic A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### EnhancedVpcRouting An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is true , enhanced VPC routing is enabled. Default: false _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### MaintenanceTrackName The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### DeferMaintenance A boolean indicating whether to enable the deferred maintenance window. _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### DeferMaintenanceStartTime A timestamp indicating the start time for the deferred maintenance window. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### DeferMaintenanceEndTime A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### DeferMaintenanceDuration An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. _Required_: No _Type_: Integer _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### RevisionTarget The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### ResourceAction The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster APIs _Required_: No _Type_: String _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) #### RotateEncryptionKey A boolean indicating if we want to rotate Encryption Keys. _Required_: No _Type_: Boolean _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return Values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ClusterIdentifier. ### 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). #### Id Returns the Id value. #### DeferMaintenanceIdentifier A unique identifier for the deferred maintenance window. #### Port Returns the Port value. #### Address Returns the Address value.