software.amazon.awscdk.services.ecs

Interface SecretVersionInfo

All Known Implementing Classes:

SecretVersionInfo.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:29.016Z")
public interface SecretVersionInfo

Specify the secret's version id or version stage.

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

Modifier and Type	Interface and Description
static class	SecretVersionInfo.Builder A builder for SecretVersionInfo
static class	SecretVersionInfo.Jsii$Proxy An implementation for SecretVersionInfo

Method Summary

Modifier and Type	Method and Description
static SecretVersionInfo.Builder	builder()
default java.lang.String	getVersionId() version id of the secret.
default java.lang.String	getVersionStage() version stage of the secret.

Method Detail

getVersionId

default java.lang.String getVersionId()

version id of the secret.

Default: - use default version id

getVersionStage

default java.lang.String getVersionStage()

version stage of the secret.

Default: - use default version stage

builder

static SecretVersionInfo.Builder builder()

Returns:

a SecretVersionInfo.Builder of SecretVersionInfo