MultiNodeJobDefinition

class aws_cdk.aws_batch.MultiNodeJobDefinition(scope, id, *, containers=None, instance_type=None, main_node=None, 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 to run multiple containers.

Resource:

AWS::Batch::JobDefinition

ExampleMetadata:

infused

Example:

multi_node_job = batch.MultiNodeJobDefinition(self, "JobDefinition",
    instance_type=ec2.InstanceType.of(ec2.InstanceClass.R4, ec2.InstanceSize.LARGE),  # optional, omit to let Batch choose the type for you
    containers=[batch.MultiNodeContainer(
        container=batch.EcsEc2ContainerDefinition(self, "mainMPIContainer",
            image=ecs.ContainerImage.from_registry("yourregsitry.com/yourMPIImage:latest"),
            cpu=256,
            memory=cdk.Size.mebibytes(2048)
        ),
        start_node=0,
        end_node=5
    )]
)
# convenience method
multi_node_job.add_container(
    start_node=6,
    end_node=10,
    container=batch.EcsEc2ContainerDefinition(self, "multiContainer",
        image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample"),
        cpu=256,
        memory=cdk.Size.mebibytes(2048)
    )
)
Parameters:

  • scope (Construct)

  • id (str)

  • containers (Optional[Sequence[Union[MultiNodeContainer, Dict[str, Any]]]]) – The containers that this multinode job will run. Default: none

  • instance_type (Optional[InstanceType]) – The instance type that this job definition will run. Default: - optimal instance, selected by Batch

  • main_node (Union[int, float, None]) – The index of the main node in this job. The main node is responsible for orchestration. Default: 0

  • propagate_tags (Optional[bool]) – Whether to propagate 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_container(*, container, end_node, start_node)

Add a container to this multinode job.

Parameters:

  • container (IEcsContainerDefinition) – The container that this node range will run.

  • end_node (Union[int, float]) – The index of the last node to run this container. The container is run on all nodes in the range [startNode, endNode] (inclusive)

  • start_node (Union[int, float]) – The index of the first node to run this container. The container is run on all nodes in the range [startNode, endNode] (inclusive)

Return type:

None

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

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-batch.MultiNodeJobDefinition'
containers

The containers that this multinode job will run.

env

The environment this resource belongs to.

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.

instance_type

If the prop instanceType is left undefined, then this will hold a fake instance type, for backwards compatibility reasons.

job_definition_arn

The ARN of this job definition.

job_definition_name

The name of this job definition.

main_node

The index of the main node in this job.

The main node is responsible for orchestration.

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

refer to an existing 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