clusters

Creates, updates, deletes or gets a cluster resource or lists clusters in a region

Overview

Name	clusters
Type	Resource
Description	An example resource schema demonstrating some basic constructs and validation rules.
Id	aws.redshift.clusters

Fields

Name	Datatype	Description
revision_target	string	The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
automated_snapshot_retention_period	integer	The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
encrypted	boolean	If true, the data in the cluster is encrypted at rest.
port	integer	The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
number_of_nodes	integer	The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
destination_region	string	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
allow_version_upgrade	boolean	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
endpoint	object
namespace_resource_policy	object	The namespace resource policy document that will be attached to a Redshift cluster.
maintenance_track_name	string	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.
owner_account	string
multi_az	boolean	A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.
tags	array	The list of tags for the cluster parameter group.
snapshot_cluster_identifier	string	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.
iam_roles	array	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
kms_key_id	string	The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
snapshot_copy_manual	boolean	Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
manage_master_password	boolean	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.
availability_zone	string	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
cluster_security_groups	array	A list of security groups to be associated with this cluster.
cluster_identifier	string	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
master_user_password	string	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.
cluster_subnet_group_name	string	The name of a cluster subnet group to be associated with this cluster.
logging_properties	object
defer_maintenance	boolean	A boolean indicating whether to enable the deferred maintenance window.
node_type	string	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
master_username	string	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.
publicly_accessible	boolean	If true, the cluster can be accessed from a public network.
defer_maintenance_identifier	string	A unique identifier for the deferred maintenance window.
manual_snapshot_retention_period	integer	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.
resource_action	string	The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
hsm_client_certificate_identifier	string	Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
elastic_ip	string	The Elastic IP (EIP) address for the cluster.
availability_zone_relocation_status	string	The availability zone relocation status of the cluster
aqua_configuration_status	string	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.
snapshot_identifier	string	The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
availability_zone_relocation	boolean	The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
snapshot_copy_grant_name	string	The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
enhanced_vpc_routing	boolean	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
cluster_parameter_group_name	string	The name of the parameter group to be associated with this cluster.
defer_maintenance_end_time	string	A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
rotate_encryption_key	boolean	A boolean indicating if we want to rotate Encryption Keys.
vpc_security_group_ids	array	A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
cluster_namespace_arn	string	The Amazon Resource Name (ARN) of the cluster namespace.
master_password_secret_arn	string	The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
cluster_version	string	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.
hsm_configuration_identifier	string	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.
preferred_maintenance_window	string	The weekly time range (in UTC) during which automated cluster maintenance can occur.
defer_maintenance_start_time	string	A timestamp indicating the start time for the deferred maintenance window.
cluster_type	string	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
classic	boolean	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.
master_password_secret_kms_key_id	string	The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
defer_maintenance_duration	integer	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.
db_name	string	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.
snapshot_copy_retention_period	integer	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.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	NodeType, MasterUsername, DBName, ClusterType, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all clusters in a region.

SELECT
region,
revision_target,
automated_snapshot_retention_period,
encrypted,
port,
number_of_nodes,
destination_region,
allow_version_upgrade,
endpoint,
namespace_resource_policy,
maintenance_track_name,
owner_account,
multi_az,
tags,
snapshot_cluster_identifier,
iam_roles,
kms_key_id,
snapshot_copy_manual,
manage_master_password,
availability_zone,
cluster_security_groups,
cluster_identifier,
master_user_password,
cluster_subnet_group_name,
logging_properties,
defer_maintenance,
node_type,
master_username,
publicly_accessible,
defer_maintenance_identifier,
manual_snapshot_retention_period,
resource_action,
hsm_client_certificate_identifier,
elastic_ip,
availability_zone_relocation_status,
aqua_configuration_status,
snapshot_identifier,
availability_zone_relocation,
snapshot_copy_grant_name,
enhanced_vpc_routing,
cluster_parameter_group_name,
defer_maintenance_end_time,
rotate_encryption_key,
vpc_security_group_ids,
cluster_namespace_arn,
master_password_secret_arn,
cluster_version,
hsm_configuration_identifier,
preferred_maintenance_window,
defer_maintenance_start_time,
cluster_type,
classic,
master_password_secret_kms_key_id,
defer_maintenance_duration,
db_name,
snapshot_copy_retention_period
FROM aws.redshift.clusters
WHERE region = 'us-east-1';

Gets all properties from an individual cluster.

