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

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

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

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

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: