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.29.0 (build 41df200)",
           date="2021-06-02T09:55:48.017Z")
 @Stability(value=Experimental)
public interface RotationScheduleProps
extends software.amazon.jsii.JsiiSerializable, RotationScheduleOptions

(experimental) Construction properties for a RotationSchedule.

Nested Class Summary

Nested Classes

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

Method Summary

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

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

getAutomaticallyAfter, getHostedRotation, getRotationLambda

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSecret

@Stability(value=Experimental)
 @NotNull
ISecret getSecret()

(experimental) 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(value=Experimental)
static RotationScheduleProps.Builder builder()

Specified by:

builder in interface RotationScheduleOptions

Returns:

a RotationScheduleProps.Builder of RotationScheduleProps