com.amazonaws.services.redshift.model

Class ModifyClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshift.model.ModifyClusterRequest

All Implemented Interfaces:

Serializable

public class ModifyClusterRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ModifyCluster operation.

Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. If you specify the same number of nodes and node type that are already configured for the cluster, an error is returned.

See Also:

AmazonRedshift.modifyCluster(ModifyClusterRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyClusterRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllowVersionUpgrade() If true, upgrades will be applied automatically to the cluster during the maintenance window.
Integer	getAutomatedSnapshotRetentionPeriod() The number of days that automated snapshots are retained.
String	getClusterIdentifier() The unique identifier of the cluster to be modified.
String	getClusterParameterGroupName() The name of the cluster parameter group to apply to this cluster.
List<String>	getClusterSecurityGroups() A list of cluster security groups to be authorized on this cluster.
String	getClusterType() The new cluster type.
String	getClusterVersion() The new version number of the Amazon Redshift engine to upgrade to.
String	getHsmClientCertificateIdentifier() Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
String	getHsmConfigurationIdentifier() 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.
String	getMasterUserPassword() The new password for the cluster master user.
String	getNewClusterIdentifier() The new identifier for the cluster.
String	getNodeType() The new node type of the cluster.
Integer	getNumberOfNodes() The new number of nodes of the cluster.
String	getPreferredMaintenanceWindow() The weekly time range (in UTC) during which system maintenance can occur, if necessary.
List<String>	getVpcSecurityGroupIds() A list of virtual private cloud (VPC) security groups to be associated with the cluster.
int	hashCode()
Boolean	isAllowVersionUpgrade() If true, upgrades will be applied automatically to the cluster during the maintenance window.
void	setAllowVersionUpgrade(Boolean allowVersionUpgrade) If true, upgrades will be applied automatically to the cluster during the maintenance window.
void	setAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod) The number of days that automated snapshots are retained.
void	setClusterIdentifier(String clusterIdentifier) The unique identifier of the cluster to be modified.
void	setClusterParameterGroupName(String clusterParameterGroupName) The name of the cluster parameter group to apply to this cluster.
void	setClusterSecurityGroups(Collection<String> clusterSecurityGroups) A list of cluster security groups to be authorized on this cluster.
void	setClusterType(String clusterType) The new cluster type.
void	setClusterVersion(String clusterVersion) The new version number of the Amazon Redshift engine to upgrade to.
void	setHsmClientCertificateIdentifier(String hsmClientCertificateIdentifier) Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
void	setHsmConfigurationIdentifier(String hsmConfigurationIdentifier) 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.
void	setMasterUserPassword(String masterUserPassword) The new password for the cluster master user.
void	setNewClusterIdentifier(String newClusterIdentifier) The new identifier for the cluster.
void	setNodeType(String nodeType) The new node type of the cluster.
void	setNumberOfNodes(Integer numberOfNodes) The new number of nodes of the cluster.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur, if necessary.
void	setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups to be associated with the cluster.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifyClusterRequest	withAllowVersionUpgrade(Boolean allowVersionUpgrade) If true, upgrades will be applied automatically to the cluster during the maintenance window.
ModifyClusterRequest	withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod) The number of days that automated snapshots are retained.
ModifyClusterRequest	withClusterIdentifier(String clusterIdentifier) The unique identifier of the cluster to be modified.
ModifyClusterRequest	withClusterParameterGroupName(String clusterParameterGroupName) The name of the cluster parameter group to apply to this cluster.
ModifyClusterRequest	withClusterSecurityGroups(Collection<String> clusterSecurityGroups) A list of cluster security groups to be authorized on this cluster.
ModifyClusterRequest	withClusterSecurityGroups(String... clusterSecurityGroups) A list of cluster security groups to be authorized on this cluster.
ModifyClusterRequest	withClusterType(String clusterType) The new cluster type.
ModifyClusterRequest	withClusterVersion(String clusterVersion) The new version number of the Amazon Redshift engine to upgrade to.
ModifyClusterRequest	withHsmClientCertificateIdentifier(String hsmClientCertificateIdentifier) Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
ModifyClusterRequest	withHsmConfigurationIdentifier(String hsmConfigurationIdentifier) 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.
ModifyClusterRequest	withMasterUserPassword(String masterUserPassword) The new password for the cluster master user.
ModifyClusterRequest	withNewClusterIdentifier(String newClusterIdentifier) The new identifier for the cluster.
ModifyClusterRequest	withNodeType(String nodeType) The new node type of the cluster.
ModifyClusterRequest	withNumberOfNodes(Integer numberOfNodes) The new number of nodes of the cluster.
ModifyClusterRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur, if necessary.
ModifyClusterRequest	withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups to be associated with the cluster.
ModifyClusterRequest	withVpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups to be associated with the cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyClusterRequest

public ModifyClusterRequest()

Method Detail

getClusterIdentifier

public String getClusterIdentifier()

The unique identifier of the cluster to be modified.

Example: examplecluster

Returns:

The unique identifier of the cluster to be modified.

Example: examplecluster

setClusterIdentifier

public void setClusterIdentifier(String clusterIdentifier)

The unique identifier of the cluster to be modified.

Example: examplecluster

Parameters:

clusterIdentifier - The unique identifier of the cluster to be modified.

Example: examplecluster

withClusterIdentifier

public ModifyClusterRequest withClusterIdentifier(String clusterIdentifier)

The unique identifier of the cluster to be modified.

Example: examplecluster

Returns a reference to this object so that method calls can be chained together.

Parameters:

clusterIdentifier - The unique identifier of the cluster to be modified.

Example: examplecluster

Returns:

A reference to this updated object so that method calls can be chained together.

getClusterType

