software.amazon.awscdk.services.rds

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.rds.DatabaseSecret

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.470Z")
 @Stability(value=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 and Description
static 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.services.secretsmanager.ISecret

ISecret.Jsii$Default, ISecret.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

addReplicaRegion, addReplicaRegion, addRotationSchedule, addToResourcePolicy, attach, 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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DatabaseSecret

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

DatabaseSecret

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

DatabaseSecret

@Stability(value=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.