interface CfnJobDefinitionProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Batch.CfnJobDefinitionProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnJobDefinitionProps |
 Java | software.amazon.awscdk.services.batch.CfnJobDefinitionProps |
 Python | aws_cdk.aws_batch.CfnJobDefinitionProps |
 TypeScript | aws-cdk-lib » aws_batch » CfnJobDefinitionProps |
Properties for defining a CfnJobDefinition.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html
Example
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
Properties
| Name | Type | Description |
|---|---|---|
| type | string | The type of job definition. |
| consumable | IResolvable | Consumable | Contains a list of consumable resources required by the job. |
| container | IResolvable | Container | An object with properties specific to Amazon ECS-based jobs. |
| ecs | IResolvable | Ecs | An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties , eksProperties , or nodeProperties . |
| eks | IResolvable | Eks | An object with properties that are specific to Amazon EKS-based jobs. |
| job | string | The name of the job definition. |
| node | IResolvable | Node | An object with properties that are specific to multi-node parallel jobs. |
| parameters? | any | Default parameters or parameter substitution placeholders that are set in the job definition. |
| platform | string[] | The platform capabilities required by the job definition. |
| propagate | boolean | IResolvable | Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. |
| resource | IResolvable | Resource | Specifies the resource retention policy settings for the job definition. |
| retry | IResolvable | Retry | The retry strategy to use for failed jobs that are submitted with this job definition. |
| scheduling | number | The scheduling priority of the job definition. |
| tags? | any | The tags that are applied to the job definition. |
| timeout? | IResolvable | Timeout | The timeout time for jobs that are submitted with this job definition. |
type
Type:
string
The type of job definition.
For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide .
- If the value is
container, then one of the following is required:containerProperties,ecsProperties, oreksProperties. - If the value is
multinode, thennodePropertiesis required.
If the job is run on Fargate resources, then
multinodeisn't supported.
consumableResourceProperties?
Type:
IResolvable | Consumable
(optional)
Contains a list of consumable resources required by the job.
containerProperties?
Type:
IResolvable | Container
(optional)
An object with properties specific to Amazon ECS-based jobs.
When containerProperties is used in the job definition, it can't be used in addition to eksProperties , ecsProperties , or nodeProperties .
ecsProperties?
Type:
IResolvable | Ecs
(optional)
An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties , eksProperties , or nodeProperties .
eksProperties?
Type:
IResolvable | Eks
(optional)
An object with properties that are specific to Amazon EKS-based jobs.
When eksProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or nodeProperties .
jobDefinitionName?
Type:
string
(optional)
The name of the job definition.
nodeProperties?
Type:
IResolvable | Node
(optional)
An object with properties that are specific to multi-node parallel jobs.
When nodeProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or eksProperties .
If the job runs on Fargate resources, don't specify
nodeProperties. UsecontainerPropertiesinstead.
parameters?
Type:
any
(optional)
Default parameters or parameter substitution placeholders that are set in the job definition.
Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the AWS Batch User Guide .
platformCapabilities?
Type:
string[]
(optional)
The platform capabilities required by the job definition.
If no value is specified, it defaults to EC2 . Jobs run on Fargate resources specify FARGATE .
propagateTags?
Type:
boolean | IResolvable
(optional)
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
resourceRetentionPolicy?
Type:
IResolvable | Resource
(optional)
Specifies the resource retention policy settings for the job definition.
retryStrategy?
Type:
IResolvable | Retry
(optional)
The retry strategy to use for failed jobs that are submitted with this job definition.
schedulingPriority?
Type:
number
(optional)
The scheduling priority of the job definition.
This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
tags?
Type:
any
(optional)
The tags that are applied to the job definition.
timeout?
Type:
IResolvable | Timeout
(optional)
The timeout time for jobs that are submitted with this job definition.
After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.