create_tenant_database¶
Operation¶
async
¶
create_tenant_database(input: CreateTenantDatabaseInput, plugins: list[Plugin] | None = None) -> CreateTenantDatabaseOutput
Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateTenantDatabaseInput
|
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 |
|---|---|
CreateTenantDatabaseOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateTenantDatabaseInput structure.
Attributes¶
class-attribute
instance-attribute
¶
character_set_name: str | None = ...
The character set for your tenant database. If you don't specify a
value, the character set name defaults to AL32UTF8.
class-attribute
instance-attribute
¶
db_instance_identifier: str | None = ...
The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.
class-attribute
instance-attribute
¶
manage_master_user_password: bool | None = ...
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
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 password for the master user in your tenant database.
Constraints:
-
Must be 8 to 30 characters.
-
Can include any printable ASCII character except forward slash (
/), double quote ("), at symbol (@), ampersand (&), or single quote ('). -
Can't be specified when
ManageMasterUserPasswordis enabled.
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 the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or 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.
If you 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 customer managed KMS key.
There is a default KMS key 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
¶
master_username: str | None = ...
The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case-sensitive.
Constraints:
-
Must be 1 to 16 letters, numbers, or underscores.
-
First character must be a letter.
-
Can't be a reserved word for the chosen database engine.
class-attribute
instance-attribute
¶
nchar_character_set_name: str | None = ...
The NCHAR value for the tenant database.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateTenantDatabaseOutput 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.