AWS CDK Reference

Appearance

v2.273.0

IJobDefinition Interface ​

Represents a JobDefinition.

Source
aws-batch/lib/job-definition-base.ts
Type last changed
v2.234.0 · 8 Jan 2026

Properties ​

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#
The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

jobDefinitionArnstringjob_definition_arnstrjobDefinitionArnStringJobDefinitionArnstringJobDefinitionArn*stringrequired#
The ARN of this job definition.
jobDefinitionNamestringjob_definition_namestrjobDefinitionNameStringJobDefinitionNamestringJobDefinitionName*stringrequired#
The name of this job definition.
jobDefinitionRefJobDefinitionReferencejob_definition_refJobDefinitionReferencejobDefinitionRefJobDefinitionReferenceJobDefinitionRefJobDefinitionReferenceJobDefinitionRefJobDefinitionReferencerequired#
A reference to a JobDefinition resource.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
parameters{ [key: string]: any }parameterstyping.Mapping[str, Any]parametersMap<String, Object>ParametersIDictionary<string, object>Parameters*map[string]interface{}= none#
The default parameters passed to the container These parameters can be referenced in the `command` that you give to the container.
retryAttemptsnumberretry_attemptsint | floatretryAttemptsNumberRetryAttemptsdoubleRetryAttempts*float64= 1#
The number of times to retry a job.

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

retryStrategiesRetryStrategy[]retry_strategiestyping.List[RetryStrategy]retryStrategiesList<RetryStrategy>RetryStrategiesRetryStrategy[]RetryStrategies*[]RetryStrategy= no `RetryStrategy`required#
Defines the retry behavior for this job.
schedulingPrioritynumberscheduling_priorityint | floatschedulingPriorityNumberSchedulingPrioritydoubleSchedulingPriority*float64= 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.

stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.
timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= 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.

Methods ​

addRetryStrategy(strategy: RetryStrategy): voiddef add_retry_strategy(self, strategy: RetryStrategy) -> Nonepublic void addRetryStrategy(RetryStrategy strategy)public void AddRetryStrategy(RetryStrategy strategy)func AddRetryStrategy(Strategy RetryStrategy)#
Add a RetryStrategy to this JobDefinition.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining