@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
date="2022-08-09T19:16:44.155Z")
public interface JobDefinitionProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
JobDefinitionProps.Builder
A builder for
JobDefinitionProps |
static class |
JobDefinitionProps.Jsii$Proxy
An implementation for
JobDefinitionProps |
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.
|
JobDefinitionContainer getContainer()
default java.lang.String getJobDefinitionName()
Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
Default: Cloudformation-generated name
default IMultiNodeProps getNodeProps()
Default: - undefined
default java.util.Map<java.lang.String,java.lang.String> getParameters()
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
default java.util.List<PlatformCapabilities> getPlatformCapabilities()
Default: - EC2
default java.lang.Number getRetryAttempts()
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
default Duration getTimeout()
You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.
Default: - undefined
static JobDefinitionProps.Builder builder()
JobDefinitionProps.Builder
of JobDefinitionProps