software.amazon.awscdk.services.batch

Interface JobDefinitionProps

All Known Implementing Classes:

JobDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:05.688Z")
public interface JobDefinitionProps

(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 and Description
static class	JobDefinitionProps.Builder A builder for JobDefinitionProps
static class	JobDefinitionProps.Jsii$Proxy An implementation for JobDefinitionProps

Method Summary

Modifier and Type	Method and Description
static JobDefinitionProps.Builder	builder()
JobDefinitionContainer	getContainer() (experimental) An object with various properties specific to container-based jobs.
default java.lang.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 java.util.Map<java.lang.String,java.lang.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 java.util.List<PlatformCapabilities>	getPlatformCapabilities() (experimental) The platform capabilities required by the job definition.
default java.lang.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.

Method Detail

getContainer

JobDefinitionContainer getContainer()

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

getJobDefinitionName

default java.lang.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

default IMultiNodeProps getNodeProps()

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

Default: - undefined

getParameters

default java.util.Map<java.lang.String,java.lang.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

default java.util.List<PlatformCapabilities> getPlatformCapabilities()

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

Default: - EC2

getRetryAttempts

default java.lang.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

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

static JobDefinitionProps.Builder builder()

Returns:

a JobDefinitionProps.Builder of JobDefinitionProps