Package software.amazon.awscdk.services.batch

Interface IJobDefinition.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IJobDefinition, IJobDefinitionRef, IJobDefinitionRef.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IEksJobDefinition.Jsii$Default
All Known Implementing Classes:
IEksJobDefinition.Jsii$Proxy, IJobDefinition.Jsii$Proxy
Enclosing interface:
IJobDefinition
@Internal public static interface IJobDefinition.Jsii$Default extends IJobDefinition, IResource.Jsii$Default, IJobDefinitionRef.Jsii$Default
Internal default implementation for IJobDefinition.

  • Method Details

    • getJobDefinitionArn

      @Stability(Stable) @NotNull default String getJobDefinitionArn()
      The ARN of this job definition.
      Specified by:
      getJobDefinitionArn in interface IJobDefinition

    • getJobDefinitionName

      @Stability(Stable) @NotNull default String getJobDefinitionName()
      The name of this job definition.
      Specified by:
      getJobDefinitionName in interface IJobDefinition

    • getRetryStrategies

      @Stability(Stable) @NotNull default List<RetryStrategy> getRetryStrategies()
      Defines the retry behavior for this job.

      Default: - no `RetryStrategy`

      Specified by:
      getRetryStrategies in interface IJobDefinition

    • getParameters

      @Stability(Stable) @Nullable default Map<String,Object> getParameters()
      The default parameters passed to the container These parameters can be referenced in the command that you give to the container.

      Default: none

      Specified by:
      getParameters in interface IJobDefinition
      See Also:

    • getRetryAttempts

      @Stability(Stable) @Nullable default Number getRetryAttempts()
      The number of times to retry a job.

      The job is retried on failure the same number of attempts as the value.

      Default: 1

      Specified by:
      getRetryAttempts in interface IJobDefinition

    • getSchedulingPriority

      @Stability(Stable) @Nullable default Number getSchedulingPriority()
      The priority of this Job.

      Only used in Fairshare Scheduling to decide which job to run first when there are multiple jobs with the same share identifier.

      Default: none

      Specified by:
      getSchedulingPriority in interface IJobDefinition

    • getTimeout

      @Stability(Stable) @Nullable default Duration getTimeout()
      The timeout time for jobs that are submitted with this job definition.

      After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

      Default: - no timeout

      Specified by:
      getTimeout in interface IJobDefinition

    • addRetryStrategy

      @Stability(Stable) default void addRetryStrategy(@NotNull RetryStrategy strategy)
      Add a RetryStrategy to this JobDefinition.

      Specified by:
      addRetryStrategy in interface IJobDefinition
      Parameters:
      strategy - This parameter is required.