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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Describes a cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_version_upgradeBoolean

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

Returns:

  • (Boolean)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#aqua_configurationTypes::AquaConfiguration

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#automated_snapshot_retention_periodInteger

The number of days that automatic cluster snapshots are retained.

Returns:

  • (Integer)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zoneString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_relocation_statusString

Describes the status of the Availability Zone relocation operation.

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_availability_statusString

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)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_create_timeTime

The date and time that the cluster was created.

Returns:

  • (Time)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifierString

The unique identifier of the cluster.

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_namespace_arnString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_nodesArray<Types::ClusterNode>

The nodes in the cluster.

Returns:



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_public_keyString

The public key for the cluster.

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_revision_numberString

The specific revision number of the database in the cluster.

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_snapshot_copy_statusTypes::ClusterSnapshotCopyStatus

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_statusString

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)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_subnet_group_nameString

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)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_versionString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#data_transfer_progressTypes::DataTransferProgress



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#db_nameString

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)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#default_iam_role_arnString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#deferred_maintenance_windowsArray<Types::DeferredMaintenanceWindow>

Describes a group of DeferredMaintenanceWindow objects.



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#elastic_ip_statusTypes::ElasticIpStatus

The status of the elastic IP (EIP) address.



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#elastic_resize_number_of_node_optionsString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#encryptedBoolean

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

Returns:

  • (Boolean)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#endpointTypes::Endpoint

The connection endpoint.

Returns:



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#enhanced_vpc_routingBoolean

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)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#expected_next_snapshot_schedule_timeTime

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)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#expected_next_snapshot_schedule_time_statusString

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)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#iam_rolesArray<Types::ClusterIamRole>

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

Returns:



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_track_nameString

The name of the maintenance track for the cluster.

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#manual_snapshot_retention_periodInteger

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)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#master_usernameString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#modify_statusString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#next_maintenance_window_start_timeTime

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

Returns:

  • (Time)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#node_typeString

The node type for the nodes in the cluster.

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_nodesInteger

The number of compute nodes in the cluster.

Returns:

  • (Integer)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#pending_actionsArray<String>

Cluster operations that are waiting to be started.

Returns:

  • (Array<String>)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#pending_modified_valuesTypes::PendingModifiedValues

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_windowString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

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

Returns:

  • (Boolean)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#reserved_node_exchange_statusTypes::ReservedNodeExchangeStatus

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#resize_infoTypes::ResizeInfo

Returns the following:

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

  • ResizeType: Returns ClassicResize

Returns:



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_schedule_identifierString

A unique identifier for the cluster snapshot schedule.

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_schedule_stateString

The current state of the cluster snapshot schedule.

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The list of tags for the cluster.

Returns:



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#total_storage_capacity_in_mega_bytesInteger

The total storage capacity of the cluster in megabytes.

Returns:

  • (Integer)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

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

Returns:

  • (String)


833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 833

class Cluster < Struct.new(
  :cluster_identifier,
  :node_type,
  :cluster_status,
  :cluster_availability_status,
  :modify_status,
  :master_username,
  :db_name,
  :endpoint,
  :cluster_create_time,
  :automated_snapshot_retention_period,
  :manual_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,
  :data_transfer_progress,
  :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,
  :pending_actions,
  :maintenance_track_name,
  :elastic_resize_number_of_node_options,
  :deferred_maintenance_windows,
  :snapshot_schedule_identifier,
  :snapshot_schedule_state,
  :expected_next_snapshot_schedule_time,
  :expected_next_snapshot_schedule_time_status,
  :next_maintenance_window_start_time,
  :resize_info,
  :availability_zone_relocation_status,
  :cluster_namespace_arn,
  :total_storage_capacity_in_mega_bytes,
  :aqua_configuration,
  :default_iam_role_arn,
  :reserved_node_exchange_status)
  SENSITIVE = []
  include Aws::Structure
end