Package software.amazon.awscdk.services.batch

Class CfnJobDefinitionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobDefinitionProps>

Enclosing interface:

CfnJobDefinitionProps

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

A builder for CfnJobDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnJobDefinitionProps	build()	Builds the configured instance.
CfnJobDefinitionProps.Builder	containerProperties(IResolvable containerProperties)	Sets the value of CfnJobDefinitionProps.getContainerProperties()
CfnJobDefinitionProps.Builder	containerProperties(CfnJobDefinition.ContainerPropertiesProperty containerProperties)	Sets the value of CfnJobDefinitionProps.getContainerProperties()
CfnJobDefinitionProps.Builder	ecsProperties(IResolvable ecsProperties)	Sets the value of CfnJobDefinitionProps.getEcsProperties()
CfnJobDefinitionProps.Builder	ecsProperties(CfnJobDefinition.EcsPropertiesProperty ecsProperties)	Sets the value of CfnJobDefinitionProps.getEcsProperties()
CfnJobDefinitionProps.Builder	eksProperties(IResolvable eksProperties)	Sets the value of CfnJobDefinitionProps.getEksProperties()
CfnJobDefinitionProps.Builder	eksProperties(CfnJobDefinition.EksPropertiesProperty eksProperties)	Sets the value of CfnJobDefinitionProps.getEksProperties()
CfnJobDefinitionProps.Builder	jobDefinitionName(String jobDefinitionName)	Sets the value of CfnJobDefinitionProps.getJobDefinitionName()
CfnJobDefinitionProps.Builder	nodeProperties(IResolvable nodeProperties)	Sets the value of CfnJobDefinitionProps.getNodeProperties()
CfnJobDefinitionProps.Builder	nodeProperties(CfnJobDefinition.NodePropertiesProperty nodeProperties)	Sets the value of CfnJobDefinitionProps.getNodeProperties()
CfnJobDefinitionProps.Builder	parameters(Object parameters)	Sets the value of CfnJobDefinitionProps.getParameters()
CfnJobDefinitionProps.Builder	platformCapabilities(List<String> platformCapabilities)	Sets the value of CfnJobDefinitionProps.getPlatformCapabilities()
CfnJobDefinitionProps.Builder	propagateTags(Boolean propagateTags)	Sets the value of CfnJobDefinitionProps.getPropagateTags()
CfnJobDefinitionProps.Builder	propagateTags(IResolvable propagateTags)	Sets the value of CfnJobDefinitionProps.getPropagateTags()
CfnJobDefinitionProps.Builder	retryStrategy(IResolvable retryStrategy)	Sets the value of CfnJobDefinitionProps.getRetryStrategy()
CfnJobDefinitionProps.Builder	retryStrategy(CfnJobDefinition.RetryStrategyProperty retryStrategy)	Sets the value of CfnJobDefinitionProps.getRetryStrategy()
CfnJobDefinitionProps.Builder	schedulingPriority(Number schedulingPriority)	Sets the value of CfnJobDefinitionProps.getSchedulingPriority()
CfnJobDefinitionProps.Builder	tags(Object tags)	Sets the value of CfnJobDefinitionProps.getTags()
CfnJobDefinitionProps.Builder	timeout(IResolvable timeout)	Sets the value of CfnJobDefinitionProps.getTimeout()
CfnJobDefinitionProps.Builder	timeout(CfnJobDefinition.TimeoutProperty timeout)	Sets the value of CfnJobDefinitionProps.getTimeout()
CfnJobDefinitionProps.Builder	type(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 Details

Builder

public Builder()

Method Details

type

@Stability(Stable)
public CfnJobDefinitionProps.Builder type(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 value is container , then one of the following is required: containerProperties , ecsProperties , or eksProperties .
• If the value is multinode , then nodeProperties is required.

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

Returns:

this

containerProperties

@Stability(Stable)
public CfnJobDefinitionProps.Builder containerProperties(IResolvable containerProperties)

Sets the value of CfnJobDefinitionProps.getContainerProperties()

Parameters:

containerProperties - An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties , ecsProperties , or nodeProperties .

Returns:

this

containerProperties

@Stability(Stable)
public CfnJobDefinitionProps.Builder containerProperties(CfnJobDefinition.ContainerPropertiesProperty containerProperties)

Sets the value of CfnJobDefinitionProps.getContainerProperties()

Parameters:

containerProperties - An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties , ecsProperties , or nodeProperties .

Returns:

this

ecsProperties

@Stability(Stable)
public CfnJobDefinitionProps.Builder ecsProperties(IResolvable ecsProperties)

Sets the value of CfnJobDefinitionProps.getEcsProperties()

Parameters:

ecsProperties - An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties , eksProperties , or nodeProperties .

Returns:

this

ecsProperties

@Stability(Stable)
public CfnJobDefinitionProps.Builder ecsProperties(CfnJobDefinition.EcsPropertiesProperty ecsProperties)

Sets the value of CfnJobDefinitionProps.getEcsProperties()

Parameters:

ecsProperties - An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties , eksProperties , or nodeProperties .

Returns:

this

eksProperties

@Stability(Stable)
public CfnJobDefinitionProps.Builder eksProperties(IResolvable eksProperties)

Sets the value of CfnJobDefinitionProps.getEksProperties()

Parameters:

eksProperties - An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or nodeProperties .

Returns:

this

eksProperties

@Stability(Stable)
public CfnJobDefinitionProps.Builder eksProperties(CfnJobDefinition.EksPropertiesProperty eksProperties)

Sets the value of CfnJobDefinitionProps.getEksProperties()

Parameters:

eksProperties - An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or nodeProperties .

Returns:

this

jobDefinitionName

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

Sets the value of CfnJobDefinitionProps.getJobDefinitionName()

Parameters:

jobDefinitionName - The name of the job definition.

Returns:

this

nodeProperties

@Stability(Stable)
public CfnJobDefinitionProps.Builder nodeProperties(IResolvable nodeProperties)

Sets the value of CfnJobDefinitionProps.getNodeProperties()

Parameters:

nodeProperties - An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or eksProperties .

If the job runs on Fargate resources, don't specify nodeProperties . Use containerProperties instead.

Returns:

this

nodeProperties

@Stability(Stable)
public CfnJobDefinitionProps.Builder nodeProperties(CfnJobDefinition.NodePropertiesProperty nodeProperties)

Sets the value of CfnJobDefinitionProps.getNodeProperties()

Parameters:

nodeProperties - An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or eksProperties .

If the job runs on Fargate resources, don't specify nodeProperties . Use containerProperties instead.

Returns:

this

parameters

@Stability(Stable)
public CfnJobDefinitionProps.Builder parameters(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

@Stability(Stable)
public CfnJobDefinitionProps.Builder platformCapabilities(List<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

@Stability(Stable)
public CfnJobDefinitionProps.Builder propagateTags(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 when the tasks are created. 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

@Stability(Stable)
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 when the tasks are created. 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

@Stability(Stable)
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

@Stability(Stable)
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

@Stability(Stable)
public CfnJobDefinitionProps.Builder schedulingPriority(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

@Stability(Stable)
public CfnJobDefinitionProps.Builder tags(Object tags)

Sets the value of CfnJobDefinitionProps.getTags()

Parameters:

tags - The tags that are applied to the job definition.

Returns:

this

timeout

@Stability(Stable)
public CfnJobDefinitionProps.Builder timeout(IResolvable timeout)

Sets the value of CfnJobDefinitionProps.getTimeout()

Parameters:

timeout - The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.

Returns:

this

timeout

@Stability(Stable)
public CfnJobDefinitionProps.Builder timeout(CfnJobDefinition.TimeoutProperty timeout)

Sets the value of CfnJobDefinitionProps.getTimeout()

Parameters:

timeout - The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.

Returns:

this

build

@Stability(Stable)
public CfnJobDefinitionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnJobDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided