Package software.amazon.awscdk.services.batch

Class MultiNodeJobDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.MultiNodeJobDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MultiNodeJobDefinitionProps>

Enclosing interface:

MultiNodeJobDefinitionProps

@Stability(Stable)
public static final class MultiNodeJobDefinitionProps.Builder
extends Object
implements software.amazon.jsii.Builder<MultiNodeJobDefinitionProps>

A builder for MultiNodeJobDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MultiNodeJobDefinitionProps	build()	Builds the configured instance.
MultiNodeJobDefinitionProps.Builder	containers(List<? extends MultiNodeContainer> containers)	Sets the value of MultiNodeJobDefinitionProps.getContainers()
MultiNodeJobDefinitionProps.Builder	instanceType(InstanceType instanceType)	Sets the value of MultiNodeJobDefinitionProps.getInstanceType()
MultiNodeJobDefinitionProps.Builder	jobDefinitionName(String jobDefinitionName)	Sets the value of JobDefinitionProps.getJobDefinitionName()
MultiNodeJobDefinitionProps.Builder	mainNode(Number mainNode)	Sets the value of MultiNodeJobDefinitionProps.getMainNode()
MultiNodeJobDefinitionProps.Builder	parameters(Map<String,? extends Object> parameters)	Sets the value of JobDefinitionProps.getParameters()
MultiNodeJobDefinitionProps.Builder	propagateTags(Boolean propagateTags)	Sets the value of MultiNodeJobDefinitionProps.getPropagateTags()
MultiNodeJobDefinitionProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of JobDefinitionProps.getRetryAttempts()
MultiNodeJobDefinitionProps.Builder	retryStrategies(List<? extends RetryStrategy> retryStrategies)	Sets the value of JobDefinitionProps.getRetryStrategies()
MultiNodeJobDefinitionProps.Builder	schedulingPriority(Number schedulingPriority)	Sets the value of JobDefinitionProps.getSchedulingPriority()
MultiNodeJobDefinitionProps.Builder	skipDeregisterOnUpdate(Boolean skipDeregisterOnUpdate)	Sets the value of JobDefinitionProps.getSkipDeregisterOnUpdate()
MultiNodeJobDefinitionProps.Builder	timeout(Duration timeout)	Sets the value of JobDefinitionProps.getTimeout()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

containers

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder containers(List<? extends MultiNodeContainer> containers)

Sets the value of MultiNodeJobDefinitionProps.getContainers()

Parameters:

containers - The containers that this multinode job will run.

Returns:

this

instanceType

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder instanceType(InstanceType instanceType)

Sets the value of MultiNodeJobDefinitionProps.getInstanceType()

Parameters:

instanceType - The instance type that this job definition will run.

Returns:

this

mainNode

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder mainNode(Number mainNode)

Sets the value of MultiNodeJobDefinitionProps.getMainNode()

Parameters:

mainNode - The index of the main node in this job. The main node is responsible for orchestration.

Returns:

this

propagateTags

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder propagateTags(Boolean propagateTags)

Sets the value of MultiNodeJobDefinitionProps.getPropagateTags()

Parameters:

propagateTags - Whether to propagate tags from the JobDefinition to the ECS task that Batch spawns.

Returns:

this

jobDefinitionName

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder jobDefinitionName(String jobDefinitionName)

Sets the value of JobDefinitionProps.getJobDefinitionName()

Parameters:

jobDefinitionName - The name of this job definition.

Returns:

this

parameters

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder parameters(Map<String,? extends Object> parameters)

Sets the value of JobDefinitionProps.getParameters()

Parameters:

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

Returns:

this

retryAttempts

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder retryAttempts(Number retryAttempts)

Sets the value of JobDefinitionProps.getRetryAttempts()

Parameters:

retryAttempts - The number of times to retry a job. The job is retried on failure the same number of attempts as the value.

Returns:

this

retryStrategies

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder retryStrategies(List<? extends RetryStrategy> retryStrategies)

Sets the value of JobDefinitionProps.getRetryStrategies()

Parameters:

retryStrategies - Defines the retry behavior for this job.

Returns:

this

schedulingPriority

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder schedulingPriority(Number schedulingPriority)

Sets the value of JobDefinitionProps.getSchedulingPriority()

Parameters:

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

Returns:

this

skipDeregisterOnUpdate

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder skipDeregisterOnUpdate(Boolean skipDeregisterOnUpdate)

Sets the value of JobDefinitionProps.getSkipDeregisterOnUpdate()

Parameters:

skipDeregisterOnUpdate - Specifies whether the previous revision of the job definition is retained in an active status after UPDATE events for the resource. When the property is set to false, the previous revision of the job definition is de-registered after a new revision is created. When the property is set to true, the previous revision of the job definition is not de-registered.

Returns:

this

timeout

@Stability(Stable)
public MultiNodeJobDefinitionProps.Builder timeout(Duration timeout)

Sets the value of JobDefinitionProps.getTimeout()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public MultiNodeJobDefinitionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<MultiNodeJobDefinitionProps>

Returns:

a new instance of MultiNodeJobDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided