clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	clusters
Type	Resource
Id	aws.redshift.clusters

Fields

The following fields are returned by SELECT queries:

describe_clusters

Name	Datatype	Description
allow_version_upgrade	boolean	A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
aqua_configuration	string	This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
automated_snapshot_retention_period	integer	The number of days that automatic cluster snapshots are retained.
availability_zone	string	The name of the Availability Zone in which the cluster is located.
availability_zone_relocation_status	string	Describes the status of the Availability Zone relocation operation.
catalog_arn	string	The Amazon Resource Name (ARN) of the Glue data catalog associated with the cluster enabled with Amazon Redshift federated permissions.
cluster_availability_status	string	The availability status of the cluster for queries. Possible values are the following: Available - The cluster is available for queries. Unavailable - The cluster is not available for queries. Maintenance - The cluster is intermittently available for queries due to maintenance activities. Modifying - The cluster is intermittently available for queries due to changes that modify the cluster. Failed - The cluster failed and is not available for queries.
cluster_create_time	string	The date and time that the cluster was created.
cluster_identifier	string	The unique identifier of the cluster.
cluster_namespace_arn	string	The namespace Amazon Resource Name (ARN) of the cluster.
cluster_nodes	string	The nodes in the cluster.
cluster_parameter_groups	string	The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
cluster_public_key	string	The public key for the cluster.
cluster_revision_number	string	The specific revision number of the database in the cluster.
cluster_security_groups	string	A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements. Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
cluster_snapshot_copy_status	string	A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
cluster_status	string	The current state of the cluster. Possible values are the following: available available, prep-for-resize available, resize-cleanup cancelling-resize creating deleting final-snapshot hardware-failure incompatible-hsm incompatible-network incompatible-parameters incompatible-restore modifying paused rebooting renaming resizing rotating-keys storage-full updating-hsm
cluster_subnet_group_name	string	The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
cluster_version	string	The version ID of the Amazon Redshift engine that is running on the cluster.
custom_domain_certificate_arn	string	The certificate Amazon Resource Name (ARN) for the custom domain name.
custom_domain_certificate_expiry_date	string	The expiration date for the certificate associated with the custom domain name.
custom_domain_name	string	The custom domain name associated with the cluster.
db_name	string	The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.
data_transfer_progress	string	Describes the status of a cluster while it is in the process of resizing with an incremental resize.
default_iam_role_arn	string	The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
deferred_maintenance_windows	string	Describes a group of DeferredMaintenanceWindow objects.
elastic_ip_status	string	The status of the elastic IP (EIP) address.
elastic_resize_number_of_node_options	string	The number of nodes that you can resize the cluster to with the elastic resize method.
encrypted	boolean	A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
endpoint	string	The connection endpoint.
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
expected_next_snapshot_schedule_time	string	The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
expected_next_snapshot_schedule_time_status	string	The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following: OnTrack - The next snapshot is expected to be taken on time. Pending - The next snapshot is pending to be taken.
extra_compute_for_automatic_optimization	string	A boolean value that, if true, indicates that the cluster allocates additional compute resources to run automatic optimization operations. Default: false
hsm_status	string	A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command. Values: active, applying
iam_roles	string	A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
ip_address_type	string	The IP address type for the cluster. Possible values are ipv4 and dualstack.
kms_key_id	string	The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
lakehouse_registration_status	string	The status of the lakehouse registration for the cluster. Indicates whether the cluster is successfully registered with Amazon Redshift federated permissions.
logging_publish_status	string	The status of system table publishing for the cluster. This field is present only when system table publishing is configured.
maintenance_track_name	string	The name of the maintenance track for the cluster.
manual_snapshot_retention_period	integer	The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
master_password_secret_arn	string	The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
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 credentials secret.
master_username	string	The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
modify_status	string	The status of a modify operation, if any, initiated for the cluster.
multi_az	string	A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
multi_az_secondary	string	The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
next_maintenance_window_start_time	string	The date and time in UTC when system maintenance can begin.
node_type	string	The node type for the nodes in the cluster.
number_of_nodes	integer	The number of compute nodes in the cluster.
pending_actions	string	Cluster operations that are waiting to be started.
pending_modified_values	string	A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
preferred_maintenance_window	string	The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
publicly_accessible	boolean	A boolean value that, if true, indicates that the cluster can be accessed from a public network. Default: false
reserved_node_exchange_status	string	The status of the reserved-node exchange request. Statuses include in-progress and requested.
resize_info	string	Returns the following: AllowCancelResize: a boolean value indicating if the resize operation can be cancelled. ResizeType: Returns ClassicResize
restore_status	string	A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
snapshot_schedule_identifier	string	A unique identifier for the cluster snapshot schedule.
snapshot_schedule_state	string	The current state of the cluster snapshot schedule.
tags	string	The list of tags for the cluster.
total_storage_capacity_in_mega_bytes	integer	The total storage capacity of the cluster in megabytes.
vpc_id	string	The identifier of the VPC the cluster is in, if the cluster is in a VPC.
vpc_security_groups	string	A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_clusters	select	region	ClusterIdentifier, MaxRecords, Marker, TagKeys, TagValues	Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned. If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
create_cluster	insert	ClusterIdentifier, NodeType, MasterUsername, region	DBName, ClusterType, MasterUserPassword, ClusterSecurityGroups, VpcSecurityGroupIds, ClusterSubnetGroupName, AvailabilityZone, PreferredMaintenanceWindow, ClusterParameterGroupName, AutomatedSnapshotRetentionPeriod, ManualSnapshotRetentionPeriod, Port, ClusterVersion, AllowVersionUpgrade, NumberOfNodes, PubliclyAccessible, Encrypted, HsmClientCertificateIdentifier, HsmConfigurationIdentifier, ElasticIp, Tags, KmsKeyId, EnhancedVpcRouting, AdditionalInfo, IamRoles, MaintenanceTrackName, SnapshotScheduleIdentifier, AvailabilityZoneRelocation, AquaConfigurationStatus, DefaultIamRoleArn, LoadSampleData, ManageMasterPassword, MasterPasswordSecretKmsKeyId, IpAddressType, MultiAZ, RedshiftIdcApplicationArn, CatalogName, ExtraComputeForAutomaticOptimization	Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked: Creating a public cluster Restoring a public cluster Modifying a private cluster to be public Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
modify_snapshot_copy_retention_period	update	ClusterIdentifier, RetentionPeriod, region	Manual	Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.
modify_cluster	update	ClusterIdentifier, region	ClusterType, NodeType, NumberOfNodes, ClusterSecurityGroups, VpcSecurityGroupIds, MasterUserPassword, ClusterParameterGroupName, AutomatedSnapshotRetentionPeriod, ManualSnapshotRetentionPeriod, PreferredMaintenanceWindow, ClusterVersion, AllowVersionUpgrade, HsmClientCertificateIdentifier, HsmConfigurationIdentifier, NewClusterIdentifier, PubliclyAccessible, ElasticIp, EnhancedVpcRouting, MaintenanceTrackName, Encrypted, KmsKeyId, AvailabilityZoneRelocation, AvailabilityZone, Port, ManageMasterPassword, MasterPasswordSecretKmsKeyId, IpAddressType, MultiAZ, ExtraComputeForAutomaticOptimization	Modifies the settings for a cluster. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked: Creating a public cluster Restoring a public cluster Modifying a private cluster to be public Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.
delete_cluster	delete	ClusterIdentifier, region	SkipFinalClusterSnapshot, FinalClusterSnapshotIdentifier, FinalClusterSnapshotRetentionPeriod	Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
cancel_resize	exec	ClusterIdentifier, region		Cancels a resize operation for a cluster.
copy_cluster_snapshot	exec	SourceSnapshotIdentifier, TargetSnapshotIdentifier, region	SourceSnapshotClusterIdentifier, ManualSnapshotRetentionPeriod	Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
disable_logging	exec	ClusterIdentifier, region	LogDestinationType, LogExports	Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
disable_snapshot_copy	exec	ClusterIdentifier, region		Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using an encrypted symmetric key from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the key in the destination region.
enable_logging	exec	ClusterIdentifier, region	BucketName, S3KeyPrefix, LogDestinationType, LogExports, S3TableKmsKeyId, S3TableGranularity	Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
enable_snapshot_copy	exec	ClusterIdentifier, DestinationRegion, region	RetentionPeriod, SnapshotCopyGrantName, ManualSnapshotRetentionPeriod	Enables the automatic copy of snapshots from one region to another region for a specified cluster.
failover_primary_compute	exec	ClusterIdentifier, region		Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
modify_aqua_configuration	exec	ClusterIdentifier, region	AquaConfigurationStatus	This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
modify_cluster_iam_roles	exec	ClusterIdentifier, region	AddIamRoles, RemoveIamRoles, DefaultIamRoleArn	Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
modify_cluster_maintenance	exec	ClusterIdentifier, region	DeferMaintenance, DeferMaintenanceIdentifier, DeferMaintenanceStartTime, DeferMaintenanceEndTime, DeferMaintenanceDuration	Modifies the maintenance settings of a cluster.
modify_lakehouse_configuration	exec	ClusterIdentifier, region	LakehouseRegistration, CatalogName, LakehouseIdcRegistration, LakehouseIdcApplicationArn, DryRun	Modifies the lakehouse configuration for a cluster. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM Identity Center trusted identity propagation.
pause_cluster	exec	ClusterIdentifier, region		Pauses a cluster.
reboot_cluster	exec	ClusterIdentifier, region		Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
resize_cluster	exec	ClusterIdentifier, region	ClusterType, NodeType, NumberOfNodes, Classic, ReservedNodeId, TargetReservedNodeOfferingId	Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge rg.large rg.xlarge rg.4xlarge rg.12xlarge ra3.large ra3.xlplus ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster.
restore_from_cluster_snapshot	exec	ClusterIdentifier, region	SnapshotIdentifier, SnapshotArn, SnapshotClusterIdentifier, Port, AvailabilityZone, AllowVersionUpgrade, ClusterSubnetGroupName, PubliclyAccessible, OwnerAccount, HsmClientCertificateIdentifier, HsmConfigurationIdentifier, ElasticIp, ClusterParameterGroupName, ClusterSecurityGroups, VpcSecurityGroupIds, PreferredMaintenanceWindow, AutomatedSnapshotRetentionPeriod, ManualSnapshotRetentionPeriod, KmsKeyId, NodeType, EnhancedVpcRouting, AdditionalInfo, IamRoles, MaintenanceTrackName, SnapshotScheduleIdentifier, NumberOfNodes, AvailabilityZoneRelocation, AquaConfigurationStatus, DefaultIamRoleArn, ReservedNodeId, TargetReservedNodeOfferingId, Encrypted, ManageMasterPassword, MasterPasswordSecretKmsKeyId, IpAddressType, MultiAZ, CatalogName, RedshiftIdcApplicationArn	Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked: Creating a public cluster Restoring a public cluster Modifying a private cluster to be public Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
restore_table_from_cluster_snapshot	exec	ClusterIdentifier, SnapshotIdentifier, SourceDatabaseName, SourceTableName, NewTableName, region	SourceSchemaName, TargetDatabaseName, TargetSchemaName, EnableCaseSensitiveIdentifier	Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot. You can't use this operation to restore tables with interleaved sort keys.
resume_cluster	exec	ClusterIdentifier, region		Resumes a paused cluster.
rotate_encryption_key	exec	ClusterIdentifier, region		Rotates the encryption keys for a cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ClusterIdentifier	string	The unique identifier of the cluster that you want to rotate the encryption keys for. Constraints: Must be the name of valid cluster that has encryption enabled.
DestinationRegion	string	The destination Amazon Web Services Region that you want to copy snapshots to. Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
MasterUsername	string	The user name associated with the admin user account for the cluster that is being created. Constraints: Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be PUBLIC. Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. The first character must be a letter. Must not contain a colon (:) or a slash (/). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
NewTableName	string	The name of the table to create as a result of the current request.
NodeType	string	The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: dc2.large | dc2.8xlarge | rg.large | rg.xlarge | rg.4xlarge | rg.12xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
RetentionPeriod	integer	The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this only changes the retention period of copied automated snapshots. If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period. Constraints: Must be at least 1 and no more than 35 for automated snapshots. If you specify the manual option, only newly copied manual snapshots will have the new retention period. If you specify the value of -1 newly copied manual snapshots are retained indefinitely. Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
SnapshotIdentifier	string	The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
SourceDatabaseName	string	The name of the source database that contains the table to restore from.
SourceSnapshotIdentifier	string	The identifier for the source snapshot. Constraints: Must be the identifier for a valid automated snapshot whose state is available.
SourceTableName	string	The name of the source table to restore from.
TargetSnapshotIdentifier	string	The identifier given to the new manual snapshot. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for the Amazon Web Services account that is making the request.
region	string	AWS region (default: us-east-1)
AddIamRoles	array	Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format.
AdditionalInfo	string	Reserved.
AllowVersionUpgrade	boolean	If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default: true
AquaConfigurationStatus	string	This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AutomatedSnapshotRetentionPeriod	integer	The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. You can't disable automated snapshots for RG or RA3 node types. Set the automated retention period from 1-35 days. Default: The value selected for the cluster from which the snapshot was taken. Constraints: Must be a value from 0 to 35.
AvailabilityZone	string	The Amazon EC2 Availability Zone in which to restore the cluster. Default: A random, system-chosen Availability Zone. Example: us-east-2a
AvailabilityZoneRelocation	boolean	The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
BucketName	string	The name of an existing S3 bucket where the log files are to be stored. Constraints: Must be in the same region as the cluster The cluster must have read bucket and put object permissions
CatalogName	string	The name of the Glue Data Catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions. Constraints: Must contain at least one lowercase letter. Can only contain lowercase letters (a-z), numbers (0-9), underscores (), and hyphens (-). Pattern: ^[a-z0-9-][a-z]+[a-z0-9_-]$ Example: my-catalog_01
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.
ClusterIdentifier	string	The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive. The default is that all clusters defined for an account are returned.
ClusterParameterGroupName	string	The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups. Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
ClusterSecurityGroups	array	A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. Cluster security groups only apply to clusters outside of VPCs.
ClusterSubnetGroupName	string	The name of the subnet group where you want to cluster restored. A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
ClusterType	string	The new cluster type for the specified cluster.
ClusterVersion	string	The new version number of the Amazon Redshift engine to upgrade to. For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. Example: 1.0
DBName	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. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
DefaultIamRoleArn	string	The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
DeferMaintenance	boolean	A boolean indicating whether to enable the deferred maintenance window.
DeferMaintenanceDuration	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 60 days or less.
DeferMaintenanceEndTime	string (date-time)	A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
DeferMaintenanceIdentifier	string	A unique identifier for the deferred maintenance window.
DeferMaintenanceStartTime	string (date-time)	A timestamp indicating the start time for the deferred maintenance window.
DryRun	boolean	A boolean value that, if true, validates the request without actually modifying the lakehouse configuration. Use this to check for errors before making changes.
ElasticIp	string	The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
EnableCaseSensitiveIdentifier	boolean	Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false (default), the names are not case sensitive.
Encrypted	boolean	Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
EnhancedVpcRouting	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
ExtraComputeForAutomaticOptimization	boolean	If true, allocates additional compute resources for running automatic optimization operations. Default: false
FinalClusterSnapshotIdentifier	string	The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false. Constraints: Must be 1 to 255 alphanumeric characters. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
FinalClusterSnapshotRetentionPeriod	integer	The number of days that a manual snapshot is retained. 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 default value is -1.
HsmClientCertificateIdentifier	string	Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier	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.
IamRoles	array	A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
IpAddressType	string	The IP address type for the cluster. Possible values are ipv4 and dualstack.
KmsKeyId	string	The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
LakehouseIdcApplicationArn	string	The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.
LakehouseIdcRegistration	string	Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.
LakehouseRegistration	string	Specifies whether to register or deregister the cluster with Amazon Redshift federated permissions. Valid values are Register or Deregister.
LoadSampleData	string	A flag that specifies whether to load sample data once the cluster is created.
LogDestinationType	string	The log destination type. An enum with possible values of s3, cloudwatch, and s3table.
LogExports	array	The collection of exported log types. When LogDestinationType is s3 or cloudwatch, possible values are connectionlog, useractivitylog, and userlog. When LogDestinationType is s3table, the values are the names of the system tables to publish. Omitting this parameter, passing an empty list, or including the value all publishes all current and future system tables.
MaintenanceTrackName	string	The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.
ManageMasterPassword	boolean	If true, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If ManageMasterPassword is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.
Manual	boolean	Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
ManualSnapshotRetentionPeriod	integer	The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
Marker	string	An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
MasterPasswordSecretKmsKeyId	string	The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
MasterUserPassword	string	The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. You can't use MasterUserPassword if ManageMasterPassword is true. Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost. Default: Uses existing setting. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), " (double quote), , /, or @.
MaxRecords	integer	The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
MultiAZ	boolean	If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
NewClusterIdentifier	string	The new identifier for the cluster. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an Amazon Web Services account. Example: examplecluster
NodeType	string	The node type that the restored cluster will be provisioned with. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc2.large node type into another dc2 type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
NumberOfNodes	integer	The number of nodes specified when provisioning the restored cluster.
OwnerAccount	string	The Amazon Web Services 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.
Port	integer	The port number on which the cluster accepts connections. Default: The same port as the original cluster. Valid values: For clusters with DC2 nodes, must be within the range 1150-65535. For clusters with RG or RA3 nodes, must be within the ranges 5431-5455 or 8191-8215.
PreferredMaintenanceWindow	string	The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
PubliclyAccessible	boolean	If true, the cluster can be accessed from a public network. Default: false
RedshiftIdcApplicationArn	string	The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.
RemoveIamRoles	array	Zero or more IAM roles in ARN format to disassociate from the cluster.
ReservedNodeId	string	The identifier of the target reserved node offering.
RetentionPeriod	integer	The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default: 7. Constraints: Must be at least 1 and no more than 35.
S3KeyPrefix	string	The prefix applied to the log file names. Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (), hyphen (-), at symbol (@).
S3TableGranularity	string	The scope of system table publishing. Valid values are cluster and account. A value of cluster scopes publishing to the individual cluster. A value of account scopes publishing to the Amazon Web Services account. This parameter is valid only when LogDestinationType is s3table.
S3TableKmsKeyId	string	The identifier of a customer managed KMS key used to encrypt the S3 tables. This parameter is valid only when LogDestinationType is s3table.
SkipFinalClusterSnapshot	boolean	Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false. Default: false
SnapshotArn	string	The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify this parameter or snapshotIdentifier, but not both.
SnapshotClusterIdentifier	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.
SnapshotCopyGrantName	string	The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
SnapshotIdentifier	string	The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter or snapshotArn, but not both. Example: my-snapshot-id
SnapshotScheduleIdentifier	string	A unique identifier for the snapshot schedule.
SourceSchemaName	string	The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
SourceSnapshotClusterIdentifier	string	The identifier 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. Constraints: Must be the identifier for a valid cluster.
TagKeys	array	A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
TagValues	array	A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
Tags	array	A list of tag instances.
TargetDatabaseName	string	The name of the database to restore the table to.
TargetReservedNodeOfferingId	string	The identifier of the target reserved node offering.
TargetSchemaName	string	The name of the schema to restore the table to.
VpcSecurityGroupIds	array	A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. VPC security groups only apply to clusters in VPCs.

SELECT examples

describe_clusters

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned. If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.

SELECT
allow_version_upgrade,
aqua_configuration,
automated_snapshot_retention_period,
availability_zone,
availability_zone_relocation_status,
catalog_arn,
cluster_availability_status,
cluster_create_time,
cluster_identifier,
cluster_namespace_arn,
cluster_nodes,
cluster_parameter_groups,
cluster_public_key,
cluster_revision_number,
cluster_security_groups,
cluster_snapshot_copy_status,
cluster_status,
cluster_subnet_group_name,
cluster_version,
custom_domain_certificate_arn,
custom_domain_certificate_expiry_date,
custom_domain_name,
db_name,
data_transfer_progress,
default_iam_role_arn,
deferred_maintenance_windows,
elastic_ip_status,
elastic_resize_number_of_node_options,
encrypted,
endpoint,
enhanced_vpc_routing,
expected_next_snapshot_schedule_time,
expected_next_snapshot_schedule_time_status,
extra_compute_for_automatic_optimization,
hsm_status,
iam_roles,
ip_address_type,
kms_key_id,
lakehouse_registration_status,
logging_publish_status,
maintenance_track_name,
manual_snapshot_retention_period,
master_password_secret_arn,
master_password_secret_kms_key_id,
master_username,
modify_status,
multi_az,
multi_az_secondary,
next_maintenance_window_start_time,
node_type,
number_of_nodes,
pending_actions,
pending_modified_values,
preferred_maintenance_window,
publicly_accessible,
reserved_node_exchange_status,
resize_info,
restore_status,
snapshot_schedule_identifier,
snapshot_schedule_state,
tags,
total_storage_capacity_in_mega_bytes,
vpc_id,
vpc_security_groups
FROM aws.redshift.clusters
WHERE region = '{{ region }}' -- required
AND ClusterIdentifier = '{{ ClusterIdentifier }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
AND TagKeys = '{{ TagKeys }}'
AND TagValues = '{{ TagValues }}'
;

