Class: Aws::SecretsManager::Types::RotationRulesType

Inherits:

Struct

• Object
• Struct
• Aws::SecretsManager::Types::RotationRulesType

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-secretsmanager/types.rb

Overview

Note:

When making an API call, you may pass RotationRulesType data as a hash:

{
  automatically_after_days: 1,
  duration: "DurationType",
  schedule_expression: "ScheduleExpressionType",
}

A structure that defines the rotation configuration for the secret.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #automatically_after_days ⇒ Integer

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

• #duration ⇒ String

  The length of the rotation window in hours, for example ‘3h` for a three hour window.

• #schedule_expression ⇒ String

  A ‘cron()` or `rate()` expression that defines the schedule for rotating your secret.

Instance Attribute Details

#automatically_after_days ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1849

class RotationRulesType < Struct.new(
  :automatically_after_days,
  :duration,
  :schedule_expression)
  SENSITIVE = []
  include Aws::Structure
end

#duration ⇒ String

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 go into the next UTC day. If you don’t specify this value, the window automatically ends at the end of the UTC day. The window begins according to the ‘ScheduleExpression`. For more information, including examples, see [Schedule expressions in Secrets Manager rotation].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1849

class RotationRulesType < Struct.new(
  :automatically_after_days,
  :duration,
  :schedule_expression)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

A ‘cron()` or `rate()` expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone.

Secrets Manager ‘rate()` expressions represent the interval in days that you want to rotate your secret, for example `rate(10 days)`. If you use a `rate()` expression, the rotation window opens at midnight, and Secrets Manager rotates your secret any time that day after midnight. You can set a `Duration` to shorten the rotation window.

You can use a ‘cron()` expression to create rotation schedules that are more detailed than a rotation interval. For more information, including examples, see [Schedule expressions in Secrets Manager rotation]. If you use a `cron()` expression, Secrets Manager rotates your secret any time during that day after the window opens. For example, `cron(0 8 1 * ? *)` represents a rotation window that occurs on the first day of every month beginning at 8:00 AM UTC. Secrets Manager rotates the secret any time that day after 8:00 AM. You can set a `Duration` to shorten the rotation window.

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_schedule.html

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1849

class RotationRulesType < Struct.new(
  :automatically_after_days,
  :duration,
  :schedule_expression)
  SENSITIVE = []
  include Aws::Structure
end