Skip to content
v2.277.0

Secret Class ​

A secret environment variable.

Example ​

ts
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),
    }
  }),
});
python
# my_secret: secretsmanager.ISecret


job_defn = batch.EcsJobDefinition(self, "JobDefn",
    container=batch.EcsEc2ContainerDefinition(self, "containerDefn",
        image=ecs.ContainerImage.from_registry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
        memory=cdk.Size.mebibytes(2048),
        cpu=256,
        secrets={
            "MY_SECRET_ENV_VAR": batch.Secret.from_secrets_manager(my_secret)
        }
    )
)
java
ISecret mySecret;


EcsJobDefinition jobDefn = EcsJobDefinition.Builder.create(this, "JobDefn")
        .container(EcsEc2ContainerDefinition.Builder.create(this, "containerDefn")
                .image(ContainerImage.fromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"))
                .memory(Size.mebibytes(2048))
                .cpu(256)
                .secrets(Map.of(
                        "MY_SECRET_ENV_VAR", Secret.fromSecretsManager(mySecret)))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
ISecret mySecret;


var jobDefn = new EcsJobDefinition(this, "JobDefn", new EcsJobDefinitionProps {
    Container = new EcsEc2ContainerDefinition(this, "containerDefn", new EcsEc2ContainerDefinitionProps {
        Image = ContainerImage.FromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
        Memory = Size.Mebibytes(2048),
        Cpu = 256,
        Secrets = new Dictionary<string, Secret> {
            { "MY_SECRET_ENV_VAR", Secret.FromSecretsManager(mySecret) }
        }
    })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var mySecret ISecret


jobDefn := batch.NewEcsJobDefinition(this, jsii.String("JobDefn"), &EcsJobDefinitionProps{
	Container: batch.NewEcsEc2ContainerDefinition(this, jsii.String("containerDefn"), &EcsEc2ContainerDefinitionProps{
		Image: ecs.ContainerImage_FromRegistry(jsii.String("public.ecr.aws/amazonlinux/amazonlinux:latest")),
		Memory: cdk.Size_Mebibytes(jsii.Number(2048)),
		Cpu: jsii.Number(256),
		Secrets: map[string]Secret{
			"MY_SECRET_ENV_VAR": batch.Secret_fromSecretsManager(mySecret),
		},
	}),
})

Initializer ​

ts
new Secret()
python
Secret()
java
new Secret()
csharp
new Secret()
go
NewSecret()

Properties ​

arnstringarnstrarnStringArnstringArn*string #
The ARN of the secret.
hasFieldmay be undefinedbooleanhas_fieldmay be undefinedboolhasFieldmay be undefinedBooleanHasFieldmay be undefinedboolHasFieldmay be undefined*bool #
Whether this secret uses a specific JSON field.

Methods ​

fromSecretsManager(secret: ISecret, field?: string): Secret // chainable@staticmethod def from_secrets_manager(secret: ISecret, field: typing.Optional[str] = None) -> Secretpublic static Secret fromSecretsManager(ISecret secret, String field)public static Secret FromSecretsManager(ISecret secret, string? field = null)func FromSecretsManager(Secret ISecret, Field *string) Secret static #
Creates a environment variable value from a secret stored in AWS Secrets Manager.
2 parameters

Parameters

  • secretsecretsecretsecretSecret — the secret stored in AWS Secrets Manager.
  • fieldfieldfieldfieldField — the name of the field with the value that you want to set as the environment variable value.
fromSecretsManagerVersion(secret: ISecret, versionInfo: SecretVersionInfo, field?: string): Secret // chainable@staticmethod def from_secrets_manager_version(secret: ISecret, version_info: SecretVersionInfo, field: typing.Optional[str] = None) -> Secretpublic static Secret fromSecretsManagerVersion(ISecret secret, SecretVersionInfo versionInfo, String field)public static Secret FromSecretsManagerVersion(ISecret secret, SecretVersionInfo versionInfo, string? field = null)func FromSecretsManagerVersion(Secret ISecret, VersionInfo SecretVersionInfo, Field *string) Secret static #
Creates a environment variable value from a secret stored in AWS Secrets Manager.
3 parameters

Parameters

  • secretsecretsecretsecretSecret — the secret stored in AWS Secrets Manager.
  • versionInfoversion_infoversionInfoversionInfoVersionInfo — the version information to reference the secret.
  • fieldfieldfieldfieldField — the name of the field with the value that you want to set as the environment variable value.
fromSsmParameter(parameter: IParameter): Secret // chainable@staticmethod def from_ssm_parameter(parameter: IParameter) -> Secretpublic static Secret fromSsmParameter(IParameter parameter)public static Secret FromSsmParameter(IParameter parameter)func FromSsmParameter(Parameter IParameter) Secret static #
Creates an environment variable value from a parameter stored in AWS Systems Manager Parameter Store.
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant #
Grants reading the secret to a principal [disable-awslint:no-grants].