software.amazon.awscdk.services.rds

Interface RotationMultiUserOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RotationMultiUserOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:13.546Z")
 @Stability(value=Experimental)
public interface RotationMultiUserOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) 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()
default Duration	getAutomaticallyAfter() (experimental) Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
default IInterfaceVpcEndpoint	getEndpoint() (experimental) The VPC interface endpoint to use for the Secrets Manager API.
default String	getExcludeCharacters() (experimental) Specifies characters to not include in generated passwords.
ISecret	getSecret() (experimental) The secret to rotate.
default SubnetSelection	getVpcSubnets() (experimental) Where to place the rotation Lambda function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSecret

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

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

getAutomaticallyAfter

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

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

Default: - 30 days

getEndpoint

@Stability(value=Experimental)
 @Nullable
default IInterfaceVpcEndpoint getEndpoint()

(experimental) The VPC interface endpoint to use for the Secrets Manager API.

If you enable private DNS hostnames for your VPC private endpoint (the default), you don't need to specify an endpoint. The standard Secrets Manager DNS hostname the Secrets Manager CLI and SDKs use by default (https://secretsmanager..amazonaws.com) automatically resolves to your VPC endpoint.

Default: https://secretsmanager..amazonaws.com

getExcludeCharacters

@Stability(value=Experimental)
 @Nullable
default String getExcludeCharacters()

(experimental) Specifies characters to not include in generated passwords.

Default: " %+~`#$&*()|[]{}:;<>?!'/

getVpcSubnets

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()

(experimental) Where to place the rotation Lambda function.

Default: - same placement as instance or cluster

builder

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

Returns:

a RotationMultiUserOptions.Builder of RotationMultiUserOptions