Interface RotationScheduleProps

All Superinterfaces:, RotationScheduleOptions
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.300Z") @Stability(Stable) public interface RotationScheduleProps extends, RotationScheduleOptions
Construction properties for a RotationSchedule.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Function function_;
 HostedRotation hostedRotation;
 Secret secret;
 RotationScheduleProps rotationScheduleProps = RotationScheduleProps.builder()
         // the properties below are optional
  • Method Details

    • getSecret

      @Stability(Stable) @NotNull ISecret getSecret()
      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.

    • builder

      @Stability(Stable) static RotationScheduleProps.Builder builder()
      a RotationScheduleProps.Builder of RotationScheduleProps