Skip to content
v2.277.0

SecretProperty Struct ​

An object that represents the secret to expose to your container.

Secrets can be exposed to a container in the following ways:

  • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
  • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data in the AWS Batch User Guide .

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const secretProperty: batch.CfnJobDefinition.SecretProperty = {
  name: 'name',
  valueFrom: 'valueFrom',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_batch as batch

secret_property = batch.CfnJobDefinition.SecretProperty(
    name="name",
    value_from="valueFrom"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.batch.*;

SecretProperty secretProperty = SecretProperty.builder()
        .name("name")
        .valueFrom("valueFrom")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Batch;

var secretProperty = new SecretProperty {
    Name = "name",
    ValueFrom = "valueFrom"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

secretProperty := &SecretProperty{
	Name: jsii.String("name"),
	ValueFrom: jsii.String("valueFrom"),
}

Properties ​

namestringnamestrnameStringNamestringName*stringrequired#
The name of the secret.
valueFromstringvalue_fromstrvalueFromStringValueFromstringValueFrom*stringrequired#
The secret to expose to the container.
notes

The supported values are either the full Amazon Resource Name (ARN) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.

If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.