SELECT
region,
revision_target,
automated_snapshot_retention_period,
encrypted,
port,
number_of_nodes,
destination_region,
allow_version_upgrade,
endpoint,
namespace_resource_policy,
maintenance_track_name,
owner_account,
multi_az,
tags,
snapshot_cluster_identifier,
iam_roles,
kms_key_id,
snapshot_copy_manual,
manage_master_password,
availability_zone,
cluster_security_groups,
cluster_identifier,
master_user_password,
cluster_subnet_group_name,
logging_properties,
defer_maintenance,
node_type,
master_username,
publicly_accessible,
defer_maintenance_identifier,
manual_snapshot_retention_period,
resource_action,
hsm_client_certificate_identifier,
elastic_ip,
availability_zone_relocation_status,
aqua_configuration_status,
snapshot_identifier,
availability_zone_relocation,
snapshot_copy_grant_name,
enhanced_vpc_routing,
cluster_parameter_group_name,
defer_maintenance_end_time,
rotate_encryption_key,
vpc_security_group_ids,
cluster_namespace_arn,
master_password_secret_arn,
cluster_version,
hsm_configuration_identifier,
preferred_maintenance_window,
defer_maintenance_start_time,
cluster_type,
classic,
master_password_secret_kms_key_id,
defer_maintenance_duration,
db_name,
snapshot_copy_retention_period
FROM aws.redshift.clusters
WHERE region = 'us-east-1' AND data__Identifier = '<ClusterIdentifier>';

INSERT example

