Skip to content

Create Tenant Database

rds_create_tenant_database R Documentation

Creates a tenant database in a DB instance that uses the multi-tenant configuration

Description

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

Usage

rds_create_tenant_database(DBInstanceIdentifier, TenantDBName,
  MasterUsername, MasterUserPassword, CharacterSetName,
  NcharCharacterSetName, Tags)

Arguments

DBInstanceIdentifier

[required] The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive.

TenantDBName

[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 create_db_instance.

MasterUsername

[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

[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

The character set for your tenant database. If you don't specify a value, the character set name defaults to AL32UTF8.

NcharCharacterSetName

The NCHAR value for the tenant database.

Tags

Value

A list with the following syntax: 

list(
  TenantDatabase = list(
    TenantDatabaseCreateTime = as.POSIXct(
      "2015-01-01"
    ),
    DBInstanceIdentifier = "string",
    TenantDBName = "string",
    Status = "string",
    MasterUsername = "string",
    DbiResourceId = "string",
    TenantDatabaseResourceId = "string",
    TenantDatabaseARN = "string",
    CharacterSetName = "string",
    NcharCharacterSetName = "string",
    DeletionProtection = TRUE|FALSE,
    PendingModifiedValues = list(
      MasterUserPassword = "string",
      TenantDBName = "string"
    ),
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax

svc$create_tenant_database(
  DBInstanceIdentifier = "string",
  TenantDBName = "string",
  MasterUsername = "string",
  MasterUserPassword = "string",
  CharacterSetName = "string",
  NcharCharacterSetName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)