interface JobDefinitionProps

Language	Type name
.NET	Amazon.CDK.AWS.Batch.JobDefinitionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#JobDefinitionProps
Java	software.amazon.awscdk.services.batch.JobDefinitionProps
Python	aws_cdk.aws_batch.JobDefinitionProps
TypeScript (source)	aws-cdk-lib » aws_batch » JobDefinitionProps

Props common to all JobDefinitions.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_batch as batch } from 'aws-cdk-lib';

declare const parameters: any;
declare const retryStrategy: batch.RetryStrategy;
const jobDefinitionProps: batch.JobDefinitionProps = {
  jobDefinitionName: 'jobDefinitionName',
  parameters: {
    parametersKey: parameters,
  },
  retryAttempts: 123,
  retryStrategies: [retryStrategy],
  schedulingPriority: 123,
  timeout: cdk.Duration.minutes(30),
};

Properties

Name	Type	Description
jobDefinitionName?	string	The name of this job definition.
parameters?	{ [string]: any }	The default parameters passed to the container These parameters can be referenced in the command that you give to the container.
retryAttempts?	number	The number of times to retry a job.
retryStrategies?	RetryStrategy[]	Defines the retry behavior for this job.
schedulingPriority?	number	The priority of this Job.
timeout?	Duration	The timeout time for jobs that are submitted with this job definition.

---

jobDefinitionName?

Type: string (optional, default: generated by CloudFormation)

The name of this job definition.

---

parameters?

Type: { [string]: any } (optional, default: none)

The default parameters passed to the container These parameters can be referenced in the command that you give to the container.

See also: https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html#parameters

---

retryAttempts?

Type: number (optional, default: 1)

The number of times to retry a job.

The job is retried on failure the same number of attempts as the value.

---

retryStrategies?

Type: RetryStrategy[] (optional, default: no RetryStrategy)

Defines the retry behavior for this job.

---

schedulingPriority?

Type: number (optional, default: none)

The priority of this Job.

Only used in Fairshare Scheduling to decide which job to run first when there are multiple jobs with the same share identifier.

---

timeout?

Type: Duration (optional, default: no timeout)

The timeout time for jobs that are submitted with this job definition.

After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.