Use the following StackQL query and manifest file to create a new cluster resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.redshift.clusters (
 NodeType,
 MasterUsername,
 ClusterType,
 DBName,
 region
)
SELECT 
'{{ NodeType }}',
 '{{ MasterUsername }}',
 '{{ ClusterType }}',
 '{{ DBName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.redshift.clusters (
 RevisionTarget,
 AutomatedSnapshotRetentionPeriod,
 Encrypted,
 Port,
 NumberOfNodes,
 DestinationRegion,
 AllowVersionUpgrade,
 Endpoint,
 NamespaceResourcePolicy,
 MaintenanceTrackName,
 OwnerAccount,
 MultiAZ,
 Tags,
 SnapshotClusterIdentifier,
 IamRoles,
 KmsKeyId,
 SnapshotCopyManual,
 ManageMasterPassword,
 AvailabilityZone,
 ClusterSecurityGroups,
 ClusterIdentifier,
 MasterUserPassword,
 ClusterSubnetGroupName,
 LoggingProperties,
 DeferMaintenance,
 NodeType,
 MasterUsername,
 PubliclyAccessible,
 ManualSnapshotRetentionPeriod,
 ResourceAction,
 HsmClientCertificateIdentifier,
 ElasticIp,
 AvailabilityZoneRelocationStatus,
 AquaConfigurationStatus,
 SnapshotIdentifier,
 AvailabilityZoneRelocation,
 SnapshotCopyGrantName,
 EnhancedVpcRouting,
 ClusterParameterGroupName,
 DeferMaintenanceEndTime,
 RotateEncryptionKey,
 VpcSecurityGroupIds,
 ClusterVersion,
 HsmConfigurationIdentifier,
 PreferredMaintenanceWindow,
 DeferMaintenanceStartTime,
 ClusterType,
 Classic,
 MasterPasswordSecretKmsKeyId,
 DeferMaintenanceDuration,
 DBName,
 SnapshotCopyRetentionPeriod,
 region
)
SELECT 
 '{{ RevisionTarget }}',
 '{{ AutomatedSnapshotRetentionPeriod }}',
 '{{ Encrypted }}',
 '{{ Port }}',
 '{{ NumberOfNodes }}',
 '{{ DestinationRegion }}',
 '{{ AllowVersionUpgrade }}',
 '{{ Endpoint }}',
 '{{ NamespaceResourcePolicy }}',
 '{{ MaintenanceTrackName }}',
 '{{ OwnerAccount }}',
 '{{ MultiAZ }}',
 '{{ Tags }}',
 '{{ SnapshotClusterIdentifier }}',
 '{{ IamRoles }}',
 '{{ KmsKeyId }}',
 '{{ SnapshotCopyManual }}',
 '{{ ManageMasterPassword }}',
 '{{ AvailabilityZone }}',
 '{{ ClusterSecurityGroups }}',
 '{{ ClusterIdentifier }}',
 '{{ MasterUserPassword }}',
 '{{ ClusterSubnetGroupName }}',
 '{{ LoggingProperties }}',
 '{{ DeferMaintenance }}',
 '{{ NodeType }}',
 '{{ MasterUsername }}',
 '{{ PubliclyAccessible }}',
 '{{ ManualSnapshotRetentionPeriod }}',
 '{{ ResourceAction }}',
 '{{ HsmClientCertificateIdentifier }}',
 '{{ ElasticIp }}',
 '{{ AvailabilityZoneRelocationStatus }}',
 '{{ AquaConfigurationStatus }}',
 '{{ SnapshotIdentifier }}',
 '{{ AvailabilityZoneRelocation }}',
 '{{ SnapshotCopyGrantName }}',
 '{{ EnhancedVpcRouting }}',
 '{{ ClusterParameterGroupName }}',
 '{{ DeferMaintenanceEndTime }}',
 '{{ RotateEncryptionKey }}',
 '{{ VpcSecurityGroupIds }}',
 '{{ ClusterVersion }}',
 '{{ HsmConfigurationIdentifier }}',
 '{{ PreferredMaintenanceWindow }}',
 '{{ DeferMaintenanceStartTime }}',
 '{{ ClusterType }}',
 '{{ Classic }}',
 '{{ MasterPasswordSecretKmsKeyId }}',
 '{{ DeferMaintenanceDuration }}',
 '{{ DBName }}',
 '{{ SnapshotCopyRetentionPeriod }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: cluster
    props:
      - name: RevisionTarget
        value: '{{ RevisionTarget }}'
      - name: AutomatedSnapshotRetentionPeriod
        value: '{{ AutomatedSnapshotRetentionPeriod }}'
      - name: Encrypted
        value: '{{ Encrypted }}'
      - name: Port
        value: '{{ Port }}'
      - name: NumberOfNodes
        value: '{{ NumberOfNodes }}'
      - name: DestinationRegion
        value: '{{ DestinationRegion }}'
      - name: AllowVersionUpgrade
        value: '{{ AllowVersionUpgrade }}'
      - name: Endpoint
        value:
          Address: '{{ Address }}'
          Port: '{{ Port }}'
      - name: NamespaceResourcePolicy
        value: {}
      - name: MaintenanceTrackName
        value: '{{ MaintenanceTrackName }}'
      - name: OwnerAccount
        value: '{{ OwnerAccount }}'
      - name: MultiAZ
        value: '{{ MultiAZ }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: SnapshotClusterIdentifier
        value: '{{ SnapshotClusterIdentifier }}'
      - name: IamRoles
        value:
          - '{{ IamRoles[0] }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: SnapshotCopyManual
        value: '{{ SnapshotCopyManual }}'
      - name: ManageMasterPassword
        value: '{{ ManageMasterPassword }}'
      - name: AvailabilityZone
        value: '{{ AvailabilityZone }}'
      - name: ClusterSecurityGroups
        value:
          - '{{ ClusterSecurityGroups[0] }}'
      - name: ClusterIdentifier
        value: '{{ ClusterIdentifier }}'
      - name: MasterUserPassword
        value: '{{ MasterUserPassword }}'
      - name: ClusterSubnetGroupName
        value: '{{ ClusterSubnetGroupName }}'
      - name: LoggingProperties
        value:
          BucketName: '{{ BucketName }}'
          S3KeyPrefix: '{{ S3KeyPrefix }}'
      - name: DeferMaintenance
        value: '{{ DeferMaintenance }}'
      - name: NodeType
        value: '{{ NodeType }}'
      - name: MasterUsername
        value: '{{ MasterUsername }}'
      - name: PubliclyAccessible
        value: '{{ PubliclyAccessible }}'
      - name: ManualSnapshotRetentionPeriod
        value: '{{ ManualSnapshotRetentionPeriod }}'
      - name: ResourceAction
        value: '{{ ResourceAction }}'
      - name: HsmClientCertificateIdentifier
        value: '{{ HsmClientCertificateIdentifier }}'
      - name: ElasticIp
        value: '{{ ElasticIp }}'
      - name: AvailabilityZoneRelocationStatus
        value: '{{ AvailabilityZoneRelocationStatus }}'
      - name: AquaConfigurationStatus
        value: '{{ AquaConfigurationStatus }}'
      - name: SnapshotIdentifier
        value: '{{ SnapshotIdentifier }}'
      - name: AvailabilityZoneRelocation
        value: '{{ AvailabilityZoneRelocation }}'
      - name: SnapshotCopyGrantName
        value: '{{ SnapshotCopyGrantName }}'
      - name: EnhancedVpcRouting
        value: '{{ EnhancedVpcRouting }}'
      - name: ClusterParameterGroupName
        value: '{{ ClusterParameterGroupName }}'
      - name: DeferMaintenanceEndTime
        value: '{{ DeferMaintenanceEndTime }}'
      - name: RotateEncryptionKey
        value: '{{ RotateEncryptionKey }}'
      - name: VpcSecurityGroupIds
        value:
          - '{{ VpcSecurityGroupIds[0] }}'
      - name: ClusterVersion
        value: '{{ ClusterVersion }}'
      - name: HsmConfigurationIdentifier
        value: '{{ HsmConfigurationIdentifier }}'
      - name: PreferredMaintenanceWindow
        value: '{{ PreferredMaintenanceWindow }}'
      - name: DeferMaintenanceStartTime
        value: '{{ DeferMaintenanceStartTime }}'
      - name: ClusterType
        value: '{{ ClusterType }}'
      - name: Classic
        value: '{{ Classic }}'
      - name: MasterPasswordSecretKmsKeyId
        value: '{{ MasterPasswordSecretKmsKeyId }}'
      - name: DeferMaintenanceDuration
        value: '{{ DeferMaintenanceDuration }}'
      - name: DBName
        value: '{{ DBName }}'
      - name: SnapshotCopyRetentionPeriod
        value: '{{ SnapshotCopyRetentionPeriod }}'

