Cluster
An example resource schema demonstrating some basic constructs and validation rules.
Constructors
Properties
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
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.
The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
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
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
The availability zone relocation status of the cluster
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
The name of the parameter group to be associated with this cluster.
A list of security groups to be associated with this cluster.
The name of a cluster subnet group to be associated with this cluster.
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
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.
A boolean indicating whether to enable the deferred maintenance window.
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.
A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
A timestamp indicating the start time for the deferred maintenance window.
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
The connection endpoint.
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
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
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.
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
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.
A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
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.
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
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.
The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. 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.
The namespace resource policy document that will be attached to a Redshift cluster. Search the CloudFormation User Guide for AWS::Redshift::Cluster for more information about the expected schema for this property.
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
The AWS account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
The weekly time range (in UTC) during which automated cluster maintenance can occur.
If true, the cluster can be accessed from a public network.
The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
A boolean indicating if we want to rotate Encryption Keys.
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.
The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
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.
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.