aws-cdk-lib.aws_batch.CfnJobDefinition.SecretProperty

interface SecretProperty

LanguageType name
.NETAmazon.CDK.AWS.Batch.CfnJobDefinition.SecretProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnJobDefinition_SecretProperty
Javasoftware.amazon.awscdk.services.batch.CfnJobDefinition.SecretProperty
Pythonaws_cdk.aws_batch.CfnJobDefinition.SecretProperty
TypeScript aws-cdk-lib » aws_batch » CfnJobDefinition » SecretProperty

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

// 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',
};

Properties

NameTypeDescription
namestringThe name of the secret.
valueFromstringThe secret to expose to the container.

name

Type: string

The name of the secret.


valueFrom

Type: string

The secret to expose to the container.

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.