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

Interface MasterUserSecret.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MasterUserSecret.Builder,MasterUserSecret>, SdkBuilder<MasterUserSecret.Builder,MasterUserSecret>, SdkPojo
Enclosing class:
MasterUserSecret
public static interface MasterUserSecret.Builder extends SdkPojo, CopyableBuilder<MasterUserSecret.Builder,MasterUserSecret>

  • Method Details

    • secretArn

      MasterUserSecret.Builder secretArn(String secretArn)

      The Amazon Resource Name (ARN) of the secret.

      Parameters:
      secretArn - The Amazon Resource Name (ARN) of the secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretStatus

      MasterUserSecret.Builder secretStatus(String secretStatus)

      The status of the secret.

      The possible status values include the following:

      • creating - The secret is being created.

      • active - The secret is available for normal use and rotation.

      • rotating - The secret is being rotated.

      • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

        When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

      Parameters:
      secretStatus - The status of the secret.

      The possible status values include the following:

      • creating - The secret is being created.

      • active - The secret is available for normal use and rotation.

      • rotating - The secret is being rotated.

      • impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret.

        When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      MasterUserSecret.Builder kmsKeyId(String kmsKeyId)

      The Amazon Web Services KMS key identifier that is used to encrypt the secret.

      Parameters:
      kmsKeyId - The Amazon Web Services KMS key identifier that is used to encrypt the secret.
      Returns:
      Returns a reference to this object so that method calls can be chained together.