Package 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.120.0 (build 192dc88)",
           date="2025-12-05T22:26:43.940Z")
@Stability(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	Description
static final class	RotationMultiUserOptions.Builder	A builder for RotationMultiUserOptions
static final class	RotationMultiUserOptions.Jsii$Proxy	An implementation for RotationMultiUserOptions

Method Summary

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

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

getAutomaticallyAfter, getEndpoint, getExcludeCharacters, getRotateImmediatelyOnUpdate, getSecurityGroup, getVpcSubnets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSecret

@Stability(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(Stable)
static RotationMultiUserOptions.Builder builder()

Returns:

a RotationMultiUserOptions.Builder of RotationMultiUserOptions