RDS / Client / modify_tenant_database

modify_tenant_database

RDS.Client.modify_tenant_database(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.modify_tenant_database(
    DBInstanceIdentifier='string',
    TenantDBName='string',
    MasterUserPassword='string',
    NewTenantDBName='string'
)

Parameters:

• DBInstanceIdentifier (string) –

  [REQUIRED]

  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.

• TenantDBName (string) –

  [REQUIRED]

  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.

• MasterUserPassword (string) –

  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.

• NewTenantDBName (string) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'TenantDatabase': {
        'TenantDatabaseCreateTime': datetime(2015, 1, 1),
        'DBInstanceIdentifier': 'string',
        'TenantDBName': 'string',
        'Status': 'string',
        'MasterUsername': 'string',
        'DbiResourceId': 'string',
        'TenantDatabaseResourceId': 'string',
        'TenantDatabaseARN': 'string',
        'CharacterSetName': 'string',
        'NcharCharacterSetName': 'string',
        'DeletionProtection': True|False,
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'TenantDBName': 'string'
        },
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • TenantDatabase (dict) –

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

    • TenantDatabaseCreateTime (datetime) –

      The creation time of the tenant database.

    • DBInstanceIdentifier (string) –

      The ID of the DB instance that contains the tenant database.

    • TenantDBName (string) –

      The database name of the tenant database.

    • Status (string) –

      The status of the tenant database.

    • MasterUsername (string) –

      The master username of the tenant database.

    • DbiResourceId (string) –

      The Amazon Web Services Region-unique, immutable identifier for the DB instance.

    • TenantDatabaseResourceId (string) –

      The Amazon Web Services Region-unique, immutable identifier for the tenant database.

    • TenantDatabaseARN (string) –

      The Amazon Resource Name (ARN) for the tenant database.

    • CharacterSetName (string) –

      The character set of the tenant database.

    • NcharCharacterSetName (string) –

      The NCHAR character set name of the tenant database.

    • DeletionProtection (boolean) –

      Specifies whether deletion protection is enabled for the DB instance.

    • PendingModifiedValues (dict) –

      Information about pending changes for a tenant database.

      • MasterUserPassword (string) –

        The master password for the tenant database.

      • TenantDBName (string) –

        The name of the tenant database.

    • TagList (list) –

      A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

      • (dict) –

        Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

        For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

        • Key (string) –

          A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

        • Value (string) –

          A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Exceptions

• RDS.Client.exceptions.DBInstanceNotFoundFault

• RDS.Client.exceptions.TenantDatabaseNotFoundFault

• RDS.Client.exceptions.TenantDatabaseAlreadyExistsFault

• RDS.Client.exceptions.InvalidDBInstanceStateFault