Package software.amazon.awscdk.services.batch

Class CfnJobDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.batch.CfnJobDefinition

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:13.184Z")
@Stability(Stable)
public class CfnJobDefinition
extends CfnResource
implements IInspectable, ITaggable

The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.

For more information, see Job Definitions in the ** .

Example:

See Also:

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

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.EcsPropertiesProperty	An object that contains the properties for the Amazon ECS resources of a job.
static interface	CfnJobDefinition.EcsTaskPropertiesProperty	The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.
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	Specifies the configuration of a Kubernetes secret volume.
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	The amount of ephemeral storage to allocate for the task.
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.ImagePullSecretProperty	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	Metadata about the Kubernetes pod.
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	This is 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.RepositoryCredentialsProperty	The repository credentials for private registry authentication.
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.RuntimePlatformProperty	An object that represents the compute environment architecture for AWS Batch jobs on Fargate.
static interface	CfnJobDefinition.SecretProperty	An object that represents the secret to expose to your container.
static interface	CfnJobDefinition.SecurityContextProperty	Example:
static interface	CfnJobDefinition.TaskContainerDependencyProperty	A list of containers that this task depends on.
static interface	CfnJobDefinition.TaskContainerPropertiesProperty	Container properties are used for Amazon ECS-based job definitions.
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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.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
protected	CfnJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)
	CfnJobDefinition(software.constructs.Construct scope, String id, CfnJobDefinitionProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
Object	getContainerProperties()	An object with properties specific to Amazon ECS-based jobs.
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 .
Object	getEksProperties()	An object with properties that are specific to Amazon EKS-based jobs.
String	getJobDefinitionName()	The name of the job definition.
Object	getNodeProperties()	An object with 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()	Tag Manager which manages the tags for this resource.
Object	getTagsRaw()	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 properties specific to Amazon ECS-based jobs.
void	setContainerProperties(CfnJobDefinition.ContainerPropertiesProperty value)	An object with properties specific to Amazon ECS-based jobs.
void	setEcsProperties(IResolvable value)	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 .
void	setEcsProperties(CfnJobDefinition.EcsPropertiesProperty value)	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 .
void	setEksProperties(IResolvable value)	An object with properties that are specific to Amazon EKS-based jobs.
void	setEksProperties(CfnJobDefinition.EksPropertiesProperty value)	An object with 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 properties that are specific to multi-node parallel jobs.
void	setNodeProperties(CfnJobDefinition.NodePropertiesProperty value)	An object with 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	setTagsRaw(Object value)	The tags that are applied to 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.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnJobDefinitionProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). 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.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getType

@Stability(Stable)
@NotNull
public String getType()

The type of job definition.

setType

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

The type of job definition.

getContainerProperties

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

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

setContainerProperties

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

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

setContainerProperties

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

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

getEcsProperties

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

setEcsProperties

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

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 .

setEcsProperties

@Stability(Stable)
public void setEcsProperties(@Nullable
 CfnJobDefinition.EcsPropertiesProperty value)

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 .

getEksProperties

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

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

setEksProperties

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

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

setEksProperties

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

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

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 properties that are specific to multi-node parallel jobs.

setNodeProperties

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

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

setNodeProperties

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

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

getParameters

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

Default parameters or parameter substitution placeholders that are set in the job definition.

setParameters

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

Default parameters or parameter substitution placeholders that are set in the job definition.

getPlatformCapabilities

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

The platform capabilities required by the job definition.

setPlatformCapabilities

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

The platform capabilities required by the job definition.

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.

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.

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.

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.

setSchedulingPriority

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

The scheduling priority of the job definition.

getTagsRaw

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

The tags that are applied to the job definition.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 Object value)

The tags that are applied to the job definition.

getTimeout

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

The timeout time for jobs that are submitted with this job definition.

setTimeout

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

The timeout time for jobs that are submitted with this job definition.

setTimeout

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

The timeout time for jobs that are submitted with this job definition.