AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RDS.AmazonRDSRequest
      Amazon.RDS.Model.CreateTenantDatabaseRequest

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z

Syntax

C#
public class CreateTenantDatabaseRequest : AmazonRDSRequest
         IAmazonWebServiceRequest

The CreateTenantDatabaseRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CharacterSetName System.String

Gets and sets the property CharacterSetName.

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

Public Property DBInstanceIdentifier System.String

Gets and sets the property DBInstanceIdentifier.

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

Public Property ManageMasterUserPassword System.Boolean

Gets and sets the property 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.

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

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.

Public Property MasterUserPassword System.String

Gets and sets the property 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.

Public Property MasterUserSecretKmsKeyId System.String

Gets and sets the property 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.

Public Property NcharCharacterSetName System.String

Gets and sets the property NcharCharacterSetName.

The NCHAR value for the tenant database.

Public Property Tags System.Collections.Generic.List<Amazon.RDS.Model.Tag>

Gets and sets the property Tags.

Public Property TenantDBName System.String

Gets and sets the property TenantDBName.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5