Package software.amazon.awscdk.mixins.preview.services.batch.mixins

Class CfnJobDefinitionMixinProps.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.batch.mixins.CfnJobDefinitionMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobDefinitionMixinProps>

Enclosing interface:

CfnJobDefinitionMixinProps

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

A builder for CfnJobDefinitionMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

consumableResourceProperties

@Stability(Stable)
public CfnJobDefinitionMixinProps.Builder consumableResourceProperties(IResolvable consumableResourceProperties)

Sets the value of CfnJobDefinitionMixinProps.getConsumableResourceProperties()

Parameters:

consumableResourceProperties - Contains a list of consumable resources required by the job.

Returns:

this

consumableResourceProperties

@Stability(Stable)
public CfnJobDefinitionMixinProps.Builder consumableResourceProperties(CfnJobDefinitionPropsMixin.ConsumableResourcePropertiesProperty consumableResourceProperties)

Sets the value of CfnJobDefinitionMixinProps.getConsumableResourceProperties()

Parameters:

consumableResourceProperties - Contains a list of consumable resources required by the job.

Returns:

this

containerProperties

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

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder containerProperties(CfnJobDefinitionPropsMixin.ContainerPropertiesProperty containerProperties)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder ecsProperties(IResolvable ecsProperties)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder ecsProperties(CfnJobDefinitionPropsMixin.EcsPropertiesProperty ecsProperties)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder eksProperties(IResolvable eksProperties)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder eksProperties(CfnJobDefinitionPropsMixin.EksPropertiesProperty eksProperties)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder jobDefinitionName(String jobDefinitionName)

Sets the value of CfnJobDefinitionMixinProps.getJobDefinitionName()

Parameters:

jobDefinitionName - The name of the job definition.

Returns:

this

nodeProperties

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

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder nodeProperties(CfnJobDefinitionPropsMixin.NodePropertiesProperty nodeProperties)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder parameters(Object parameters)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder platformCapabilities(List<String> platformCapabilities)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder propagateTags(Boolean propagateTags)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder propagateTags(IResolvable propagateTags)

Sets the value of CfnJobDefinitionMixinProps.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

resourceRetentionPolicy

@Stability(Stable)
public CfnJobDefinitionMixinProps.Builder resourceRetentionPolicy(IResolvable resourceRetentionPolicy)

Sets the value of CfnJobDefinitionMixinProps.getResourceRetentionPolicy()

Parameters:

resourceRetentionPolicy - Specifies the resource retention policy settings for the job definition.

Returns:

this

resourceRetentionPolicy

@Stability(Stable)
public CfnJobDefinitionMixinProps.Builder resourceRetentionPolicy(CfnJobDefinitionPropsMixin.ResourceRetentionPolicyProperty resourceRetentionPolicy)

Sets the value of CfnJobDefinitionMixinProps.getResourceRetentionPolicy()

Parameters:

resourceRetentionPolicy - Specifies the resource retention policy settings for the job definition.

Returns:

this

retryStrategy

@Stability(Stable)
public CfnJobDefinitionMixinProps.Builder retryStrategy(IResolvable retryStrategy)

Sets the value of CfnJobDefinitionMixinProps.getRetryStrategy()

Parameters:

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

Returns:

this

retryStrategy

@Stability(Stable)
public CfnJobDefinitionMixinProps.Builder retryStrategy(CfnJobDefinitionPropsMixin.RetryStrategyProperty retryStrategy)

Sets the value of CfnJobDefinitionMixinProps.getRetryStrategy()

Parameters:

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

Returns:

this

schedulingPriority

@Stability(Stable)
public CfnJobDefinitionMixinProps.Builder schedulingPriority(Number schedulingPriority)

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder tags(Object tags)

Sets the value of CfnJobDefinitionMixinProps.getTags()

Parameters:

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

Returns:

this

timeout

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

Sets the value of CfnJobDefinitionMixinProps.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 CfnJobDefinitionMixinProps.Builder timeout(CfnJobDefinitionPropsMixin.TimeoutProperty timeout)

Sets the value of CfnJobDefinitionMixinProps.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

type

@Stability(Stable)
public CfnJobDefinitionMixinProps.Builder type(String type)

Sets the value of CfnJobDefinitionMixinProps.getType()

Parameters:

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 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

build

@Stability(Stable)
public CfnJobDefinitionMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnJobDefinitionMixinProps

Throws:

NullPointerException - if any required attribute was not provided