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, ManageMasterUserPassword,
  MasterUserSecretKmsKeyId, 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

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 ManageMasterUserPassword is enabled.
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.
ManageMasterUserPassword

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 MasterUserPassword is specified.
MasterUserSecretKmsKeyId

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.
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"
    ),
    MasterUserSecret = list(
      SecretArn = "string",
      SecretStatus = "string",
      KmsKeyId = "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",
  ManageMasterUserPassword = TRUE|FALSE,
  MasterUserSecretKmsKeyId = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)