Interface ModifyTenantDatabaseRequest.Builder

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

  • Method Details

    • dbInstanceIdentifier

      ModifyTenantDatabaseRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)

      The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing DB instance.

      Parameters:
      dbInstanceIdentifier - The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive.

      Constraints:

      • Must match the identifier of an existing DB instance.

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

    • tenantDBName

      ModifyTenantDatabaseRequest.Builder tenantDBName(String tenantDBName)

      The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.

      Constraints:

      • Must match the identifier of an existing tenant database.

      Parameters:
      tenantDBName - The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.

      Constraints:

      • Must match the identifier of an existing tenant database.

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

    • masterUserPassword

      ModifyTenantDatabaseRequest.Builder masterUserPassword(String masterUserPassword)

      The new password for the master user of the specified tenant database in your DB instance.

      Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

      Constraints:

      • Can include any printable ASCII character except /, " (double quote), @, & (ampersand), and ' (single quote).

      Length constraints:

      • Must contain between 8 and 30 characters.

      Parameters:
      masterUserPassword - The new password for the master user of the specified tenant database in your DB instance.

      Amazon RDS operations never return the password, so this action provides a way to regain access to a tenant database user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

      Constraints:

      • Can include any printable ASCII character except /, " (double quote), @, & (ampersand), and ' (single quote).

      Length constraints:

      • Must contain between 8 and 30 characters.

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

    • newTenantDBName

      ModifyTenantDatabaseRequest.Builder newTenantDBName(String newTenantDBName)

      The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.

      Constraints:

      • Can't be the string null or any other reserved word.

      • Can't be longer than 8 characters.

      Parameters:
      newTenantDBName - The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive.

      Constraints:

      • Can't be the string null or any other reserved word.

      • Can't be longer than 8 characters.

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

    • manageMasterUserPassword

      ModifyTenantDatabaseRequest.Builder manageMasterUserPassword(Boolean manageMasterUserPassword)

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

      If the tenant database doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.

      If the tenant database already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.

      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.

      If the tenant database doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword.

      If the tenant database already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.

      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.

    • rotateMasterUserPassword

      ModifyTenantDatabaseRequest.Builder rotateMasterUserPassword(Boolean rotateMasterUserPassword)

      Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

      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 secret value contains the updated password.

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

      Constraints:

      • You must apply the change immediately when rotating the master user password.

      Parameters:
      rotateMasterUserPassword - Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

      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 secret value contains the updated password.

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

      Constraints:

      • You must apply the change immediately when rotating the master user password.

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

    • masterUserSecretKmsKeyId

      ModifyTenantDatabaseRequest.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 both of the following conditions are met:

      • The tenant database doesn't manage the master user password in Amazon Web Services Secrets Manager.

        If the tenant database already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.

      • You're turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.

        If you're turning on ManageMasterUserPassword and 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 self-managed KMS key.

      The Amazon Web Services KMS key identifier is any of the following:

      • Key ARN

      • Key ID

      • Alias ARN

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

      A default KMS key exists 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 both of the following conditions are met:

      • The tenant database doesn't manage the master user password in Amazon Web Services Secrets Manager.

        If the tenant database already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.

      • You're turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.

        If you're turning on ManageMasterUserPassword and 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 self-managed KMS key.

      The Amazon Web Services KMS key identifier is any of the following:

      • Key ARN

      • Key ID

      • Alias ARN

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

      A default KMS key exists 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.

    • overrideConfiguration

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

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