Package software.amazon.awscdk.services.batch

Class EcsJobDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.EcsJobDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EcsJobDefinitionProps>

Enclosing interface:

EcsJobDefinitionProps

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

A builder for EcsJobDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EcsJobDefinitionProps	build()	Builds the configured instance.
EcsJobDefinitionProps.Builder	container(IEcsContainerDefinition container)	Sets the value of EcsJobDefinitionProps.getContainer()
EcsJobDefinitionProps.Builder	jobDefinitionName(String jobDefinitionName)	Sets the value of JobDefinitionProps.getJobDefinitionName()
EcsJobDefinitionProps.Builder	parameters(Map<String,? extends Object> parameters)	Sets the value of JobDefinitionProps.getParameters()
EcsJobDefinitionProps.Builder	propagateTags(Boolean propagateTags)	Sets the value of EcsJobDefinitionProps.getPropagateTags()
EcsJobDefinitionProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of JobDefinitionProps.getRetryAttempts()
EcsJobDefinitionProps.Builder	retryStrategies(List<? extends RetryStrategy> retryStrategies)	Sets the value of JobDefinitionProps.getRetryStrategies()
EcsJobDefinitionProps.Builder	schedulingPriority(Number schedulingPriority)	Sets the value of JobDefinitionProps.getSchedulingPriority()
EcsJobDefinitionProps.Builder	skipDeregisterOnUpdate(Boolean skipDeregisterOnUpdate)	Sets the value of JobDefinitionProps.getSkipDeregisterOnUpdate()
EcsJobDefinitionProps.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

container

@Stability(Stable)
public EcsJobDefinitionProps.Builder container(IEcsContainerDefinition container)

Sets the value of EcsJobDefinitionProps.getContainer()

Parameters:

container - The container that this job will run. This parameter is required.

Returns:

this

propagateTags

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

Sets the value of EcsJobDefinitionProps.getPropagateTags()

Parameters:

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

Returns:

this

jobDefinitionName

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

Sets the value of JobDefinitionProps.getJobDefinitionName()

Parameters:

jobDefinitionName - The name of this job definition.

Returns:

this

parameters

@Stability(Stable)
public EcsJobDefinitionProps.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 EcsJobDefinitionProps.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 EcsJobDefinitionProps.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 EcsJobDefinitionProps.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 EcsJobDefinitionProps.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 EcsJobDefinitionProps.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 EcsJobDefinitionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EcsJobDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided