Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

Cluster

Describes a cluster.

Contents

Note

In the following list, the required parameters are described first.

AllowVersionUpgrade

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

Type: Boolean

Required: No

AutomatedSnapshotRetentionPeriod

The number of days that automatic cluster snapshots are retained.

Type: Integer

Required: No

AvailabilityZone

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

Type: String

Required: No

ClusterCreateTime

The date and time that the cluster was created.

Type: Timestamp

Required: No

ClusterIdentifier

The unique identifier of the cluster.

Type: String

Required: No

ClusterNodes.member.N

The nodes in the cluster.

Type: Array of ClusterNode objects

Required: No

ClusterParameterGroups.ClusterParameterGroup.N

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

Type: Array of ClusterParameterGroupStatus objects

Required: No

ClusterPublicKey

The public key for the cluster.

Type: String

Required: No

ClusterRevisionNumber

The specific revision number of the database in the cluster.

Type: String

Required: No

ClusterSecurityGroups.ClusterSecurityGroup.N

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.

Type: Array of ClusterSecurityGroupMembership objects

Required: No

ClusterSnapshotCopyStatus

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

Type: ClusterSnapshotCopyStatus object

Required: No

ClusterStatus

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

  • available

  • creating

  • deleting

  • final-snapshot

  • hardware-failure

  • incompatible-hsm

  • incompatible-network

  • incompatible-parameters

  • incompatible-restore

  • modifying

  • rebooting

  • renaming

  • resizing

  • rotating-keys

  • storage-full

  • updating-hsm

Type: String

Required: No

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.

Type: String

Required: No

ClusterVersion

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

Type: String

Required: No

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.

Type: String

Required: No

ElasticIpStatus

The status of the elastic IP (EIP) address.

Type: ElasticIpStatus object

Required: No

Encrypted

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

Type: Boolean

Required: No

Endpoint

The connection endpoint.

Type: Endpoint object

Required: No

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

Type: Boolean

Required: No

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

Type: HsmStatus object

Required: No

IamRoles.ClusterIamRole.N

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

Type: Array of ClusterIamRole objects

Required: No

KmsKeyId

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

Type: String

Required: No

MaintenanceTrackName

Type: String

Required: No

MasterUsername

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

Type: String

Required: No

ModifyStatus

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

Type: String

Required: No

NodeType

The node type for the nodes in the cluster.

Type: String

Required: No

NumberOfNodes

The number of compute nodes in the cluster.

Type: Integer

Required: No

PendingActions.member.N

Type: Array of strings

Required: No

PendingModifiedValues

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

Type: PendingModifiedValues object

Required: No

PreferredMaintenanceWindow

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

Type: String

Required: No

PubliclyAccessible

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

Type: Boolean

Required: No

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.

Type: RestoreStatus object

Required: No

Tags.Tag.N

The list of tags for the cluster.

Type: Array of Tag objects

Required: No

VpcId

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

Type: String

Required: No

VpcSecurityGroups.VpcSecurityGroup.N

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.

Type: Array of VpcSecurityGroupMembership objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: