Amazonka.SecretsManager.Types.SecretListEntry

Documentation

data SecretListEntry

A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use GetSecretValue .

See: newSecretListEntry smart constructor.

Constructors

SecretListEntry'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the secret.

• createdDate :: Maybe POSIX

  The date and time when a secret was created.

• deletedDate :: Maybe POSIX

  The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

• description :: Maybe Text

  The user-provided description of the secret.

• kmsKeyId :: Maybe Text

  The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

• lastAccessedDate :: Maybe POSIX

  The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

• lastChangedDate :: Maybe POSIX

  The last date and time that this secret was modified in any way.

• lastRotatedDate :: Maybe POSIX

  The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.

• name :: Maybe Text

  The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

• nextRotationDate :: Maybe POSIX
• owningService :: Maybe Text

  Returns the name of the service that created the secret.

• primaryRegion :: Maybe Text

  The Region where Secrets Manager originated the secret.

• rotationEnabled :: Maybe Bool

  Indicates whether automatic, scheduled rotation is enabled for this secret.

• rotationLambdaARN :: Maybe Text

  The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .

• rotationRules :: Maybe RotationRulesType

  A structure that defines the rotation configuration for the secret.

• secretVersionsToStages :: Maybe (HashMap Text (NonEmpty Text))

  A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.

  A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

• tags :: Maybe [Tag]

  The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

Instances

FromJSON SecretListEntry

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Methods

parseJSON :: Value -> Parser SecretListEntry

parseJSONList :: Value -> Parser [SecretListEntry]

Generic SecretListEntry

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Associated Types

type Rep SecretListEntry :: Type -> Type

Methods

from :: SecretListEntry -> Rep SecretListEntry x

to :: Rep SecretListEntry x -> SecretListEntry

Read SecretListEntry

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Methods

readsPrec :: Int -> ReadS SecretListEntry

readList :: ReadS [SecretListEntry]

readPrec :: ReadPrec SecretListEntry

readListPrec :: ReadPrec [SecretListEntry]

Show SecretListEntry

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Methods

showsPrec :: Int -> SecretListEntry -> ShowS

show :: SecretListEntry -> String

showList :: [SecretListEntry] -> ShowS

NFData SecretListEntry

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Methods

rnf :: SecretListEntry -> ()

Eq SecretListEntry

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Methods

(==) :: SecretListEntry -> SecretListEntry -> Bool

(/=) :: SecretListEntry -> SecretListEntry -> Bool

Hashable SecretListEntry

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Methods

hashWithSalt :: Int -> SecretListEntry -> Int

hash :: SecretListEntry -> Int

type Rep SecretListEntry

Defined in Amazonka.SecretsManager.Types.SecretListEntry

type Rep SecretListEntry = D1 ('MetaData "SecretListEntry" "Amazonka.SecretsManager.Types.SecretListEntry" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "SecretListEntry'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "deletedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastAccessedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "lastChangedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lastRotatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextRotationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "owningService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "primaryRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "rotationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "rotationLambdaARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "rotationRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RotationRulesType)) :*: (S1 ('MetaSel ('Just "secretVersionsToStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (NonEmpty Text)))) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))))))))

newSecretListEntry :: SecretListEntry

Create a value of SecretListEntry 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:arn:SecretListEntry', secretListEntry_arn - The Amazon Resource Name (ARN) of the secret.

$sel:createdDate:SecretListEntry', secretListEntry_createdDate - The date and time when a secret was created.

$sel:deletedDate:SecretListEntry', secretListEntry_deletedDate - The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

$sel:description:SecretListEntry', secretListEntry_description - The user-provided description of the secret.

$sel:kmsKeyId:SecretListEntry', secretListEntry_kmsKeyId - The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

$sel:lastAccessedDate:SecretListEntry', secretListEntry_lastAccessedDate - The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

$sel:lastChangedDate:SecretListEntry', secretListEntry_lastChangedDate - The last date and time that this secret was modified in any way.

$sel:lastRotatedDate:SecretListEntry', secretListEntry_lastRotatedDate - The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.

$sel:name:SecretListEntry', secretListEntry_name - The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

$sel:nextRotationDate:SecretListEntry', secretListEntry_nextRotationDate - Undocumented member.

$sel:owningService:SecretListEntry', secretListEntry_owningService - Returns the name of the service that created the secret.

$sel:primaryRegion:SecretListEntry', secretListEntry_primaryRegion - The Region where Secrets Manager originated the secret.

$sel:rotationEnabled:SecretListEntry', secretListEntry_rotationEnabled - Indicates whether automatic, scheduled rotation is enabled for this secret.

$sel:rotationLambdaARN:SecretListEntry', secretListEntry_rotationLambdaARN - The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .

$sel:rotationRules:SecretListEntry', secretListEntry_rotationRules - A structure that defines the rotation configuration for the secret.

$sel:secretVersionsToStages:SecretListEntry', secretListEntry_secretVersionsToStages - A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

$sel:tags:SecretListEntry', secretListEntry_tags - The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

secretListEntry_arn :: Lens' SecretListEntry (Maybe Text)

The Amazon Resource Name (ARN) of the secret.

secretListEntry_createdDate :: Lens' SecretListEntry (Maybe UTCTime)

The date and time when a secret was created.

secretListEntry_deletedDate :: Lens' SecretListEntry (Maybe UTCTime)

The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

secretListEntry_description :: Lens' SecretListEntry (Maybe Text)

The user-provided description of the secret.

secretListEntry_kmsKeyId :: Lens' SecretListEntry (Maybe Text)

The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

secretListEntry_lastAccessedDate :: Lens' SecretListEntry (Maybe UTCTime)

The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

secretListEntry_lastChangedDate :: Lens' SecretListEntry (Maybe UTCTime)

The last date and time that this secret was modified in any way.

secretListEntry_lastRotatedDate :: Lens' SecretListEntry (Maybe UTCTime)

The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.

secretListEntry_name :: Lens' SecretListEntry (Maybe Text)

The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

secretListEntry_nextRotationDate :: Lens' SecretListEntry (Maybe UTCTime)

Undocumented member.

secretListEntry_owningService :: Lens' SecretListEntry (Maybe Text)

Returns the name of the service that created the secret.

secretListEntry_primaryRegion :: Lens' SecretListEntry (Maybe Text)

The Region where Secrets Manager originated the secret.

secretListEntry_rotationEnabled :: Lens' SecretListEntry (Maybe Bool)

Indicates whether automatic, scheduled rotation is enabled for this secret.

secretListEntry_rotationLambdaARN :: Lens' SecretListEntry (Maybe Text)

The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .

secretListEntry_rotationRules :: Lens' SecretListEntry (Maybe RotationRulesType)

A structure that defines the rotation configuration for the secret.

secretListEntry_secretVersionsToStages :: Lens' SecretListEntry (Maybe (HashMap Text (NonEmpty Text)))

A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

secretListEntry_tags :: Lens' SecretListEntry (Maybe [Tag])

The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .