ModifyClusterRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.redshift.model.RedshiftRequest
    - - software.amazon.awssdk.services.redshift.model.ModifyClusterRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ModifyClusterRequest.Builder,ModifyClusterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ModifyClusterRequest
extends RedshiftRequest
implements ToCopyableBuilder<ModifyClusterRequest.Builder,ModifyClusterRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ModifyClusterRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ModifyClusterRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allowVersionUpgrade()` If `true`, major version upgrades will be applied automatically to the cluster during the maintenance window.
`Integer`	`automatedSnapshotRetentionPeriod()` The number of days that automated snapshots are retained.
`static ModifyClusterRequest.Builder`	`builder()`
`String`	`clusterIdentifier()` The unique identifier of the cluster to be modified.
`String`	`clusterParameterGroupName()` The name of the cluster parameter group to apply to this cluster.
`List<String>`	`clusterSecurityGroups()` A list of cluster security groups to be authorized on this cluster.
`String`	`clusterType()` The new cluster type.
`String`	`clusterVersion()` The new version number of the Amazon Redshift engine to upgrade to.
`String`	`elasticIp()` The Elastic IP (EIP) address for the cluster.
`Boolean`	`encrypted()` Indicates whether the cluster is encrypted.
`Boolean`	`enhancedVpcRouting()` An option that specifies whether to create the cluster with enhanced VPC routing enabled.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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.
`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.
`String`	`kmsKeyId()` The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
`String`	`maintenanceTrackName()` The name for the maintenance track that you want to assign for the cluster.
`Integer`	`manualSnapshotRetentionPeriod()` The default for number of days that a newly created manual snapshot is retained.
`String`	`masterUserPassword()` The new password for the cluster master user.
`String`	`newClusterIdentifier()` The new identifier for the cluster.
`String`	`nodeType()` The new node type of the cluster.
`Integer`	`numberOfNodes()` The new number of nodes of the cluster.
`String`	`preferredMaintenanceWindow()` The weekly time range (in UTC) during which system maintenance can occur, if necessary.
`Boolean`	`publiclyAccessible()` If `true`, the cluster can be accessed from a public network.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyClusterRequest.Builder>`	`serializableBuilderClass()`
`ModifyClusterRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`List<String>`	`vpcSecurityGroupIds()` A list of virtual private cloud (VPC) security groups to be associated with the cluster.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clusterIdentifier
```
public String clusterIdentifier()
```
    The unique identifier of the cluster to be modified.
    
    Example: examplecluster
    
    Returns:
    
    The unique identifier of the cluster to be modified.
    
    Example: examplecluster
  - clusterType
```
public String clusterType()
```
    The new cluster type.
    
    When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
    
    Valid Values: multi-node | single-node
    
    Returns:
    
    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
  - nodeType
```
public 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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge
    
    Returns:
    
    The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
    
    When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
    
    Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge
  - numberOfNodes
```
public 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.
    
    Returns:
    
    The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.
    
    When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
    
    Valid Values: Integer greater than 0.
  - clusterSecurityGroups
```
public List<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
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.
    
    Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
    
    Constraints:
    
    Must be 1 to 255 alphanumeric characters or hyphens
    
    First character must be a letter
    
    Cannot end with a hyphen or contain two consecutive hyphens
  - vpcSecurityGroupIds
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
  - masterUserPassword
```
public String masterUserPassword()
```
    The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
    
    Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.
    
    Default: Uses existing setting.
    
    Constraints:
    - Must be between 8 and 64 characters in length.
    - Must contain at least one uppercase letter.
    - Must contain at least one lowercase letter.
    - Must contain one number.
    - Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
    Returns:
    The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
    
    Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.
    
    Default: Uses existing setting.
    
    Constraints:
    
    Must be between 8 and 64 characters in length.
    
    Must contain at least one uppercase letter.
    
    Must contain at least one lowercase letter.
    
    Must contain one number.
    
    Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
  - clusterParameterGroupName
```
public String clusterParameterGroupName()
```
    The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.
    
    Default: Uses existing setting.
    
    Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
    
    Returns:
    
    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.
  - automatedSnapshotRetentionPeriod
```
public Integer automatedSnapshotRetentionPeriod()
```
    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
    
    If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.
    
    Default: Uses existing setting.
    
    Constraints: Must be a value from 0 to 35.
    
    Returns:
    
    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.
  - manualSnapshotRetentionPeriod
```
public 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.
    
    Returns:
    
    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.
  - preferredMaintenanceWindow
