class Secret

Language	Type name
.NET	Amazon.CDK.AWS.Batch.Secret
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#Secret
Java	software.amazon.awscdk.services.batch.Secret
Python	aws_cdk.aws_batch.Secret
TypeScript (source)	aws-cdk-lib » aws_batch » Secret

A secret environment variable.

Example

declare const mySecret: secretsmanager.ISecret;

const jobDefn = new batch.EcsJobDefinition(this, 'JobDefn', {
  container: new batch.EcsEc2ContainerDefinition(this, 'containerDefn', {
    image: ecs.ContainerImage.fromRegistry('public.ecr.aws/amazonlinux/amazonlinux:latest'),
    memory: cdk.Size.mebibytes(2048),
    cpu: 256,
    secrets: {
      MY_SECRET_ENV_VAR: batch.Secret.fromSecretsManager(mySecret),
    }
  }),
});

Initializer

new Secret()

Properties

Name	Type	Description
arn	string	The ARN of the secret.
hasField?	boolean	Whether this secret uses a specific JSON field.

---

arn

Type: string

The ARN of the secret.

---

hasField?

Type: boolean (optional)

Whether this secret uses a specific JSON field.

Methods

Name	Description
grantRead(grantee)	Grants reading the secret to a principal.
static fromSecretsManager(secret, field?)	Creates a environment variable value from a secret stored in AWS Secrets Manager.
static fromSecretsManagerVersion(secret, versionInfo, field?)	Creates a environment variable value from a secret stored in AWS Secrets Manager.
static fromSsmParameter(parameter)	Creates an environment variable value from a parameter stored in AWS Systems Manager Parameter Store.

---

grantRead(grantee)

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants reading the secret to a principal.

---

static fromSecretsManager(secret, field?)

public static fromSecretsManager(secret: ISecret, field?: string): Secret

Parameters

• secret ISecret — the secret stored in AWS Secrets Manager.
• field string — the name of the field with the value that you want to set as the environment variable value.

Returns

• Secret

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

---

static fromSecretsManagerVersion(secret, versionInfo, field?)

public static fromSecretsManagerVersion(secret: ISecret, versionInfo: SecretVersionInfo, field?: string): Secret

Parameters

• secret ISecret — the secret stored in AWS Secrets Manager.
• versionInfo SecretVersionInfo — the version information to reference the secret.
• field string — the name of the field with the value that you want to set as the environment variable value.

Returns

• Secret

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

---

static fromSsmParameter(parameter)

public static fromSsmParameter(parameter: IParameter): Secret

Parameters

• parameter IParameter

Returns

• Secret

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