RDS / Client / create_tenant_database

create_tenant_database#

RDS.Client.create_tenant_database(**kwargs)#

Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.

Request Syntax

response = client.create_tenant_database(
    DBInstanceIdentifier='string',
    TenantDBName='string',
    MasterUsername='string',
    MasterUserPassword='string',
    CharacterSetName='string',
    NcharCharacterSetName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

DBInstanceIdentifier (string) –
[REQUIRED]

The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn’t case-sensitive.
TenantDBName (string) –
[REQUIRED]

The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as DBName in CreateDBInstance.
MasterUsername (string) –
[REQUIRED]

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.
MasterUserPassword (string) –
[REQUIRED]

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 ( ').
CharacterSetName (string) – The character set for your tenant database. If you don’t specify a value, the character set name defaults to AL32UTF8.
NcharCharacterSetName (string) – The NCHAR value for the tenant database.
Tags (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}_.:/=+\-@]*)$”).

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 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

RDS.Client.exceptions.DBInstanceNotFoundFault
RDS.Client.exceptions.InvalidDBInstanceStateFault
RDS.Client.exceptions.TenantDatabaseAlreadyExistsFault
RDS.Client.exceptions.TenantDatabaseQuotaExceededFault