You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Redshift::Types::Cluster

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a cluster.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#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.

Returns:

  • (Boolean) —

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

#automated_snapshot_retention_period ⇒ Integer

The number of days that automatic cluster snapshots are retained.

Returns:

  • (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.

Returns:

  • (String) —

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

#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.

Returns:

  • (String) —

    The availability status of the cluster for queries.

#cluster_create_time ⇒ Time

The date and time that the cluster was created.

Returns:

  • (Time) —

    The date and time that the cluster was created.

#cluster_identifier ⇒ String

The unique identifier of the cluster.

Returns:

  • (String) —

    The unique identifier of the cluster.

#cluster_namespace_arn ⇒ String

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

Returns:

  • (String) —

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

#cluster_nodes ⇒ Array<Types::ClusterNode>

The nodes in the cluster.

Returns:

#cluster_parameter_groups ⇒ Array<Types::ClusterParameterGroupStatus>

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

Returns:

#cluster_public_key ⇒ String

The public key for the cluster.

Returns:

  • (String) —

    The public key for the cluster.

#cluster_revision_number ⇒ String

The specific revision number of the database in the cluster.

Returns:

  • (String) —

    The specific revision number of the database in the cluster.

#cluster_security_groups ⇒ Array<Types::ClusterSecurityGroupMembership>

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.

Returns:

#cluster_snapshot_copy_status ⇒ Types::ClusterSnapshotCopyStatus

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

Returns:

#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

Returns:

  • (String) —

    The current state of the cluster.

#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.

Returns:

  • (String) —

    The name of the subnet group that is associated with the cluster.

#cluster_version ⇒ String

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

Returns:

  • (String) —

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

#data_transfer_progress ⇒ Types::DataTransferProgress

Returns:

#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.

Returns:

  • (String) —

    The name of the initial database that was created when the cluster was created.

#deferred_maintenance_windows ⇒ Array<Types::DeferredMaintenanceWindow>

Describes a group of DeferredMaintenanceWindow objects.

Returns:

#elastic_ip_status ⇒ Types::ElasticIpStatus

The status of the elastic IP (EIP) address.

Returns:

#elastic_resize_number_of_node_options ⇒ String

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

Returns:

  • (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.

Returns:

  • (Boolean) —

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

#endpoint ⇒ Types::Endpoint

The connection endpoint.

Returns:

#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

Returns:

  • (Boolean) —

    An option that specifies whether to create the cluster with enhanced VPC routing enabled.

#expected_next_snapshot_schedule_time ⇒ Time

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

Returns:

  • (Time) —

    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.

Returns:

  • (String) —

    The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled.

#hsm_status ⇒ Types::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

Returns:

  • (Types::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.

#iam_roles ⇒ Array<Types::ClusterIamRole>

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

Returns:

  • (Array<Types::ClusterIamRole>) —

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

#kms_key_id ⇒ String

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

Returns:

  • (String) —

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

#maintenance_track_name ⇒ String

The name of the maintenance track for the cluster.

Returns:

  • (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.

Returns:

  • (Integer) —

    The default number of days to retain a manual snapshot.

#master_username ⇒ String

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

Returns:

  • (String) —

    The master user name for the cluster.

#modify_status ⇒ String

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

Returns:

  • (String) —

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

#next_maintenance_window_start_time ⇒ Time

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

Returns:

  • (Time) —

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

#node_type ⇒ String

The node type for the nodes in the cluster.

Returns:

  • (String) —

    The node type for the nodes in the cluster.

#number_of_nodes ⇒ Integer

The number of compute nodes in the cluster.

Returns:

  • (Integer) —

    The number of compute nodes in the cluster.

#pending_actions ⇒ Array<String>

Cluster operations that are waiting to be started.

Returns:

  • (Array<String>) —

    Cluster operations that are waiting to be started.

#pending_modified_values ⇒ Types::PendingModifiedValues

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

Returns:

#preferred_maintenance_window ⇒ String

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

Returns:

  • (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.

Returns:

  • (Boolean) —

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

#resize_info ⇒ Types::ResizeInfo

Returns the following:

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

  • ResizeType: Returns ClassicResize

Returns:

#restore_status ⇒ Types::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.

Returns:

#snapshot_schedule_identifier ⇒ String

A unique identifier for the cluster snapshot schedule.

Returns:

  • (String) —

    A unique identifier for the cluster snapshot schedule.

#snapshot_schedule_state ⇒ String

The current state of the cluster snapshot schedule.

Possible values:

  • MODIFYING
  • ACTIVE
  • FAILED

Returns:

  • (String) —

    The current state of the cluster snapshot schedule.

#tags ⇒ Array<Types::Tag>

The list of tags for the cluster.

Returns:

  • (Array<Types::Tag>) —

    The list of tags for the cluster.

#vpc_id ⇒ String

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

Returns:

  • (String) —

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

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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.

Returns: