Skip to main content

clusters

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

Overview​

Nameclusters
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idawscc.redshift.clusters

Fields​

NameDatatypeDescription
revision_targetstringThe identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
automated_snapshot_retention_periodintegerThe number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1
encryptedbooleanIf true, the data in the cluster is encrypted at rest.
portintegerThe port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings
number_of_nodesintegerThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
destination_regionstringThe 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_upgradebooleanMajor version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True
▶endpointobject
namespace_resource_policyobjectThe namespace resource policy document that will be attached to a Redshift cluster.
maintenance_track_namestringThe 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_accountstring
multi_azbooleanA 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.
▶tagsarrayThe list of tags for the cluster parameter group.
snapshot_cluster_identifierstringThe 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_rolesarrayA 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_idstringThe AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
snapshot_copy_manualbooleanIndicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
manage_master_passwordbooleanA 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_zonestringThe 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_groupsarrayA list of security groups to be associated with this cluster.
cluster_identifierstringA 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_passwordstringThe 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_namestringThe name of a cluster subnet group to be associated with this cluster.
▶logging_propertiesobject
defer_maintenancebooleanA boolean indicating whether to enable the deferred maintenance window.
node_typestringThe node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.large | ra3.4xlarge | ra3.16xlarge
master_usernamestringThe 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_accessiblebooleanIf true, the cluster can be accessed from a public network.
defer_maintenance_identifierstringA unique identifier for the deferred maintenance window.
manual_snapshot_retention_periodintegerThe 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.<br />The value must be either -1 or an integer between 1 and 3,653.
resource_actionstringThe Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs
hsm_client_certificate_identifierstringSpecifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM
elastic_ipstringThe Elastic IP (EIP) address for the cluster.
availability_zone_relocation_statusstringThe availability zone relocation status of the cluster
aqua_configuration_statusstringThe value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.<br />enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.<br />disabled - Don't use AQUA.<br />auto - Amazon Redshift determines whether to use AQUA.<br />
snapshot_identifierstringThe name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
availability_zone_relocationbooleanThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
snapshot_copy_grant_namestringThe name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
enhanced_vpc_routingbooleanAn 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.<br />If this option is true , enhanced VPC routing is enabled.<br />Default: false
cluster_parameter_group_namestringThe name of the parameter group to be associated with this cluster.
defer_maintenance_end_timestringA timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
rotate_encryption_keybooleanA boolean indicating if we want to rotate Encryption Keys.
vpc_security_group_idsarrayA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
cluster_namespace_arnstringThe Amazon Resource Name (ARN) of the cluster namespace.
master_password_secret_arnstringThe Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
cluster_versionstringThe 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_identifierstringSpecifies 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_windowstringThe weekly time range (in UTC) during which automated cluster maintenance can occur.
defer_maintenance_start_timestringA timestamp indicating the start time for the deferred maintenance window.
cluster_typestringThe 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
classicbooleanA 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_idstringThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.
defer_maintenance_durationintegerAn 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_namestringThe 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_periodintegerThe number of days to retain automated snapshots in the destination region after they are copied from the source region. <br />Default is 7. <br />Constraints: Must be at least 1 and no more than 35.
regionstringAWS region.

For more information, see AWS::Redshift::Cluster.

Methods​

NameResourceAccessible byRequired Params
create_resourceclustersINSERTNodeType, MasterUsername, DBName, ClusterType, region
delete_resourceclustersDELETEIdentifier, region
update_resourceclustersUPDATEIdentifier, PatchDocument, region
list_resourcesclusters_list_onlySELECTregion
get_resourceclustersSELECTIdentifier, region

SELECT examples​

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 awscc.redshift.clusters
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ cluster_identifier }}';

INSERT example​

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

/*+ create */
INSERT INTO awscc.redshift.clusters (
  NodeType,
  MasterUsername,
  ClusterType,
  DBName,
  region
)
SELECT
  '{{ node_type }}',
  '{{ master_username }}',
  '{{ cluster_type }}',
  '{{ db_name }}',
  '{{ region }}';

UPDATE example​

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

/*+ update */
UPDATE awscc.redshift.clusters
SET PatchDocument = string('{{ {
    "RevisionTarget": revision_target,
    "AutomatedSnapshotRetentionPeriod": automated_snapshot_retention_period,
    "Encrypted": encrypted,
    "Port": port,
    "NumberOfNodes": number_of_nodes,
    "DestinationRegion": destination_region,
    "AllowVersionUpgrade": allow_version_upgrade,
    "NamespaceResourcePolicy": namespace_resource_policy,
    "MaintenanceTrackName": maintenance_track_name,
    "MultiAZ": multi_az,
    "Tags": tags,
    "IamRoles": iam_roles,
    "KmsKeyId": kms_key_id,
    "SnapshotCopyManual": snapshot_copy_manual,
    "ManageMasterPassword": manage_master_password,
    "AvailabilityZone": availability_zone,
    "ClusterSecurityGroups": cluster_security_groups,
    "MasterUserPassword": master_user_password,
    "LoggingProperties": logging_properties,
    "DeferMaintenance": defer_maintenance,
    "NodeType": node_type,
    "PubliclyAccessible": publicly_accessible,
    "ManualSnapshotRetentionPeriod": manual_snapshot_retention_period,
    "ResourceAction": resource_action,
    "HsmClientCertificateIdentifier": hsm_client_certificate_identifier,
    "ElasticIp": elastic_ip,
    "AvailabilityZoneRelocationStatus": availability_zone_relocation_status,
    "AquaConfigurationStatus": aqua_configuration_status,
    "AvailabilityZoneRelocation": availability_zone_relocation,
    "SnapshotCopyGrantName": snapshot_copy_grant_name,
    "EnhancedVpcRouting": enhanced_vpc_routing,
    "ClusterParameterGroupName": cluster_parameter_group_name,
    "DeferMaintenanceEndTime": defer_maintenance_end_time,
    "RotateEncryptionKey": rotate_encryption_key,
    "VpcSecurityGroupIds": vpc_security_group_ids,
    "ClusterVersion": cluster_version,
    "HsmConfigurationIdentifier": hsm_configuration_identifier,
    "PreferredMaintenanceWindow": preferred_maintenance_window,
    "DeferMaintenanceStartTime": defer_maintenance_start_time,
    "ClusterType": cluster_type,
    "Classic": classic,
    "MasterPasswordSecretKmsKeyId": master_password_secret_kms_key_id,
    "DeferMaintenanceDuration": defer_maintenance_duration,
    "SnapshotCopyRetentionPeriod": snapshot_copy_retention_period
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ cluster_identifier }}';

DELETE example​

/*+ delete */
DELETE FROM awscc.redshift.clusters
WHERE
  Identifier = '{{ cluster_identifier }}' AND
  region = 'us-east-1';

Permissions​

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

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