Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.Types.MasterUserSecret

Description

Synopsis

Documentation

data MasterUserSecret Source #

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

See: newMasterUserSecret smart constructor.

Constructors

MasterUserSecret'

Fields

kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
secretArn :: Maybe Text
The Amazon Resource Name (ARN) of the secret.
secretStatus :: Maybe Text
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.

Instances

Instances details

FromXML MasterUserSecret Source #
Instance details Defined in Amazonka.RDS.Types.MasterUserSecret Methods parseXML :: [Node] -> Either String MasterUserSecret #
Generic MasterUserSecret Source #
Instance details Defined in Amazonka.RDS.Types.MasterUserSecret Associated Types type Rep MasterUserSecret :: Type -> Type # Methods from :: MasterUserSecret -> Rep MasterUserSecret x # to :: Rep MasterUserSecret x -> MasterUserSecret #
Read MasterUserSecret Source #
Instance details Defined in Amazonka.RDS.Types.MasterUserSecret Methods readsPrec :: Int -> ReadS MasterUserSecret # readList :: ReadS [MasterUserSecret] # readPrec :: ReadPrec MasterUserSecret # readListPrec :: ReadPrec [MasterUserSecret] #
Show MasterUserSecret Source #
Instance details Defined in Amazonka.RDS.Types.MasterUserSecret Methods showsPrec :: Int -> MasterUserSecret -> ShowS # show :: MasterUserSecret -> String # showList :: [MasterUserSecret] -> ShowS #
NFData MasterUserSecret Source #
Instance details Defined in Amazonka.RDS.Types.MasterUserSecret Methods rnf :: MasterUserSecret -> () #
Eq MasterUserSecret Source #
Instance details Defined in Amazonka.RDS.Types.MasterUserSecret Methods (==) :: MasterUserSecret -> MasterUserSecret -> Bool # (/=) :: MasterUserSecret -> MasterUserSecret -> Bool #
Hashable MasterUserSecret Source #
Instance details Defined in Amazonka.RDS.Types.MasterUserSecret Methods hashWithSalt :: Int -> MasterUserSecret -> Int # hash :: MasterUserSecret -> Int #
type Rep MasterUserSecret Source #
Instance details Defined in Amazonka.RDS.Types.MasterUserSecret type Rep MasterUserSecret = D1 ('MetaData "MasterUserSecret" "Amazonka.RDS.Types.MasterUserSecret" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "MasterUserSecret'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "secretStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMasterUserSecret :: MasterUserSecret Source #

Create a value of MasterUserSecret with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:MasterUserSecret', masterUserSecret_kmsKeyId - The Amazon Web Services KMS key identifier that is used to encrypt the secret.

$sel:secretArn:MasterUserSecret', masterUserSecret_secretArn - The Amazon Resource Name (ARN) of the secret.

$sel:secretStatus:MasterUserSecret', masterUserSecret_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.

masterUserSecret_kmsKeyId :: Lens' MasterUserSecret (Maybe Text) Source #

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

masterUserSecret_secretArn :: Lens' MasterUserSecret (Maybe Text) Source #

The Amazon Resource Name (ARN) of the secret.

masterUserSecret_secretStatus :: Lens' MasterUserSecret (Maybe Text) Source #

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.