public String getClusterType()

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:

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

setClusterType

public void setClusterType(String clusterType)

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

Parameters:

clusterType - 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

withClusterType

public ModifyClusterRequest withClusterType(String clusterType)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

getNodeType

public String getNodeType()

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

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 the DescribeResize to track the progress of the resize request.

Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.

Returns:

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

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 the DescribeResize to track the progress of the resize request.

Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.

setNodeType

public void setNodeType(String nodeType)

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

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 the DescribeResize to track the progress of the resize request.

Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.

Parameters:

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

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 the DescribeResize to track the progress of the resize request.

Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.

withNodeType

public ModifyClusterRequest withNodeType(String nodeType)

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

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 the DescribeResize to track the progress of the resize request.

Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

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 the DescribeResize to track the progress of the resize request.

Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.

Returns:

A reference to this updated object so that method calls can be chained together.

getNumberOfNodes

public Integer getNumberOfNodes()

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

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:

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

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.

setNumberOfNodes

public void setNumberOfNodes(Integer numberOfNodes)

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

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.

Parameters:

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

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.

withNumberOfNodes

public ModifyClusterRequest withNumberOfNodes(Integer numberOfNodes)

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

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 a reference to this object so that method calls can be chained together.

Parameters:

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

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:

A reference to this updated object so that method calls can be chained together.

getClusterSecurityGroups

public List<String> getClusterSecurityGroups()

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:

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

setClusterSecurityGroups

public void setClusterSecurityGroups(Collection<String> clusterSecurityGroups)

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

Parameters:

clusterSecurityGroups - 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

withClusterSecurityGroups

public ModifyClusterRequest withClusterSecurityGroups(String... clusterSecurityGroups)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

withClusterSecurityGroups

public ModifyClusterRequest withClusterSecurityGroups(Collection<String> clusterSecurityGroups)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

getVpcSecurityGroupIds

public List<String> getVpcSecurityGroupIds()

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

Returns:

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

setVpcSecurityGroupIds

public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

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

Parameters:

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

withVpcSecurityGroupIds

public ModifyClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withVpcSecurityGroupIds

public ModifyClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMasterUserPassword

public String getMasterUserPassword()

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:

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.

setMasterUserPassword

public void setMasterUserPassword(String masterUserPassword)

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.

Parameters:

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

withMasterUserPassword

public ModifyClusterRequest withMasterUserPassword(String masterUserPassword)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

getClusterParameterGroupName

public String getClusterParameterGroupName()

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:

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.

setClusterParameterGroupName

public void setClusterParameterGroupName(String clusterParameterGroupName)

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.

Parameters:

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

withClusterParameterGroupName

public ModifyClusterRequest withClusterParameterGroupName(String clusterParameterGroupName)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

getAutomatedSnapshotRetentionPeriod

public Integer getAutomatedSnapshotRetentionPeriod()

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:

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.

setAutomatedSnapshotRetentionPeriod

public void setAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)

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.

Parameters:

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

withAutomatedSnapshotRetentionPeriod

public ModifyClusterRequest withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

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:

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.

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

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.

Parameters:

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

withPreferredMaintenanceWindow

public ModifyClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

getClusterVersion

public String getClusterVersion()

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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.

Example: 1.0

Returns:

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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.

Example: 1.0

setClusterVersion

public void setClusterVersion(String clusterVersion)

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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.

Example: 1.0

Parameters:

clusterVersion - 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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.

Example: 1.0

withClusterVersion

public ModifyClusterRequest withClusterVersion(String clusterVersion)

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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.

Example: 1.0

Returns a reference to this object so that method calls can be chained together.

Parameters:

clusterVersion - 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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Management Guide.

Example: 1.0

Returns:

A reference to this updated object so that method calls can be chained together.

isAllowVersionUpgrade

public Boolean isAllowVersionUpgrade()

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

Default: false

Returns:

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

Default: false

setAllowVersionUpgrade

public void setAllowVersionUpgrade(Boolean allowVersionUpgrade)

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

Default: false

Parameters:

allowVersionUpgrade - If true, upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

withAllowVersionUpgrade

public ModifyClusterRequest withAllowVersionUpgrade(Boolean allowVersionUpgrade)

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

Default: false

Returns a reference to this object so that method calls can be chained together.

Parameters:

allowVersionUpgrade - If true, upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

Returns:

A reference to this updated object so that method calls can be chained together.

getAllowVersionUpgrade

public Boolean getAllowVersionUpgrade()

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

Default: false

Returns:

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

Default: false

getHsmClientCertificateIdentifier

public String getHsmClientCertificateIdentifier()

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

Returns:

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

setHsmClientCertificateIdentifier

public void setHsmClientCertificateIdentifier(String hsmClientCertificateIdentifier)

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

Parameters:

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

withHsmClientCertificateIdentifier

public ModifyClusterRequest withHsmClientCertificateIdentifier(String hsmClientCertificateIdentifier)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getHsmConfigurationIdentifier

public String getHsmConfigurationIdentifier()

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:

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.

setHsmConfigurationIdentifier

public void setHsmConfigurationIdentifier(String hsmConfigurationIdentifier)

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.

Parameters:

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

withHsmConfigurationIdentifier

public ModifyClusterRequest withHsmConfigurationIdentifier(String hsmConfigurationIdentifier)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

getNewClusterIdentifier

public String getNewClusterIdentifier()

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:

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

setNewClusterIdentifier

public void setNewClusterIdentifier(String newClusterIdentifier)

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

Parameters:

newClusterIdentifier - 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

withNewClusterIdentifier

public ModifyClusterRequest withNewClusterIdentifier(String newClusterIdentifier)

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 a reference to this object so that method calls can be chained together.

Parameters:

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

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object