INSERT examples

create_cluster

Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked: Creating a public cluster Restoring a public cluster Modifying a private cluster to be public Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

INSERT INTO aws.redshift.clusters (
ClusterIdentifier,
NodeType,
MasterUsername,
region,
DBName,
ClusterType,
MasterUserPassword,
ClusterSecurityGroups,
VpcSecurityGroupIds,
ClusterSubnetGroupName,
AvailabilityZone,
PreferredMaintenanceWindow,
ClusterParameterGroupName,
AutomatedSnapshotRetentionPeriod,
ManualSnapshotRetentionPeriod,
Port,
ClusterVersion,
AllowVersionUpgrade,
NumberOfNodes,
PubliclyAccessible,
Encrypted,
HsmClientCertificateIdentifier,
HsmConfigurationIdentifier,
ElasticIp,
Tags,
KmsKeyId,
EnhancedVpcRouting,
AdditionalInfo,
IamRoles,
MaintenanceTrackName,
SnapshotScheduleIdentifier,
AvailabilityZoneRelocation,
AquaConfigurationStatus,
DefaultIamRoleArn,
LoadSampleData,
ManageMasterPassword,
MasterPasswordSecretKmsKeyId,
IpAddressType,
MultiAZ,
RedshiftIdcApplicationArn,
CatalogName,
ExtraComputeForAutomaticOptimization
)
SELECT 
'{{ ClusterIdentifier }}',
'{{ NodeType }}',
'{{ MasterUsername }}',
'{{ region }}',
'{{ DBName }}',
'{{ ClusterType }}',
'{{ MasterUserPassword }}',
'{{ ClusterSecurityGroups }}',
'{{ VpcSecurityGroupIds }}',
'{{ ClusterSubnetGroupName }}',
'{{ AvailabilityZone }}',
'{{ PreferredMaintenanceWindow }}',
'{{ ClusterParameterGroupName }}',
'{{ AutomatedSnapshotRetentionPeriod }}',
'{{ ManualSnapshotRetentionPeriod }}',
'{{ Port }}',
'{{ ClusterVersion }}',
'{{ AllowVersionUpgrade }}',
'{{ NumberOfNodes }}',
'{{ PubliclyAccessible }}',
'{{ Encrypted }}',
'{{ HsmClientCertificateIdentifier }}',
'{{ HsmConfigurationIdentifier }}',
'{{ ElasticIp }}',
'{{ Tags }}',
'{{ KmsKeyId }}',
'{{ EnhancedVpcRouting }}',
'{{ AdditionalInfo }}',
'{{ IamRoles }}',
'{{ MaintenanceTrackName }}',
'{{ SnapshotScheduleIdentifier }}',
'{{ AvailabilityZoneRelocation }}',
'{{ AquaConfigurationStatus }}',
'{{ DefaultIamRoleArn }}',
'{{ LoadSampleData }}',
'{{ ManageMasterPassword }}',
'{{ MasterPasswordSecretKmsKeyId }}',
'{{ IpAddressType }}',
'{{ MultiAZ }}',
'{{ RedshiftIdcApplicationArn }}',
'{{ CatalogName }}',
'{{ ExtraComputeForAutomaticOptimization }}'
RETURNING
allow_version_upgrade,
aqua_configuration,
automated_snapshot_retention_period,
availability_zone,
availability_zone_relocation_status,
catalog_arn,
cluster_availability_status,
cluster_create_time,
cluster_identifier,
cluster_namespace_arn,
cluster_nodes,
cluster_parameter_groups,
cluster_public_key,
cluster_revision_number,
cluster_security_groups,
cluster_snapshot_copy_status,
cluster_status,
cluster_subnet_group_name,
cluster_version,
custom_domain_certificate_arn,
custom_domain_certificate_expiry_date,
custom_domain_name,
db_name,
data_transfer_progress,
default_iam_role_arn,
deferred_maintenance_windows,
elastic_ip_status,
elastic_resize_number_of_node_options,
encrypted,
endpoint,
enhanced_vpc_routing,
expected_next_snapshot_schedule_time,
expected_next_snapshot_schedule_time_status,
extra_compute_for_automatic_optimization,
hsm_status,
iam_roles,
ip_address_type,
kms_key_id,
lakehouse_registration_status,
logging_publish_status,
maintenance_track_name,
manual_snapshot_retention_period,
master_password_secret_arn,
master_password_secret_kms_key_id,
master_username,
modify_status,
multi_az,
multi_az_secondary,
next_maintenance_window_start_time,
node_type,
number_of_nodes,
pending_actions,
pending_modified_values,
preferred_maintenance_window,
publicly_accessible,
reserved_node_exchange_status,
resize_info,
restore_status,
snapshot_schedule_identifier,
snapshot_schedule_state,
tags,
total_storage_capacity_in_mega_bytes,
vpc_id,
vpc_security_groups
;

Manifest

# Description fields are for documentation purposes
- name: clusters
props:
  - name: ClusterIdentifier
    value: "{{ ClusterIdentifier }}"
    description: Required parameter for the clusters resource.
  - name: NodeType
    value: "{{ NodeType }}"
    description: Required parameter for the clusters resource.
  - name: MasterUsername
    value: "{{ MasterUsername }}"
    description: Required parameter for the clusters resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the clusters resource.
  - name: DBName
    value: "{{ DBName }}"
    description: 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. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
    description: 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. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
  - name: ClusterType
    value: "{{ ClusterType }}"
    description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node
    description: The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node
  - name: MasterUserPassword
    value: "{{ MasterUserPassword }}"
    description: The password associated with the admin user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), " (double quote), , /, or @.
    description: The password associated with the admin user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), " (double quote), , /, or @.
  - name: ClusterSecurityGroups
    value: "{{ ClusterSecurityGroups }}"
    description: A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift.
    description: A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift.
  - name: VpcSecurityGroupIds
    value: "{{ VpcSecurityGroupIds }}"
    description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster.
    description: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster.
  - name: ClusterSubnetGroupName
    value: "{{ ClusterSubnetGroupName }}"
    description: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
    description: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
  - name: AvailabilityZone
    value: "{{ AvailabilityZone }}"
    description: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: us-east-2d Constraint: The specified Availability Zone must be in the same region as the current endpoint.
    description: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: us-east-2d Constraint: The specified Availability Zone must be in the same region as the current endpoint.
  - name: PreferredMaintenanceWindow
    value: "{{ PreferredMaintenanceWindow }}"
    description: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
    description: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
  - name: ClusterParameterGroupName
    value: "{{ ClusterParameterGroupName }}"
    description: The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
    description: The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
  - name: AutomatedSnapshotRetentionPeriod
    value: {{ AutomatedSnapshotRetentionPeriod }}
    description: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. You can't disable automated snapshots for RG or RA3 node types. Set the automated retention period from 1-35 days. Default: 1 Constraints: Must be a value from 0 to 35.
    description: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. You can't disable automated snapshots for RG or RA3 node types. Set the automated retention period from 1-35 days. Default: 1 Constraints: Must be a value from 0 to 35.
  - name: ManualSnapshotRetentionPeriod
    value: {{ ManualSnapshotRetentionPeriod }}
    description: The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
    description: The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653.
  - name: Port
    value: {{ Port }}
    description: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: 5439 Valid Values: For clusters with RG or RA3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with RG or RA3 nodes, it isn't required that you change the port to these ranges.) For clusters with dc2 nodes - Select a port within the range 1150-65535.
    description: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: 5439 Valid Values: For clusters with RG or RA3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with RG or RA3 nodes, it isn't required that you change the port to these ranges.) For clusters with dc2 nodes - Select a port within the range 1150-65535.
  - name: ClusterVersion
    value: "{{ ClusterVersion }}"
    description: 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. Constraints: Only version 1.0 is currently available. Example: 1.0
    description: 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. Constraints: Only version 1.0 is currently available. Example: 1.0
  - name: AllowVersionUpgrade
    value: {{ AllowVersionUpgrade }}
    description: If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: true
    description: If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: true
  - name: NumberOfNodes
    value: {{ NumberOfNodes }}
    description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: 1 Constraints: Value must be at least 1 and no more than 100.
    description: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: 1 Constraints: Value must be at least 1 and no more than 100.
  - name: PubliclyAccessible
    value: {{ PubliclyAccessible }}
    description: If true, the cluster can be accessed from a public network. Default: false
    description: If true, the cluster can be accessed from a public network. Default: false
  - name: Encrypted
    value: {{ Encrypted }}
    description: If true, the data in the cluster is encrypted at rest. If you set the value on this parameter to false, the request will fail. Default: true
    description: If true, the data in the cluster is encrypted at rest. If you set the value on this parameter to false, the request will fail. Default: true
  - name: HsmClientCertificateIdentifier
    value: "{{ HsmClientCertificateIdentifier }}"
    description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
    description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
  - name: HsmConfigurationIdentifier
    value: "{{ HsmConfigurationIdentifier }}"
    description: 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.
    description: 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.
  - name: ElasticIp
    value: "{{ ElasticIp }}"
    description: The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
    description: The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
  - name: Tags
    value: "{{ Tags }}"
    description: A list of tag instances.
    description: A list of tag instances.
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"
    description: The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
    description: The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
  - name: EnhancedVpcRouting
    value: {{ EnhancedVpcRouting }}
    description: 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
    description: 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
  - name: AdditionalInfo
    value: "{{ AdditionalInfo }}"
    description: Reserved.
    description: Reserved.
  - name: IamRoles
    value: "{{ IamRoles }}"
    description: A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
    description: A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
  - name: MaintenanceTrackName
    value: "{{ MaintenanceTrackName }}"
    description: An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.
    description: An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.
  - name: SnapshotScheduleIdentifier
    value: "{{ SnapshotScheduleIdentifier }}"
    description: A unique identifier for the snapshot schedule.
    description: A unique identifier for the snapshot schedule.
  - name: AvailabilityZoneRelocation
    value: {{ AvailabilityZoneRelocation }}
    description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
    description: The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
  - name: AquaConfigurationStatus
    value: "{{ AquaConfigurationStatus }}"
    description: This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
    description: This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
  - name: DefaultIamRoleArn
    value: "{{ DefaultIamRoleArn }}"
    description: The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
    description: The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
  - name: LoadSampleData
    value: "{{ LoadSampleData }}"
    description: A flag that specifies whether to load sample data once the cluster is created.
    description: A flag that specifies whether to load sample data once the cluster is created.
  - name: ManageMasterPassword
    value: {{ ManageMasterPassword }}
    description: If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. 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.
    description: If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. 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.
  - name: MasterPasswordSecretKmsKeyId
    value: "{{ MasterPasswordSecretKmsKeyId }}"
    description: The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
    description: The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
  - name: IpAddressType
    value: "{{ IpAddressType }}"
    description: The IP address types that the cluster supports. Possible values are ipv4 and dualstack.
    description: The IP address types that the cluster supports. Possible values are ipv4 and dualstack.
  - name: MultiAZ
    value: {{ MultiAZ }}
    description: If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
    description: If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
  - name: RedshiftIdcApplicationArn
    value: "{{ RedshiftIdcApplicationArn }}"
    description: The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.
    description: The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.
  - name: CatalogName
    value: "{{ CatalogName }}"
    description: The name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions. Constraints: Must contain at least one lowercase letter. Can only contain lowercase letters (a-z), numbers (0-9), underscores (_), and hyphens (-). Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$ Example: my-catalog_01
    description: The name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions. Constraints: Must contain at least one lowercase letter. Can only contain lowercase letters (a-z), numbers (0-9), underscores (_), and hyphens (-). Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$ Example: my-catalog_01
  - name: ExtraComputeForAutomaticOptimization
    value: {{ ExtraComputeForAutomaticOptimization }}
    description: If true, allocates additional compute resources for running automatic optimization operations. Default: false
    description: If true, allocates additional compute resources for running automatic optimization operations. Default: false

