Class BatchSubmitJobProps
Properties for RunBatchJob.
Inheritance
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class BatchSubmitJobProps : Object, IBatchSubmitJobProps, ITaskStateBaseProps
Syntax (vb)
Public Class BatchSubmitJobProps
Inherits Object
Implements IBatchSubmitJobProps, ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.Batch;
JobDefinition batchJobDefinition;
JobQueue batchQueue;
var task = new BatchSubmitJob(this, "Submit Job", new BatchSubmitJobProps {
JobDefinitionArn = batchJobDefinition.JobDefinitionArn,
JobName = "MyJob",
JobQueueArn = batchQueue.JobQueueArn
});
Synopsis
Constructors
BatchSubmitJobProps() |
Properties
ArraySize | The array size can be between 2 and 10,000. |
Attempts | The number of times to move a job to the RUNNABLE status. |
Comment | An optional description for this state. |
ContainerOverrides | 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. |
DependsOn | A list of dependencies for the job. |
Heartbeat | Timeout for the heartbeat. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
IntegrationPattern | AWS Step Functions integrates with services directly in the Amazon States Language. |
JobDefinitionArn | The arn of the job definition used by this job. |
JobName | The name of the job. |
JobQueueArn | The arn of the job queue into which the job is submitted. |
OutputPath | JSONPath expression to select select a portion of the state output to pass to the next state. |
Payload | The payload to be passed as parameters to the batch job. |
ResultPath | JSONPath expression to indicate where to inject the state's output. |
ResultSelector | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
Timeout | Timeout for the state machine. |
Constructors
BatchSubmitJobProps()
public BatchSubmitJobProps()
Properties
ArraySize
The array size can be between 2 and 10,000.
public Nullable<double> ArraySize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
Attempts
The number of times to move a job to the RUNNABLE status.
public Nullable<double> Attempts { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: - No comment
ContainerOverrides
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.
public IBatchContainerOverrides ContainerOverrides { get; set; }
Property Value
Remarks
Default: - No container overrides
DependsOn
A list of dependencies for the job.
public IBatchJobDependency[] DependsOn { get; set; }
Property Value
Remarks
A job can depend upon a maximum of 20 jobs.
Default: - No dependencies
Heartbeat
Timeout for the heartbeat.
public Duration Heartbeat { get; set; }
Property Value
Remarks
Default: - None
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string InputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }
Property Value
System.Nullable<IntegrationPattern>
Remarks
You can control these AWS services using service integration patterns
Default: - IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
JobDefinitionArn
The arn of the job definition used by this job.
public string JobDefinitionArn { get; set; }
Property Value
System.String
JobName
The name of the job.
public string JobName { get; set; }
Property Value
System.String
Remarks
The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
JobQueueArn
The arn of the job queue into which the job is submitted.
public string JobQueueArn { get; set; }
Property Value
System.String
OutputPath
JSONPath expression to select select a portion of the state output to pass to the next state.
public string OutputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
Payload
The payload to be passed as parameters to the batch job.
public TaskInput Payload { get; set; }
Property Value
Remarks
Default: - No parameters are passed
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string ResultPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
ResultSelector
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
public IDictionary<string, object> ResultSelector { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
Timeout
Timeout for the state machine.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: - None