EcsJobDefinition

class aws_cdk.aws_batch.EcsJobDefinition(scope, id, *, container, propagate_tags=None, job_definition_name=None, parameters=None, retry_attempts=None, retry_strategies=None, scheduling_priority=None, timeout=None)

Bases: Resource

A JobDefinition that uses ECS orchestration.

Resource:: AWS::Batch::JobDefinition
ExampleMetadata:: infused

Example:

# vpc: ec2.IVpc


ecs_job = batch.EcsJobDefinition(self, "JobDefn",
    container=batch.EcsEc2ContainerDefinition(self, "containerDefn",
        image=ecs.ContainerImage.from_registry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
        memory=cdk.Size.mebibytes(2048),
        cpu=256
    )
)

queue = batch.JobQueue(self, "JobQueue",
    compute_environments=[batch.OrderedComputeEnvironment(
        compute_environment=batch.ManagedEc2EcsComputeEnvironment(self, "managedEc2CE",
            vpc=vpc
        ),
        order=1
    )],
    priority=10
)

user = iam.User(self, "MyUser")
ecs_job.grant_submit_job(user, queue)

Parameters:

scope (Construct) –
id (str) –
container (IEcsContainerDefinition) – The container that this job will run.
propagate_tags (Optional[bool]) – Whether to propogate tags from the JobDefinition to the ECS task that Batch spawns. Default: false
job_definition_name (Optional[str]) – The name of this job definition. Default: - generated by CloudFormation
parameters (Optional[Mapping[str, Any]]) – The default parameters passed to the container These parameters can be referenced in the command that you give to the container. Default: none
retry_attempts (Union[int, float, None]) – The number of times to retry a job. The job is retried on failure the same number of attempts as the value. Default: 1
retry_strategies (Optional[Sequence[RetryStrategy]]) – Defines the retry behavior for this job. Default: - no RetryStrategy
scheduling_priority (Union[int, float, 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. Default: none
timeout (Optional[Duration]) – 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. Default: - no timeout

Methods

add_retry_strategy(strategy)

Add a RetryStrategy to this JobDefinition.

Parameters:

strategy (RetryStrategy) –

Return type:

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant_submit_job(identity, queue)

Grants the batch:submitJob permission to the identity on both this job definition and the queue.

Parameters:

identity (IGrantable) –
queue (IJobQueue) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

container: The container that this job will run.

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

job_definition_arn: The ARN of this job definition.

job_definition_name: The name of this job definition.

node: The tree node.

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

propagate_tags: Whether to propogate tags from the JobDefinition to the ECS task that Batch spawns.

retry_attempts

The number of times to retry a job.

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

retry_strategies: Defines the retry behavior for this job.

scheduling_priority

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.

stack: The stack in which this resource is defined.

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.

Static Methods

classmethod from_job_definition_arn(scope, id, job_definition_arn)

Import a JobDefinition by its arn.

Parameters:

scope (Construct) –
id (str) –
job_definition_arn (str) –

Return type:

IJobDefinition

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool