Package software.amazon.awscdk.services.batch

Interface JobDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.664Z")
@Stability(Experimental)
public interface JobDefinitionProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Construction properties of the JobDefinition construct.

Example:

 import software.amazon.awscdk.services.ssm.*;
 JobDefinition.Builder.create(this, "job-def")
         .container(JobDefinitionContainer.builder()
                 .image(EcrImage.fromRegistry("docker/whalesay"))
                 .logConfiguration(LogConfiguration.builder()
                         .logDriver(LogDriver.AWSLOGS)
                         .options(Map.of("awslogs-region", "us-east-1"))
                         .secretOptions(List.of(ExposedSecret.fromParametersStore("xyz", StringParameter.fromStringParameterName(this, "parameter", "xyz"))))
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	JobDefinitionProps.Builder	A builder for JobDefinitionProps
static final class	JobDefinitionProps.Jsii$Proxy	An implementation for JobDefinitionProps

Method Summary

Modifier and Type	Method	Description
static JobDefinitionProps.Builder	builder()
JobDefinitionContainer	getContainer()	(experimental) An object with various properties specific to container-based jobs.
default String	getJobDefinitionName()	(experimental) The name of the job definition.
default IMultiNodeProps	getNodeProps()	(experimental) An object with various properties specific to multi-node parallel jobs.
default Map<String,String>	getParameters()	(experimental) When you submit a job, you can specify parameters that should replace the placeholders or override the default job definition parameters.
default List<PlatformCapabilities>	getPlatformCapabilities()	(experimental) The platform capabilities required by the job definition.
default Number	getRetryAttempts()	(experimental) The number of times to move a job to the RUNNABLE status.
default Duration	getTimeout()	(experimental) The timeout configuration for jobs that are submitted with this job definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainer

@Stability(Experimental)
@NotNull
JobDefinitionContainer getContainer()

(experimental) An object with various properties specific to container-based jobs.

getJobDefinitionName

@Stability(Experimental)
@Nullable
default String getJobDefinitionName()

(experimental) The name of the job definition.

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

Default: Cloudformation-generated name

getNodeProps

@Stability(Experimental)
@Nullable
default IMultiNodeProps getNodeProps()

(experimental) An object with various properties specific to multi-node parallel jobs.

Default: - undefined

getParameters

@Stability(Experimental)
@Nullable
default Map<String,String> getParameters()

(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

getPlatformCapabilities

@Stability(Experimental)
@Nullable
default List<PlatformCapabilities> getPlatformCapabilities()

(experimental) The platform capabilities required by the job definition.

Default: - EC2

getRetryAttempts

@Stability(Experimental)
@Nullable
default Number getRetryAttempts()

(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

getTimeout

@Stability(Experimental)
@Nullable
default Duration getTimeout()

(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

builder

@Stability(Experimental)
static JobDefinitionProps.Builder builder()

Returns:

a JobDefinitionProps.Builder of JobDefinitionProps