@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 |
getAvailabilityZone()
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
|
Boolean |
getAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster
modification is complete.
|
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 |
getEncrypted()
Indicates whether the cluster is encrypted.
|
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 |
getIpAddressType()
The IP address types that the cluster supports.
|
String |
getKmsKeyId()
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the
cluster.
|
String |
getMaintenanceTrackName()
The name for the maintenance track that you want to assign for the cluster.
|
Boolean |
getManageMasterPassword()
If
true , Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. |
Integer |
getManualSnapshotRetentionPeriod()
The default for number of days that a newly created manual snapshot is retained.
|
String |
getMasterPasswordSecretKmsKeyId()
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
String |
getMasterUserPassword()
The new password for the cluster admin user.
|
Boolean |
getMultiAZ()
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to
be deployed in two Availability Zones.
|
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.
|
Integer |
getPort()
The option to change the port of an Amazon Redshift 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 |
isAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster
modification is complete.
|
Boolean |
isEncrypted()
Indicates whether the cluster is encrypted.
|
Boolean |
isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Boolean |
isManageMasterPassword()
If
true , Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. |
Boolean |
isMultiAZ()
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to
be deployed in two Availability Zones.
|
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 |
setAvailabilityZone(String availabilityZone)
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
|
void |
setAvailabilityZoneRelocation(Boolean availabilityZoneRelocation)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster
modification is complete.
|
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 |
setEncrypted(Boolean encrypted)
Indicates whether the cluster is encrypted.
|
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 |
setIpAddressType(String ipAddressType)
The IP address types that the cluster supports.
|
void |
setKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the
cluster.
|
void |
setMaintenanceTrackName(String maintenanceTrackName)
The name for the maintenance track that you want to assign for the cluster.
|
void |
setManageMasterPassword(Boolean manageMasterPassword)
If
true , Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. |
void |
setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default for number of days that a newly created manual snapshot is retained.
|
void |
setMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
void |
setMasterUserPassword(String masterUserPassword)
The new password for the cluster admin user.
|
void |
setMultiAZ(Boolean multiAZ)
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to
be deployed in two Availability Zones.
|
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 |
setPort(Integer port)
The option to change the port of an Amazon Redshift 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.
|
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 |
withAvailabilityZone(String availabilityZone)
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
|
ModifyClusterRequest |
withAvailabilityZoneRelocation(Boolean availabilityZoneRelocation)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster
modification is complete.
|
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 |
withEncrypted(Boolean encrypted)
Indicates whether the cluster is encrypted.
|
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 |
withIpAddressType(String ipAddressType)
The IP address types that the cluster supports.
|
ModifyClusterRequest |
withKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the
cluster.
|
ModifyClusterRequest |
withMaintenanceTrackName(String maintenanceTrackName)
The name for the maintenance track that you want to assign for the cluster.
|
ModifyClusterRequest |
withManageMasterPassword(Boolean manageMasterPassword)
If
true , Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. |
ModifyClusterRequest |
withManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default for number of days that a newly created manual snapshot is retained.
|
ModifyClusterRequest |
withMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
ModifyClusterRequest |
withMasterUserPassword(String masterUserPassword)
The new password for the cluster admin user.
|
ModifyClusterRequest |
withMultiAZ(Boolean multiAZ)
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to
be deployed in two Availability Zones.
|
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 |
withPort(Integer port)
The option to change the port of an Amazon Redshift 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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.xlplus
|
ra3.4xlarge
| ra3.16xlarge
nodeType
- The new node type of the cluster. If you specify a new node type, you must also specify the number of
nodes parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.xlplus
|
ra3.4xlarge
| ra3.16xlarge
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.xlplus
|
ra3.4xlarge
| ra3.16xlarge
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.xlplus
|
ra3.4xlarge
| ra3.16xlarge
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.xlplus
|
ra3.4xlarge
| ra3.16xlarge
nodeType
- The new node type of the cluster. If you specify a new node type, you must also specify the number of
nodes parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.xlplus
|
ra3.4xlarge
| ra3.16xlarge
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: Integer greater than 0
.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
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. This change is asynchronously applied as soon as possible.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is
asynchronously applied as soon as possible.public ModifyClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
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. This change is
asynchronously applied as soon as possible.public ModifyClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
vpcSecurityGroupIds
- A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is
asynchronously applied as soon as possible.public void setMasterUserPassword(String masterUserPassword)
The new password for the cluster admin 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.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Operations never return the password, so this operation provides a way to regain access to the admin 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-126) except '
(single quote), "
(double quote), \
, /
, or @
.
masterUserPassword
- The new password for the cluster admin 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.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Operations never return the password, so this operation provides a way to regain access to the admin 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-126) except '
(single quote),
"
(double quote), \
, /
, or @
.
public String getMasterUserPassword()
The new password for the cluster admin 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.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Operations never return the password, so this operation provides a way to regain access to the admin 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-126) except '
(single quote), "
(double quote), \
, /
, or @
.
MasterUserPassword
element exists in the PendingModifiedValues
element of the operation response.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Operations never return the password, so this operation provides a way to regain access to the admin 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-126) except '
(single quote),
"
(double quote), \
, /
, or @
.
public ModifyClusterRequest withMasterUserPassword(String masterUserPassword)
The new password for the cluster admin 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.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Operations never return the password, so this operation provides a way to regain access to the admin 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-126) except '
(single quote), "
(double quote), \
, /
, or @
.
masterUserPassword
- The new password for the cluster admin 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.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Operations never return the password, so this operation provides a way to regain access to the admin 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-126) except '
(single quote),
"
(double quote), \
, /
, or @
.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
public void setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
manualSnapshotRetentionPeriod
- The default for number of days that a newly created manual snapshot is retained. If the value is -1, the
manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of
existing manual snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
public Integer getManualSnapshotRetentionPeriod()
The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
public ModifyClusterRequest withManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
manualSnapshotRetentionPeriod
- The default for number of days that a newly created manual snapshot is retained. If the value is -1, the
manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of
existing manual snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 void setMaintenanceTrackName(String maintenanceTrackName)
The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The
new track name stays in the PendingModifiedValues
for the cluster until the next maintenance window.
When the maintenance track changes, the cluster is switched to the latest cluster release available for the
maintenance track. At this point, the maintenance track name is applied.
maintenanceTrackName
- The name for the maintenance track that you want to assign for the cluster. This name change is
asynchronous. The new track name stays in the PendingModifiedValues
for the cluster until the
next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster
release available for the maintenance track. At this point, the maintenance track name is applied.public String getMaintenanceTrackName()
The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The
new track name stays in the PendingModifiedValues
for the cluster until the next maintenance window.
When the maintenance track changes, the cluster is switched to the latest cluster release available for the
maintenance track. At this point, the maintenance track name is applied.
PendingModifiedValues
for the cluster until
the next maintenance window. When the maintenance track changes, the cluster is switched to the latest
cluster release available for the maintenance track. At this point, the maintenance track name is
applied.public ModifyClusterRequest withMaintenanceTrackName(String maintenanceTrackName)
The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The
new track name stays in the PendingModifiedValues
for the cluster until the next maintenance window.
When the maintenance track changes, the cluster is switched to the latest cluster release available for the
maintenance track. At this point, the maintenance track name is applied.
maintenanceTrackName
- The name for the maintenance track that you want to assign for the cluster. This name change is
asynchronous. The new track name stays in the PendingModifiedValues
for the cluster until the
next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster
release available for the maintenance track. At this point, the maintenance track name is applied.public void setEncrypted(Boolean encrypted)
Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the
KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If you don't
provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
encrypted
- Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for
the KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If
you don't provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
public Boolean getEncrypted()
Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the
KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If you don't
provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If
you don't provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
public ModifyClusterRequest withEncrypted(Boolean encrypted)
Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the
KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If you don't
provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
encrypted
- Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for
the KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If
you don't provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
public Boolean isEncrypted()
Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the
KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If you don't
provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
KmsKeyId
parameter, we encrypt the cluster with the provided KmsKeyId
. If
you don't provide a KmsKeyId
, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
public void setKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
kmsKeyId
- The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the
cluster.public String getKmsKeyId()
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
public ModifyClusterRequest withKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
kmsKeyId
- The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the
cluster.public void setAvailabilityZoneRelocation(Boolean availabilityZoneRelocation)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
availabilityZoneRelocation
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the
cluster modification is complete.public Boolean getAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
public ModifyClusterRequest withAvailabilityZoneRelocation(Boolean availabilityZoneRelocation)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
availabilityZoneRelocation
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the
cluster modification is complete.public Boolean isAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
public void setAvailabilityZone(String availabilityZone)
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
availabilityZone
- The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.public String getAvailabilityZone()
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
public ModifyClusterRequest withAvailabilityZone(String availabilityZone)
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
availabilityZone
- The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.public void setPort(Integer port)
The option to change the port of an Amazon Redshift cluster.
Valid Values:
For clusters with ra3 nodes - Select a port within the ranges 5431-5455
or 8191-8215
.
(If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)
For clusters with dc2 nodes - Select a port within the range 1150-65535
.
port
- The option to change the port of an Amazon Redshift cluster.
Valid Values:
For clusters with ra3 nodes - Select a port within the ranges 5431-5455
or
8191-8215
. (If you have an existing cluster with ra3 nodes, it isn't required that you change
the port to these ranges.)
For clusters with dc2 nodes - Select a port within the range 1150-65535
.
public Integer getPort()
The option to change the port of an Amazon Redshift cluster.
Valid Values:
For clusters with ra3 nodes - Select a port within the ranges 5431-5455
or 8191-8215
.
(If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)
For clusters with dc2 nodes - Select a port within the range 1150-65535
.
Valid Values:
For clusters with ra3 nodes - Select a port within the ranges 5431-5455
or
8191-8215
. (If you have an existing cluster with ra3 nodes, it isn't required that you
change the port to these ranges.)
For clusters with dc2 nodes - Select a port within the range 1150-65535
.
public ModifyClusterRequest withPort(Integer port)
The option to change the port of an Amazon Redshift cluster.
Valid Values:
For clusters with ra3 nodes - Select a port within the ranges 5431-5455
or 8191-8215
.
(If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)
For clusters with dc2 nodes - Select a port within the range 1150-65535
.
port
- The option to change the port of an Amazon Redshift cluster.
Valid Values:
For clusters with ra3 nodes - Select a port within the ranges 5431-5455
or
8191-8215
. (If you have an existing cluster with ra3 nodes, it isn't required that you change
the port to these ranges.)
For clusters with dc2 nodes - Select a port within the range 1150-65535
.
public void setManageMasterPassword(Boolean manageMasterPassword)
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't
use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for
the admin user account's password.
manageMasterPassword
- If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You
can't use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses
MasterUserPassword
for the admin user account's password.public Boolean getManageMasterPassword()
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't
use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for
the admin user account's password.
true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials.
You can't use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses
MasterUserPassword
for the admin user account's password.public ModifyClusterRequest withManageMasterPassword(Boolean manageMasterPassword)
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't
use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for
the admin user account's password.
manageMasterPassword
- If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You
can't use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses
MasterUserPassword
for the admin user account's password.public Boolean isManageMasterPassword()
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't
use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for
the admin user account's password.
true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials.
You can't use MasterUserPassword
if ManageMasterPassword
is true. If
ManageMasterPassword
is false or not set, Amazon Redshift uses
MasterUserPassword
for the admin user account's password.public void setMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret. You can only use this parameter if ManageMasterPassword
is true.public String getMasterPasswordSecretKmsKeyId()
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
ManageMasterPassword
is true.public ModifyClusterRequest withMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret. You can only use this parameter if ManageMasterPassword
is true.public void setIpAddressType(String ipAddressType)
The IP address types that the cluster supports. Possible values are ipv4
and dualstack
.
ipAddressType
- The IP address types that the cluster supports. Possible values are ipv4
and
dualstack
.public String getIpAddressType()
The IP address types that the cluster supports. Possible values are ipv4
and dualstack
.
ipv4
and
dualstack
.public ModifyClusterRequest withIpAddressType(String ipAddressType)
The IP address types that the cluster supports. Possible values are ipv4
and dualstack
.
ipAddressType
- The IP address types that the cluster supports. Possible values are ipv4
and
dualstack
.public void setMultiAZ(Boolean multiAZ)
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.
multiAZ
- If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be
modified to be deployed in two Availability Zones.public Boolean getMultiAZ()
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.
public ModifyClusterRequest withMultiAZ(Boolean multiAZ)
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.
multiAZ
- If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be
modified to be deployed in two Availability Zones.public Boolean isMultiAZ()
If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.
public String toString()
toString
in class Object
Object.toString()
public ModifyClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()