Amazonka.SecretsManager.Types.RotationRulesType

Documentation

data RotationRulesType

A structure that defines the rotation configuration for the secret.

See: newRotationRulesType smart constructor.

Constructors

RotationRulesType'

Fields

• automaticallyAfterDays :: Maybe Natural

  The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.

  In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.

• duration :: Maybe Text

  The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.

• scheduleExpression :: Maybe Text

  A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.

  Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

  You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

Instances

FromJSON RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

parseJSON :: Value -> Parser RotationRulesType

parseJSONList :: Value -> Parser [RotationRulesType]

ToJSON RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

toJSON :: RotationRulesType -> Value

toEncoding :: RotationRulesType -> Encoding

toJSONList :: [RotationRulesType] -> Value

toEncodingList :: [RotationRulesType] -> Encoding

Generic RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Associated Types

type Rep RotationRulesType :: Type -> Type

Methods

from :: RotationRulesType -> Rep RotationRulesType x

to :: Rep RotationRulesType x -> RotationRulesType

Read RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

readsPrec :: Int -> ReadS RotationRulesType

readList :: ReadS [RotationRulesType]

readPrec :: ReadPrec RotationRulesType

readListPrec :: ReadPrec [RotationRulesType]

Show RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

showsPrec :: Int -> RotationRulesType -> ShowS

show :: RotationRulesType -> String

showList :: [RotationRulesType] -> ShowS

NFData RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

rnf :: RotationRulesType -> ()

Eq RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

(==) :: RotationRulesType -> RotationRulesType -> Bool

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

Hashable RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

Methods

hashWithSalt :: Int -> RotationRulesType -> Int

hash :: RotationRulesType -> Int

type Rep RotationRulesType

Defined in Amazonka.SecretsManager.Types.RotationRulesType

type Rep RotationRulesType = D1 ('MetaData "RotationRulesType" "Amazonka.SecretsManager.Types.RotationRulesType" "amazonka-secretsmanager-2.0-8tljeZ4CwL92E7JavkDb0o" 'False) (C1 ('MetaCons "RotationRulesType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "automaticallyAfterDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newRotationRulesType :: RotationRulesType

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 - The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.

In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.

$sel:duration:RotationRulesType', rotationRulesType_duration - The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.

$sel:scheduleExpression:RotationRulesType', rotationRulesType_scheduleExpression - A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.

Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

rotationRulesType_automaticallyAfterDays :: Lens' RotationRulesType (Maybe Natural)

The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.

In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.

rotationRulesType_duration :: Lens' RotationRulesType (Maybe Text)

The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.

rotationRulesType_scheduleExpression :: Lens' RotationRulesType (Maybe Text)

A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.

Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.