```
public String preferredMaintenanceWindow()
```
    The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.
    
    This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
    
    Default: Uses existing setting.
    
    Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
    
    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
    
    Constraints: Must be at least 30 minutes.
    
    Returns:
    
    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.
  - clusterVersion
```
public 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
    
    Returns:
    
    The new version number of the Amazon Redshift engine to upgrade to.
    
    For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
    
    Example: 1.0
  - allowVersionUpgrade
```
public Boolean allowVersionUpgrade()
```
    If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
    
    Default: false
    
    Returns:
    
    If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
    
    Default: false
  - hsmClientCertificateIdentifier
```
public String hsmClientCertificateIdentifier()
```
    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
    
    Returns:
    
    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
  - hsmConfigurationIdentifier
```
public String hsmConfigurationIdentifier()
```
    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
    
    Returns:
    
    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.
  - newClusterIdentifier
```
public String newClusterIdentifier()
```
    The new identifier for the cluster.
    
    Constraints:
    - Must contain from 1 to 63 alphanumeric characters or hyphens.
    - Alphabetic characters must be lowercase.
    - First character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    - Must be unique for all clusters within an AWS account.
    Example: examplecluster
    Returns:
    The new identifier for the cluster.
    
    Constraints:
    
    Must contain from 1 to 63 alphanumeric characters or hyphens.
    
    Alphabetic characters must be lowercase.
    
    First character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Must be unique for all clusters within an AWS account.
    
    Example: examplecluster
  - publiclyAccessible
```
public Boolean publiclyAccessible()
```
    If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
    
    Returns:
    
    If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
  - elasticIp
```
public 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.
    
    Returns:
    
    The Elastic IP (EIP) address for the cluster.
    
    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
  - enhancedVpcRouting
```
public 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
    
    Returns:
    
    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
  - maintenanceTrackName
```
public 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.
    
    Returns:
    
    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.
  - encrypted
```
public Boolean encrypted()
```
    Indicates whether the cluster is encrypted. If the cluster is encrypted and you provide a value for the KmsKeyId parameter, we will encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we will encrypt with the default key. In the China region we will use legacy encryption if you specify that the cluster is encrypted.
    
    Returns:
    
    Indicates whether the cluster is encrypted. If the cluster is encrypted and you provide a value for the KmsKeyId parameter, we will encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we will encrypt with the default key. In the China region we will use legacy encryption if you specify that the cluster is encrypted.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
    
    Returns:
    
    The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
  - toBuilder
```
public ModifyClusterRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyClusterRequest.Builder,ModifyClusterRequest>
    
    Specified by:
    
    toBuilder in class RedshiftRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ModifyClusterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModifyClusterRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ModifyClusterRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clusterIdentifier

clusterType

nodeType

numberOfNodes

clusterSecurityGroups

vpcSecurityGroupIds

masterUserPassword

clusterParameterGroupName

automatedSnapshotRetentionPeriod

manualSnapshotRetentionPeriod

preferredMaintenanceWindow

clusterVersion

allowVersionUpgrade

hsmClientCertificateIdentifier

hsmConfigurationIdentifier

newClusterIdentifier

publiclyAccessible

elasticIp

enhancedVpcRouting

maintenanceTrackName

encrypted

kmsKeyId

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields