software.amazon.awscdk.services.secretsmanager

Class CfnRotationSchedule.RotationRulesProperty.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.CfnRotationSchedule.RotationRulesProperty.Builder

Enclosing interface:

CfnRotationSchedule.RotationRulesProperty

public static final class CfnRotationSchedule.RotationRulesProperty.Builder
extends java.lang.Object

A builder for CfnRotationSchedule.RotationRulesProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnRotationSchedule.RotationRulesProperty.Builder	automaticallyAfterDays(java.lang.Number automaticallyAfterDays) Sets the value of CfnRotationSchedule.RotationRulesProperty.getAutomaticallyAfterDays()
CfnRotationSchedule.RotationRulesProperty	build() Builds the configured instance.
CfnRotationSchedule.RotationRulesProperty.Builder	duration(java.lang.String duration) Sets the value of CfnRotationSchedule.RotationRulesProperty.getDuration()
CfnRotationSchedule.RotationRulesProperty.Builder	scheduleExpression(java.lang.String scheduleExpression) Sets the value of CfnRotationSchedule.RotationRulesProperty.getScheduleExpression()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

automaticallyAfterDays

public CfnRotationSchedule.RotationRulesProperty.Builder automaticallyAfterDays(java.lang.Number automaticallyAfterDays)

Sets the value of CfnRotationSchedule.RotationRulesProperty.getAutomaticallyAfterDays()

Parameters:

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.

Returns:

this

duration

public CfnRotationSchedule.RotationRulesProperty.Builder duration(java.lang.String duration)

Sets the value of CfnRotationSchedule.RotationRulesProperty.getDuration()

Parameters:

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 .

Returns:

this

scheduleExpression

public CfnRotationSchedule.RotationRulesProperty.Builder scheduleExpression(java.lang.String scheduleExpression)

Sets the value of CfnRotationSchedule.RotationRulesProperty.getScheduleExpression()

Parameters:

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.

Returns:

this

build

public CfnRotationSchedule.RotationRulesProperty build()

Builds the configured instance.

Returns:

a new instance of CfnRotationSchedule.RotationRulesProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided