@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ModifyClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ModifyClusterRequest() |
Modifier and Type | Method and Description |
---|---|
ModifyClusterRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getAllowVersionUpgrade()
If
true , major version 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 |
getElasticIp()
The Elastic IP (EIP) address for the cluster.
|
Boolean |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
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.
|
Boolean |
getPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
List<String> |
getVpcSecurityGroupIds()
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
|
int |
hashCode() |
Boolean |
isAllowVersionUpgrade()
If
true , major version upgrades will be applied automatically to the cluster during the maintenance
window. |
Boolean |
isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Boolean |
isPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
void |
setAllowVersionUpgrade(Boolean allowVersionUpgrade)
If
true , 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 |
setEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
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)
If
true , 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.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
ModifyClusterRequest |
withAllowVersionUpgrade(Boolean allowVersionUpgrade)
If
true , major version 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 |
withElasticIp(String elasticIp)
The Elastic IP (EIP) address for the cluster.
|
ModifyClusterRequest |
withEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
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 |
withPubliclyAccessible(Boolean publiclyAccessible)
If
true , the cluster can be accessed from a public network. |
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.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster to be modified.
Example: examplecluster
clusterIdentifier
- The unique identifier of the cluster to be modified.
Example: examplecluster
public String getClusterIdentifier()
The unique identifier of the cluster to be modified.
Example: examplecluster
Example: examplecluster
public ModifyClusterRequest withClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster to be modified.
Example: examplecluster
clusterIdentifier
- The unique identifier of the cluster to be modified.
Example: examplecluster
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
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
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
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
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
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
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.
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
.
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
.
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.
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
.
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
.
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.
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
.
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
.
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.
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
.
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
.
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.
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
.
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
.
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.
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
.
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
.
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
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
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
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
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
NOTE: This method appends the values to the existing list (if any). Use
setClusterSecurityGroups(java.util.Collection)
or
withClusterSecurityGroups(java.util.Collection)
if you want to override the existing values.
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
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
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
public List<String> getVpcSecurityGroupIds()
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups to be associated with the cluster.public ModifyClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
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)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups to be associated with the cluster.public ModifyClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups to be associated with the cluster.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.
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.
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.
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.
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.
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.
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.
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.
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.
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
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
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
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
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
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
public void setAllowVersionUpgrade(Boolean allowVersionUpgrade)
If true
, major version upgrades will be applied automatically to the cluster during the maintenance
window.
Default: false
allowVersionUpgrade
- If true
, major version upgrades will be applied automatically to the cluster during the
maintenance window.
Default: false
public Boolean getAllowVersionUpgrade()
If true
, major version upgrades will be applied automatically to the cluster during the maintenance
window.
Default: false
true
, major version upgrades will be applied automatically to the cluster during the
maintenance window.
Default: false
public ModifyClusterRequest withAllowVersionUpgrade(Boolean allowVersionUpgrade)
If true
, major version upgrades will be applied automatically to the cluster during the maintenance
window.
Default: false
allowVersionUpgrade
- If true
, major version upgrades will be applied automatically to the cluster during the
maintenance window.
Default: false
public Boolean isAllowVersionUpgrade()
If true
, major version upgrades will be applied automatically to the cluster during the maintenance
window.
Default: false
true
, major version upgrades will be applied automatically to the cluster during the
maintenance window.
Default: false
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.
hsmClientCertificateIdentifier
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data
encryption keys stored in an HSM.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.
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.
hsmClientCertificateIdentifier
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data
encryption keys stored in an HSM.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.
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.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.
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.
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.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
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
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
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
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
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
public void setPubliclyAccessible(Boolean publiclyAccessible)
If true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be
publicly available.
publiclyAccessible
- If true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set
to be publicly available.public Boolean getPubliclyAccessible()
If true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be
publicly available.
true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set
to be publicly available.public ModifyClusterRequest withPubliclyAccessible(Boolean publiclyAccessible)
If true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be
publicly available.
publiclyAccessible
- If true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set
to be publicly available.public Boolean isPubliclyAccessible()
If true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be
publicly available.
true
, the cluster can be accessed from a public network. Only clusters in VPCs can be set
to be publicly available.public void setElasticIp(String 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.
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.
public String 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.
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.
public ModifyClusterRequest withElasticIp(String 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.
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.
public void setEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
enhancedVpcRouting
- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a
cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing
in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Boolean getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
If this option is true
, enhanced VPC routing is enabled.
Default: false
public ModifyClusterRequest withEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
enhancedVpcRouting
- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a
cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing
in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Boolean isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
If this option is true
, enhanced VPC routing is enabled.
Default: false
public String toString()
toString
in class Object
Object.toString()
public ModifyClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.