Package software.amazon.awscdk.services.batch

Class JobDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.JobDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JobDefinitionProps>

Enclosing interface:

JobDefinitionProps

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

A builder for JobDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JobDefinitionProps	build()	Builds the configured instance.
JobDefinitionProps.Builder	container(JobDefinitionContainer container)	Sets the value of JobDefinitionProps.getContainer()
JobDefinitionProps.Builder	jobDefinitionName(String jobDefinitionName)	Sets the value of JobDefinitionProps.getJobDefinitionName()
JobDefinitionProps.Builder	nodeProps(IMultiNodeProps nodeProps)	Sets the value of JobDefinitionProps.getNodeProps()
JobDefinitionProps.Builder	parameters(Map<String,String> parameters)	Sets the value of JobDefinitionProps.getParameters()
JobDefinitionProps.Builder	platformCapabilities(List<? extends PlatformCapabilities> platformCapabilities)	Sets the value of JobDefinitionProps.getPlatformCapabilities()
JobDefinitionProps.Builder	retryAttempts(Number retryAttempts)	Sets the value of JobDefinitionProps.getRetryAttempts()
JobDefinitionProps.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(Experimental)
public JobDefinitionProps.Builder container(JobDefinitionContainer container)

Sets the value of JobDefinitionProps.getContainer()

Parameters:

container - An object with various properties specific to container-based jobs. This parameter is required.

Returns:

this

jobDefinitionName

@Stability(Experimental)
public JobDefinitionProps.Builder jobDefinitionName(String jobDefinitionName)

Sets the value of JobDefinitionProps.getJobDefinitionName()

Parameters:

jobDefinitionName - The name of the job definition. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

this

nodeProps

@Stability(Experimental)
public JobDefinitionProps.Builder nodeProps(IMultiNodeProps nodeProps)

Sets the value of JobDefinitionProps.getNodeProps()

Parameters:

nodeProps - An object with various properties specific to multi-node parallel jobs.

Returns:

this

parameters

@Stability(Experimental)
public JobDefinitionProps.Builder parameters(Map<String,String> parameters)

Sets the value of JobDefinitionProps.getParameters()

Parameters:

parameters - When you submit a job, you can specify parameters that should replace the placeholders or override the default job definition parameters. Parameters in job submission requests take precedence over the defaults in a job definition. This allows you to use the same job definition for multiple jobs that use the same format, and programmatically change values in the command at submission time.

Returns:

this

platformCapabilities

@Stability(Experimental)
public JobDefinitionProps.Builder platformCapabilities(List<? extends PlatformCapabilities> platformCapabilities)

Sets the value of JobDefinitionProps.getPlatformCapabilities()

Parameters:

platformCapabilities - The platform capabilities required by the job definition.

Returns:

this

retryAttempts

@Stability(Experimental)
public JobDefinitionProps.Builder retryAttempts(Number retryAttempts)

Sets the value of JobDefinitionProps.getRetryAttempts()

Parameters:

retryAttempts - The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

Returns:

this

timeout

@Stability(Experimental)
public JobDefinitionProps.Builder timeout(Duration timeout)

Sets the value of JobDefinitionProps.getTimeout()

Parameters:

timeout - The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.

Returns:

this

build

@Stability(Experimental)
public JobDefinitionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of JobDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided