Package software.amazon.awscdk.services.docdb

Class DatabaseSecret

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.secretsmanager.Secret

software.amazon.awscdk.services.docdb.DatabaseSecret

All Implemented Interfaces:

IEnvironmentAware, IResource, ISecret, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:08.430Z")
@Stability(Stable)
public class DatabaseSecret
extends Secret

A database secret.

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	Class	Description
static final class	DatabaseSecret.Builder	A fluent builder for DatabaseSecret.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.secretsmanager.ISecret

ISecret.Jsii$Default, ISecret.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DatabaseSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseSecret(software.amazon.jsii.JsiiObjectRef objRef)
	DatabaseSecret(software.constructs.Construct scope, String id, DatabaseSecretProps props)

Method Summary

Methods inherited from class software.amazon.awscdk.services.secretsmanager.Secret

addReplicaRegion, addReplicaRegion, addRotationSchedule, addToResourcePolicy, attach, cfnDynamicReferenceKey, cfnDynamicReferenceKey, denyAccountRootDelete, fromSecretAttributes, fromSecretCompleteArn, fromSecretNameV2, fromSecretPartialArn, getArnForPolicies, getAutoCreatePolicy, getEncryptionKey, getExcludeCharacters, getSecretArn, getSecretFullArn, getSecretName, getSecretValue, grantRead, grantRead, grantWrite, isSecret, secretValueFromJson

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

DatabaseSecret

protected DatabaseSecret(software.amazon.jsii.JsiiObjectRef objRef)

DatabaseSecret

protected DatabaseSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DatabaseSecret

@Stability(Stable)
public DatabaseSecret(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 DatabaseSecretProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.