

This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Batch::JobDefinition Secret
<a name="aws-properties-batch-jobdefinition-secret"></a>

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](https://docs.amazonaws.cn/batch/latest/userguide/specifying-sensitive-data.html) in the *Amazon Batch User Guide*.

## Syntax
<a name="aws-properties-batch-jobdefinition-secret-syntax"></a>

To declare this entity in your Amazon CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-batch-jobdefinition-secret-syntax.json"></a>

```
{
  "[Name](#cfn-batch-jobdefinition-secret-name)" : {{String}},
  "[ValueFrom](#cfn-batch-jobdefinition-secret-valuefrom)" : {{String}}
}
```

### YAML
<a name="aws-properties-batch-jobdefinition-secret-syntax.yaml"></a>

```
  [Name](#cfn-batch-jobdefinition-secret-name): {{String}}
  [ValueFrom](#cfn-batch-jobdefinition-secret-valuefrom): {{String}}
```

## Properties
<a name="aws-properties-batch-jobdefinition-secret-properties"></a>

`Name`  <a name="cfn-batch-jobdefinition-secret-name"></a>
The name of the secret.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ValueFrom`  <a name="cfn-batch-jobdefinition-secret-valuefrom"></a>
The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Amazon Secrets Manager secret or the full ARN of the parameter in the Amazon Systems Manager Parameter Store.  
If the Amazon 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.
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)