Package software.amazon.awssdk.services.redshift.model

Class ModifyClusterRequest

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("software.amazon.awssdk:codegen") public final class ModifyClusterRequest extends RedshiftRequest implements ToCopyableBuilder<ModifyClusterRequest.Builder,ModifyClusterRequest>

  • Method Details

    • clusterIdentifier

      public final 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 final 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 final 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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

      Returns:
      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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

    • numberOfNodes

      public final 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.

      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.

      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.

    • hasClusterSecurityGroups

      public final boolean hasClusterSecurityGroups()
      For responses, this returns true if the service returned a value for the ClusterSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • clusterSecurityGroups

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClusterSecurityGroups() method.

      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

    • hasVpcSecurityGroupIds

      public final boolean hasVpcSecurityGroupIds()
      For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • vpcSecurityGroupIds

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

      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 final 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 @.

      Returns:
      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 @.

    • clusterParameterGroupName

      public final 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 final 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.

      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.

      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.

    • manualSnapshotRetentionPeriod

      public final 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 final 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 final 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 final 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 final 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 final 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 final 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

      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 Amazon Web Services account.

      Example: examplecluster

    • publiclyAccessible

      public final 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 final 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 final 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 final 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 final 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.

      Returns:
      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

      public final String kmsKeyId()

      The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

      Returns:
      The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

    • availabilityZoneRelocation

      public final Boolean availabilityZoneRelocation()

      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

      Returns:
      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

    • availabilityZone

      public final String availabilityZone()

      The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.

      Returns:
      The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.

    • port

      public final 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 ds2 or dc2 nodes - Select a port within the range 1150-65535.

      Returns:
      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 ds2 or dc2 nodes - Select a port within the range 1150-65535.

    • manageMasterPassword

      public final 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.

      Returns:
      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.

    • masterPasswordSecretKmsKeyId

      public final 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.

      Returns:
      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.

    • ipAddressType

      public final String ipAddressType()

      The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

      Returns:
      The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

    • multiAZ

      public final 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.

      Returns:
      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.

    • 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 final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <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 final 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.