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

Class: Aws::Redshift::Types::ModifyClusterMessage

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

Overview

Note:

When making an API call, you may pass ModifyClusterMessage data as a hash:

{
  cluster_identifier: "String", # required
  cluster_type: "String",
  node_type: "String",
  number_of_nodes: 1,
  cluster_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  master_user_password: "String",
  cluster_parameter_group_name: "String",
  automated_snapshot_retention_period: 1,
  preferred_maintenance_window: "String",
  cluster_version: "String",
  allow_version_upgrade: false,
  hsm_client_certificate_identifier: "String",
  hsm_configuration_identifier: "String",
  new_cluster_identifier: "String",
  publicly_accessible: false,
  elastic_ip: "String",
  enhanced_vpc_routing: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#allow_version_upgradeBoolean

If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

Returns:

  • (Boolean)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#automated_snapshot_retention_periodInteger

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

Returns:

  • (Integer)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#cluster_identifierString

The unique identifier of the cluster to be modified.

Example: examplecluster

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#cluster_parameter_group_nameString

The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#cluster_security_groupsArray<String>

A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

  • (Array<String>)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#cluster_typeString

The new cluster type.

When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

Valid Values: multi-node | single-node

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#cluster_versionString

The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Example: 1.0

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#elastic_ipString

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  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)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#hsm_client_certificate_identifierString

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#hsm_configuration_identifierString

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#master_user_passwordString

The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.

Default: Uses existing setting.

Constraints:

  • Must be between 8 and 64 characters in length.

  • Must contain at least one uppercase letter.

  • Must contain at least one lowercase letter.

  • Must contain one number.

  • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#new_cluster_identifierString

The new identifier for the cluster.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an AWS account.

Example: examplecluster

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#node_typeString

The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#number_of_nodesInteger

The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: Integer greater than 0.

Returns:

  • (Integer)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#preferred_maintenance_windowString

The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes.

Returns:

  • (String)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#publicly_accessibleBoolean

If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

Returns:

  • (Boolean)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

A list of virtual private cloud (VPC) security groups to be associated with the cluster.

Returns:

  • (Array<String>)


4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 4732

class ModifyClusterMessage < Struct.new(
  :cluster_identifier,
  :cluster_type,
  :node_type,
  :number_of_nodes,
  :cluster_security_groups,
  :vpc_security_group_ids,
  :master_user_password,
  :cluster_parameter_group_name,
  :automated_snapshot_retention_period,
  :preferred_maintenance_window,
  :cluster_version,
  :allow_version_upgrade,
  :hsm_client_certificate_identifier,
  :hsm_configuration_identifier,
  :new_cluster_identifier,
  :publicly_accessible,
  :elastic_ip,
  :enhanced_vpc_routing)
  include Aws::Structure
end