software.amazon.awscdk

Class SecretValue

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Intrinsic

software.amazon.awscdk.SecretValue

All Implemented Interfaces:

IResolvable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:44.847Z")
 @Stability(value=Experimental)
public class SecretValue
extends Intrinsic

(experimental) Work with secret values in the CDK.

Secret values in the CDK (such as those retrieved from SecretsManager) are represented as regular strings, just like other values that are only available at deployment time.

To help you avoid accidental mistakes which would lead to you putting your secret values directly into a CloudFormation template, constructs that take secret values will not allow you to pass in a literal secret value. They do so by calling Secret.assertSafeSecret().

You can escape the check by calling Secret.plainText(), but doing so is highly discouraged.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecretValue.Builder (experimental) A fluent builder for SecretValue.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IResolvable.Jsii$Default, IResolvable.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecretValue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SecretValue(software.amazon.jsii.JsiiObjectRef objRef)
	SecretValue(Object value)
	SecretValue(Object value, IntrinsicProps options)

Method Summary

Modifier and Type	Method and Description
static SecretValue	cfnDynamicReference(CfnDynamicReference ref) (experimental) Obtain the secret value through a CloudFormation dynamic reference.
static SecretValue	cfnParameter(CfnParameter param) (experimental) Obtain the secret value through a CloudFormation parameter.
static SecretValue	plainText(String secret) (experimental) Construct a literal secret value for use with secret-aware constructs.
static SecretValue	secretsManager(String secretId) (experimental) Creates a `SecretValue` with a value which is dynamically loaded from AWS Secrets Manager.
static SecretValue	secretsManager(String secretId, SecretsManagerSecretOptions options) (experimental) Creates a `SecretValue` with a value which is dynamically loaded from AWS Secrets Manager.
static SecretValue	ssmSecure(String parameterName, String version) (experimental) Use a secret value stored from a Systems Manager (SSM) parameter.

Methods inherited from class software.amazon.awscdk.Intrinsic

getCreationStack, newError, resolve, toJSON, 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.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

SecretValue

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

SecretValue

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

SecretValue

@Stability(value=Experimental)
public SecretValue(@NotNull
                                                  Object value,
                                                  @Nullable
                                                  IntrinsicProps options)

Parameters:

value - This parameter is required.

options -

SecretValue

@Stability(value=Experimental)
public SecretValue(@NotNull
                                                  Object value)

Parameters:

value - This parameter is required.

Method Detail

cfnDynamicReference

@Stability(value=Experimental)
 @NotNull
public static SecretValue cfnDynamicReference(@NotNull
                                                                                       CfnDynamicReference ref)

(experimental) Obtain the secret value through a CloudFormation dynamic reference.

If possible, use SecretValue.ssmSecure or SecretValue.secretsManager directly.

Parameters:

ref - The dynamic reference to use. This parameter is required.

cfnParameter

@Stability(value=Experimental)
 @NotNull
public static SecretValue cfnParameter(@NotNull
                                                                                CfnParameter param)

(experimental) Obtain the secret value through a CloudFormation parameter.

Generally, this is not a recommended approach. AWS Secrets Manager is the recommended way to reference secrets.

Parameters:

param - The CloudFormation parameter to use. This parameter is required.

plainText

@Stability(value=Experimental)
 @NotNull
public static SecretValue plainText(@NotNull
                                                                             String secret)

(experimental) Construct a literal secret value for use with secret-aware constructs.

Do not use this method for any secrets that you care about.

The only reasonable use case for using this method is when you are testing.

Parameters:

secret - This parameter is required.

secretsManager

@Stability(value=Experimental)
 @NotNull
public static SecretValue secretsManager(@NotNull
                                                                                  String secretId,
                                                                                  @Nullable
                                                                                  SecretsManagerSecretOptions options)

(experimental) Creates a `SecretValue` with a value which is dynamically loaded from AWS Secrets Manager.

Parameters:

secretId - The ID or ARN of the secret. This parameter is required.

options - Options.

secretsManager

@Stability(value=Experimental)
 @NotNull
public static SecretValue secretsManager(@NotNull
                                                                                  String secretId)

(experimental) Creates a `SecretValue` with a value which is dynamically loaded from AWS Secrets Manager.

Parameters:

secretId - The ID or ARN of the secret. This parameter is required.

ssmSecure

@Stability(value=Experimental)
 @NotNull
public static SecretValue ssmSecure(@NotNull
                                                                             String parameterName,
                                                                             @NotNull
                                                                             String version)

(experimental) Use a secret value stored from a Systems Manager (SSM) parameter.

Parameters:

parameterName - The name of the parameter in the Systems Manager Parameter Store. This parameter is required.

version - An integer that specifies the version of the parameter to use. This parameter is required.