Class ModifyClusterRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Iftrue
, major version upgrades will be applied automatically to the cluster during the maintenance window.The number of days that automated snapshots are retained.The unique identifier of the cluster to be modified.The name of the cluster parameter group to apply to this cluster.A list of cluster security groups to be authorized on this cluster.The new cluster type.The new version number of the Amazon Redshift engine to upgrade to.The Elastic IP (EIP) address for the cluster.Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.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.The new password for the cluster master user.The new identifier for the cluster.The new node type of the cluster.The new number of nodes of the cluster.The weekly time range (in UTC) during which system maintenance can occur, if necessary.Iftrue
, the cluster can be accessed from a public network.A list of virtual private cloud (VPC) security groups to be associated with the cluster.int
hashCode()
Iftrue
, major version upgrades will be applied automatically to the cluster during the maintenance window.Iftrue
, the cluster can be accessed from a public network.void
setAllowVersionUpgrade
(Boolean allowVersionUpgrade) Iftrue
, major version 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
setElasticIp
(String elasticIp) The Elastic IP (EIP) address for the cluster.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
setPubliclyAccessible
(Boolean publiclyAccessible) Iftrue
, the cluster can be accessed from a public network.void
setVpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups to be associated with the cluster.toString()
Returns a string representation of this object; useful for testing and debugging.withAllowVersionUpgrade
(Boolean allowVersionUpgrade) Iftrue
, major version upgrades will be applied automatically to the cluster during the maintenance window.withAutomatedSnapshotRetentionPeriod
(Integer automatedSnapshotRetentionPeriod) The number of days that automated snapshots are retained.withClusterIdentifier
(String clusterIdentifier) The unique identifier of the cluster to be modified.withClusterParameterGroupName
(String clusterParameterGroupName) The name of the cluster parameter group to apply to this cluster.withClusterSecurityGroups
(String... clusterSecurityGroups) A list of cluster security groups to be authorized on this cluster.withClusterSecurityGroups
(Collection<String> clusterSecurityGroups) A list of cluster security groups to be authorized on this cluster.withClusterType
(String clusterType) The new cluster type.withClusterVersion
(String clusterVersion) The new version number of the Amazon Redshift engine to upgrade to.withElasticIp
(String elasticIp) The Elastic IP (EIP) address for the cluster.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.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.withMasterUserPassword
(String masterUserPassword) The new password for the cluster master user.withNewClusterIdentifier
(String newClusterIdentifier) The new identifier for the cluster.withNodeType
(String nodeType) The new node type of the cluster.withNumberOfNodes
(Integer numberOfNodes) The new number of nodes of the cluster.withPreferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range (in UTC) during which system maintenance can occur, if necessary.withPubliclyAccessible
(Boolean publiclyAccessible) Iftrue
, the cluster can be accessed from a public network.withVpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups to be associated with the cluster.withVpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of virtual private cloud (VPC) security groups to be associated with the cluster.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
ModifyClusterRequest
public ModifyClusterRequest()
-
-
Method Details
-
setClusterIdentifier
The unique identifier of the cluster to be modified.
Example:
examplecluster
- Parameters:
clusterIdentifier
- The unique identifier of the cluster to be modified.Example:
examplecluster
-
getClusterIdentifier
The unique identifier of the cluster to be modified.
Example:
examplecluster
- Returns:
- The unique identifier of the cluster to be modified.
Example:
examplecluster
-
withClusterIdentifier
The unique identifier of the cluster to be modified.
Example:
examplecluster
- Parameters:
clusterIdentifier
- The unique identifier of the cluster to be modified.Example:
examplecluster
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClusterType
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
-
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
-
withClusterType
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNodeType
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
.- 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.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
.
-
getNodeType
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:
- 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
.
-
withNodeType
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
.- 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.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:
- Returns a reference to this object so that method calls can be chained together.
-
setNumberOfNodes
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
.- 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.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
.
-
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.
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.
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
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
.- 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.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:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
NOTE: This method appends the values to the existing list (if any). Use
setClusterSecurityGroups(java.util.Collection)
orwithClusterSecurityGroups(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
withClusterSecurityGroups
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
orwithVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups to be associated with the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVpcSecurityGroupIds
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUserPassword
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 thePendingModifiedValues
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, theMasterUserPassword
element exists in thePendingModifiedValues
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.
-
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 thePendingModifiedValues
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 thePendingModifiedValues
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
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 thePendingModifiedValues
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, theMasterUserPassword
element exists in thePendingModifiedValues
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:
- Returns a reference to this object so that method calls can be chained together.
-
setClusterParameterGroupName
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.
-
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.
-
withClusterParameterGroupName
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAutomatedSnapshotRetentionPeriod
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredMaintenanceWindow
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.
-
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.
-
withPreferredMaintenanceWindow
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClusterVersion
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
- 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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example:
1.0
-
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster 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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example:
1.0
-
withClusterVersion
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
- 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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example:
1.0
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAllowVersionUpgrade
If
true
, major version upgrades will be applied automatically to the cluster during the maintenance window.Default:
false
- Parameters:
allowVersionUpgrade
- Iftrue
, major version upgrades will be applied automatically to the cluster during the maintenance window.Default:
false
-
getAllowVersionUpgrade
If
true
, major version upgrades will be applied automatically to the cluster during the maintenance window.Default:
false
- Returns:
- If
true
, major version upgrades will be applied automatically to the cluster during the maintenance window.Default:
false
-
withAllowVersionUpgrade
If
true
, major version upgrades will be applied automatically to the cluster during the maintenance window.Default:
false
- Parameters:
allowVersionUpgrade
- Iftrue
, major version upgrades will be applied automatically to the cluster during the maintenance window.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAllowVersionUpgrade
If
true
, major version upgrades will be applied automatically to the cluster during the maintenance window.Default:
false
- Returns:
- If
true
, major version upgrades will be applied automatically to the cluster during the maintenance window.Default:
false
-
setHsmClientCertificateIdentifier
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setHsmConfigurationIdentifier
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.
-
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.
-
withHsmConfigurationIdentifier
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNewClusterIdentifier
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
-
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
-
withNewClusterIdentifier
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPubliclyAccessible
If
true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
-
getPubliclyAccessible
If
true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.- Returns:
- If
true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
-
withPubliclyAccessible
If
true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isPubliclyAccessible
If
true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.- Returns:
- If
true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
-
setElasticIp
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.
- Parameters:
elasticIp
- 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.
-
getElasticIp
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:
- 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.
-
withElasticIp
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.
- Parameters:
elasticIp
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-