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

Interface CreateClusterRequest.Builder

    • Method Detail

      • adminUserName

        CreateClusterRequest.Builder adminUserName​(String adminUserName)

        The name of the Amazon DocumentDB elastic clusters administrator.

        Constraints:

        • Must be from 1 to 63 letters or numbers.

        • The first character must be a letter.

        • Cannot be a reserved word.

        Parameters:
        adminUserName - The name of the Amazon DocumentDB elastic clusters administrator.

        Constraints:

        • Must be from 1 to 63 letters or numbers.

        • The first character must be a letter.

        • Cannot be a reserved word.

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

      • adminUserPassword

        CreateClusterRequest.Builder adminUserPassword​(String adminUserPassword)

        The password for the Amazon DocumentDB elastic clusters administrator. The password 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 (@).

        Parameters:
        adminUserPassword - The password for the Amazon DocumentDB elastic clusters administrator. The password 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 (@).

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

      • authType

        CreateClusterRequest.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:
        Auth, Auth

      • authType

        CreateClusterRequest.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:
        Auth, Auth

      • backupRetentionPeriod

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

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

      • clusterName

        CreateClusterRequest.Builder clusterName​(String clusterName)

        The name of the new elastic cluster. This parameter is stored as a lowercase string.

        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

        Parameters:
        clusterName - The name of the new elastic cluster. This parameter is stored as a lowercase string.

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

      • kmsKeyId

        CreateClusterRequest.Builder kmsKeyId​(String 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.

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

      • preferredBackupWindow

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

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

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

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

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

        CreateClusterRequest.Builder subnetIds​(Collection<String> subnetIds)

        The Amazon EC2 subnet IDs for the new elastic cluster.

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

      • subnetIds

        CreateClusterRequest.Builder subnetIds​(String... subnetIds)

        The Amazon EC2 subnet IDs for the new elastic cluster.

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

      • tags

        CreateClusterRequest.Builder tags​(Map<String,​String> tags)

        The tags to be assigned to the new elastic cluster.

        Parameters:
        tags - The tags to be assigned to the new elastic cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        CreateClusterRequest.Builder vpcSecurityGroupIds​(Collection<String> vpcSecurityGroupIds)

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

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

      • vpcSecurityGroupIds

        CreateClusterRequest.Builder vpcSecurityGroupIds​(String... vpcSecurityGroupIds)

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

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