@aws-cdk_aws-batch-alpha.MultiNodeJobDefinitionProps

interface MultiNodeJobDefinitionProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.MultiNodeJobDefinitionProps
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#MultiNodeJobDefinitionProps
Javasoftware.amazon.awscdk.services.batch.alpha.MultiNodeJobDefinitionProps
Pythonaws_cdk.aws_batch_alpha.MultiNodeJobDefinitionProps
TypeScript (source)@aws-cdk/aws-batch-alpha ยป MultiNodeJobDefinitionProps

Props to configure a MultiNodeJobDefinition.

Example

import * as cdk from 'aws-cdk-lib';
const multiNodeJob = new batch.MultiNodeJobDefinition(this, 'JobDefinition', {
  instanceType: ec2.InstanceType.of(ec2.InstanceClass.R4, ec2.InstanceSize.LARGE),
  containers: [{
    container: new batch.EcsEc2ContainerDefinition(this, 'mainMPIContainer', {
      image: ecs.ContainerImage.fromRegistry('yourregsitry.com/yourMPIImage:latest'),
      cpu: 256,
      memory: cdk.Size.mebibytes(2048),
    }),
    startNode: 0,
    endNode: 5,
  }],
});
// convenience method
multiNodeJob.addContainer({
  startNode: 6,
  endNode: 10,
  container: new batch.EcsEc2ContainerDefinition(this, 'multiContainer', {
    image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
    cpu: 256,
    memory: cdk.Size.mebibytes(2048),
  }),
});

Properties

NameTypeDescription
instanceType๐Ÿ”นInstanceTypeThe instance type that this job definition will run.
containers?๐Ÿ”นMultiNodeContainer[]The containers that this multinode job will run.
jobDefinitionName?๐Ÿ”นstringThe name of this job definition.
mainNode?๐Ÿ”นnumberThe index of the main node in this job.
parameters?๐Ÿ”น{ [string]: any }The default parameters passed to the container These parameters can be referenced in the command that you give to the container.
propagateTags?๐Ÿ”นbooleanWhether to propogate tags from the JobDefinition to the ECS task that Batch spawns.
retryAttempts?๐Ÿ”นnumberThe number of times to retry a job.
retryStrategies?๐Ÿ”นRetryStrategy[]Defines the retry behavior for this job.
schedulingPriority?๐Ÿ”นnumberThe priority of this Job.
timeout?๐Ÿ”นDurationThe timeout time for jobs that are submitted with this job definition.

instanceType๐Ÿ”น

Type: InstanceType

The instance type that this job definition will run.


containers?๐Ÿ”น

Type: MultiNodeContainer[] (optional, default: none)

The containers that this multinode job will run.

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


jobDefinitionName?๐Ÿ”น

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

The name of this job definition.


mainNode?๐Ÿ”น

Type: number (optional, default: 0)

The index of the main node in this job.

The main node is responsible for orchestration.


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


propagateTags?๐Ÿ”น

Type: boolean (optional, default: false)

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


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.