Package software.amazon.awssdk.services.docdbelastic.model

Interface Cluster.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Cluster.Builder,Cluster>, SdkBuilder<Cluster.Builder,Cluster>, SdkPojo
Enclosing class:
Cluster
public static interface Cluster.Builder extends SdkPojo, CopyableBuilder<Cluster.Builder,Cluster>

  • Method Details

    • adminUserName

      Cluster.Builder adminUserName(String adminUserName)

      The name of the elastic cluster administrator.

      Parameters:
      adminUserName - The name of the elastic cluster administrator.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authType

      Cluster.Builder authType(String authType)

      The authentication type for the elastic cluster.

      Parameters:
      authType - The authentication type for the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authType

      Cluster.Builder authType(Auth authType)

      The authentication type for the elastic cluster.

      Parameters:
      authType - The authentication type for the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • backupRetentionPeriod

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

    • clusterArn

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

    • clusterEndpoint

      Cluster.Builder clusterEndpoint(String clusterEndpoint)

      The URL used to connect to the elastic cluster.

      Parameters:
      clusterEndpoint - The URL used to connect to the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterName

      Cluster.Builder clusterName(String clusterName)

      The name of the elastic cluster.

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

    • createTime

      Cluster.Builder createTime(String createTime)

      The time when the elastic cluster was created in Universal Coordinated Time (UTC).

      Parameters:
      createTime - The time when the elastic cluster was created in Universal Coordinated Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      Cluster.Builder kmsKeyId(String kmsKeyId)

      The KMS key identifier to use to encrypt the elastic cluster.

      Parameters:
      kmsKeyId - The KMS key identifier to use to encrypt the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredBackupWindow

      Cluster.Builder preferredBackupWindow(String preferredBackupWindow)

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

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

    • preferredMaintenanceWindow

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

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

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

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

    • shardCapacity

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

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

      Cluster.Builder shardInstanceCount(Integer shardInstanceCount)

      The number of replica instances applying to all shards in the 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 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.

    • shards

      Cluster.Builder shards(Collection<Shard> shards)

      The total number of shards in the cluster.

      Parameters:
      shards - The total number of shards in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shards

      Cluster.Builder shards(Shard... shards)

      The total number of shards in the cluster.

      Parameters:
      shards - The total number of shards in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shards

      Cluster.Builder shards(Consumer<Shard.Builder>... shards)

      The total number of shards in the cluster.

      This is a convenience method that creates an instance of the Shard.Builder avoiding the need to create one manually via Shard.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to shards(List<Shard>).

      Parameters:
      shards - a consumer that will call methods on Shard.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Cluster.Builder status(String status)

      The status of the elastic cluster.

      Parameters:
      status - The status of the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Cluster.Builder status(Status status)

      The status of the elastic cluster.

      Parameters:
      status - The status of the elastic cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • subnetIds

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

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

      Cluster.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

      A list of EC2 VPC security groups associated with thie elastic cluster.

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

    • vpcSecurityGroupIds

      Cluster.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)

      A list of EC2 VPC security groups associated with thie elastic cluster.

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