java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.ModifyTenantDatabaseRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ModifyTenantDatabaseRequest.Builder,ModifyTenantDatabaseRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ModifyTenantDatabaseRequest
extends RdsRequest
implements ToCopyableBuilder<ModifyTenantDatabaseRequest.Builder,ModifyTenantDatabaseRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ModifyTenantDatabaseRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ModifyTenantDatabaseRequest.Builder`	`builder()`
`String`	`dbInstanceIdentifier()`	The identifier of the DB instance that contains the tenant database that you are modifying.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`manageMasterUserPassword()`	Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
`String`	`masterUserPassword()`	The new password for the master user of the specified tenant database in your DB instance.
`String`	`masterUserSecretKmsKeyId()`	The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
`String`	`newTenantDBName()`	The new name of the tenant database when renaming a tenant database.
`Boolean`	`rotateMasterUserPassword()`	Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModifyTenantDatabaseRequest.Builder>`	`serializableBuilderClass()`
`String`	`tenantDBName()`	The user-supplied name of the tenant database that you want to modify.
`ModifyTenantDatabaseRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbInstanceIdentifier
```
public final String dbInstanceIdentifier()
```
    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.
    Returns:
    
    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
```
public final String tenantDBName()
```
    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.
    Returns:
    
    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
```
public final String 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.
    Returns:
    
    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
```
public final String 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.
    Returns:
    
    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.
  - manageMasterUserPassword
```
public final Boolean 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 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.
    Returns:
    
    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.
  - rotateMasterUserPassword
```
public final Boolean 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:
    
    You must apply the change immediately when rotating the master user password.
    Returns:
    
    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.
  - masterUserSecretKmsKeyId
```
public final String 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 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.
    Returns:
    
    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.
  - toBuilder
```
public ModifyTenantDatabaseRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModifyTenantDatabaseRequest.Builder,ModifyTenantDatabaseRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
  - builder
```
public static ModifyTenantDatabaseRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModifyTenantDatabaseRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ModifyTenantDatabaseRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbInstanceIdentifier

tenantDBName

masterUserPassword

newTenantDBName

manageMasterUserPassword

rotateMasterUserPassword

masterUserSecretKmsKeyId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField