Package software.amazon.awscdk.services.batch

Class JobDefinition.Builder

java.lang.Object
software.amazon.awscdk.services.batch.JobDefinition.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<JobDefinition>
Enclosing class:
JobDefinition
@Stability(Experimental) public static final class JobDefinition.Builder extends Object implements software.amazon.jsii.Builder<JobDefinition>
(experimental) A fluent builder for JobDefinition.

  • Method Details

    • create

      @Stability(Experimental) public static JobDefinition.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of JobDefinition.Builder.

    • container

      @Stability(Experimental) public JobDefinition.Builder container(JobDefinitionContainer container)
      (experimental) An object with various properties specific to container-based jobs.

      Parameters:
      container - An object with various properties specific to container-based jobs. This parameter is required.
      Returns:
      this

    • jobDefinitionName

      @Stability(Experimental) public JobDefinition.Builder jobDefinitionName(String jobDefinitionName)
      (experimental) The name of the job definition.

      Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

      Default: Cloudformation-generated name

      Parameters:
      jobDefinitionName - The name of the job definition. This parameter is required.
      Returns:
      this

    • nodeProps

      @Stability(Experimental) public JobDefinition.Builder nodeProps(IMultiNodeProps nodeProps)
      (experimental) An object with various properties specific to multi-node parallel jobs.

      Default: - undefined

      Parameters:
      nodeProps - An object with various properties specific to multi-node parallel jobs. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Experimental) public JobDefinition.Builder parameters(Map<String,String> parameters)
      (experimental) When you submit a job, you can specify parameters that should replace the placeholders or override the default job definition parameters.

      Parameters in job submission requests take precedence over the defaults in a job definition. This allows you to use the same job definition for multiple jobs that use the same format, and programmatically change values in the command at submission time.

      Default: - undefined

      Parameters:
      parameters - When you submit a job, you can specify parameters that should replace the placeholders or override the default job definition parameters. This parameter is required.
      Returns:
      this

    • platformCapabilities

      @Stability(Experimental) public JobDefinition.Builder platformCapabilities(List<? extends PlatformCapabilities> platformCapabilities)
      (experimental) The platform capabilities required by the job definition.

      Default: - EC2

      Parameters:
      platformCapabilities - The platform capabilities required by the job definition. This parameter is required.
      Returns:
      this

    • retryAttempts

      @Stability(Experimental) public JobDefinition.Builder retryAttempts(Number retryAttempts)
      (experimental) The number of times to move a job to the RUNNABLE status.

      You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

      Default: 1

      Parameters:
      retryAttempts - The number of times to move a job to the RUNNABLE status. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Experimental) public JobDefinition.Builder timeout(Duration timeout)
      (experimental) The timeout configuration for jobs that are submitted with this job definition.

      You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.

      Default: - undefined

      Parameters:
      timeout - The timeout configuration for jobs that are submitted with this job definition. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public JobDefinition build()
      Specified by:
      build in interface software.amazon.jsii.Builder<JobDefinition>
      Returns:
      a newly built instance of JobDefinition.