Package software.amazon.awscdk.services.batch

Interface MultiNodeJobDefinitionProps

All Superinterfaces:

JobDefinitionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MultiNodeJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:55.487Z")
@Stability(Stable)
public interface MultiNodeJobDefinitionProps
extends software.amazon.jsii.JsiiSerializable, JobDefinitionProps

Props to configure a MultiNodeJobDefinition.

Example:

 MultiNodeJobDefinition multiNodeJob = MultiNodeJobDefinition.Builder.create(this, "JobDefinition")
         .instanceType(InstanceType.of(InstanceClass.R4, InstanceSize.LARGE)) // optional, omit to let Batch choose the type for you
         .containers(List.of(MultiNodeContainer.builder()
                 .container(EcsEc2ContainerDefinition.Builder.create(this, "mainMPIContainer")
                         .image(ContainerImage.fromRegistry("yourregsitry.com/yourMPIImage:latest"))
                         .cpu(256)
                         .memory(Size.mebibytes(2048))
                         .build())
                 .startNode(0)
                 .endNode(5)
                 .build()))
         .build();
 // convenience method
 multiNodeJob.addContainer(MultiNodeContainer.builder()
         .startNode(6)
         .endNode(10)
         .container(EcsEc2ContainerDefinition.Builder.create(this, "multiContainer")
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .cpu(256)
                 .memory(Size.mebibytes(2048))
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MultiNodeJobDefinitionProps.Builder	A builder for MultiNodeJobDefinitionProps
static final class	MultiNodeJobDefinitionProps.Jsii$Proxy	An implementation for MultiNodeJobDefinitionProps

Method Summary

Modifier and Type	Method	Description
static MultiNodeJobDefinitionProps.Builder	builder()
default List<MultiNodeContainer>	getContainers()	The containers that this multinode job will run.
default InstanceType	getInstanceType()	The instance type that this job definition will run.
default Number	getMainNode()	The index of the main node in this job.
default Boolean	getPropagateTags()	Whether to propogate tags from the JobDefinition to the ECS task that Batch spawns.

Methods inherited from interface software.amazon.awscdk.services.batch.JobDefinitionProps

getJobDefinitionName, getParameters, getRetryAttempts, getRetryStrategies, getSchedulingPriority, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainers

@Stability(Stable)
@Nullable
default List<MultiNodeContainer> getContainers()

The containers that this multinode job will run.

Default: none

See Also:

• https://aws.amazon.com/blogs/compute/building-a-tightly-coupled-molecular-dynamics-workflow-with-multi-node-parallel-jobs-in-aws-batch/

getInstanceType

@Stability(Stable)
@Nullable
default InstanceType getInstanceType()

The instance type that this job definition will run.

Default: - optimal instance, selected by Batch

getMainNode

@Stability(Stable)
@Nullable
default Number getMainNode()

The index of the main node in this job.

The main node is responsible for orchestration.

Default: 0

getPropagateTags

@Stability(Stable)
@Nullable
default Boolean getPropagateTags()

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

Default: false

builder

@Stability(Stable)
static MultiNodeJobDefinitionProps.Builder builder()

Returns:

a MultiNodeJobDefinitionProps.Builder of MultiNodeJobDefinitionProps