Interface ModifyClusterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ModifyClusterRequest.Builder,ModifyClusterRequest>, RedshiftRequest.Builder, SdkBuilder<ModifyClusterRequest.Builder,ModifyClusterRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ModifyClusterRequest
@Mutable @NotThreadSafe public static interface ModifyClusterRequest.Builder extends RedshiftRequest.Builder, SdkPojo, CopyableBuilder<ModifyClusterRequest.Builder,ModifyClusterRequest>

  • Method Details

    • clusterIdentifier

      ModifyClusterRequest.Builder clusterIdentifier(String clusterIdentifier)

      The unique identifier of the cluster to be modified.

      Example: examplecluster

      Parameters:
      clusterIdentifier - The unique identifier of the cluster to be modified.

      Example: examplecluster

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterType

      ModifyClusterRequest.Builder clusterType(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • nodeType

      ModifyClusterRequest.Builder nodeType(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.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

      Parameters:
      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.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfNodes

      ModifyClusterRequest.Builder numberOfNodes(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • clusterSecurityGroups

      ModifyClusterRequest.Builder clusterSecurityGroups(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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterSecurityGroups

      ModifyClusterRequest.Builder clusterSecurityGroups(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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroupIds

      ModifyClusterRequest.Builder vpcSecurityGroupIds(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroupIds

      ModifyClusterRequest.Builder vpcSecurityGroupIds(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterUserPassword

      ModifyClusterRequest.Builder masterUserPassword(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 @.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • clusterParameterGroupName

      ModifyClusterRequest.Builder clusterParameterGroupName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • automatedSnapshotRetentionPeriod

      ModifyClusterRequest.Builder automatedSnapshotRetentionPeriod(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • manualSnapshotRetentionPeriod

      ModifyClusterRequest.Builder manualSnapshotRetentionPeriod(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • preferredMaintenanceWindow

      ModifyClusterRequest.Builder preferredMaintenanceWindow(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • clusterVersion

      ModifyClusterRequest.Builder clusterVersion(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • allowVersionUpgrade

      ModifyClusterRequest.Builder allowVersionUpgrade(Boolean allowVersionUpgrade)

      If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

      Default: false

      Parameters:
      allowVersionUpgrade - If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hsmClientCertificateIdentifier

      ModifyClusterRequest.Builder hsmClientCertificateIdentifier(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • hsmConfigurationIdentifier

      ModifyClusterRequest.Builder hsmConfigurationIdentifier(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • newClusterIdentifier

      ModifyClusterRequest.Builder newClusterIdentifier(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • publiclyAccessible

      ModifyClusterRequest.Builder publiclyAccessible(Boolean publiclyAccessible)

      If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

      Default: false

      Parameters:
      publiclyAccessible - If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

      Default: false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • elasticIp

      ModifyClusterRequest.Builder elasticIp(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • enhancedVpcRouting

      ModifyClusterRequest.Builder enhancedVpcRouting(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maintenanceTrackName

      ModifyClusterRequest.Builder maintenanceTrackName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • encrypted

      ModifyClusterRequest.Builder encrypted(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      ModifyClusterRequest.Builder kmsKeyId(String kmsKeyId)

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

      Parameters:
      kmsKeyId - The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZoneRelocation

      ModifyClusterRequest.Builder availabilityZoneRelocation(Boolean availabilityZoneRelocation)

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

      Parameters:
      availabilityZoneRelocation - The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availabilityZone

      ModifyClusterRequest.Builder availabilityZone(String availabilityZone)

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

      Parameters:
      availabilityZone - The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • port

      ModifyClusterRequest.Builder port(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • manageMasterPassword

      ModifyClusterRequest.Builder manageMasterPassword(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • masterPasswordSecretKmsKeyId

      ModifyClusterRequest.Builder masterPasswordSecretKmsKeyId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • ipAddressType

      ModifyClusterRequest.Builder ipAddressType(String ipAddressType)

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

      Parameters:
      ipAddressType - The IP address types that the cluster supports. Possible values are ipv4 and dualstack.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multiAZ

      ModifyClusterRequest.Builder multiAZ(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ModifyClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ModifyClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.