software.amazon.awscdk.services.batch

Class CfnJobDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.batch.CfnJobDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobDefinition>

Enclosing class:

CfnJobDefinition

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

A fluent builder for CfnJobDefinition.

Method Summary

Modifier and Type	Method and Description
CfnJobDefinition	build()
CfnJobDefinition.Builder	containerProperties(CfnJobDefinition.ContainerPropertiesProperty containerProperties) An object with various properties specific to container-based jobs.
CfnJobDefinition.Builder	containerProperties(IResolvable containerProperties) An object with various properties specific to container-based jobs.
static CfnJobDefinition.Builder	create(software.constructs.Construct scope, String id)
CfnJobDefinition.Builder	jobDefinitionName(String jobDefinitionName) The name of the job definition.
CfnJobDefinition.Builder	nodeProperties(CfnJobDefinition.NodePropertiesProperty nodeProperties) An object with various properties specific to multi-node parallel jobs.
CfnJobDefinition.Builder	nodeProperties(IResolvable nodeProperties) An object with various properties specific to multi-node parallel jobs.
CfnJobDefinition.Builder	parameters(Object parameters) Default parameters or parameter substitution placeholders that are set in the job definition.
CfnJobDefinition.Builder	platformCapabilities(List<String> platformCapabilities) The platform capabilities required by the job definition.
CfnJobDefinition.Builder	propagateTags(Boolean propagateTags) Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
CfnJobDefinition.Builder	propagateTags(IResolvable propagateTags) Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
CfnJobDefinition.Builder	retryStrategy(CfnJobDefinition.RetryStrategyProperty retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.
CfnJobDefinition.Builder	retryStrategy(IResolvable retryStrategy) The retry strategy to use for failed jobs that are submitted with this job definition.
CfnJobDefinition.Builder	schedulingPriority(Number schedulingPriority) The scheduling priority of the job definition.
CfnJobDefinition.Builder	tags(Object tags) The tags applied to the job definition.
CfnJobDefinition.Builder	timeout(CfnJobDefinition.TimeoutProperty timeout) The timeout configuration for jobs that are submitted with this job definition.
CfnJobDefinition.Builder	timeout(IResolvable timeout) The timeout configuration for jobs that are submitted with this job definition.
CfnJobDefinition.Builder	type(String type) The type of job definition.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnJobDefinition.Builder create(software.constructs.Construct scope,
                                                                       String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnJobDefinition.AuthorizationConfigProperty.Builder.

type

@Stability(value=Stable)
public CfnJobDefinition.Builder type(String type)

The type of job definition.

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.

Parameters:

type - The type of job definition. This parameter is required.

Returns:

this

containerProperties

@Stability(value=Stable)
public CfnJobDefinition.Builder containerProperties(CfnJobDefinition.ContainerPropertiesProperty containerProperties)

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

Parameters:

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

Returns:

this

containerProperties

@Stability(value=Stable)
public CfnJobDefinition.Builder containerProperties(IResolvable containerProperties)

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

Parameters:

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

Returns:

this

jobDefinitionName

@Stability(value=Stable)
public CfnJobDefinition.Builder jobDefinitionName(String jobDefinitionName)

The name of the job definition.

Parameters:

jobDefinitionName - The name of the job definition. This parameter is required.

Returns:

this

nodeProperties

@Stability(value=Stable)
public CfnJobDefinition.Builder nodeProperties(CfnJobDefinition.NodePropertiesProperty 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.

Parameters:

nodeProperties - An object with various properties specific to multi-node parallel jobs. This parameter is required.

Returns:

this

nodeProperties

@Stability(value=Stable)
public CfnJobDefinition.Builder nodeProperties(IResolvable 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.

Parameters:

nodeProperties - An object with various properties specific to multi-node parallel jobs. This parameter is required.

Returns:

this

parameters

@Stability(value=Stable)
public CfnJobDefinition.Builder parameters(Object 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 .

Parameters:

parameters - Default parameters or parameter substitution placeholders that are set in the job definition. This parameter is required.

Returns:

this

platformCapabilities

@Stability(value=Stable)
public CfnJobDefinition.Builder platformCapabilities(List<String> 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 .

Parameters:

platformCapabilities - The platform capabilities required by the job definition. This parameter is required.

Returns:

this

propagateTags

@Stability(value=Stable)
public CfnJobDefinition.Builder propagateTags(Boolean 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.

Parameters:

propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. This parameter is required.

Returns:

this

propagateTags

@Stability(value=Stable)
public CfnJobDefinition.Builder propagateTags(IResolvable 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.

Parameters:

propagateTags - Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. This parameter is required.

Returns:

this

retryStrategy

@Stability(value=Stable)
public CfnJobDefinition.Builder retryStrategy(CfnJobDefinition.RetryStrategyProperty retryStrategy)

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

Parameters:

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

Returns:

this

retryStrategy

@Stability(value=Stable)
public CfnJobDefinition.Builder retryStrategy(IResolvable retryStrategy)

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

Parameters:

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

Returns:

this

schedulingPriority

@Stability(value=Stable)
public CfnJobDefinition.Builder schedulingPriority(Number 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.

Parameters:

schedulingPriority - The scheduling priority of the job definition. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnJobDefinition.Builder tags(Object tags)

The tags applied to the job definition.

Parameters:

tags - The tags applied to the job definition. This parameter is required.

Returns:

this

timeout

@Stability(value=Stable)
public CfnJobDefinition.Builder timeout(CfnJobDefinition.TimeoutProperty 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.

Parameters:

timeout - The timeout configuration for jobs that are submitted with this job definition. This parameter is required.

Returns:

this

timeout

@Stability(value=Stable)
public CfnJobDefinition.Builder timeout(IResolvable 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.

Parameters:

timeout - The timeout configuration for jobs that are submitted with this job definition. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnJobDefinition build()

Specified by:

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