@Stability(value=Experimental) public static final class JobDefinition.Builder extends Object implements software.amazon.jsii.Builder<JobDefinition>
JobDefinition
.Modifier and Type | Method and Description |
---|---|
JobDefinition |
build() |
JobDefinition.Builder |
container(JobDefinitionContainer container)
(experimental) An object with various properties specific to container-based jobs.
|
static JobDefinition.Builder |
create(software.constructs.Construct scope,
String id) |
JobDefinition.Builder |
jobDefinitionName(String jobDefinitionName)
(experimental) The name of the job definition.
|
JobDefinition.Builder |
nodeProps(IMultiNodeProps nodeProps)
(experimental) An object with various properties specific to multi-node parallel jobs.
|
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.
|
JobDefinition.Builder |
platformCapabilities(List<? extends PlatformCapabilities> platformCapabilities)
(experimental) The platform capabilities required by the job definition.
|
JobDefinition.Builder |
retryAttempts(Number retryAttempts)
(experimental) The number of times to move a job to the RUNNABLE status.
|
JobDefinition.Builder |
timeout(Duration timeout)
(experimental) The timeout configuration for jobs that are submitted with this job definition.
|
@Stability(value=Experimental) public static JobDefinition.Builder create(software.constructs.Construct scope, String id)
scope
- This parameter is required.id
- This parameter is required.JobDefinition.Builder
.@Stability(value=Experimental) public JobDefinition.Builder container(JobDefinitionContainer container)
container
- An object with various properties specific to container-based jobs. This parameter is required.this
@Stability(value=Experimental) public JobDefinition.Builder jobDefinitionName(String jobDefinitionName)
Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
Default: Cloudformation-generated name
jobDefinitionName
- The name of the job definition. This parameter is required.this
@Stability(value=Experimental) public JobDefinition.Builder nodeProps(IMultiNodeProps nodeProps)
Default: - undefined
nodeProps
- An object with various properties specific to multi-node parallel jobs. This parameter is required.this
@Stability(value=Experimental) public JobDefinition.Builder parameters(Map<String,String> 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
- 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.this
@Stability(value=Experimental) public JobDefinition.Builder platformCapabilities(List<? extends PlatformCapabilities> platformCapabilities)
Default: - EC2
platformCapabilities
- The platform capabilities required by the job definition. This parameter is required.this
@Stability(value=Experimental) public JobDefinition.Builder retryAttempts(Number retryAttempts)
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
retryAttempts
- The number of times to move a job to the RUNNABLE status. This parameter is required.this
@Stability(value=Experimental) public JobDefinition.Builder timeout(Duration timeout)
You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.
Default: - undefined
timeout
- The timeout configuration for jobs that are submitted with this job definition. This parameter is required.this
@Stability(value=Experimental) public JobDefinition build()
build
in interface software.amazon.jsii.Builder<JobDefinition>
Copyright © 2023. All rights reserved.