#[non_exhaustive]pub struct RotationRulesType {
pub automatically_after_days: Option<i64>,
pub duration: Option<String>,
pub schedule_expression: Option<String>,
}
Expand description
A structure that defines the rotation configuration for the secret.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.automatically_after_days: Option<i64>
The number of days between 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. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation date based on the previous rotation. Manually updating the secret value by calling PutSecretValue
or UpdateSecret
is considered a valid rotation.
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: Option<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 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.
schedule_expression: Option<String>
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.
Implementations§
Source§impl RotationRulesType
impl RotationRulesType
Sourcepub fn automatically_after_days(&self) -> Option<i64>
pub fn automatically_after_days(&self) -> Option<i64>
The number of days between 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. If you use this field to set the rotation schedule, Secrets Manager calculates the next rotation date based on the previous rotation. Manually updating the secret value by calling PutSecretValue
or UpdateSecret
is considered a valid rotation.
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
.
Sourcepub fn duration(&self) -> Option<&str>
pub fn duration(&self) -> Option<&str>
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.
Sourcepub fn schedule_expression(&self) -> Option<&str>
pub fn schedule_expression(&self) -> Option<&str>
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.
Source§impl RotationRulesType
impl RotationRulesType
Sourcepub fn builder() -> RotationRulesTypeBuilder
pub fn builder() -> RotationRulesTypeBuilder
Creates a new builder-style object to manufacture RotationRulesType
.
Trait Implementations§
Source§impl Clone for RotationRulesType
impl Clone for RotationRulesType
Source§fn clone(&self) -> RotationRulesType
fn clone(&self) -> RotationRulesType
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for RotationRulesType
impl Debug for RotationRulesType
Source§impl PartialEq for RotationRulesType
impl PartialEq for RotationRulesType
impl StructuralPartialEq for RotationRulesType
Auto Trait Implementations§
impl Freeze for RotationRulesType
impl RefUnwindSafe for RotationRulesType
impl Send for RotationRulesType
impl Sync for RotationRulesType
impl Unpin for RotationRulesType
impl UnwindSafe for RotationRulesType
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)