Describes the tenant databases in a DB instance that uses the multi-tenant configuration¶

Description¶

Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.

Usage¶

rds_describe_tenant_databases(DBInstanceIdentifier, TenantDBName,
  Filters, Marker, MaxRecords)

Arguments¶

• DBInstanceIdentifier

  The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive.

• TenantDBName

  The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case-sensitive.

• Filters

  A filter that specifies one or more database tenants to describe.

  Supported filters:

  • tenant-db-name - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names.
  • tenant-database-resource-id - Tenant database resource identifiers.
  • dbi-resource-id - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers.

• Marker

  An optional pagination token provided by a previous describe_tenant_databases request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

• MaxRecords

  The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Value¶

A list with the following syntax:

list(
  Marker = "string",
  TenantDatabases = list(
    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$describe_tenant_databases(
  DBInstanceIdentifier = "string",
  TenantDBName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  Marker = "string",
  MaxRecords = 123
)