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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.743Z")
 @Stability(value=Stable)
public abstract class Secret
extends software.amazon.jsii.JsiiObject

A secret environment variable.

Example:

 Secret secret;
 StringParameter parameter;
 Ec2TaskDefinition taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
 taskDefinition.addContainer("TheContainer", ContainerDefinitionOptions.builder()
         .image(ContainerImage.fromRegistry("example-image"))
         .memoryLimitMiB(256)
         .logging(LogDrivers.firelens(FireLensLogDriverProps.builder()
                 .options(Map.of())
                 .secretOptions(Map.of( // Retrieved from AWS Secrets Manager or AWS Systems Manager Parameter Store
                         "apikey", Secret.fromSecretsManager(secret),
                         "host", Secret.fromSsmParameter(parameter)))
                 .build()))
         .build());
 

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) Creates a environment variable value from a secret stored in AWS Secrets Manager.
static Secret	fromSecretsManager(ISecret secret, String field) Creates a environment variable value from a secret stored in AWS Secrets Manager.
static Secret	fromSecretsManagerVersion(ISecret secret, SecretVersionInfo versionInfo) Creates a environment variable value from a secret stored in AWS Secrets Manager.
static Secret	fromSecretsManagerVersion(ISecret secret, SecretVersionInfo versionInfo, String field) Creates a environment variable value from a secret stored in AWS Secrets Manager.
static Secret	fromSsmParameter(IParameter parameter) Creates an environment variable value from a parameter stored in AWS Systems Manager Parameter Store.
abstract String	getArn() The ARN of the secret.
abstract Boolean	getHasField() Whether this secret uses a specific JSON field.
abstract Grant	grantRead(IGrantable grantee) 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=Stable)
protected Secret()

Method Detail

fromSecretsManager

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

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=Stable)
 @NotNull
public static Secret fromSecretsManager(@NotNull
                                                                           ISecret secret)

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=Stable)
 @NotNull
public static Secret fromSecretsManagerVersion(@NotNull
                                                                                  ISecret secret,
                                                                                  @NotNull
                                                                                  SecretVersionInfo versionInfo,
                                                                                  @Nullable
                                                                                  String field)

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=Stable)
 @NotNull
public static Secret fromSecretsManagerVersion(@NotNull
                                                                                  ISecret secret,
                                                                                  @NotNull
                                                                                  SecretVersionInfo versionInfo)

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=Stable)
 @NotNull
public static Secret fromSsmParameter(@NotNull
                                                                         IParameter parameter)

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

Parameters:

parameter - This parameter is required.

grantRead

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

Grants reading the secret to a principal.

Parameters:

grantee - This parameter is required.

getArn

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

The ARN of the secret.

getHasField

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

Whether this secret uses a specific JSON field.