software.amazon.awscdk.services.rds

Interface RotationMultiUserOptions

All Superinterfaces:

CommonRotationUserOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RotationMultiUserOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.503Z")
 @Stability(value=Stable)
public interface RotationMultiUserOptions
extends software.amazon.jsii.JsiiSerializable, CommonRotationUserOptions

Options to add the multi user rotation.

Example:

 DatabaseInstance instance;
 DatabaseSecret myImportedSecret;
 instance.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()
ISecret	getSecret() The secret to rotate.

Methods inherited from interface software.amazon.awscdk.services.rds.CommonRotationUserOptions

getAutomaticallyAfter, getEndpoint, getExcludeCharacters, getVpcSubnets

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: 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: the arn of the master secret which will be used to create users/change passwords>
 }
 

builder

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

Specified by:

builder in interface CommonRotationUserOptions

Returns:

a RotationMultiUserOptions.Builder of RotationMultiUserOptions