software.amazon.awscdk.services.stepfunctions.tasks

Interface RunBatchJobProps

All Known Implementing Classes:

RunBatchJobProps.Jsii$Proxy

Deprecated.

use `BatchSubmitJob`

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.381Z")
 @Deprecated
public interface RunBatchJobProps

(deprecated) Properties for RunBatchJob.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.services.stepfunctions.tasks.*;
 import software.amazon.awscdk.core.*;
 InstanceType instanceType;
 Object payload;
 RunBatchJobProps runBatchJobProps = RunBatchJobProps.builder()
         .jobDefinitionArn("jobDefinitionArn")
         .jobName("jobName")
         .jobQueueArn("jobQueueArn")
         // the properties below are optional
         .arraySize(123)
         .attempts(123)
         .containerOverrides(ContainerOverrides.builder()
                 .command(List.of("command"))
                 .environment(Map.of(
                         "environmentKey", "environment"))
                 .gpuCount(123)
                 .instanceType(instanceType)
                 .memory(123)
                 .vcpus(123)
                 .build())
         .dependsOn(List.of(JobDependency.builder()
                 .jobId("jobId")
                 .type("type")
                 .build()))
         .integrationPattern(ServiceIntegrationPattern.FIRE_AND_FORGET)
         .payload(Map.of(
                 "payloadKey", payload))
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RunBatchJobProps.Builder Deprecated.
static class	RunBatchJobProps.Jsii$Proxy Deprecated.

Method Summary

Modifier and Type	Method and Description
static RunBatchJobProps.Builder	builder() Deprecated.
default java.lang.Number	getArraySize() Deprecated.
default java.lang.Number	getAttempts() Deprecated.
default ContainerOverrides	getContainerOverrides() Deprecated.
default java.util.List<JobDependency>	getDependsOn() Deprecated.
default ServiceIntegrationPattern	getIntegrationPattern() Deprecated.
java.lang.String	getJobDefinitionArn() Deprecated.
java.lang.String	getJobName() Deprecated.
java.lang.String	getJobQueueArn() Deprecated.
default java.util.Map<java.lang.String,java.lang.Object>	getPayload() Deprecated.
default Duration	getTimeout() Deprecated.

Method Detail

getJobDefinitionArn

@Deprecated
java.lang.String getJobDefinitionArn()

Deprecated.

(deprecated) The arn of the job definition used by this job.

getJobName

@Deprecated
java.lang.String getJobName()

Deprecated.

(deprecated) The name of the job.

The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

getJobQueueArn

@Deprecated
java.lang.String getJobQueueArn()

Deprecated.

(deprecated) The arn of the job queue into which the job is submitted.

getArraySize

@Deprecated
default java.lang.Number getArraySize()

Deprecated.

(deprecated) The array size can be between 2 and 10,000.

If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

Default: - No array size

getAttempts

@Deprecated
default java.lang.Number getAttempts()

Deprecated.

(deprecated) 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

getContainerOverrides

@Deprecated
default ContainerOverrides getContainerOverrides()

Deprecated.

(deprecated) A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.

Default: - No container overrides

See Also:

https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides

getDependsOn

@Deprecated
default java.util.List<JobDependency> getDependsOn()

Deprecated.

(deprecated) A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

Default: - No dependencies

See Also:

https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn

getIntegrationPattern

@Deprecated
default ServiceIntegrationPattern getIntegrationPattern()

Deprecated.

(deprecated) The service integration pattern indicates different ways to call TerminateCluster.

The valid value is either FIRE_AND_FORGET or SYNC.

Default: SYNC

getPayload

@Deprecated
default java.util.Map<java.lang.String,java.lang.Object> getPayload()

Deprecated.

(deprecated) The payload to be passed as parametrs to the batch job.

Default: - No parameters are passed

getTimeout

@Deprecated
default Duration getTimeout()

Deprecated.

(deprecated) The timeout configuration for this SubmitJob operation.

The minimum value for the timeout is 60 seconds.

Default: - No timeout

See Also:

https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-timeout

builder

@Deprecated
static RunBatchJobProps.Builder builder()

Deprecated.

Returns:

a RunBatchJobProps.Builder of RunBatchJobProps