Skip to content

Modify Tenant Database

rds_modify_tenant_database R Documentation

Modifies an existing tenant database in a DB instance

Description

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.

Usage

rds_modify_tenant_database(DBInstanceIdentifier, TenantDBName,
  MasterUserPassword, NewTenantDBName)

Arguments

DBInstanceIdentifier

[required] 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.

TenantDBName

[required] The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive.

Constraints:

  • Must match the identifier of an existing tenant database.

MasterUserPassword

The new password for the master user of the specified tenant database in your DB instance.

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.

NewTenantDBName

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.

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$modify_tenant_database(
  DBInstanceIdentifier = "string",
  TenantDBName = "string",
  MasterUserPassword = "string",
  NewTenantDBName = "string"
)