ModifyTenantDatabase - Amazon Relational Database Service
Request ParametersResponse ElementsErrorsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ModifyTenantDatabase

Modifies an existing tenant database in a DB instance. You can change the tenant database name or the master user password. This operation is supported only for RDS for Oracle CDB instances using the multi-tenant configuration.

Request Parameters

For information about the parameters that are common to all actions, see Common 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.

Type: String

Required: Yes

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.

Type: String

Required: Yes

ManageMasterUserPassword

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

If the tenant database doesn't manage the master user password with Amazon 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 Secrets Manager, and you specify that the master user password is not managed with Amazon 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 Secrets Manager in the Amazon RDS User Guide.

Constraints:

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

Type: Boolean

Required: No

MasterUserPassword

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

Note

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.

Type: String

Required: No

MasterUserSecretKmsKeyId

The Amazon KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon 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 Secrets Manager.

    If the tenant database already manages the master user password in Amazon 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 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 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.

Type: String

Required: No

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.

Type: String

Required: No

RotateMasterUserPassword

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

This setting is valid only if the master user password is managed by RDS in Amazon Secrets Manager for the DB instance. The secret value contains the updated password.

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

Constraints:

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

Type: Boolean

Required: No

Response Elements

The following element is returned by the service.

TenantDatabase

A tenant database in the DB instance. This data type is an element in the response to the DescribeTenantDatabases action.

Type: TenantDatabase object

Errors

For information about the errors that are common to all actions, see Common Errors.

DBInstanceNotFound

DBInstanceIdentifier doesn't refer to an existing DB instance.

HTTP Status Code: 404

InvalidDBInstanceState

The DB instance isn't in a valid state.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

An error occurred accessing an Amazon KMS key.

HTTP Status Code: 400

TenantDatabaseAlreadyExists

You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.

HTTP Status Code: 400

TenantDatabaseNotFound

The specified tenant database wasn't found in the DB instance.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: