software.amazon.awscdk.services.batch

Class CfnJobDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.batch.CfnJobDefinitionProps.Builder

Enclosing interface:

CfnJobDefinitionProps

public static final class CfnJobDefinitionProps.Builder
extends java.lang.Object

A builder for CfnJobDefinitionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnJobDefinitionProps	build() Builds the configured instance.
CfnJobDefinitionProps.Builder	containerProperties(CfnJobDefinition.ContainerPropertiesProperty containerProperties) Sets the value of CfnJobDefinitionProps.getContainerProperties()
CfnJobDefinitionProps.Builder	containerProperties(IResolvable containerProperties) Sets the value of CfnJobDefinitionProps.getContainerProperties()
CfnJobDefinitionProps.Builder	jobDefinitionName(java.lang.String jobDefinitionName) Sets the value of CfnJobDefinitionProps.getJobDefinitionName()
CfnJobDefinitionProps.Builder	nodeProperties(CfnJobDefinition.NodePropertiesProperty nodeProperties) Sets the value of CfnJobDefinitionProps.getNodeProperties()
CfnJobDefinitionProps.Builder	nodeProperties(IResolvable nodeProperties) Sets the value of CfnJobDefinitionProps.getNodeProperties()
CfnJobDefinitionProps.Builder	parameters(java.lang.Object parameters) Sets the value of CfnJobDefinitionProps.getParameters()
CfnJobDefinitionProps.Builder	platformCapabilities(java.util.List<java.lang.String> platformCapabilities) Sets the value of CfnJobDefinitionProps.getPlatformCapabilities()
CfnJobDefinitionProps.Builder	propagateTags(java.lang.Boolean propagateTags) Sets the value of CfnJobDefinitionProps.getPropagateTags()
CfnJobDefinitionProps.Builder	propagateTags(IResolvable propagateTags) Sets the value of CfnJobDefinitionProps.getPropagateTags()
CfnJobDefinitionProps.Builder	retryStrategy(CfnJobDefinition.RetryStrategyProperty retryStrategy) Sets the value of CfnJobDefinitionProps.getRetryStrategy()
CfnJobDefinitionProps.Builder	retryStrategy(IResolvable retryStrategy) Sets the value of CfnJobDefinitionProps.getRetryStrategy()
CfnJobDefinitionProps.Builder	schedulingPriority(java.lang.Number schedulingPriority) Sets the value of CfnJobDefinitionProps.getSchedulingPriority()
CfnJobDefinitionProps.Builder	tags(java.lang.Object tags) Sets the value of CfnJobDefinitionProps.getTags()
CfnJobDefinitionProps.Builder	timeout(CfnJobDefinition.TimeoutProperty timeout) Sets the value of CfnJobDefinitionProps.getTimeout()
CfnJobDefinitionProps.Builder	timeout(IResolvable timeout) Sets the value of CfnJobDefinitionProps.getTimeout()
CfnJobDefinitionProps.Builder	type(java.lang.String type) Sets the value of CfnJobDefinitionProps.getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

type

public CfnJobDefinitionProps.Builder type(java.lang.String type)

Sets the value of CfnJobDefinitionProps.getType()

Parameters:

type - The type of job definition. This parameter is required. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide .

If the job is run on Fargate resources, then multinode isn't supported.

Returns:

this

containerProperties

public CfnJobDefinitionProps.Builder containerProperties(IResolvable containerProperties)

Sets the value of CfnJobDefinitionProps.getContainerProperties()

Parameters:

containerProperties - An object with various properties specific to container-based jobs.

Returns:

this

containerProperties

public CfnJobDefinitionProps.Builder containerProperties(CfnJobDefinition.ContainerPropertiesProperty containerProperties)

Sets the value of CfnJobDefinitionProps.getContainerProperties()

Parameters:

containerProperties - An object with various properties specific to container-based jobs.

Returns:

this

jobDefinitionName

public CfnJobDefinitionProps.Builder jobDefinitionName(java.lang.String jobDefinitionName)

Sets the value of CfnJobDefinitionProps.getJobDefinitionName()

Parameters:

jobDefinitionName - The name of the job definition.

Returns:

this

nodeProperties

public CfnJobDefinitionProps.Builder nodeProperties(IResolvable nodeProperties)

Sets the value of CfnJobDefinitionProps.getNodeProperties()

Parameters:

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

If the job runs on Fargate resources, then you must not specify nodeProperties ; use containerProperties instead.

Returns:

this

nodeProperties

public CfnJobDefinitionProps.Builder nodeProperties(CfnJobDefinition.NodePropertiesProperty nodeProperties)

Sets the value of CfnJobDefinitionProps.getNodeProperties()

Parameters:

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

If the job runs on Fargate resources, then you must not specify nodeProperties ; use containerProperties instead.

Returns:

this

parameters

public CfnJobDefinitionProps.Builder parameters(java.lang.Object parameters)

Sets the value of CfnJobDefinitionProps.getParameters()

Parameters:

parameters - Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the AWS Batch User Guide .

Returns:

this

platformCapabilities

public CfnJobDefinitionProps.Builder platformCapabilities(java.util.List<java.lang.String> platformCapabilities)

Sets the value of CfnJobDefinitionProps.getPlatformCapabilities()

Parameters:

platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2 . Jobs run on Fargate resources specify FARGATE .

Returns:

this

propagateTags

public CfnJobDefinitionProps.Builder propagateTags(java.lang.Boolean propagateTags)

Sets the value of CfnJobDefinitionProps.getPropagateTags()

Parameters:

propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Returns:

this

propagateTags

public CfnJobDefinitionProps.Builder propagateTags(IResolvable propagateTags)

Sets the value of CfnJobDefinitionProps.getPropagateTags()

Parameters:

propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Returns:

this

retryStrategy

public CfnJobDefinitionProps.Builder retryStrategy(IResolvable retryStrategy)

Sets the value of CfnJobDefinitionProps.getRetryStrategy()

Parameters:

retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition.

Returns:

this

retryStrategy

public CfnJobDefinitionProps.Builder retryStrategy(CfnJobDefinition.RetryStrategyProperty retryStrategy)

Sets the value of CfnJobDefinitionProps.getRetryStrategy()

Parameters:

retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition.

Returns:

this

schedulingPriority

public CfnJobDefinitionProps.Builder schedulingPriority(java.lang.Number schedulingPriority)

Sets the value of CfnJobDefinitionProps.getSchedulingPriority()

Parameters:

schedulingPriority - The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

Returns:

this

tags

public CfnJobDefinitionProps.Builder tags(java.lang.Object tags)

Sets the value of CfnJobDefinitionProps.getTags()

Parameters:

tags - The tags applied to the job definition.

Returns:

this

timeout

public CfnJobDefinitionProps.Builder timeout(IResolvable timeout)

Sets the value of CfnJobDefinitionProps.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 haven't finished.

Returns:

this

timeout

public CfnJobDefinitionProps.Builder timeout(CfnJobDefinition.TimeoutProperty timeout)

Sets the value of CfnJobDefinitionProps.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 haven't finished.

Returns:

this

build

public CfnJobDefinitionProps build()

Builds the configured instance.

Returns:

a new instance of CfnJobDefinitionProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided