libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SecretsManager.Types

Description

 
Synopsis

Service Configuration

defaultService :: Service Source #

API version 2017-10-17 of the Amazon Secrets Manager SDK configuration.

Errors

_MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You provided a resource-based policy with syntax errors.

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You provided an invalid value for a parameter.

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You provided a parameter value that is not valid for the current state of the resource.

Possible causes:

  • You tried to perform the operation on a secret that's currently marked deleted.
  • You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.

_DecryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError Source #

Secrets Manager can't decrypt the protected secret text using the provided KMS key.

_PublicPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.

_EncryptionFailure :: AsError a => Getting (First ServiceError) a ServiceError Source #

Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.

_PreconditionNotMetException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request failed because you did not complete all the prerequisite steps.

_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #

You provided an invalid NextToken value.

_InternalServiceError :: AsError a => Getting (First ServiceError) a ServiceError Source #

An error occurred on the server side.

_ResourceExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

A resource with the ID you requested already exists.

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

We can't find the resource that you asked for.

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request failed because it would exceed one of the Secrets Manager internal limits.

FilterNameStringType

newtype FilterNameStringType Source #

Instances

Instances details
Eq FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Ord FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Read FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Show FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Generic FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Associated Types

type Rep FilterNameStringType :: Type -> Type #

NFData FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

Methods

rnf :: FilterNameStringType -> () #

Hashable FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToJSON FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToJSONKey FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

FromJSON FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

FromJSONKey FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToLog FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToHeader FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToQuery FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

FromXML FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToXML FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToByteString FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

FromText FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

ToText FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

type Rep FilterNameStringType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.FilterNameStringType