UPDATE examples

modify_snapshot_copy_retention_period

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

UPDATE aws.redshift.clusters
SET 
-- No updatable properties
WHERE 
ClusterIdentifier = '{{ ClusterIdentifier }}' --required
AND RetentionPeriod = '{{ RetentionPeriod }}' --required
AND region = '{{ region }}' --required
AND Manual = {{ Manual}}
RETURNING
allow_version_upgrade,
aqua_configuration,
automated_snapshot_retention_period,
availability_zone,
availability_zone_relocation_status,
catalog_arn,
cluster_availability_status,
cluster_create_time,
cluster_identifier,
cluster_namespace_arn,
cluster_nodes,
cluster_parameter_groups,
cluster_public_key,
cluster_revision_number,
cluster_security_groups,
cluster_snapshot_copy_status,
cluster_status,
cluster_subnet_group_name,
cluster_version,
custom_domain_certificate_arn,
custom_domain_certificate_expiry_date,
custom_domain_name,
db_name,
data_transfer_progress,
default_iam_role_arn,
deferred_maintenance_windows,
elastic_ip_status,
elastic_resize_number_of_node_options,
encrypted,
endpoint,
enhanced_vpc_routing,
expected_next_snapshot_schedule_time,
expected_next_snapshot_schedule_time_status,
extra_compute_for_automatic_optimization,
hsm_status,
iam_roles,
ip_address_type,
kms_key_id,
lakehouse_registration_status,
logging_publish_status,
maintenance_track_name,
manual_snapshot_retention_period,
master_password_secret_arn,
master_password_secret_kms_key_id,
master_username,
modify_status,
multi_az,
multi_az_secondary,
next_maintenance_window_start_time,
node_type,
number_of_nodes,
pending_actions,
pending_modified_values,
preferred_maintenance_window,
publicly_accessible,
reserved_node_exchange_status,
resize_info,
restore_status,
snapshot_schedule_identifier,
snapshot_schedule_state,
tags,
total_storage_capacity_in_mega_bytes,
vpc_id,
vpc_security_groups;

modify_cluster

Modifies the settings for a cluster. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. You can add another security or parameter group, or change the admin user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked: Creating a public cluster Restoring a public cluster Modifying a private cluster to be public Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

UPDATE aws.redshift.clusters
SET 
-- No updatable properties
WHERE 
ClusterIdentifier = '{{ ClusterIdentifier }}' --required
AND region = '{{ region }}' --required
AND ClusterType = '{{ ClusterType}}'
AND NodeType = '{{ NodeType}}'
AND NumberOfNodes = '{{ NumberOfNodes}}'
AND ClusterSecurityGroups = '{{ ClusterSecurityGroups}}'
AND VpcSecurityGroupIds = '{{ VpcSecurityGroupIds}}'
AND MasterUserPassword = '{{ MasterUserPassword}}'
AND ClusterParameterGroupName = '{{ ClusterParameterGroupName}}'
AND AutomatedSnapshotRetentionPeriod = '{{ AutomatedSnapshotRetentionPeriod}}'
AND ManualSnapshotRetentionPeriod = '{{ ManualSnapshotRetentionPeriod}}'
AND PreferredMaintenanceWindow = '{{ PreferredMaintenanceWindow}}'
AND ClusterVersion = '{{ ClusterVersion}}'
AND AllowVersionUpgrade = {{ AllowVersionUpgrade}}
AND HsmClientCertificateIdentifier = '{{ HsmClientCertificateIdentifier}}'
AND HsmConfigurationIdentifier = '{{ HsmConfigurationIdentifier}}'
AND NewClusterIdentifier = '{{ NewClusterIdentifier}}'
AND PubliclyAccessible = {{ PubliclyAccessible}}
AND ElasticIp = '{{ ElasticIp}}'
AND EnhancedVpcRouting = {{ EnhancedVpcRouting}}
AND MaintenanceTrackName = '{{ MaintenanceTrackName}}'
AND Encrypted = {{ Encrypted}}
AND KmsKeyId = '{{ KmsKeyId}}'
AND AvailabilityZoneRelocation = {{ AvailabilityZoneRelocation}}
AND AvailabilityZone = '{{ AvailabilityZone}}'
AND Port = '{{ Port}}'
AND ManageMasterPassword = {{ ManageMasterPassword}}
AND MasterPasswordSecretKmsKeyId = '{{ MasterPasswordSecretKmsKeyId}}'
AND IpAddressType = '{{ IpAddressType}}'
AND MultiAZ = {{ MultiAZ}}
AND ExtraComputeForAutomaticOptimization = {{ ExtraComputeForAutomaticOptimization}}
RETURNING
allow_version_upgrade,
aqua_configuration,
automated_snapshot_retention_period,
availability_zone,
availability_zone_relocation_status,
catalog_arn,
cluster_availability_status,
cluster_create_time,
cluster_identifier,
cluster_namespace_arn,
cluster_nodes,
cluster_parameter_groups,
cluster_public_key,
cluster_revision_number,
cluster_security_groups,
cluster_snapshot_copy_status,
cluster_status,
cluster_subnet_group_name,
cluster_version,
custom_domain_certificate_arn,
custom_domain_certificate_expiry_date,
custom_domain_name,
db_name,
data_transfer_progress,
default_iam_role_arn,
deferred_maintenance_windows,
elastic_ip_status,
elastic_resize_number_of_node_options,
encrypted,
endpoint,
enhanced_vpc_routing,
expected_next_snapshot_schedule_time,
expected_next_snapshot_schedule_time_status,
extra_compute_for_automatic_optimization,
hsm_status,
iam_roles,
ip_address_type,
kms_key_id,
lakehouse_registration_status,
logging_publish_status,
maintenance_track_name,
manual_snapshot_retention_period,
master_password_secret_arn,
master_password_secret_kms_key_id,
master_username,
modify_status,
multi_az,
multi_az_secondary,
next_maintenance_window_start_time,
node_type,
number_of_nodes,
pending_actions,
pending_modified_values,
preferred_maintenance_window,
publicly_accessible,
reserved_node_exchange_status,
resize_info,
restore_status,
snapshot_schedule_identifier,
snapshot_schedule_state,
tags,
total_storage_capacity_in_mega_bytes,
vpc_id,
vpc_security_groups;

DELETE examples

delete_cluster

Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide. If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

DELETE FROM aws.redshift.clusters
WHERE ClusterIdentifier = '{{ ClusterIdentifier }}' --required
AND region = '{{ region }}' --required
AND SkipFinalClusterSnapshot = '{{ SkipFinalClusterSnapshot }}'
AND FinalClusterSnapshotIdentifier = '{{ FinalClusterSnapshotIdentifier }}'
AND FinalClusterSnapshotRetentionPeriod = '{{ FinalClusterSnapshotRetentionPeriod }}'
;

Lifecycle Methods

cancel_resize

Cancels a resize operation for a cluster.

EXEC aws.redshift.clusters.cancel_resize 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required
;

copy_cluster_snapshot

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state. When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

EXEC aws.redshift.clusters.copy_cluster_snapshot 
@SourceSnapshotIdentifier='{{ SourceSnapshotIdentifier }}' --required, 
@TargetSnapshotIdentifier='{{ TargetSnapshotIdentifier }}' --required, 
@region='{{ region }}' --required, 
@SourceSnapshotClusterIdentifier='{{ SourceSnapshotClusterIdentifier }}', 
@ManualSnapshotRetentionPeriod='{{ ManualSnapshotRetentionPeriod }}'
;

disable_logging

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

EXEC aws.redshift.clusters.disable_logging 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required, 
@LogDestinationType='{{ LogDestinationType }}', 
@LogExports='{{ LogExports }}'
;

disable_snapshot_copy

Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using an encrypted symmetric key from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the key in the destination region.

EXEC aws.redshift.clusters.disable_snapshot_copy 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required
;

enable_logging

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

EXEC aws.redshift.clusters.enable_logging 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required, 
@BucketName='{{ BucketName }}', 
@S3KeyPrefix='{{ S3KeyPrefix }}', 
@LogDestinationType='{{ LogDestinationType }}', 
@LogExports='{{ LogExports }}', 
@S3TableKmsKeyId='{{ S3TableKmsKeyId }}', 
@S3TableGranularity='{{ S3TableGranularity }}'
;

enable_snapshot_copy

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

EXEC aws.redshift.clusters.enable_snapshot_copy 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@DestinationRegion='{{ DestinationRegion }}' --required, 
@region='{{ region }}' --required, 
@RetentionPeriod='{{ RetentionPeriod }}', 
@SnapshotCopyGrantName='{{ SnapshotCopyGrantName }}', 
@ManualSnapshotRetentionPeriod='{{ ManualSnapshotRetentionPeriod }}'
;

failover_primary_compute

Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.

EXEC aws.redshift.clusters.failover_primary_compute 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required
;

modify_aqua_configuration

This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

EXEC aws.redshift.clusters.modify_aqua_configuration 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required, 
@AquaConfigurationStatus='{{ AquaConfigurationStatus }}'
;

modify_cluster_iam_roles

Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

EXEC aws.redshift.clusters.modify_cluster_iam_roles 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required, 
@AddIamRoles='{{ AddIamRoles }}', 
@RemoveIamRoles='{{ RemoveIamRoles }}', 
@DefaultIamRoleArn='{{ DefaultIamRoleArn }}'
;

modify_cluster_maintenance

Modifies the maintenance settings of a cluster.

EXEC aws.redshift.clusters.modify_cluster_maintenance 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required, 
@DeferMaintenance={{ DeferMaintenance }}, 
@DeferMaintenanceIdentifier='{{ DeferMaintenanceIdentifier }}', 
@DeferMaintenanceStartTime='{{ DeferMaintenanceStartTime }}', 
@DeferMaintenanceEndTime='{{ DeferMaintenanceEndTime }}', 
@DeferMaintenanceDuration='{{ DeferMaintenanceDuration }}'
;

modify_lakehouse_configuration

Modifies the lakehouse configuration for a cluster. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM Identity Center trusted identity propagation.

EXEC aws.redshift.clusters.modify_lakehouse_configuration 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required, 
@LakehouseRegistration='{{ LakehouseRegistration }}', 
@CatalogName='{{ CatalogName }}', 
@LakehouseIdcRegistration='{{ LakehouseIdcRegistration }}', 
@LakehouseIdcApplicationArn='{{ LakehouseIdcApplicationArn }}', 
@DryRun={{ DryRun }}
;

pause_cluster

Pauses a cluster.

EXEC aws.redshift.clusters.pause_cluster 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required
;

reboot_cluster

Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

EXEC aws.redshift.clusters.reboot_cluster 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required
;

resize_cluster

Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method. Elastic resize operations have the following restrictions: You can only resize clusters of the following types: dc2.large dc2.8xlarge rg.large rg.xlarge rg.4xlarge rg.12xlarge ra3.large ra3.xlplus ra3.4xlarge ra3.16xlarge The type of nodes that you add must match the node type for the cluster.

EXEC aws.redshift.clusters.resize_cluster 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required, 
@ClusterType='{{ ClusterType }}', 
@NodeType='{{ NodeType }}', 
@NumberOfNodes='{{ NumberOfNodes }}', 
@Classic={{ Classic }}, 
@ReservedNodeId='{{ ReservedNodeId }}', 
@TargetReservedNodeOfferingId='{{ TargetReservedNodeOfferingId }}'
;

restore_from_cluster_snapshot

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore. If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked: Creating a public cluster Restoring a public cluster Modifying a private cluster to be public Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide. For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

EXEC aws.redshift.clusters.restore_from_cluster_snapshot 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required, 
@SnapshotIdentifier='{{ SnapshotIdentifier }}', 
@SnapshotArn='{{ SnapshotArn }}', 
@SnapshotClusterIdentifier='{{ SnapshotClusterIdentifier }}', 
@Port='{{ Port }}', 
@AvailabilityZone='{{ AvailabilityZone }}', 
@AllowVersionUpgrade={{ AllowVersionUpgrade }}, 
@ClusterSubnetGroupName='{{ ClusterSubnetGroupName }}', 
@PubliclyAccessible={{ PubliclyAccessible }}, 
@OwnerAccount='{{ OwnerAccount }}', 
@HsmClientCertificateIdentifier='{{ HsmClientCertificateIdentifier }}', 
@HsmConfigurationIdentifier='{{ HsmConfigurationIdentifier }}', 
@ElasticIp='{{ ElasticIp }}', 
@ClusterParameterGroupName='{{ ClusterParameterGroupName }}', 
@ClusterSecurityGroups='{{ ClusterSecurityGroups }}', 
@VpcSecurityGroupIds='{{ VpcSecurityGroupIds }}', 
@PreferredMaintenanceWindow='{{ PreferredMaintenanceWindow }}', 
@AutomatedSnapshotRetentionPeriod='{{ AutomatedSnapshotRetentionPeriod }}', 
@ManualSnapshotRetentionPeriod='{{ ManualSnapshotRetentionPeriod }}', 
@KmsKeyId='{{ KmsKeyId }}', 
@NodeType='{{ NodeType }}', 
@EnhancedVpcRouting={{ EnhancedVpcRouting }}, 
@AdditionalInfo='{{ AdditionalInfo }}', 
@IamRoles='{{ IamRoles }}', 
@MaintenanceTrackName='{{ MaintenanceTrackName }}', 
@SnapshotScheduleIdentifier='{{ SnapshotScheduleIdentifier }}', 
@NumberOfNodes='{{ NumberOfNodes }}', 
@AvailabilityZoneRelocation={{ AvailabilityZoneRelocation }}, 
@AquaConfigurationStatus='{{ AquaConfigurationStatus }}', 
@DefaultIamRoleArn='{{ DefaultIamRoleArn }}', 
@ReservedNodeId='{{ ReservedNodeId }}', 
@TargetReservedNodeOfferingId='{{ TargetReservedNodeOfferingId }}', 
@Encrypted={{ Encrypted }}, 
@ManageMasterPassword={{ ManageMasterPassword }}, 
@MasterPasswordSecretKmsKeyId='{{ MasterPasswordSecretKmsKeyId }}', 
@IpAddressType='{{ IpAddressType }}', 
@MultiAZ={{ MultiAZ }}, 
@CatalogName='{{ CatalogName }}', 
@RedshiftIdcApplicationArn='{{ RedshiftIdcApplicationArn }}'
;

restore_table_from_cluster_snapshot

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from. You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot. You can't use this operation to restore tables with interleaved sort keys.

EXEC aws.redshift.clusters.restore_table_from_cluster_snapshot 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@SnapshotIdentifier='{{ SnapshotIdentifier }}' --required, 
@SourceDatabaseName='{{ SourceDatabaseName }}' --required, 
@SourceTableName='{{ SourceTableName }}' --required, 
@NewTableName='{{ NewTableName }}' --required, 
@region='{{ region }}' --required, 
@SourceSchemaName='{{ SourceSchemaName }}', 
@TargetDatabaseName='{{ TargetDatabaseName }}', 
@TargetSchemaName='{{ TargetSchemaName }}', 
@EnableCaseSensitiveIdentifier={{ EnableCaseSensitiveIdentifier }}
;

resume_cluster

Resumes a paused cluster.

EXEC aws.redshift.clusters.resume_cluster 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required
;

rotate_encryption_key

Rotates the encryption keys for a cluster.

EXEC aws.redshift.clusters.rotate_encryption_key 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@region='{{ region }}' --required
;