DELETE example

/*+ delete */
DELETE FROM aws.redshift.clusters
WHERE data__Identifier = '<ClusterIdentifier>'
AND region = 'us-east-1';

Permissions

To operate on the clusters resource, the following permissions are required:

Read

redshift:DescribeClusters,
redshift:DescribeLoggingStatus,
redshift:DescribeSnapshotCopyGrant,
redshift:DescribeClusterDbRevisions,
redshift:DescribeTags,
redshift:GetResourcePolicy

Create

iam:PassRole,
iam:CreateServiceLinkedRole,
redshift:DescribeClusters,
redshift:CreateCluster,
redshift:RestoreFromClusterSnapshot,
redshift:EnableLogging,
redshift:DescribeLoggingStatus,
redshift:CreateTags,
redshift:DescribeTags,
redshift:GetResourcePolicy,
redshift:PutResourcePolicy,
redshift:ModifyClusterMaintenance,
ec2:DescribeVpcs,
ec2:DescribeSubnets,
ec2:DescribeNetworkInterfaces,
ec2:DescribeAddresses,
ec2:AssociateAddress,
ec2:CreateNetworkInterface,
ec2:ModifyNetworkInterfaceAttribute,
ec2:CreateVpcEndpoint,
ec2:DescribeVpcEndpoints,
ec2:ModifyVpcEndpoint,
ec2:AllocateAddress,
ec2:CreateSecurityGroup,
ec2:DescribeVpcAttribute,
ec2:DescribeSecurityGroups,
ec2:DescribeInternetGateways,
ec2:DescribeSecurityGroupRules,
ec2:DescribeAvailabilityZones,
ec2:DescribeNetworkAcls,
ec2:DescribeRouteTables,
cloudwatch:PutMetricData

Update

iam:PassRole,
redshift:DescribeClusters,
redshift:ModifyCluster,
redshift:ModifyClusterIamRoles,
redshift:EnableLogging,
redshift:CreateTags,
redshift:DeleteTags,
redshift:DescribeTags,
redshift:DisableLogging,
redshift:DescribeLoggingStatus,
redshift:RebootCluster,
redshift:EnableSnapshotCopy,
redshift:DisableSnapshotCopy,
redshift:ModifySnapshotCopyRetentionPeriod,
redshift:ModifyAquaConfiguration,
redshift:ResizeCluster,
redshift:ModifyClusterMaintenance,
redshift:DescribeClusterDbRevisions,
redshift:ModifyClusterDbRevisions,
redshift:PauseCluster,
redshift:ResumeCluster,
redshift:RotateEncryptionKey,
redshift:FailoverPrimaryCompute,
redshift:PutResourcePolicy,
redshift:GetResourcePolicy,
redshift:DeleteResourcePolicy,
cloudwatch:PutMetricData

List

redshift:DescribeTags,
redshift:DescribeClusters

Delete

redshift:DescribeTags,
redshift:DescribeClusters,
redshift:DeleteCluster