type Rep FilterNameStringType = D1 ('MetaData "FilterNameStringType" "Amazonka.SecretsManager.Types.FilterNameStringType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'True) (C1 ('MetaCons "FilterNameStringType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromFilterNameStringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SortOrderType

newtype SortOrderType Source #

Constructors

SortOrderType' 

Bundled Patterns

pattern SortOrderType_Asc :: SortOrderType 
pattern SortOrderType_Desc :: SortOrderType 

Instances

Instances details
Eq SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Ord SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Read SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Show SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Generic SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Associated Types

type Rep SortOrderType :: Type -> Type #

NFData SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Methods

rnf :: SortOrderType -> () #

Hashable SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToJSON SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToJSONKey SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

FromJSON SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

FromJSONKey SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToLog SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToHeader SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToQuery SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

FromXML SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToXML SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Methods

toXML :: SortOrderType -> XML #

ToByteString SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

FromText SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

ToText SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

Methods

toText :: SortOrderType -> Text #

type Rep SortOrderType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SortOrderType

type Rep SortOrderType = D1 ('MetaData "SortOrderType" "Amazonka.SecretsManager.Types.SortOrderType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'True) (C1 ('MetaCons "SortOrderType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSortOrderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

StatusType

newtype StatusType Source #

Constructors

StatusType' 

Fields

Bundled Patterns

pattern StatusType_Failed :: StatusType 
pattern StatusType_InProgress :: StatusType 
pattern StatusType_InSync :: StatusType 

Instances

Instances details
Eq StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Ord StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Read StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Show StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Generic StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Associated Types

type Rep StatusType :: Type -> Type #

NFData StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Methods

rnf :: StatusType -> () #

Hashable StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToJSON StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToJSONKey StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

FromJSON StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

FromJSONKey StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToLog StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToHeader StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToQuery StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

FromXML StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToXML StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Methods

toXML :: StatusType -> XML #

ToByteString StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

FromText StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

ToText StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

Methods

toText :: StatusType -> Text #

type Rep StatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.StatusType

type Rep StatusType = D1 ('MetaData "StatusType" "Amazonka.SecretsManager.Types.StatusType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'True) (C1 ('MetaCons "StatusType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStatusType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Filter

data Filter Source #

Allows you to add filters when you use the search function in Secrets Manager.

See: newFilter smart constructor.

Constructors

Filter' 

Fields

  • values :: Maybe (NonEmpty Text)

    Filters your list of secrets by a specific value.

    You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

  • key :: Maybe FilterNameStringType

    Filters your list of secrets by a specific key.

Instances

Instances details
Eq Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Methods

(==) :: Filter -> Filter -> Bool #

(/=) :: Filter -> Filter -> Bool #

Read Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Show Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Generic Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Associated Types

type Rep Filter :: Type -> Type #

Methods

from :: Filter -> Rep Filter x #

to :: Rep Filter x -> Filter #

NFData Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Methods

rnf :: Filter -> () #

Hashable Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

Methods

hashWithSalt :: Int -> Filter -> Int #

hash :: Filter -> Int #

ToJSON Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

type Rep Filter Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Filter

type Rep Filter = D1 ('MetaData "Filter" "Amazonka.SecretsManager.Types.Filter" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FilterNameStringType))))

newFilter :: Filter Source #

Create a value of Filter 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:values:Filter', filter_values - Filters your list of secrets by a specific value.

You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

$sel:key:Filter', filter_key - Filters your list of secrets by a specific key.

filter_values :: Lens' Filter (Maybe (NonEmpty Text)) Source #

Filters your list of secrets by a specific value.

You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

filter_key :: Lens' Filter (Maybe FilterNameStringType) Source #

Filters your list of secrets by a specific key.

ReplicaRegionType

data ReplicaRegionType Source #

(Optional) Custom type consisting of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias.

See: newReplicaRegionType smart constructor.

Constructors

ReplicaRegionType' 

Fields

Instances

Instances details
Eq ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Read ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Show ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Generic ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Associated Types

type Rep ReplicaRegionType :: Type -> Type #

NFData ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

Methods

rnf :: ReplicaRegionType -> () #

Hashable ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

ToJSON ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

type Rep ReplicaRegionType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicaRegionType

type Rep ReplicaRegionType = D1 ('MetaData "ReplicaRegionType" "Amazonka.SecretsManager.Types.ReplicaRegionType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ReplicaRegionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newReplicaRegionType :: ReplicaRegionType Source #

Create a value of ReplicaRegionType 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:ReplicaRegionType', replicaRegionType_kmsKeyId - Can be an ARN, Key ID, or Alias.

$sel:region:ReplicaRegionType', replicaRegionType_region - Describes a single instance of Region objects.

replicaRegionType_kmsKeyId :: Lens' ReplicaRegionType (Maybe Text) Source #

Can be an ARN, Key ID, or Alias.

replicaRegionType_region :: Lens' ReplicaRegionType (Maybe Text) Source #

Describes a single instance of Region objects.

ReplicationStatusType

data ReplicationStatusType Source #

A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.

See: newReplicationStatusType smart constructor.

Constructors

ReplicationStatusType' 

Fields

Instances

Instances details
Eq ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Read ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Show ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Generic ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Associated Types

type Rep ReplicationStatusType :: Type -> Type #

NFData ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

Methods

rnf :: ReplicationStatusType -> () #

Hashable ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

FromJSON ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

type Rep ReplicationStatusType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ReplicationStatusType

type Rep ReplicationStatusType = D1 ('MetaData "ReplicationStatusType" "Amazonka.SecretsManager.Types.ReplicationStatusType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ReplicationStatusType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatusType)) :*: S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastAccessedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newReplicationStatusType :: ReplicationStatusType Source #

Create a value of ReplicationStatusType 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:status:ReplicationStatusType', replicationStatusType_status - The status can be InProgress, Failed, or InSync.

$sel:kmsKeyId:ReplicationStatusType', replicationStatusType_kmsKeyId - Can be an ARN, Key ID, or Alias.

$sel:statusMessage:ReplicationStatusType', replicationStatusType_statusMessage - Status message such as "/Secret with this name already exists in this region/".

$sel:region:ReplicationStatusType', replicationStatusType_region - The Region where replication occurs.

$sel:lastAccessedDate:ReplicationStatusType', replicationStatusType_lastAccessedDate - The date that you last accessed the secret in the Region.

replicationStatusType_status :: Lens' ReplicationStatusType (Maybe StatusType) Source #

The status can be InProgress, Failed, or InSync.

replicationStatusType_statusMessage :: Lens' ReplicationStatusType (Maybe Text) Source #

Status message such as "/Secret with this name already exists in this region/".

replicationStatusType_region :: Lens' ReplicationStatusType (Maybe Text) Source #

The Region where replication occurs.

replicationStatusType_lastAccessedDate :: Lens' ReplicationStatusType (Maybe UTCTime) Source #

The date that you last accessed the secret in the Region.

RotationRulesType

data RotationRulesType Source #

A structure that defines the rotation configuration for the secret.

See: newRotationRulesType smart constructor.

Constructors

RotationRulesType' 

Fields

  • automaticallyAfterDays :: Maybe Natural

    Specifies the number of days between automatic scheduled rotations of the secret.

    Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

Instances

Instances details
Eq RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Read RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Show RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Generic RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Associated Types

type Rep RotationRulesType :: Type -> Type #

NFData RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

rnf :: RotationRulesType -> () #

Hashable RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

ToJSON RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

FromJSON RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

type Rep RotationRulesType Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.RotationRulesType

type Rep RotationRulesType = D1 ('MetaData "RotationRulesType" "Amazonka.SecretsManager.Types.RotationRulesType" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "RotationRulesType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "automaticallyAfterDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))

newRotationRulesType :: RotationRulesType Source #

Create a value of RotationRulesType 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:automaticallyAfterDays:RotationRulesType', rotationRulesType_automaticallyAfterDays - Specifies the number of days between automatic scheduled rotations of the secret.

Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

rotationRulesType_automaticallyAfterDays :: Lens' RotationRulesType (Maybe Natural) Source #

Specifies the number of days between automatic scheduled rotations of the secret.

Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

SecretListEntry

data SecretListEntry Source #

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

See: newSecretListEntry smart constructor.

Constructors

SecretListEntry' 

Fields

  • lastChangedDate :: Maybe POSIX

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

  • primaryRegion :: Maybe Text

    The Region where Secrets Manager originated the secret.

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the secret.

    For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.

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

  • rotationRules :: Maybe RotationRulesType

    A structure that defines the rotation configuration for the secret.

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

  • rotationEnabled :: Maybe Bool

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

  • createdDate :: Maybe POSIX

    The date and time when a secret was created.

  • kmsKeyId :: Maybe Text

    The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager, for this account.

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

  • owningService :: Maybe Text

    Returns the name of the service that created the secret.

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

  • lastAccessedDate :: Maybe POSIX

    The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

  • description :: Maybe Text

    The user-provided description of the 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.

  • 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

Instances details
Eq SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Read SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Show SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Generic SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Associated Types

type Rep SecretListEntry :: Type -> Type #

NFData SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

Methods

rnf :: SecretListEntry -> () #

Hashable SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

FromJSON SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

type Rep SecretListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretListEntry

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

newSecretListEntry :: SecretListEntry Source #

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:lastChangedDate:SecretListEntry', secretListEntry_lastChangedDate - The last date and time that this secret was modified in any way.

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

$sel:arn:SecretListEntry', secretListEntry_arn - The Amazon Resource Name (ARN) of the secret.

For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.

$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:rotationRules:SecretListEntry', secretListEntry_rotationRules - A structure that defines the rotation configuration for the secret.

$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:rotationEnabled:SecretListEntry', secretListEntry_rotationEnabled - Indicates whether automatic, scheduled rotation is enabled for this secret.

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

$sel:kmsKeyId:SecretListEntry', secretListEntry_kmsKeyId - The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager, for this account.

$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:owningService:SecretListEntry', secretListEntry_owningService - Returns the name of the service that created the secret.

$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:lastAccessedDate:SecretListEntry', secretListEntry_lastAccessedDate - The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

$sel:description:SecretListEntry', secretListEntry_description - The user-provided description of the 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: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_lastChangedDate :: Lens' SecretListEntry (Maybe UTCTime) Source #

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

secretListEntry_primaryRegion :: Lens' SecretListEntry (Maybe Text) Source #

The Region where Secrets Manager originated the secret.

secretListEntry_arn :: Lens' SecretListEntry (Maybe Text) Source #

The Amazon Resource Name (ARN) of the secret.

For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.

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

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_rotationRules :: Lens' SecretListEntry (Maybe RotationRulesType) Source #

A structure that defines the rotation configuration for the secret.

secretListEntry_deletedDate :: Lens' SecretListEntry (Maybe UTCTime) Source #

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_rotationEnabled :: Lens' SecretListEntry (Maybe Bool) Source #

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

secretListEntry_createdDate :: Lens' SecretListEntry (Maybe UTCTime) Source #

The date and time when a secret was created.

secretListEntry_kmsKeyId :: Lens' SecretListEntry (Maybe Text) Source #

The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager, for this account.

secretListEntry_name :: Lens' SecretListEntry (Maybe Text) Source #

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_owningService :: Lens' SecretListEntry (Maybe Text) Source #

Returns the name of the service that created the secret.

secretListEntry_lastRotatedDate :: Lens' SecretListEntry (Maybe UTCTime) Source #

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_lastAccessedDate :: Lens' SecretListEntry (Maybe UTCTime) Source #

The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

secretListEntry_description :: Lens' SecretListEntry (Maybe Text) Source #

The user-provided description of the secret.

secretListEntry_rotationLambdaARN :: Lens' SecretListEntry (Maybe Text) Source #

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_tags :: Lens' SecretListEntry (Maybe [Tag]) Source #

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

SecretVersionsListEntry

data SecretVersionsListEntry Source #

A structure that contains information about one version of a secret.

See: newSecretVersionsListEntry smart constructor.

Constructors

SecretVersionsListEntry' 

Fields

Instances

Instances details
Eq SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Read SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Show SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Generic SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Associated Types

type Rep SecretVersionsListEntry :: Type -> Type #

NFData SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

Methods

rnf :: SecretVersionsListEntry -> () #

Hashable SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

FromJSON SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

type Rep SecretVersionsListEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.SecretVersionsListEntry

type Rep SecretVersionsListEntry = D1 ('MetaData "SecretVersionsListEntry" "Amazonka.SecretsManager.Types.SecretVersionsListEntry" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "SecretVersionsListEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "kmsKeyIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "lastAccessedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newSecretVersionsListEntry :: SecretVersionsListEntry Source #

Create a value of SecretVersionsListEntry 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:versionId:SecretVersionsListEntry', secretVersionsListEntry_versionId - The unique version identifier of this version of the secret.

$sel:versionStages:SecretVersionsListEntry', secretVersionsListEntry_versionStages - An array of staging labels that are currently associated with this version of the secret.

$sel:createdDate:SecretVersionsListEntry', secretVersionsListEntry_createdDate - The date and time this version of the secret was created.

$sel:kmsKeyIds:SecretVersionsListEntry', secretVersionsListEntry_kmsKeyIds - The KMS keys used to encrypt the secret version.

$sel:lastAccessedDate:SecretVersionsListEntry', secretVersionsListEntry_lastAccessedDate - The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.

secretVersionsListEntry_versionId :: Lens' SecretVersionsListEntry (Maybe Text) Source #

The unique version identifier of this version of the secret.

secretVersionsListEntry_versionStages :: Lens' SecretVersionsListEntry (Maybe (NonEmpty Text)) Source #

An array of staging labels that are currently associated with this version of the secret.

secretVersionsListEntry_createdDate :: Lens' SecretVersionsListEntry (Maybe UTCTime) Source #

The date and time this version of the secret was created.

secretVersionsListEntry_kmsKeyIds :: Lens' SecretVersionsListEntry (Maybe [Text]) Source #

The KMS keys used to encrypt the secret version.

secretVersionsListEntry_lastAccessedDate :: Lens' SecretVersionsListEntry (Maybe UTCTime) Source #

The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.

Tag

data Tag Source #

A structure that contains information about a tag.

See: newTag smart constructor.

Constructors

Tag' 

Fields

Instances

Instances details
Eq Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Read Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Show Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

Generic Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Associated Types

type Rep Tag :: Type -> Type #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

NFData Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Methods

rnf :: Tag -> () #

Hashable Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

ToJSON Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

FromJSON Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

type Rep Tag Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.Tag

type Rep Tag = D1 ('MetaData "Tag" "Amazonka.SecretsManager.Types.Tag" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newTag :: Tag Source #

Create a value of Tag 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:value:Tag', tag_value - The string value associated with the key of the tag.

$sel:key:Tag', tag_key - The key identifier, or name, of the tag.

tag_value :: Lens' Tag (Maybe Text) Source #

The string value associated with the key of the tag.

tag_key :: Lens' Tag (Maybe Text) Source #

The key identifier, or name, of the tag.

ValidationErrorsEntry

data ValidationErrorsEntry Source #

Displays errors that occurred during validation of the resource policy.

See: newValidationErrorsEntry smart constructor.

Constructors

ValidationErrorsEntry' 

Fields

Instances

Instances details
Eq ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Read ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Show ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Generic ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Associated Types

type Rep ValidationErrorsEntry :: Type -> Type #

NFData ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

Methods

rnf :: ValidationErrorsEntry -> () #

Hashable ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

FromJSON ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

type Rep ValidationErrorsEntry Source # 
Instance details

Defined in Amazonka.SecretsManager.Types.ValidationErrorsEntry

type Rep ValidationErrorsEntry = D1 ('MetaData "ValidationErrorsEntry" "Amazonka.SecretsManager.Types.ValidationErrorsEntry" "libZSservicesZSamazonka-secretsmanagerZSamazonka-secretsmanager" 'False) (C1 ('MetaCons "ValidationErrorsEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "checkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newValidationErrorsEntry :: ValidationErrorsEntry Source #

Create a value of ValidationErrorsEntry 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:checkName:ValidationErrorsEntry', validationErrorsEntry_checkName - Checks the name of the policy.

$sel:errorMessage:ValidationErrorsEntry', validationErrorsEntry_errorMessage - Displays error messages if validation encounters problems during validation of the resource policy.

validationErrorsEntry_errorMessage :: Lens' ValidationErrorsEntry (Maybe Text) Source #

Displays error messages if validation encounters problems during validation of the resource policy.