public class ModifyClusterRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
allowVersionUpgrade
If
true , major version upgrades will be applied
automatically to the cluster during the maintenance window. |
private java.lang.Integer |
automatedSnapshotRetentionPeriod
The number of days that automated snapshots are retained.
|
private java.lang.String |
clusterIdentifier
The unique identifier of the cluster to be modified.
|
private java.lang.String |
clusterParameterGroupName
The name of the cluster parameter group to apply to this cluster.
|
private SdkInternalList<java.lang.String> |
clusterSecurityGroups
A list of cluster security groups to be authorized on this cluster.
|
private java.lang.String |
clusterType
The new cluster type.
|
private java.lang.String |
clusterVersion
The new version number of the Amazon Redshift engine to upgrade to.
|
private java.lang.String |
elasticIp
The Elastic IP (EIP) address for the cluster.
|
private java.lang.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.
|
private java.lang.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.
|
private java.lang.String |
masterUserPassword
The new password for the cluster master user.
|
private java.lang.String |
newClusterIdentifier
The new identifier for the cluster.
|
private java.lang.String |
nodeType
The new node type of the cluster.
|
private java.lang.Integer |
numberOfNodes
The new number of nodes of the cluster.
|
private java.lang.String |
preferredMaintenanceWindow
The weekly time range (in UTC) during which system maintenance can occur,
if necessary.
|
private java.lang.Boolean |
publiclyAccessible
If
true , the cluster can be accessed from a public network. |
private SdkInternalList<java.lang.String> |
vpcSecurityGroupIds
A list of virtual private cloud (VPC) security groups to be associated
with the cluster.
|
NOOP
Constructor and Description |
---|
ModifyClusterRequest() |
Modifier and Type | Method and Description |
---|---|
ModifyClusterRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getAllowVersionUpgrade()
If
true , major version upgrades will be applied
automatically to the cluster during the maintenance window. |
java.lang.Integer |
getAutomatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
java.lang.String |
getClusterIdentifier()
The unique identifier of the cluster to be modified.
|
java.lang.String |
getClusterParameterGroupName()
The name of the cluster parameter group to apply to this cluster.
|
java.util.List<java.lang.String> |
getClusterSecurityGroups()
A list of cluster security groups to be authorized on this cluster.
|
java.lang.String |
getClusterType()
The new cluster type.
|
java.lang.String |
getClusterVersion()
The new version number of the Amazon Redshift engine to upgrade to.
|
java.lang.String |
getElasticIp()
The Elastic IP (EIP) address for the cluster.
|
java.lang.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.
|
java.lang.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.
|
java.lang.String |
getMasterUserPassword()
The new password for the cluster master user.
|
java.lang.String |
getNewClusterIdentifier()
The new identifier for the cluster.
|
java.lang.String |
getNodeType()
The new node type of the cluster.
|
java.lang.Integer |
getNumberOfNodes()
The new number of nodes of the cluster.
|
java.lang.String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which system maintenance can occur,
if necessary.
|
java.lang.Boolean |
getPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
java.util.List<java.lang.String> |
getVpcSecurityGroupIds()
A list of virtual private cloud (VPC) security groups to be associated
with the cluster.
|
int |
hashCode() |
java.lang.Boolean |
isAllowVersionUpgrade()
If
true , major version upgrades will be applied
automatically to the cluster during the maintenance window. |
java.lang.Boolean |
isPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
void |
setAllowVersionUpgrade(java.lang.Boolean allowVersionUpgrade)
If
true , major version upgrades will be applied
automatically to the cluster during the maintenance window. |
void |
setAutomatedSnapshotRetentionPeriod(java.lang.Integer automatedSnapshotRetentionPeriod)
The number of days that automated snapshots are retained.
|
void |
setClusterIdentifier(java.lang.String clusterIdentifier)
The unique identifier of the cluster to be modified.
|
void |
setClusterParameterGroupName(java.lang.String clusterParameterGroupName)
The name of the cluster parameter group to apply to this cluster.
|
void |
setClusterSecurityGroups(java.util.Collection<java.lang.String> clusterSecurityGroups)
A list of cluster security groups to be authorized on this cluster.
|
void |
setClusterType(java.lang.String clusterType)
The new cluster type.
|
void |
setClusterVersion(java.lang.String clusterVersion)
The new version number of the Amazon Redshift engine to upgrade to.
|
void |
setElasticIp(java.lang.String elasticIp)
The Elastic IP (EIP) address for the cluster.
|
void |
setHsmClientCertificateIdentifier(java.lang.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(java.lang.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(java.lang.String masterUserPassword)
The new password for the cluster master user.
|
void |
setNewClusterIdentifier(java.lang.String newClusterIdentifier)
The new identifier for the cluster.
|
void |
setNodeType(java.lang.String nodeType)
The new node type of the cluster.
|
void |
setNumberOfNodes(java.lang.Integer numberOfNodes)
The new number of nodes of the cluster.
|
void |
setPreferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur,
if necessary.
|
void |
setPubliclyAccessible(java.lang.Boolean publiclyAccessible)
If
true , the cluster can be accessed from a public network. |
void |
setVpcSecurityGroupIds(java.util.Collection<java.lang.String> vpcSecurityGroupIds)
A list of virtual private cloud (VPC) security groups to be associated
with the cluster.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
ModifyClusterRequest |
withAllowVersionUpgrade(java.lang.Boolean allowVersionUpgrade)
If
true , major version upgrades will be applied
automatically to the cluster during the maintenance window. |
ModifyClusterRequest |
withAutomatedSnapshotRetentionPeriod(java.lang.Integer automatedSnapshotRetentionPeriod)
The number of days that automated snapshots are retained.
|
ModifyClusterRequest |
withClusterIdentifier(java.lang.String clusterIdentifier)
The unique identifier of the cluster to be modified.
|
ModifyClusterRequest |
withClusterParameterGroupName(java.lang.String clusterParameterGroupName)
The name of the cluster parameter group to apply to this cluster.
|
ModifyClusterRequest |
withClusterSecurityGroups(java.util.Collection<java.lang.String> clusterSecurityGroups)
A list of cluster security groups to be authorized on this cluster.
|
ModifyClusterRequest |
withClusterSecurityGroups(java.lang.String... clusterSecurityGroups)
A list of cluster security groups to be authorized on this cluster.
|
ModifyClusterRequest |
withClusterType(java.lang.String clusterType)
The new cluster type.
|
ModifyClusterRequest |
withClusterVersion(java.lang.String clusterVersion)
The new version number of the Amazon Redshift engine to upgrade to.
|
ModifyClusterRequest |
withElasticIp(java.lang.String elasticIp)
The Elastic IP (EIP) address for the cluster.
|
ModifyClusterRequest |
withHsmClientCertificateIdentifier(java.lang.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(java.lang.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(java.lang.String masterUserPassword)
The new password for the cluster master user.
|
ModifyClusterRequest |
withNewClusterIdentifier(java.lang.String newClusterIdentifier)
The new identifier for the cluster.
|
ModifyClusterRequest |
withNodeType(java.lang.String nodeType)
The new node type of the cluster.
|
ModifyClusterRequest |
withNumberOfNodes(java.lang.Integer numberOfNodes)
The new number of nodes of the cluster.
|
ModifyClusterRequest |
withPreferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)
The weekly time range (in UTC) during which system maintenance can occur,
if necessary.
|
ModifyClusterRequest |
withPubliclyAccessible(java.lang.Boolean publiclyAccessible)
If
true , the cluster can be accessed from a public network. |
ModifyClusterRequest |
withVpcSecurityGroupIds(java.util.Collection<java.lang.String> vpcSecurityGroupIds)
A list of virtual private cloud (VPC) security groups to be associated
with the cluster.
|
ModifyClusterRequest |
withVpcSecurityGroupIds(java.lang.String... vpcSecurityGroupIds)
A list of virtual private cloud (VPC) security groups to be associated
with the cluster.
|
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
private java.lang.String clusterIdentifier
The unique identifier of the cluster to be modified.
Example: examplecluster
private java.lang.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
private java.lang.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
.
private java.lang.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
.
private SdkInternalList<java.lang.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:
private SdkInternalList<java.lang.String> vpcSecurityGroupIds
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
private java.lang.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.
Default: Uses existing setting.
Constraints:
private java.lang.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.
private java.lang.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.
private java.lang.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.
private java.lang.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
private java.lang.Boolean allowVersionUpgrade
If true
, major version upgrades will be applied
automatically to the cluster during the maintenance window.
Default: false
private java.lang.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.
private java.lang.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.
private java.lang.String newClusterIdentifier
The new identifier for the cluster.
Constraints:
Example: examplecluster
private java.lang.Boolean publiclyAccessible
If true
, the cluster can be accessed from a public network.
Only clusters in VPCs can be set to be publicly available.
private java.lang.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.
public void setClusterIdentifier(java.lang.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 java.lang.String getClusterIdentifier()
The unique identifier of the cluster to be modified.
Example: examplecluster
Example: examplecluster
public ModifyClusterRequest withClusterIdentifier(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.util.List<java.lang.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:
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
public void setClusterSecurityGroups(java.util.Collection<java.lang.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:
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:
public ModifyClusterRequest withClusterSecurityGroups(java.lang.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:
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:
public ModifyClusterRequest withClusterSecurityGroups(java.util.Collection<java.lang.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:
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:
public java.util.List<java.lang.String> getVpcSecurityGroupIds()
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
public void setVpcSecurityGroupIds(java.util.Collection<java.lang.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(java.lang.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(java.util.Collection<java.lang.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(java.lang.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.
Default: Uses existing setting.
Constraints:
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. Default: Uses existing setting.
Constraints:
public java.lang.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.
Default: Uses existing setting.
Constraints:
MasterUserPassword
element exists in the
PendingModifiedValues
element of the operation
response. Default: Uses existing setting.
Constraints:
public ModifyClusterRequest withMasterUserPassword(java.lang.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.
Default: Uses existing setting.
Constraints:
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. Default: Uses existing setting.
Constraints:
public void setClusterParameterGroupName(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.String newClusterIdentifier)
The new identifier for the cluster.
Constraints:
Example: examplecluster
newClusterIdentifier
- The new identifier for the cluster.
Constraints:
Example: examplecluster
public java.lang.String getNewClusterIdentifier()
The new identifier for the cluster.
Constraints:
Example: examplecluster
Constraints:
Example: examplecluster
public ModifyClusterRequest withNewClusterIdentifier(java.lang.String newClusterIdentifier)
The new identifier for the cluster.
Constraints:
Example: examplecluster
newClusterIdentifier
- The new identifier for the cluster.
Constraints:
Example: examplecluster
public void setPubliclyAccessible(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ModifyClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()