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',
    ManageMasterUserPassword=True|False,
    RotateMasterUserPassword=True|False,
    MasterUserSecretKmsKeyId='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.

  • ManageMasterUserPassword (boolean) –

    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.

  • RotateMasterUserPassword (boolean) –

    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.

  • MasterUserSecretKmsKeyId (string) –

    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.

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'
        },
        'MasterUserSecret': {
            'SecretArn': 'string',
            'SecretStatus': 'string',
            'KmsKeyId': '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.

      • MasterUserSecret (dict) –

        Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

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

        • SecretArn (string) –

          The Amazon Resource Name (ARN) of the secret.

        • SecretStatus (string) –

          The status of the secret.

          The possible status values include the following:

          • creating - The secret is being created.

          • active - The secret is available for normal use and rotation.

          • rotating - The secret is being rotated.

          • impaired - The secret can be used to access database credentials, but it can’t be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

        • KmsKeyId (string) –

          The Amazon Web Services KMS key identifier that is used to encrypt the secret.

      • TagList (list) –

        A list of tags.

        For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora 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 or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora 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