Documentation

Describes a cluster.

See: newCluster smart constructor.

Create a value of Cluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allowVersionUpgrade:Cluster', cluster_allowVersionUpgrade - A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

$sel:aquaConfiguration:Cluster', cluster_aquaConfiguration - This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Cluster, cluster_automatedSnapshotRetentionPeriod - The number of days that automatic cluster snapshots are retained.

$sel:availabilityZone:Cluster', cluster_availabilityZone - The name of the Availability Zone in which the cluster is located.

$sel:availabilityZoneRelocationStatus:Cluster', cluster_availabilityZoneRelocationStatus - Describes the status of the Availability Zone relocation operation.

$sel:clusterAvailabilityStatus:Cluster', cluster_clusterAvailabilityStatus - 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.

$sel:clusterCreateTime:Cluster', cluster_clusterCreateTime - The date and time that the cluster was created.

Cluster, cluster_clusterIdentifier - The unique identifier of the cluster.

$sel:clusterNamespaceArn:Cluster', cluster_clusterNamespaceArn - The namespace Amazon Resource Name (ARN) of the cluster.

$sel:clusterNodes:Cluster', cluster_clusterNodes - The nodes in the cluster.

$sel:clusterParameterGroups:Cluster', cluster_clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

$sel:clusterPublicKey:Cluster', cluster_clusterPublicKey - The public key for the cluster.

$sel:clusterRevisionNumber:Cluster', cluster_clusterRevisionNumber - The specific revision number of the database in the cluster.

$sel:clusterSecurityGroups:Cluster', cluster_clusterSecurityGroups - 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.

$sel:clusterSnapshotCopyStatus:Cluster', cluster_clusterSnapshotCopyStatus - A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

$sel:clusterStatus:Cluster', cluster_clusterStatus - 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

$sel:clusterSubnetGroupName:Cluster', cluster_clusterSubnetGroupName - 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, cluster_clusterVersion - The version ID of the Amazon Redshift engine that is running on the cluster.

$sel:dbName:Cluster', cluster_dbName - 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.

$sel:dataTransferProgress:Cluster', cluster_dataTransferProgress -

$sel:defaultIamRoleArn:Cluster', cluster_defaultIamRoleArn - The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.

$sel:deferredMaintenanceWindows:Cluster', cluster_deferredMaintenanceWindows - Describes a group of DeferredMaintenanceWindow objects.

$sel:elasticIpStatus:Cluster', cluster_elasticIpStatus - The status of the elastic IP (EIP) address.

$sel:elasticResizeNumberOfNodeOptions:Cluster', cluster_elasticResizeNumberOfNodeOptions - The number of nodes that you can resize the cluster to with the elastic resize method.

$sel:encrypted:Cluster', cluster_encrypted - A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

$sel:endpoint:Cluster', cluster_endpoint - The connection endpoint.

Cluster, cluster_enhancedVpcRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

$sel:expectedNextSnapshotScheduleTime:Cluster', cluster_expectedNextSnapshotScheduleTime - The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

$sel:expectedNextSnapshotScheduleTimeStatus:Cluster', cluster_expectedNextSnapshotScheduleTimeStatus - 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.

$sel:hsmStatus:Cluster', cluster_hsmStatus - 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

$sel:iamRoles:Cluster', cluster_iamRoles - A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

$sel:kmsKeyId:Cluster', cluster_kmsKeyId - The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

Cluster, cluster_maintenanceTrackName - The name of the maintenance track for the cluster.

Cluster, cluster_manualSnapshotRetentionPeriod - 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.

$sel:masterUsername:Cluster', cluster_masterUsername - The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

$sel:modifyStatus:Cluster', cluster_modifyStatus - The status of a modify operation, if any, initiated for the cluster.

$sel:nextMaintenanceWindowStartTime:Cluster', cluster_nextMaintenanceWindowStartTime - The date and time in UTC when system maintenance can begin.

Cluster, cluster_nodeType - The node type for the nodes in the cluster.

Cluster, cluster_numberOfNodes - The number of compute nodes in the cluster.

$sel:pendingActions:Cluster', cluster_pendingActions - Cluster operations that are waiting to be started.

$sel:pendingModifiedValues:Cluster', cluster_pendingModifiedValues - A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

$sel:preferredMaintenanceWindow:Cluster', cluster_preferredMaintenanceWindow - The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

Cluster, cluster_publiclyAccessible - A boolean value that, if true, indicates that the cluster can be accessed from a public network.

$sel:reservedNodeExchangeStatus:Cluster', cluster_reservedNodeExchangeStatus - The status of the reserved-node exchange request. Statuses include in-progress and requested.

$sel:resizeInfo:Cluster', cluster_resizeInfo - Returns the following:

• AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
• ResizeType: Returns ClassicResize

$sel:restoreStatus:Cluster', cluster_restoreStatus - 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.

$sel:snapshotScheduleIdentifier:Cluster', cluster_snapshotScheduleIdentifier - A unique identifier for the cluster snapshot schedule.

$sel:snapshotScheduleState:Cluster', cluster_snapshotScheduleState - The current state of the cluster snapshot schedule.

$sel:tags:Cluster', cluster_tags - The list of tags for the cluster.

$sel:totalStorageCapacityInMegaBytes:Cluster', cluster_totalStorageCapacityInMegaBytes - The total storage capacity of the cluster in megabytes.

$sel:vpcId:Cluster', cluster_vpcId - The identifier of the VPC the cluster is in, if the cluster is in a VPC.

$sel:vpcSecurityGroups:Cluster', cluster_vpcSecurityGroups - 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.

A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

The number of days that automatic cluster snapshots are retained.

The name of the Availability Zone in which the cluster is located.

Describes the status of the Availability Zone relocation operation.

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.

The date and time that the cluster was created.

The unique identifier of the cluster.

The namespace Amazon Resource Name (ARN) of the cluster.

The nodes in the cluster.

The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

The public key for the cluster.

The specific revision number of the database in the cluster.

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.

A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

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

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

The version ID of the Amazon Redshift engine that is running on the cluster.

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.

The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.

Describes a group of DeferredMaintenanceWindow objects.

The status of the elastic IP (EIP) address.

The number of nodes that you can resize the cluster to with the elastic resize method.

A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

The connection endpoint.

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

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.

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

A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

The name of the maintenance track for the cluster.

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.

The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

The status of a modify operation, if any, initiated for the cluster.

The date and time in UTC when system maintenance can begin.

The node type for the nodes in the cluster.

The number of compute nodes in the cluster.

Cluster operations that are waiting to be started.

A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

A boolean value that, if true, indicates that the cluster can be accessed from a public network.

The status of the reserved-node exchange request. Statuses include in-progress and requested.

Returns the following:

• AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
• ResizeType: Returns ClassicResize

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.

A unique identifier for the cluster snapshot schedule.

The current state of the cluster snapshot schedule.

The list of tags for the cluster.

The total storage capacity of the cluster in megabytes.

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

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.