Cluster

class Cluster

Describes a cluster.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The number of days that automatic cluster snapshots are retained.

Link copied to clipboard

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

Link copied to clipboard

Describes the status of the Availability Zone relocation operation.

Link copied to clipboard

The availability status of the cluster for queries. Possible values are the following:

Link copied to clipboard

The date and time that the cluster was created.

Link copied to clipboard

The unique identifier of the cluster.

Link copied to clipboard

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

Link copied to clipboard

The nodes in the cluster.

Link copied to clipboard

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

Link copied to clipboard

The public key for the cluster.

Link copied to clipboard

The specific revision number of the database in the cluster.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The current state of the cluster. Possible values are the following:

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The certificate Amazon Resource Name (ARN) for the custom domain name.

Link copied to clipboard

The expiration date for the certificate associated with the custom domain name.

Link copied to clipboard

The custom domain name associated with the cluster.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Describes a group of DeferredMaintenanceWindow objects.

Link copied to clipboard

The status of the elastic IP (EIP) address.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The connection endpoint.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The IP address type for the cluster. Possible values are ipv4 and dualstack.

Link copied to clipboard

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

Link copied to clipboard

The name of the maintenance track for the cluster.

Link copied to clipboard

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.

Link copied to clipboard

The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.

Link copied to clipboard

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.

Link copied to clipboard

The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.

Link copied to clipboard

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

Link copied to clipboard

The node type for the nodes in the cluster.

Link copied to clipboard

The number of compute nodes in the cluster.

Link copied to clipboard

Cluster operations that are waiting to be started.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns the following:

Link copied to clipboard

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.

Link copied to clipboard

A unique identifier for the cluster snapshot schedule.

Link copied to clipboard

The current state of the cluster snapshot schedule.

Link copied to clipboard
val tags: List<Tag>?

The list of tags for the cluster.

Link copied to clipboard

The total storage capacity of the cluster in megabytes.

Link copied to clipboard

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

Link copied to clipboard

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.

Functions

Link copied to clipboard
inline fun copy(block: Cluster.Builder.() -> Unit = {}): Cluster
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String