Package software.amazon.awscdk.services.secretsmanager

Interface RotationScheduleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, RotationScheduleOptions

All Known Implementing Classes:

RotationScheduleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:24.673Z")
@Stability(Stable)
public interface RotationScheduleProps
extends software.amazon.jsii.JsiiSerializable, RotationScheduleOptions

Construction properties for a RotationSchedule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.secretsmanager.*;
 Function function_;
 HostedRotation hostedRotation;
 Secret secret;
 RotationScheduleProps rotationScheduleProps = RotationScheduleProps.builder()
         .secret(secret)
         // the properties below are optional
         .automaticallyAfter(Duration.minutes(30))
         .hostedRotation(hostedRotation)
         .rotateImmediatelyOnUpdate(false)
         .rotationLambda(function_)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RotationScheduleProps.Builder	A builder for RotationScheduleProps
static final class	RotationScheduleProps.Jsii$Proxy	An implementation for RotationScheduleProps

Method Summary

Modifier and Type	Method	Description
static RotationScheduleProps.Builder	builder()
ISecret	getSecret()	The secret to rotate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.secretsmanager.RotationScheduleOptions

getAutomaticallyAfter, getHostedRotation, getRotateImmediatelyOnUpdate, getRotationLambda

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()

Returns:

a RotationScheduleProps.Builder of RotationScheduleProps