Package software.amazon.awscdk.services.secretsmanager

Class RotationSchedule.Builder

java.lang.Object
software.amazon.awscdk.services.secretsmanager.RotationSchedule.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<RotationSchedule>
Enclosing class:
RotationSchedule
@Stability(Stable) public static final class RotationSchedule.Builder extends Object implements software.amazon.jsii.Builder<RotationSchedule>
A fluent builder for RotationSchedule.

  • Method Details

    • create

      @Stability(Stable) public static RotationSchedule.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of RotationSchedule.Builder.

    • automaticallyAfter

      @Stability(Stable) public RotationSchedule.Builder automaticallyAfter(Duration automaticallyAfter)
      Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

      The minimum value is 4 hours. The maximum value is 1000 days.

      A value of zero (Duration.days(0)) will not create RotationRules.

      Default: Duration.days(30)

      Parameters:
      automaticallyAfter - Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation. This parameter is required.
      Returns:
      this

    • hostedRotation

      @Stability(Stable) public RotationSchedule.Builder hostedRotation(HostedRotation hostedRotation)
      Hosted rotation.

      Default: - either `rotationLambda` or `hostedRotation` must be specified

      Parameters:
      hostedRotation - Hosted rotation. This parameter is required.
      Returns:
      this

    • rotateImmediatelyOnUpdate

      @Stability(Stable) public RotationSchedule.Builder rotateImmediatelyOnUpdate(Boolean rotateImmediatelyOnUpdate)
      Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.

      Default: true

      Parameters:
      rotateImmediatelyOnUpdate - Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. This parameter is required.
      Returns:
      this

    • rotationLambda

      @Stability(Stable) public RotationSchedule.Builder rotationLambda(IFunction rotationLambda)
      A Lambda function that can rotate the secret.

      Default: - either `rotationLambda` or `hostedRotation` must be specified

      Parameters:
      rotationLambda - A Lambda function that can rotate the secret. This parameter is required.
      Returns:
      this

    • secret

      @Stability(Stable) public RotationSchedule.Builder secret(ISecret secret)
      The secret to rotate.

      If hosted rotation is used, this must be a JSON string with the following format: 

       {
   "engine": <required: database engine>,
   "host": <required: instance host name>,
   "username": <required: username>,
   "password": <required: password>,
   "dbname": <optional: database name>,
   "port": <optional: if not specified, default port will be used>,
   "masterarn": <required for multi user rotation: the arn of the master secret which will be used to create users/change passwords>
 }

      This is typically the case for a secret referenced from an AWS::SecretsManager::SecretTargetAttachment or an ISecret returned by the attach() method of Secret.

      Parameters:
      secret - The secret to rotate. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public RotationSchedule build()
      Specified by:
      build in interface software.amazon.jsii.Builder<RotationSchedule>
      Returns:
      a newly built instance of RotationSchedule.