Interface UpdateClusterRequest.Builder

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

  • Method Details

    • adminUserPassword

      UpdateClusterRequest.Builder adminUserPassword(String adminUserPassword)

      The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

      Constraints: Must contain from 8 to 100 characters.

      Parameters:
      adminUserPassword - The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

      Constraints: Must contain from 8 to 100 characters.

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

    • authType

      UpdateClusterRequest.Builder authType(String authType)

      The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

      Parameters:
      authType - The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authType

      UpdateClusterRequest.Builder authType(Auth authType)

      The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

      Parameters:
      authType - The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • backupRetentionPeriod

      UpdateClusterRequest.Builder backupRetentionPeriod(Integer backupRetentionPeriod)

      The number of days for which automatic snapshots are retained.

      Parameters:
      backupRetentionPeriod - The number of days for which automatic snapshots are retained.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      UpdateClusterRequest.Builder clientToken(String clientToken)

      The client token for the elastic cluster.

      Parameters:
      clientToken - The client token for the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterArn

      UpdateClusterRequest.Builder clusterArn(String clusterArn)

      The ARN identifier of the elastic cluster.

      Parameters:
      clusterArn - The ARN identifier of the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredBackupWindow

      UpdateClusterRequest.Builder preferredBackupWindow(String preferredBackupWindow)

      The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

      Parameters:
      preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredMaintenanceWindow

      UpdateClusterRequest.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

      Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

      Constraints: Minimum 30-minute window.

      Parameters:
      preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

      Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

      Constraints: Minimum 30-minute window.

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

    • shardCapacity

      UpdateClusterRequest.Builder shardCapacity(Integer shardCapacity)

      The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

      Parameters:
      shardCapacity - The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shardCount

      UpdateClusterRequest.Builder shardCount(Integer shardCount)

      The number of shards assigned to the elastic cluster. Maximum is 32.

      Parameters:
      shardCount - The number of shards assigned to the elastic cluster. Maximum is 32.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shardInstanceCount

      UpdateClusterRequest.Builder shardInstanceCount(Integer shardInstanceCount)

      The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      Parameters:
      shardInstanceCount - The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      UpdateClusterRequest.Builder subnetIds(Collection<String> subnetIds)

      The Amazon EC2 subnet IDs for the elastic cluster.

      Parameters:
      subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      UpdateClusterRequest.Builder subnetIds(String... subnetIds)

      The Amazon EC2 subnet IDs for the elastic cluster.

      Parameters:
      subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroupIds

      UpdateClusterRequest.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A list of EC2 VPC security groups to associate with the elastic cluster.

      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcSecurityGroupIds

      UpdateClusterRequest.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

      A list of EC2 VPC security groups to associate with the elastic cluster.

      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateClusterRequest.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

      UpdateClusterRequest.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.