Package software.amazon.awscdk.services.batch

Interface CfnJobDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.922Z")
@Stability(Stable)
public interface CfnJobDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnJobDefinition.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJobDefinitionProps.Builder	A builder for CfnJobDefinitionProps
static final class	CfnJobDefinitionProps.Jsii$Proxy	An implementation for CfnJobDefinitionProps

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinitionProps.Builder	builder()
default Object	getContainerProperties()	An object with properties specific to Amazon ECS-based jobs.
default Object	getEcsProperties()	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 .
default Object	getEksProperties()	An object with properties that are specific to Amazon EKS-based jobs.
default String	getJobDefinitionName()	The name of the job definition.
default Object	getNodeProperties()	An object with properties that are specific to multi-node parallel jobs.
default Object	getParameters()	Default parameters or parameter substitution placeholders that are set in the job definition.
default List<String>	getPlatformCapabilities()	The platform capabilities required by the job definition.
default Object	getPropagateTags()	Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
default Object	getRetryStrategy()	The retry strategy to use for failed jobs that are submitted with this job definition.
default Number	getSchedulingPriority()	The scheduling priority of the job definition.
default Object	getTags()	The tags that are applied to the job definition.
default Object	getTimeout()	The timeout time for jobs that are submitted with this job definition.
String	getType()	The type of job definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-type

getContainerProperties

@Stability(Stable)
@Nullable
default Object getContainerProperties()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-containerproperties

getEcsProperties

@Stability(Stable)
@Nullable
default Object getEcsProperties()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-ecsproperties

getEksProperties

@Stability(Stable)
@Nullable
default Object getEksProperties()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-eksproperties

getJobDefinitionName

@Stability(Stable)
@Nullable
default String getJobDefinitionName()

The name of the job definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-jobdefinitionname

getNodeProperties

@Stability(Stable)
@Nullable
default Object getNodeProperties()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-nodeproperties

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-parameters

getPlatformCapabilities

@Stability(Stable)
@Nullable
default List<String> getPlatformCapabilities()

The platform capabilities required by the job definition.

If no value is specified, it defaults to EC2 . Jobs run on Fargate resources specify FARGATE .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-platformcapabilities

getPropagateTags

@Stability(Stable)
@Nullable
default Object getPropagateTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-propagatetags

getRetryStrategy

@Stability(Stable)
@Nullable
default Object getRetryStrategy()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-retrystrategy

getSchedulingPriority

@Stability(Stable)
@Nullable
default Number getSchedulingPriority()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-schedulingpriority

getTags

@Stability(Stable)
@Nullable
default Object getTags()

The tags that are applied to the job definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-tags

getTimeout

@Stability(Stable)
@Nullable
default Object getTimeout()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-timeout

builder

@Stability(Stable)
static CfnJobDefinitionProps.Builder builder()

Returns:

a CfnJobDefinitionProps.Builder of CfnJobDefinitionProps