Interface CreateTenantDatabaseRequest.Builder

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

  • Method Details

    • dbInstanceIdentifier

      CreateTenantDatabaseRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

      The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.

      Parameters:
      dbInstanceIdentifier - The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tenantDBName

      CreateTenantDatabaseRequest.Builder tenantDBName(String tenantDBName)

      The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.

      Parameters:
      tenantDBName - The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterUsername

      CreateTenantDatabaseRequest.Builder masterUsername(String masterUsername)

      The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.

      Constraints:

      • Must be 1 to 16 letters, numbers, or underscores.

      • First character must be a letter.

      • Can't be a reserved word for the chosen database engine.

      Parameters:
      masterUsername - The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.

      Constraints:

      • Must be 1 to 16 letters, numbers, or underscores.

      • First character must be a letter.

      • Can't be a reserved word for the chosen database engine.

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

    • masterUserPassword

      CreateTenantDatabaseRequest.Builder masterUserPassword(String masterUserPassword)

      The password for the master user in your tenant database.

      Constraints:

      • Must be 8 to 30 characters.

      • Can include any printable ASCII character except forward slash (/), double quote (" ), at symbol (@), ampersand (&), or single quote (').

      • Can't be specified when ManageMasterUserPassword is enabled.

      Parameters:
      masterUserPassword - The password for the master user in your tenant database.

      Constraints:

      • Must be 8 to 30 characters.

      • Can include any printable ASCII character except forward slash (/), double quote ( "), at symbol (@), ampersand (&), or single quote ( ').

      • Can't be specified when ManageMasterUserPassword is enabled.

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

    • characterSetName

      CreateTenantDatabaseRequest.Builder characterSetName(String characterSetName)

      The character set for your tenant database. If you don't specify a value, the character set name defaults to AL32UTF8.

      Parameters:
      characterSetName - The character set for your tenant database. If you don't specify a value, the character set name defaults to AL32UTF8.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ncharCharacterSetName

      CreateTenantDatabaseRequest.Builder ncharCharacterSetName(String ncharCharacterSetName)

      The NCHAR value for the tenant database.

      Parameters:
      ncharCharacterSetName - The NCHAR value for the tenant database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • manageMasterUserPassword

      CreateTenantDatabaseRequest.Builder manageMasterUserPassword(Boolean manageMasterUserPassword)

      Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

      Constraints:

      • Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

      Parameters:
      manageMasterUserPassword - Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

      For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

      Constraints:

      • Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

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

    • masterUserSecretKmsKeyId

      CreateTenantDatabaseRequest.Builder masterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)

      The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

      This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

      There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

      Parameters:
      masterUserSecretKmsKeyId - The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

      This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

      If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

      There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

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

    • tags

      CreateTenantDatabaseRequest.Builder tags(Collection<Tag> tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTenantDatabaseRequest.Builder tags(Tag... tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTenantDatabaseRequest.Builder tags(Consumer<Tag.Builder>... tags)
      Sets the value of the Tags property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

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

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

    • overrideConfiguration

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

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