software.amazon.awscdk.services.docdb

Interface DatabaseSecretProps

All Known Implementing Classes:

DatabaseSecretProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:01.244Z")
public interface DatabaseSecretProps

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 and Description
static class	DatabaseSecretProps.Builder A builder for DatabaseSecretProps
static class	DatabaseSecretProps.Jsii$Proxy An implementation for DatabaseSecretProps

Method Summary

Modifier and Type	Method and Description
static DatabaseSecretProps.Builder	builder()
default IKey	getEncryptionKey() The KMS key to use to encrypt the secret.
default java.lang.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 java.lang.String	getSecretName() The physical name of the secret.
java.lang.String	getUsername() The username.

Method Detail

getUsername

java.lang.String getUsername()

The username.

getEncryptionKey

default IKey getEncryptionKey()

The KMS key to use to encrypt the secret.

Default: default master key

getExcludeCharacters

default java.lang.String getExcludeCharacters()

Characters to not include in the generated password.

Default: "\"

getMasterSecret

default ISecret getMasterSecret()

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

Default: - no master secret information will be included

getSecretName

default java.lang.String getSecretName()

The physical name of the secret.

Default: Secretsmanager will generate a physical name for the secret

builder

static DatabaseSecretProps.Builder builder()

Returns:

a DatabaseSecretProps.Builder of DatabaseSecretProps