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

Inherits:

Struct

Object
Struct
Aws::Redshift::Types::Cluster

show all

Includes:: Structure

Defined in:: lib/aws-sdk-redshift/types.rb

Overview

Describes a cluster.

Instance Attribute Summary collapse

#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.
#automated_snapshot_retention_period ⇒ 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.
#cluster_create_time ⇒ Time

The date and time that the cluster was created.
#cluster_identifier ⇒ String

The unique identifier of the cluster.
#cluster_nodes ⇒ Array<Types::ClusterNode>

The nodes in the cluster.
#cluster_parameter_groups ⇒ Array<Types::ClusterParameterGroupStatus>

The list of cluster parameter groups that are associated with this cluster.
#cluster_public_key ⇒ String

The public key for the cluster.
#cluster_revision_number ⇒ 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.
#cluster_snapshot_copy_status ⇒ Types::ClusterSnapshotCopyStatus

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

The current state of the cluster.
#cluster_subnet_group_name ⇒ 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.
#db_name ⇒ String

The name of the initial database that was created when the cluster was created.
#elastic_ip_status ⇒ Types::ElasticIpStatus

The status of the elastic IP (EIP) address.
#encrypted ⇒ Boolean

A Boolean value that, if true, indicates that data in the cluster is encrypted at rest.
#endpoint ⇒ Types::Endpoint

The connection endpoint.
#enhanced_vpc_routing ⇒ Boolean

An option that specifies whether to create the cluster with enhanced VPC routing 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.
#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.
#kms_key_id ⇒ String

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

The master user name for the cluster.
#modify_status ⇒ String

The status of a modify operation, if any, initiated for the cluster.
#node_type ⇒ String

The node type for the nodes in the cluster.
#number_of_nodes ⇒ Integer

The number of compute nodes in the cluster.
#pending_modified_values ⇒ Types::PendingModifiedValues

A value that, if present, indicates that changes to the cluster are pending.
#preferred_maintenance_window ⇒ 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.
#restore_status ⇒ Types::RestoreStatus

A value that describes the status of a cluster restore action.
#tags ⇒ 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.
#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.

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)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#automated_snapshot_retention_period ⇒ `Integer`

The number of days that automatic cluster snapshots are retained.

Returns:

(Integer)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#availability_zone ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#cluster_create_time ⇒ `Time`

The date and time that the cluster was created.

Returns:

(Time)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#cluster_identifier ⇒ `String`

The unique identifier of the cluster.

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#cluster_nodes ⇒ `Array<Types::ClusterNode>`

The nodes in the cluster.

Returns:

(Array<Types::ClusterNode>)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

(Array<Types::ClusterParameterGroupStatus>)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#cluster_public_key ⇒ `String`

The public key for the cluster.

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#cluster_revision_number ⇒ `String`

The specific revision number of the database in the cluster.

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

(Array<Types::ClusterSecurityGroupMembership>)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

(Types::ClusterSnapshotCopyStatus)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#cluster_status ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#cluster_version ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#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 ‘dev`dev was created by default.

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#elastic_ip_status ⇒ `Types::ElasticIpStatus`

The status of the elastic IP (EIP) address.

Returns:

(Types::ElasticIpStatus)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#encrypted ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#endpoint ⇒ `Types::Endpoint`

The connection endpoint.

Returns:

(Types::Endpoint)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#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][1: in the Amazon Redshift Cluster Management

Guide.

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

Default: false

[1]: docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html

Returns:

(Boolean)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#modify_status ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#node_type ⇒ `String`

The node type for the nodes in the cluster.

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#number_of_nodes ⇒ `Integer`

The number of compute nodes in the cluster.

Returns:

(Integer)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

(Types::PendingModifiedValues)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

(Types::RestoreStatus)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The list of tags for the cluster.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

#vpc_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

(Array<Types::VpcSecurityGroupMembership>)

# File 'lib/aws-sdk-redshift/types.rb', line 359

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :cluster_security_groups,
  :vpc_security_groups,
  :cluster_parameter_groups,
  :cluster_subnet_group_name,
  :vpc_id,
  :availability_zone,
  :preferred_maintenance_window,
  :pending_modified_values,
  :cluster_version,
  :allow_version_upgrade,
  :number_of_nodes,
  :publicly_accessible,
  :encrypted,
  :restore_status,
  :hsm_status,
  :cluster_snapshot_copy_status,
  :cluster_public_key,
  :cluster_nodes,
  :elastic_ip_status,
  :cluster_revision_number,
  :tags,
  :kms_key_id,
  :enhanced_vpc_routing,
  :iam_roles)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#allow_version_upgrade ⇒ Boolean

#automated_snapshot_retention_period ⇒ Integer

#availability_zone ⇒ String

#cluster_create_time ⇒ Time

#cluster_identifier ⇒ String

#cluster_nodes ⇒ Array<Types::ClusterNode>

#cluster_parameter_groups ⇒ Array<Types::ClusterParameterGroupStatus>

#cluster_public_key ⇒ String

#cluster_revision_number ⇒ String

#cluster_security_groups ⇒ Array<Types::ClusterSecurityGroupMembership>

#cluster_snapshot_copy_status ⇒ Types::ClusterSnapshotCopyStatus

#cluster_status ⇒ String

#cluster_subnet_group_name ⇒ String

#cluster_version ⇒ String

#db_name ⇒ String

#elastic_ip_status ⇒ Types::ElasticIpStatus

#encrypted ⇒ Boolean

#endpoint ⇒ Types::Endpoint

#enhanced_vpc_routing ⇒ Boolean

#hsm_status ⇒ Types::HsmStatus

#iam_roles ⇒ Array<Types::ClusterIamRole>

#kms_key_id ⇒ String

#master_username ⇒ String

#modify_status ⇒ String

#node_type ⇒ String

#number_of_nodes ⇒ Integer

#pending_modified_values ⇒ Types::PendingModifiedValues

#preferred_maintenance_window ⇒ String

#publicly_accessible ⇒ Boolean

#restore_status ⇒ Types::RestoreStatus

#tags ⇒ Array<Types::Tag>

#vpc_id ⇒ String

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

#allow_version_upgrade ⇒ `Boolean`

#automated_snapshot_retention_period ⇒ `Integer`

#availability_zone ⇒ `String`

#cluster_create_time ⇒ `Time`

#cluster_identifier ⇒ `String`

#cluster_nodes ⇒ `Array<Types::ClusterNode>`

#cluster_parameter_groups ⇒ `Array<Types::ClusterParameterGroupStatus>`

#cluster_public_key ⇒ `String`

#cluster_revision_number ⇒ `String`

#cluster_security_groups ⇒ `Array<Types::ClusterSecurityGroupMembership>`

#cluster_snapshot_copy_status ⇒ `Types::ClusterSnapshotCopyStatus`

#cluster_status ⇒ `String`

#cluster_subnet_group_name ⇒ `String`

#cluster_version ⇒ `String`

#db_name ⇒ `String`

#elastic_ip_status ⇒ `Types::ElasticIpStatus`

#encrypted ⇒ `Boolean`

#endpoint ⇒ `Types::Endpoint`

#enhanced_vpc_routing ⇒ `Boolean`

#hsm_status ⇒ `Types::HsmStatus`

#iam_roles ⇒ `Array<Types::ClusterIamRole>`

#kms_key_id ⇒ `String`

#master_username ⇒ `String`

#modify_status ⇒ `String`

#node_type ⇒ `String`

#number_of_nodes ⇒ `Integer`

#pending_modified_values ⇒ `Types::PendingModifiedValues`

#preferred_maintenance_window ⇒ `String`

#publicly_accessible ⇒ `Boolean`

#restore_status ⇒ `Types::RestoreStatus`

#tags ⇒ `Array<Types::Tag>`

#vpc_id ⇒ `String`

#vpc_security_groups ⇒ `Array<Types::VpcSecurityGroupMembership>`