class Aws::Redshift::Types::Cluster
Describes a cluster.
@!attribute [rw] cluster_identifier
The unique identifier of the cluster. @return [String]
@!attribute [rw] node_type
The node type for the nodes in the cluster. @return [String]
@!attribute [rw] cluster_status
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` @return [String]
@!attribute [rw] cluster_availability_status
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. @return [String]
@!attribute [rw] modify_status
The status of a modify operation, if any, initiated for the cluster. @return [String]
@!attribute [rw] master_username
The admin user name for the cluster. This name is used to connect to the database that is specified in the **DBName** parameter. @return [String]
@!attribute [rw] db_name
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 `dev`dev was created by default. @return [String]
@!attribute [rw] endpoint
The connection endpoint. @return [Types::Endpoint]
@!attribute [rw] cluster_create_time
The date and time that the cluster was created. @return [Time]
@!attribute [rw] automated_snapshot_retention_period
The number of days that automatic cluster snapshots are retained. @return [Integer]
@!attribute [rw] manual_snapshot_retention_period
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. @return [Integer]
@!attribute [rw] cluster_security_groups
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. @return [Array<Types::ClusterSecurityGroupMembership>]
@!attribute [rw] vpc_security_groups
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. @return [Array<Types::VpcSecurityGroupMembership>]
@!attribute [rw] cluster_parameter_groups
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status. @return [Array<Types::ClusterParameterGroupStatus>]
@!attribute [rw] cluster_subnet_group_name
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC. @return [String]
@!attribute [rw] vpc_id
The identifier of the VPC the cluster is in, if the cluster is in a VPC. @return [String]
@!attribute [rw] availability_zone
The name of the Availability Zone in which the cluster is located. @return [String]
@!attribute [rw] preferred_maintenance_window
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. @return [String]
@!attribute [rw] pending_modified_values
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements. @return [Types::PendingModifiedValues]
@!attribute [rw] cluster_version
The version ID of the Amazon Redshift engine that is running on the cluster. @return [String]
@!attribute [rw] allow_version_upgrade
A boolean value that, if `true`, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. @return [Boolean]
@!attribute [rw] number_of_nodes
The number of compute nodes in the cluster. @return [Integer]
@!attribute [rw] publicly_accessible
A boolean value that, if `true`, indicates that the cluster can be accessed from a public network. @return [Boolean]
@!attribute [rw] encrypted
A boolean value that, if `true`, indicates that data in the cluster is encrypted at rest. @return [Boolean]
@!attribute [rw] restore_status
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. @return [Types::RestoreStatus]
@!attribute [rw] data_transfer_progress
@return [Types::DataTransferProgress]
@!attribute [rw] hsm_status
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 @return [Types::HsmStatus]
@!attribute [rw] cluster_snapshot_copy_status
A value that returns the destination region and retention period that are configured for cross-region snapshot copy. @return [Types::ClusterSnapshotCopyStatus]
@!attribute [rw] cluster_public_key
The public key for the cluster. @return [String]
@!attribute [rw] cluster_nodes
The nodes in the cluster. @return [Array<Types::ClusterNode>]
@!attribute [rw] elastic_ip_status
The status of the elastic IP (EIP) address. @return [Types::ElasticIpStatus]
@!attribute [rw] cluster_revision_number
The specific revision number of the database in the cluster. @return [String]
@!attribute [rw] tags
The list of tags for the cluster. @return [Array<Types::Tag>]
@!attribute [rw] kms_key_id
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster. @return [String]
@!attribute [rw] enhanced_vpc_routing
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][1] in the Amazon Redshift Cluster Management Guide. If this option is `true`, enhanced VPC routing is enabled. Default: false [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html @return [Boolean]
@!attribute [rw] iam_roles
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. @return [Array<Types::ClusterIamRole>]
@!attribute [rw] pending_actions
Cluster operations that are waiting to be started. @return [Array<String>]
@!attribute [rw] maintenance_track_name
The name of the maintenance track for the cluster. @return [String]
@!attribute [rw] elastic_resize_number_of_node_options
The number of nodes that you can resize the cluster to with the elastic resize method. @return [String]
@!attribute [rw] deferred_maintenance_windows
Describes a group of `DeferredMaintenanceWindow` objects. @return [Array<Types::DeferredMaintenanceWindow>]
@!attribute [rw] snapshot_schedule_identifier
A unique identifier for the cluster snapshot schedule. @return [String]
@!attribute [rw] snapshot_schedule_state
The current state of the cluster snapshot schedule. @return [String]
@!attribute [rw] expected_next_snapshot_schedule_time
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. @return [Time]
@!attribute [rw] expected_next_snapshot_schedule_time_status
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. @return [String]
@!attribute [rw] next_maintenance_window_start_time
The date and time in UTC when system maintenance can begin. @return [Time]
@!attribute [rw] resize_info
Returns the following: * AllowCancelResize: a boolean value indicating if the resize operation can be cancelled. * ResizeType: Returns ClassicResize @return [Types::ResizeInfo]
@!attribute [rw] availability_zone_relocation_status
Describes the status of the Availability Zone relocation operation. @return [String]
@!attribute [rw] cluster_namespace_arn
The namespace Amazon Resource Name (ARN) of the cluster. @return [String]
@!attribute [rw] total_storage_capacity_in_mega_bytes
The total storage capacity of the cluster in megabytes. @return [Integer]
@!attribute [rw] aqua_configuration
The AQUA (Advanced Query Accelerator) configuration of the cluster. @return [Types::AquaConfiguration]
@see docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/Cluster AWS API Documentation
Constants
- SENSITIVE