AWS Tools for Windows PowerShell
Command 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.

Synopsis

Calls the Amazon Relational Database Service ModifyTenantDatabase API operation.

Syntax

Edit-RDSTenantDatabase
-DBInstanceIdentifier <String>
-ManageMasterUserPassword <Boolean>
-MasterUserPassword <String>
-MasterUserSecretKmsKeyId <String>
-NewTenantDBName <String>
-RotateMasterUserPassword <Boolean>
-TenantDBName <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonRDSConfig>

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.

Parameters

-ClientConfig <AmazonRDSConfig>
Amazon.PowerShell.Cmdlets.RDS.AmazonRDSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBInstanceIdentifier <String>
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.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManageMasterUserPassword <Boolean>
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 MasterUserPassword.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 MasterUserPassword. In this case, Amazon RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserPassword <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterUserSecretKmsKeyId <String>
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 tenant database doesn't manage the master user password in Amazon Web Services Secrets Manager.If the tenant database already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key used to encrypt the secret.
  • You're turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager.If you're turning on ManageMasterUserPassword and 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 self-managed KMS key.
The Amazon Web Services KMS key identifier is any of the following:
  • Key ARN
  • Key ID
  • Alias ARN
  • 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.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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NewTenantDBName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DBInstanceIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^DBInstanceIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RotateMasterUserPassword <Boolean>
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:
  • You must apply the change immediately when rotating the master user password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'TenantDatabase'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RDS.Model.ModifyTenantDatabaseResponse). Specifying the name of a property of type Amazon.RDS.Model.ModifyTenantDatabaseResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TenantDBName <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.RDS.Model.TenantDatabase or Amazon.RDS.Model.ModifyTenantDatabaseResponse
This cmdlet returns an Amazon.RDS.Model.TenantDatabase object. The service call response (type Amazon.RDS.Model.ModifyTenantDatabaseResponse) can be returned by specifying '-Select *'.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z