Package software.amazon.awscdk.services.batch

Class CfnJobDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.batch.CfnJobDefinition

All Implemented Interfaces:

IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.552Z")
@Stability(Stable)
public class CfnJobDefinition
extends CfnResource
implements IInspectable

A CloudFormation AWS::Batch::JobDefinition.

The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition. For more information, see Job Definitions in the ** .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 Object labels;
 Object limits;
 Object options;
 Object parameters;
 Object requests;
 Object tags;
 CfnJobDefinition cfnJobDefinition = CfnJobDefinition.Builder.create(this, "MyCfnJobDefinition")
         .type("type")
         // the properties below are optional
         .containerProperties(ContainerPropertiesProperty.builder()
                 .image("image")
                 // the properties below are optional
                 .command(List.of("command"))
                 .environment(List.of(EnvironmentProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .ephemeralStorage(EphemeralStorageProperty.builder()
                         .sizeInGiB(123)
                         .build())
                 .executionRoleArn("executionRoleArn")
                 .fargatePlatformConfiguration(FargatePlatformConfigurationProperty.builder()
                         .platformVersion("platformVersion")
                         .build())
                 .instanceType("instanceType")
                 .jobRoleArn("jobRoleArn")
                 .linuxParameters(LinuxParametersProperty.builder()
                         .devices(List.of(DeviceProperty.builder()
                                 .containerPath("containerPath")
                                 .hostPath("hostPath")
                                 .permissions(List.of("permissions"))
                                 .build()))
                         .initProcessEnabled(false)
                         .maxSwap(123)
                         .sharedMemorySize(123)
                         .swappiness(123)
                         .tmpfs(List.of(TmpfsProperty.builder()
                                 .containerPath("containerPath")
                                 .size(123)
                                 // the properties below are optional
                                 .mountOptions(List.of("mountOptions"))
                                 .build()))
                         .build())
                 .logConfiguration(LogConfigurationProperty.builder()
                         .logDriver("logDriver")
                         // the properties below are optional
                         .options(options)
                         .secretOptions(List.of(SecretProperty.builder()
                                 .name("name")
                                 .valueFrom("valueFrom")
                                 .build()))
                         .build())
                 .memory(123)
                 .mountPoints(List.of(MountPointsProperty.builder()
                         .containerPath("containerPath")
                         .readOnly(false)
                         .sourceVolume("sourceVolume")
                         .build()))
                 .networkConfiguration(NetworkConfigurationProperty.builder()
                         .assignPublicIp("assignPublicIp")
                         .build())
                 .privileged(false)
                 .readonlyRootFilesystem(false)
                 .resourceRequirements(List.of(ResourceRequirementProperty.builder()
                         .type("type")
                         .value("value")
                         .build()))
                 .secrets(List.of(SecretProperty.builder()
                         .name("name")
                         .valueFrom("valueFrom")
                         .build()))
                 .ulimits(List.of(UlimitProperty.builder()
                         .hardLimit(123)
                         .name("name")
                         .softLimit(123)
                         .build()))
                 .user("user")
                 .vcpus(123)
                 .volumes(List.of(VolumesProperty.builder()
                         .efsVolumeConfiguration(EfsVolumeConfigurationProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 // the properties below are optional
                                 .authorizationConfig(AuthorizationConfigProperty.builder()
                                         .accessPointId("accessPointId")
                                         .iam("iam")
                                         .build())
                                 .rootDirectory("rootDirectory")
                                 .transitEncryption("transitEncryption")
                                 .transitEncryptionPort(123)
                                 .build())
                         .host(VolumesHostProperty.builder()
                                 .sourcePath("sourcePath")
                                 .build())
                         .name("name")
                         .build()))
                 .build())
         .eksProperties(EksPropertiesProperty.builder()
                 .podProperties(PodPropertiesProperty.builder()
                         .containers(List.of(EksContainerProperty.builder()
                                 .image("image")
                                 // the properties below are optional
                                 .args(List.of("args"))
                                 .command(List.of("command"))
                                 .env(List.of(EksContainerEnvironmentVariableProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .value("value")
                                         .build()))
                                 .imagePullPolicy("imagePullPolicy")
                                 .name("name")
                                 .resources(ResourcesProperty.builder()
                                         .limits(limits)
                                         .requests(requests)
                                         .build())
                                 .securityContext(SecurityContextProperty.builder()
                                         .privileged(false)
                                         .readOnlyRootFilesystem(false)
                                         .runAsGroup(123)
                                         .runAsNonRoot(false)
                                         .runAsUser(123)
                                         .build())
                                 .volumeMounts(List.of(EksContainerVolumeMountProperty.builder()
                                         .mountPath("mountPath")
                                         .name("name")
                                         .readOnly(false)
                                         .build()))
                                 .build()))
                         .dnsPolicy("dnsPolicy")
                         .hostNetwork(false)
                         .metadata(MetadataProperty.builder()
                                 .labels(labels)
                                 .build())
                         .serviceAccountName("serviceAccountName")
                         .volumes(List.of(EksVolumeProperty.builder()
                                 .name("name")
                                 // the properties below are optional
                                 .emptyDir(EmptyDirProperty.builder()
                                         .medium("medium")
                                         .sizeLimit("sizeLimit")
                                         .build())
                                 .hostPath(HostPathProperty.builder()
                                         .path("path")
                                         .build())
                                 .secret(EksSecretProperty.builder()
                                         .secretName("secretName")
                                         // the properties below are optional
                                         .optional(false)
                                         .build())
                                 .build()))
                         .build())
                 .build())
         .jobDefinitionName("jobDefinitionName")
         .nodeProperties(NodePropertiesProperty.builder()
                 .mainNode(123)
                 .nodeRangeProperties(List.of(NodeRangePropertyProperty.builder()
                         .targetNodes("targetNodes")
                         // the properties below are optional
                         .container(ContainerPropertiesProperty.builder()
                                 .image("image")
                                 // the properties below are optional
                                 .command(List.of("command"))
                                 .environment(List.of(EnvironmentProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .ephemeralStorage(EphemeralStorageProperty.builder()
                                         .sizeInGiB(123)
                                         .build())
                                 .executionRoleArn("executionRoleArn")
                                 .fargatePlatformConfiguration(FargatePlatformConfigurationProperty.builder()
                                         .platformVersion("platformVersion")
                                         .build())
                                 .instanceType("instanceType")
                                 .jobRoleArn("jobRoleArn")
                                 .linuxParameters(LinuxParametersProperty.builder()
                                         .devices(List.of(DeviceProperty.builder()
                                                 .containerPath("containerPath")
                                                 .hostPath("hostPath")
                                                 .permissions(List.of("permissions"))
                                                 .build()))
                                         .initProcessEnabled(false)
                                         .maxSwap(123)
                                         .sharedMemorySize(123)
                                         .swappiness(123)
                                         .tmpfs(List.of(TmpfsProperty.builder()
                                                 .containerPath("containerPath")
                                                 .size(123)
                                                 // the properties below are optional
                                                 .mountOptions(List.of("mountOptions"))
                                                 .build()))
                                         .build())
                                 .logConfiguration(LogConfigurationProperty.builder()
                                         .logDriver("logDriver")
                                         // the properties below are optional
                                         .options(options)
                                         .secretOptions(List.of(SecretProperty.builder()
                                                 .name("name")
                                                 .valueFrom("valueFrom")
                                                 .build()))
                                         .build())
                                 .memory(123)
                                 .mountPoints(List.of(MountPointsProperty.builder()
                                         .containerPath("containerPath")
                                         .readOnly(false)
                                         .sourceVolume("sourceVolume")
                                         .build()))
                                 .networkConfiguration(NetworkConfigurationProperty.builder()
                                         .assignPublicIp("assignPublicIp")
                                         .build())
                                 .privileged(false)
                                 .readonlyRootFilesystem(false)
                                 .resourceRequirements(List.of(ResourceRequirementProperty.builder()
                                         .type("type")
                                         .value("value")
                                         .build()))
                                 .secrets(List.of(SecretProperty.builder()
                                         .name("name")
                                         .valueFrom("valueFrom")
                                         .build()))
                                 .ulimits(List.of(UlimitProperty.builder()
                                         .hardLimit(123)
                                         .name("name")
                                         .softLimit(123)
                                         .build()))
                                 .user("user")
                                 .vcpus(123)
                                 .volumes(List.of(VolumesProperty.builder()
                                         .efsVolumeConfiguration(EfsVolumeConfigurationProperty.builder()
                                                 .fileSystemId("fileSystemId")
                                                 // the properties below are optional
                                                 .authorizationConfig(AuthorizationConfigProperty.builder()
                                                         .accessPointId("accessPointId")
                                                         .iam("iam")
                                                         .build())
                                                 .rootDirectory("rootDirectory")
                                                 .transitEncryption("transitEncryption")
                                                 .transitEncryptionPort(123)
                                                 .build())
                                         .host(VolumesHostProperty.builder()
                                                 .sourcePath("sourcePath")
                                                 .build())
                                         .name("name")
                                         .build()))
                                 .build())
                         .build()))
                 .numNodes(123)
                 .build())
         .parameters(parameters)
         .platformCapabilities(List.of("platformCapabilities"))
         .propagateTags(false)
         .retryStrategy(RetryStrategyProperty.builder()
                 .attempts(123)
                 .evaluateOnExit(List.of(EvaluateOnExitProperty.builder()
                         .action("action")
                         // the properties below are optional
                         .onExitCode("onExitCode")
                         .onReason("onReason")
                         .onStatusReason("onStatusReason")
                         .build()))
                 .build())
         .schedulingPriority(123)
         .tags(tags)
         .timeout(TimeoutProperty.builder()
                 .attemptDurationSeconds(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnJobDefinition.AuthorizationConfigProperty	The authorization configuration details for the Amazon EFS file system.
static final class	CfnJobDefinition.Builder	A fluent builder for CfnJobDefinition.
static interface	CfnJobDefinition.ContainerPropertiesProperty	Container properties are used for Amazon ECS based job definitions.
static interface	CfnJobDefinition.DeviceProperty	An object that represents a container instance host device.
static interface	CfnJobDefinition.EfsVolumeConfigurationProperty	This is used when you're using an Amazon Elastic File System file system for job storage.
static interface	CfnJobDefinition.EksContainerEnvironmentVariableProperty	An environment variable.
static interface	CfnJobDefinition.EksContainerProperty	EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job.
static interface	CfnJobDefinition.EksContainerVolumeMountProperty	The volume mounts for a container for an Amazon EKS job.
static interface	CfnJobDefinition.EksPropertiesProperty	An object that contains the properties for the Kubernetes resources of a job.
static interface	CfnJobDefinition.EksSecretProperty	Example:
static interface	CfnJobDefinition.EksVolumeProperty	Specifies an Amazon EKS volume for a job definition.
static interface	CfnJobDefinition.EmptyDirProperty	Example:
static interface	CfnJobDefinition.EnvironmentProperty	The Environment property type specifies environment variables to use in a job definition.
static interface	CfnJobDefinition.EphemeralStorageProperty	Example:
static interface	CfnJobDefinition.EvaluateOnExitProperty	Specifies an array of up to 5 conditions to be met, and an action to take ( RETRY or EXIT ) if all conditions are met.
static interface	CfnJobDefinition.FargatePlatformConfigurationProperty	The platform configuration for jobs that are running on Fargate resources.
static interface	CfnJobDefinition.HostPathProperty	Example:
static interface	CfnJobDefinition.LinuxParametersProperty	Linux-specific modifications that are applied to the container, such as details for device mappings.
static interface	CfnJobDefinition.LogConfigurationProperty	Log configuration options to send to a custom log driver for the container.
static interface	CfnJobDefinition.MetadataProperty	Example:
static interface	CfnJobDefinition.MountPointsProperty	Details for a Docker volume mount point that's used in a job's container properties.
static interface	CfnJobDefinition.NetworkConfigurationProperty	The network configuration for jobs that are running on Fargate resources.
static interface	CfnJobDefinition.NodePropertiesProperty	An object that represents the node properties of a multi-node parallel job.
static interface	CfnJobDefinition.NodeRangePropertyProperty	An object that represents the properties of the node range for a multi-node parallel job.
static interface	CfnJobDefinition.PodPropertiesProperty	The properties for the pod.
static interface	CfnJobDefinition.ResourceRequirementProperty	The type and amount of a resource to assign to a container.
static interface	CfnJobDefinition.ResourcesProperty	Example:
static interface	CfnJobDefinition.RetryStrategyProperty	The retry strategy that's associated with a job.
static interface	CfnJobDefinition.SecretProperty	An object that represents the secret to expose to your container.
static interface	CfnJobDefinition.SecurityContextProperty	Example:
static interface	CfnJobDefinition.TimeoutProperty	An object that represents a job timeout configuration.
static interface	CfnJobDefinition.TmpfsProperty	The container path, mount options, and size of the tmpfs mount.
static interface	CfnJobDefinition.UlimitProperty	The ulimit settings to pass to the container.
static interface	CfnJobDefinition.VolumesHostProperty	Determine whether your data volume persists on the host container instance and where it's stored.
static interface	CfnJobDefinition.VolumesProperty	A list of volumes that are associated with the job.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnJobDefinition(Construct scope, String id, CfnJobDefinitionProps props)	Create a new AWS::Batch::JobDefinition.
protected	CfnJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
Object	getContainerProperties()	An object with various properties specific to Amazon ECS based jobs.
Object	getEksProperties()	An object with various properties that are specific to Amazon EKS based jobs.
String	getJobDefinitionName()	The name of the job definition.
Object	getNodeProperties()	An object with various properties that are specific to multi-node parallel jobs.
Object	getParameters()	Default parameters or parameter substitution placeholders that are set in the job definition.
List<String>	getPlatformCapabilities()	The platform capabilities required by the job definition.
Object	getPropagateTags()	Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
Object	getRetryStrategy()	The retry strategy to use for failed jobs that are submitted with this job definition.
Number	getSchedulingPriority()	The scheduling priority of the job definition.
TagManager	getTags()	The tags that are applied to the job definition.
Object	getTimeout()	The timeout time for jobs that are submitted with this job definition.
String	getType()	The type of job definition.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContainerProperties(IResolvable value)	An object with various properties specific to Amazon ECS based jobs.
void	setContainerProperties(CfnJobDefinition.ContainerPropertiesProperty value)	An object with various properties specific to Amazon ECS based jobs.
void	setEksProperties(IResolvable value)	An object with various properties that are specific to Amazon EKS based jobs.
void	setEksProperties(CfnJobDefinition.EksPropertiesProperty value)	An object with various properties that are specific to Amazon EKS based jobs.
void	setJobDefinitionName(String value)	The name of the job definition.
void	setNodeProperties(IResolvable value)	An object with various properties that are specific to multi-node parallel jobs.
void	setNodeProperties(CfnJobDefinition.NodePropertiesProperty value)	An object with various properties that are specific to multi-node parallel jobs.
void	setParameters(Object value)	Default parameters or parameter substitution placeholders that are set in the job definition.
void	setPlatformCapabilities(List<String> value)	The platform capabilities required by the job definition.
void	setPropagateTags(Boolean value)	Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
void	setPropagateTags(IResolvable value)	Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
void	setRetryStrategy(IResolvable value)	The retry strategy to use for failed jobs that are submitted with this job definition.
void	setRetryStrategy(CfnJobDefinition.RetryStrategyProperty value)	The retry strategy to use for failed jobs that are submitted with this job definition.
void	setSchedulingPriority(Number value)	The scheduling priority of the job definition.
void	setTimeout(IResolvable value)	The timeout time for jobs that are submitted with this job definition.
void	setTimeout(CfnJobDefinition.TimeoutProperty value)	The timeout time for jobs that are submitted with this job definition.
void	setType(String value)	The type of job definition.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnJobDefinition

protected CfnJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

CfnJobDefinition

protected CfnJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnJobDefinition

@Stability(Stable)
public CfnJobDefinition(@NotNull
 Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnJobDefinitionProps props)

Create a new AWS::Batch::JobDefinition.

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

props -

• resource properties.

This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector -

• tree inspector to collect and process attributes.

This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

The tags that are applied to the job definition.

getParameters

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

setParameters

@Stability(Stable)
public void setParameters(@NotNull
 Object value)

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 .

getType

@Stability(Stable)
@NotNull
public 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 job is run on Fargate resources, then multinode isn't supported.

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

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.

getContainerProperties

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

An object with various properties specific to Amazon ECS based jobs.

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

setContainerProperties

@Stability(Stable)
public void setContainerProperties(@Nullable
 IResolvable value)

An object with various properties specific to Amazon ECS based jobs.

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

setContainerProperties

@Stability(Stable)
public void setContainerProperties(@Nullable
 CfnJobDefinition.ContainerPropertiesProperty value)

An object with various properties specific to Amazon ECS based jobs.

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

getEksProperties

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

An object with various properties that are specific to Amazon EKS based jobs.

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

setEksProperties

@Stability(Stable)
public void setEksProperties(@Nullable
 IResolvable value)

An object with various properties that are specific to Amazon EKS based jobs.

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

setEksProperties

@Stability(Stable)
public void setEksProperties(@Nullable
 CfnJobDefinition.EksPropertiesProperty value)

An object with various properties that are specific to Amazon EKS based jobs.

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

getJobDefinitionName

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

The name of the job definition.

setJobDefinitionName

@Stability(Stable)
public void setJobDefinitionName(@Nullable
 String value)

The name of the job definition.

getNodeProperties

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

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

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

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

setNodeProperties

@Stability(Stable)
public void setNodeProperties(@Nullable
 IResolvable value)

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

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

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

setNodeProperties

@Stability(Stable)
public void setNodeProperties(@Nullable
 CfnJobDefinition.NodePropertiesProperty value)

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

Valid values are containerProperties , eksProperties , and nodeProperties . Only one can be specified.

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

getPlatformCapabilities

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

setPlatformCapabilities

@Stability(Stable)
public void setPlatformCapabilities(@Nullable
 List<String> value)

The platform capabilities required by the job definition.

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

getPropagateTags

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

setPropagateTags

@Stability(Stable)
public void setPropagateTags(@Nullable
 Boolean value)

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.

setPropagateTags

@Stability(Stable)
public void setPropagateTags(@Nullable
 IResolvable value)

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.

getRetryStrategy

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

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

setRetryStrategy

@Stability(Stable)
public void setRetryStrategy(@Nullable
 IResolvable value)

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

setRetryStrategy

@Stability(Stable)
public void setRetryStrategy(@Nullable
 CfnJobDefinition.RetryStrategyProperty value)

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

getSchedulingPriority

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

setSchedulingPriority

@Stability(Stable)
public void setSchedulingPriority(@Nullable
 Number value)

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.

getTimeout

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

setTimeout

@Stability(Stable)
public void setTimeout(@Nullable
 IResolvable value)

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.

setTimeout

@Stability(Stable)
public void setTimeout(@Nullable
 CfnJobDefinition.TimeoutProperty value)

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.