Package software.amazon.awscdk.services.rds

Class DatabaseSecret

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.secretsmanager.Secret

software.amazon.awscdk.services.rds.DatabaseSecret

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.172Z")
@Stability(Stable)
public class DatabaseSecret
extends Secret

A database secret.

Example:

 DatabaseInstance instance;
 DatabaseSecret myUserSecret = DatabaseSecret.Builder.create(this, "MyUserSecret")
         .username("myuser")
         .secretName("my-user-secret") // optional, defaults to a CloudFormation-generated name
         .masterSecret(instance.getSecret())
         .excludeCharacters("{}[]()'\"/\\")
         .build();
 ISecret myUserSecretAttached = myUserSecret.attach(instance); // Adds DB connections information in the secret
 instance.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.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

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

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

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

ISecret.Jsii$Default, ISecret.Jsii$Proxy

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, addTargetAttachment, addToResourcePolicy, attach, denyAccountRootDelete, fromSecretArn, fromSecretAttributes, fromSecretCompleteArn, fromSecretName, fromSecretNameV2, fromSecretPartialArn, getArnForPolicies, getAutoCreatePolicy, getEncryptionKey, getSecretArn, getSecretFullArn, getSecretName, getSecretValue, grantRead, grantRead, grantWrite, secretValueFromJson, validate

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class software.constructs.Construct

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.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.