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 ModifyTenantDatabase operation. 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.
Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z
public class ModifyTenantDatabaseRequest : AmazonRDSRequest IAmazonWebServiceRequest
The ModifyTenantDatabaseRequest type exposes the following members
Name | Description | |
---|---|---|
![]() |
ModifyTenantDatabaseRequest() |
Name | Type | Description | |
---|---|---|---|
![]() |
DBInstanceIdentifier | System.String |
Gets and sets the property DBInstanceIdentifier. The identifier of the DB instance that contains the tenant database that you are modifying. This parameter isn't case-sensitive. Constraints:
|
![]() |
ManageMasterUserPassword | System.Boolean |
Gets and sets the property ManageMasterUserPassword. Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
If the tenant database doesn't manage the master user password with Amazon Web Services
Secrets Manager, you can turn on this management. In this case, you can't specify
If the tenant database already manages the master user password with Amazon Web Services
Secrets Manager, and you specify that the master user password is not managed with
Amazon Web Services Secrets Manager, then you must specify For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints:
|
![]() |
MasterUserPassword | System.String |
Gets and sets the property 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:
Length constraints:
|
![]() |
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 both of the following conditions are met:
The Amazon Web Services KMS key identifier is any of the following:
To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. A default KMS key exists for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. |
![]() |
NewTenantDBName | System.String |
Gets and sets the property NewTenantDBName. The new name of the tenant database when renaming a tenant database. This parameter isn’t case-sensitive. Constraints:
|
![]() |
RotateMasterUserPassword | System.Boolean |
Gets and sets the property RotateMasterUserPassword. Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password. 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 secret value contains the updated password. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints:
|
![]() |
TenantDBName | System.String |
Gets and sets the property TenantDBName. The user-supplied name of the tenant database that you want to modify. This parameter isn’t case-sensitive. Constraints:
|
.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