software.amazon.awscdk.services.secretsmanager

Class CfnRotationSchedule.RotationRulesProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRotationSchedule.RotationRulesProperty>

Enclosing interface:

CfnRotationSchedule.RotationRulesProperty

@Stability(value=Stable)
public static final class CfnRotationSchedule.RotationRulesProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRotationSchedule.RotationRulesProperty>

A builder for CfnRotationSchedule.RotationRulesProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnRotationSchedule.RotationRulesProperty.Builder	automaticallyAfterDays(Number automaticallyAfterDays) Sets the value of CfnRotationSchedule.RotationRulesProperty.getAutomaticallyAfterDays()
CfnRotationSchedule.RotationRulesProperty	build() Builds the configured instance.
CfnRotationSchedule.RotationRulesProperty.Builder	duration(String duration) Sets the value of CfnRotationSchedule.RotationRulesProperty.getDuration()
CfnRotationSchedule.RotationRulesProperty.Builder	scheduleExpression(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

@Stability(value=Stable)
public CfnRotationSchedule.RotationRulesProperty.Builder automaticallyAfterDays(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

@Stability(value=Stable)
public CfnRotationSchedule.RotationRulesProperty.Builder duration(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 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 .

Returns:

this

scheduleExpression

@Stability(value=Stable)
public CfnRotationSchedule.RotationRulesProperty.Builder scheduleExpression(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 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.

Returns:

this

build

@Stability(value=Stable)
public CfnRotationSchedule.RotationRulesProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRotationSchedule.RotationRulesProperty>

Returns:

a new instance of CfnRotationSchedule.RotationRulesProperty

Throws:

NullPointerException - if any required attribute was not provided