software.amazon.awscdk.services.ecs

Class Secret

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.Secret

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:47.629Z")
 @Stability(value=Experimental)
public abstract class Secret
extends software.amazon.jsii.JsiiObject

(experimental) A secret environment variable.

Example:

 Secret secret;
 Secret dbSecret;
 StringParameter parameter;
 TaskDefinition taskDefinition;
 Bucket s3Bucket;
 ContainerDefinition newContainer = taskDefinition.addContainer("container", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .memoryLimitMiB(1024)
         .environment(Map.of( // clear text, not for sensitive data
                 "STAGE", "prod"))
         .environmentFiles(List.of(EnvironmentFile.fromAsset("./demo-env-file.env"), EnvironmentFile.fromBucket(s3Bucket, "assets/demo-env-file.env")))
         .secrets(Map.of( // Retrieved from AWS Secrets Manager or AWS Systems Manager Parameter Store at container start-up.
                 "SECRET", Secret.fromSecretsManager(secret),
                 "DB_PASSWORD", Secret.fromSecretsManager(dbSecret, "password"),  // Reference a specific JSON field, (requires platform version 1.4.0 or later for Fargate tasks)
                 "API_KEY", Secret.fromSecretsManagerVersion(secret, SecretVersionInfo.builder().versionId("12345").build(), "apiKey"),  // Reference a specific version of the secret by its version id or version stage (requires platform version 1.4.0 or later for Fargate tasks)
                 "PARAMETER", Secret.fromSsmParameter(parameter)))
         .build());
 newContainer.addEnvironment("QUEUE_NAME", "MyQueue");
 

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Secret()
protected	Secret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Secret(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static Secret	fromSecretsManager(ISecret secret) (experimental) Creates a environment variable value from a secret stored in AWS Secrets Manager.
static Secret	fromSecretsManager(ISecret secret, String field) (experimental) Creates a environment variable value from a secret stored in AWS Secrets Manager.
static Secret	fromSecretsManagerVersion(ISecret secret, SecretVersionInfo versionInfo) (experimental) Creates a environment variable value from a secret stored in AWS Secrets Manager.
static Secret	fromSecretsManagerVersion(ISecret secret, SecretVersionInfo versionInfo, String field) (experimental) Creates a environment variable value from a secret stored in AWS Secrets Manager.
static Secret	fromSsmParameter(IParameter parameter) (experimental) Creates an environment variable value from a parameter stored in AWS Systems Manager Parameter Store.
abstract String	getArn() (experimental) The ARN of the secret.
abstract Boolean	getHasField() (experimental) Whether this secret uses a specific JSON field.
abstract Grant	grantRead(IGrantable grantee) (experimental) Grants reading the secret to a principal.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Secret

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

Secret

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

Secret

@Stability(value=Experimental)
protected Secret()

Method Detail

fromSecretsManager

@Stability(value=Experimental)
 @NotNull
public static Secret fromSecretsManager(@NotNull
                                                                                 ISecret secret,
                                                                                 @Nullable
                                                                                 String field)

(experimental) Creates a environment variable value from a secret stored in AWS Secrets Manager.

Parameters:

secret - the secret stored in AWS Secrets Manager. This parameter is required.

field - the name of the field with the value that you want to set as the environment variable value.

fromSecretsManager

@Stability(value=Experimental)
 @NotNull
public static Secret fromSecretsManager(@NotNull
                                                                                 ISecret secret)

(experimental) Creates a environment variable value from a secret stored in AWS Secrets Manager.

Parameters:

secret - the secret stored in AWS Secrets Manager. This parameter is required.

fromSecretsManagerVersion

@Stability(value=Experimental)
 @NotNull
public static Secret fromSecretsManagerVersion(@NotNull
                                                                                        ISecret secret,
                                                                                        @NotNull
                                                                                        SecretVersionInfo versionInfo,
                                                                                        @Nullable
                                                                                        String field)

(experimental) Creates a environment variable value from a secret stored in AWS Secrets Manager.

Parameters:

secret - the secret stored in AWS Secrets Manager. This parameter is required.

versionInfo - the version information to reference the secret. This parameter is required.

field - the name of the field with the value that you want to set as the environment variable value.

fromSecretsManagerVersion

@Stability(value=Experimental)
 @NotNull
public static Secret fromSecretsManagerVersion(@NotNull
                                                                                        ISecret secret,
                                                                                        @NotNull
                                                                                        SecretVersionInfo versionInfo)

(experimental) Creates a environment variable value from a secret stored in AWS Secrets Manager.

Parameters:

secret - the secret stored in AWS Secrets Manager. This parameter is required.

versionInfo - the version information to reference the secret. This parameter is required.

fromSsmParameter

@Stability(value=Experimental)
 @NotNull
public static Secret fromSsmParameter(@NotNull
                                                                               IParameter parameter)

(experimental) Creates an environment variable value from a parameter stored in AWS Systems Manager Parameter Store.

Parameters:

parameter - This parameter is required.

grantRead

@Stability(value=Experimental)
 @NotNull
public abstract Grant grantRead(@NotNull
                                                                         IGrantable grantee)

(experimental) Grants reading the secret to a principal.

Parameters:

grantee - This parameter is required.

getArn

@Stability(value=Experimental)
 @NotNull
public abstract String getArn()

(experimental) The ARN of the secret.

getHasField

@Stability(value=Experimental)
 @Nullable
public abstract Boolean getHasField()

(experimental) Whether this secret uses a specific JSON field.