Package software.amazon.awscdk.services.secretsmanager

Class RotationScheduleProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • secret

      @Stability(Stable) public RotationScheduleProps.Builder secret(ISecret secret)
      Sets the value of RotationScheduleProps.getSecret()
      Parameters:
      secret - The secret to rotate. This parameter is required. 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.

      Returns:
      this

    • automaticallyAfter

      @Stability(Stable) public RotationScheduleProps.Builder automaticallyAfter(Duration automaticallyAfter)
      Sets the value of RotationScheduleOptions.getAutomaticallyAfter()
      Parameters:
      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.

      Returns:
      this

    • hostedRotation

      @Stability(Stable) public RotationScheduleProps.Builder hostedRotation(HostedRotation hostedRotation)
      Sets the value of RotationScheduleOptions.getHostedRotation()
      Parameters:
      hostedRotation - Hosted rotation.
      Returns:
      this

    • rotateImmediatelyOnUpdate

      @Stability(Stable) public RotationScheduleProps.Builder rotateImmediatelyOnUpdate(Boolean rotateImmediatelyOnUpdate)
      Sets the value of RotationScheduleOptions.getRotateImmediatelyOnUpdate()
      Parameters:
      rotateImmediatelyOnUpdate - Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
      Returns:
      this

    • rotationLambda

      @Stability(Stable) public RotationScheduleProps.Builder rotationLambda(IFunction rotationLambda)
      Sets the value of RotationScheduleOptions.getRotationLambda()
      Parameters:
      rotationLambda - A Lambda function that can rotate the secret.
      Returns:
      this

    • build

      @Stability(Stable) public RotationScheduleProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<RotationScheduleProps>
      Returns:
      a new instance of RotationScheduleProps
      Throws:
      NullPointerException - if any required attribute was not provided