modify_tenant_database¶
Operation¶
async
¶
modify_tenant_database(input: ModifyTenantDatabaseInput, plugins: list[Plugin] | None = None) -> ModifyTenantDatabaseOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyTenantDatabaseInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyTenantDatabaseOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyTenantDatabaseInput structure.
Attributes¶
class-attribute
instance-attribute
¶
db_instance_identifier: str | None = ...
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.
class-attribute
instance-attribute
¶
manage_master_user_password: bool | None = ...
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
MasterUserPasswordis specified.
class-attribute
instance-attribute
¶
master_user_password: str | None = ...
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.
class-attribute
instance-attribute
¶
master_user_secret_kms_key_id: str | None = ...
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
ManageMasterUserPasswordto 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.
class-attribute
instance-attribute
¶
new_tenant_db_name: str | None = ...
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.
class-attribute
instance-attribute
¶
rotate_master_user_password: bool | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyTenantDatabaseOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
A tenant database in the DB instance. This data type is an element in
the response to the DescribeTenantDatabases action.