Package software.amazon.awssdk.services.rds.model

Class CreateTenantDatabaseRequest

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.CreateTenantDatabaseRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTenantDatabaseRequest.Builder,CreateTenantDatabaseRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTenantDatabaseRequest extends RdsRequest implements ToCopyableBuilder<CreateTenantDatabaseRequest.Builder,CreateTenantDatabaseRequest>

  • Method Details

    • dbInstanceIdentifier

      public final String dbInstanceIdentifier()

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

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

    • tenantDBName

      public final String 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.

      Returns:
      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.

    • masterUsername

      public final String 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.

      Returns:
      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.

    • masterUserPassword

      public final String 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.

      Returns:
      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.

    • characterSetName

      public final String characterSetName()

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

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

    • ncharCharacterSetName

      public final String ncharCharacterSetName()

      The NCHAR value for the tenant database.

      Returns:
      The NCHAR value for the tenant database.

    • manageMasterUserPassword

      public final Boolean 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.

      Returns:
      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.

    • 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 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.

      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 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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()
      Returns the value of the Tags property for this object.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The value of the Tags property for this object.

    • toBuilder

      public CreateTenantDatabaseRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateTenantDatabaseRequest.Builder,CreateTenantDatabaseRequest>
      Specified by:
      toBuilder in class RdsRequest

    • builder

      public static CreateTenantDatabaseRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTenantDatabaseRequest.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