software.amazon.awscdk.services.docdb

Interface RotationMultiUserOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RotationMultiUserOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:28.680Z")
 @Stability(value=Stable)
public interface RotationMultiUserOptions
extends software.amazon.jsii.JsiiSerializable

Options to add the multi user rotation.

Example:

 import software.amazon.awscdk.services.secretsmanager.*;
 Secret myImportedSecret;
 DatabaseCluster cluster;
 cluster.addRotationMultiUser("MyUser", RotationMultiUserOptions.builder()
         .secret(myImportedSecret)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RotationMultiUserOptions.Builder	builder()
default Duration	getAutomaticallyAfter() Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
ISecret	getSecret() The secret to rotate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSecret

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

The secret to rotate.

It must be a JSON string with the following format:

 {
    "engine": <required: must be set to 'mongo'>,
    "host": <required: instance host name>,
    "username": <required: username>,
    "password": <required: password>,
    "dbname": <optional: database name>,
    "port": <optional: if not specified, default port 27017 will be used>,
    "masterarn": <required: the arn of the master secret which will be used to create users/change passwords>
    "ssl": <optional: if not specified, defaults to false. This must be true if being used for DocumentDB rotations
           where the cluster has TLS enabled>
 }
 

getAutomaticallyAfter

@Stability(value=Stable)
 @Nullable
default Duration getAutomaticallyAfter()

Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

Default: Duration.days(30)

builder

@Stability(value=Stable)
static RotationMultiUserOptions.Builder builder()

Returns:

a RotationMultiUserOptions.Builder of RotationMultiUserOptions