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, IJobDefinitionRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:59.534Z") @Stability(Stable) public class CfnJobDefinition extends CfnResource implements IInspectable, IJobDefinitionRef, 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:

  • 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)
      Create a new AWS::Batch::JobDefinition.

      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

    • fromJobDefinitionArn

      @Stability(Stable) @NotNull public static IJobDefinitionRef fromJobDefinitionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IJobDefinitionRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromJobDefinitionName

      @Stability(Stable) @NotNull public static IJobDefinitionRef fromJobDefinitionName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String jobDefinitionName)
      Creates a new IJobDefinitionRef from a jobDefinitionName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      jobDefinitionName - This parameter is required.

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

    • getAttrJobDefinitionArn

      @Stability(Stable) @NotNull public String getAttrJobDefinitionArn()
      The job definition ARN, such as batch: *us-east-1* : *111122223333* :job-definition/ *test-gpu* : *2* .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getJobDefinitionRef

      @Stability(Stable) @NotNull public JobDefinitionReference getJobDefinitionRef()
      A reference to a JobDefinition resource.
      Specified by:
      getJobDefinitionRef in interface IJobDefinitionRef

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

    • getConsumableResourceProperties

      @Stability(Stable) @Nullable public Object getConsumableResourceProperties()
      Contains a list of consumable resources required by the job.

      Returns union: either IResolvable or CfnJobDefinition.ConsumableResourcePropertiesProperty

    • setConsumableResourceProperties

      @Stability(Stable) public void setConsumableResourceProperties(@Nullable IResolvable value)
      Contains a list of consumable resources required by the job.

    • setConsumableResourceProperties

      @Stability(Stable) public void setConsumableResourceProperties(@Nullable CfnJobDefinition.ConsumableResourcePropertiesProperty value)
      Contains a list of consumable resources required by the job.

    • getContainerProperties

      @Stability(Stable) @Nullable public Object getContainerProperties()
      An object with properties specific to Amazon ECS-based jobs.

      Returns union: either IResolvable or CfnJobDefinition.ContainerPropertiesProperty

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

      Returns union: either IResolvable or CfnJobDefinition.EcsPropertiesProperty

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

      Returns union: either IResolvable or CfnJobDefinition.EksPropertiesProperty

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

      Returns union: either IResolvable or CfnJobDefinition.NodePropertiesProperty

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

      Returns union: either Boolean or IResolvable

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

    • getResourceRetentionPolicy

      @Stability(Stable) @Nullable public Object getResourceRetentionPolicy()
      Specifies the resource retention policy settings for the job definition.

      Returns union: either IResolvable or CfnJobDefinition.ResourceRetentionPolicyProperty

    • setResourceRetentionPolicy

      @Stability(Stable) public void setResourceRetentionPolicy(@Nullable IResolvable value)
      Specifies the resource retention policy settings for the job definition.

    • setResourceRetentionPolicy

      @Stability(Stable) public void setResourceRetentionPolicy(@Nullable CfnJobDefinition.ResourceRetentionPolicyProperty value)
      Specifies the resource retention policy settings for the job definition.

    • getRetryStrategy

      @Stability(Stable) @Nullable public Object getRetryStrategy()
      The retry strategy to use for failed jobs that are submitted with this job definition.

      Returns union: either IResolvable or CfnJobDefinition.RetryStrategyProperty

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

      Returns union: either IResolvable or CfnJobDefinition.TimeoutProperty

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