Package software.amazon.awscdk.services.docdbelastic

Class CfnClusterProps.Builder

java.lang.Object
software.amazon.awscdk.services.docdbelastic.CfnClusterProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnClusterProps>
Enclosing interface:
CfnClusterProps
@Stability(Stable) public static final class CfnClusterProps.Builder extends Object implements software.amazon.jsii.Builder<CfnClusterProps>
A builder for CfnClusterProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • adminUserName

      @Stability(Stable) public CfnClusterProps.Builder adminUserName(String adminUserName)
      Sets the value of CfnClusterProps.getAdminUserName()
      Parameters:
      adminUserName - The name of the Amazon DocumentDB elastic clusters administrator. This parameter is required. Constraints :

      • Must be from 1 to 63 letters or numbers.
      • The first character must be a letter.
      • Cannot be a reserved word.
      Returns:
      this

    • authType

      @Stability(Stable) public CfnClusterProps.Builder authType(String authType)
      Sets the value of CfnClusterProps.getAuthType()
      Parameters:
      authType - The authentication type used to determine where to fetch the password used for accessing the elastic cluster. This parameter is required. Valid types are PLAIN_TEXT or SECRET_ARN .
      Returns:
      this

    • clusterName

      @Stability(Stable) public CfnClusterProps.Builder clusterName(String clusterName)
      Sets the value of CfnClusterProps.getClusterName()
      Parameters:
      clusterName - The name of the new elastic cluster. This parameter is stored as a lowercase string. This parameter is required. Constraints :

      • Must contain from 1 to 63 letters, numbers, or hyphens.
      • The first character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example : my-cluster

      Returns:
      this

    • shardCapacity

      @Stability(Stable) public CfnClusterProps.Builder shardCapacity(Number shardCapacity)
      Sets the value of CfnClusterProps.getShardCapacity()
      Parameters:
      shardCapacity - The number of vCPUs assigned to each elastic cluster shard. This parameter is required. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
      Returns:
      this

    • shardCount

      @Stability(Stable) public CfnClusterProps.Builder shardCount(Number shardCount)
      Sets the value of CfnClusterProps.getShardCount()
      Parameters:
      shardCount - The number of shards assigned to the elastic cluster. This parameter is required. Maximum is 32.
      Returns:
      this

    • adminUserPassword

      @Stability(Stable) public CfnClusterProps.Builder adminUserPassword(String adminUserPassword)
      Sets the value of CfnClusterProps.getAdminUserPassword()
      Parameters:
      adminUserPassword - The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters. Constraints :

      • Must contain from 8 to 100 characters.
      • Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
      • A valid AdminUserName entry is also required.
      Returns:
      this

    • backupRetentionPeriod

      @Stability(Stable) public CfnClusterProps.Builder backupRetentionPeriod(Number backupRetentionPeriod)
      Sets the value of CfnClusterProps.getBackupRetentionPeriod()
      Parameters:
      backupRetentionPeriod - The number of days for which automatic snapshots are retained.
      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnClusterProps.Builder kmsKeyId(String kmsKeyId)
      Sets the value of CfnClusterProps.getKmsKeyId()
      Parameters:
      kmsKeyId - The KMS key identifier to use to encrypt the new elastic cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

      If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

      Returns:
      this

    • preferredBackupWindow

      @Stability(Stable) public CfnClusterProps.Builder preferredBackupWindow(String preferredBackupWindow)
      Sets the value of CfnClusterProps.getPreferredBackupWindow()
      Parameters:
      preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
      Returns:
      this

    • preferredMaintenanceWindow

      @Stability(Stable) public CfnClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
      Sets the value of CfnClusterProps.getPreferredMaintenanceWindow()
      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 AWS Region , occurring on a random day of the week.

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

      Constraints : Minimum 30-minute window.

      Returns:
      this

    • shardInstanceCount

      @Stability(Stable) public CfnClusterProps.Builder shardInstanceCount(Number shardInstanceCount)
      Sets the value of CfnClusterProps.getShardInstanceCount()
      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:
      this

    • subnetIds

      @Stability(Stable) public CfnClusterProps.Builder subnetIds(List<String> subnetIds)
      Sets the value of CfnClusterProps.getSubnetIds()
      Parameters:
      subnetIds - The Amazon EC2 subnet IDs for the new elastic cluster.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnClusterProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnClusterProps.getTags()
      Parameters:
      tags - The tags to be assigned to the new elastic cluster.
      Returns:
      this

    • vpcSecurityGroupIds

      @Stability(Stable) public CfnClusterProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)
      Sets the value of CfnClusterProps.getVpcSecurityGroupIds()
      Parameters:
      vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the new elastic cluster.
      Returns:
      this

    • build

      @Stability(Stable) public CfnClusterProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnClusterProps>
      Returns:
      a new instance of CfnClusterProps
      Throws:
      NullPointerException - if any required attribute was not provided