Package software.amazon.awscdk.services.docdb

Interface DatabaseSecretProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseSecretProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:59.955Z")
@Stability(Stable)
public interface DatabaseSecretProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for a DatabaseSecret.

Example:

 DatabaseCluster cluster;
 DatabaseSecret myUserSecret = DatabaseSecret.Builder.create(this, "MyUserSecret")
         .username("myuser")
         .masterSecret(cluster.getSecret())
         .build();
 ISecret myUserSecretAttached = myUserSecret.attach(cluster); // Adds DB connections information in the secret
 cluster.addRotationMultiUser("MyUser", RotationMultiUserOptions.builder() // Add rotation using the multi user scheme
         .secret(myUserSecretAttached).build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DatabaseSecretProps.Builder	builder()
default IKey	getEncryptionKey()	The KMS key to use to encrypt the secret.
default String	getExcludeCharacters()	Characters to not include in the generated password.
default ISecret	getMasterSecret()	The master secret which will be used to rotate this secret.
default String	getSecretName()	The physical name of the secret.
String	getUsername()	The username.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUsername

@Stability(Stable)
@NotNull
String getUsername()

The username.

getEncryptionKey

@Stability(Stable)
@Nullable
default IKey getEncryptionKey()

The KMS key to use to encrypt the secret.

Default: default master key

getExcludeCharacters

@Stability(Stable)
@Nullable
default String getExcludeCharacters()

Characters to not include in the generated password.

Default: "\"@/"

getMasterSecret

@Stability(Stable)
@Nullable
default ISecret getMasterSecret()

The master secret which will be used to rotate this secret.

Default: - no master secret information will be included

getSecretName

@Stability(Stable)
@Nullable
default String getSecretName()

The physical name of the secret.

Default: Secretsmanager will generate a physical name for the secret

builder

@Stability(Stable)
static DatabaseSecretProps.Builder builder()

Returns:

a DatabaseSecretProps.Builder of DatabaseSecretProps