Interface IBatchSubmitJobProps
Properties for RunBatchJob.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBatchSubmitJobProps : ITaskStateBaseProps
Syntax (vb)
Public Interface IBatchSubmitJobProps
Inherits ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.Batch;
EcsJobDefinition batchJobDefinition;
JobQueue batchQueue;
var task = new BatchSubmitJob(this, "Submit Job", new BatchSubmitJobProps {
JobDefinitionArn = batchJobDefinition.JobDefinitionArn,
JobName = "MyJob",
JobQueueArn = batchQueue.JobQueueArn
});
Synopsis
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. |
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. |
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. |
Payload | The payload to be passed as parameters to the batch job. |
Tags | The tags applied to the job request. |
Properties
ArraySize
The array size can be between 2 and 10,000.
virtual Nullable<double> ArraySize { get; }
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.
virtual Nullable<double> Attempts { get; }
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
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.
virtual IBatchContainerOverrides ContainerOverrides { get; }
Property Value
Remarks
Default: - No container overrides
DependsOn
A list of dependencies for the job.
virtual IBatchJobDependency[] DependsOn { get; }
Property Value
Remarks
A job can depend upon a maximum of 20 jobs.
Default: - No dependencies
JobDefinitionArn
The arn of the job definition used by this job.
string JobDefinitionArn { get; }
Property Value
System.String
JobName
The name of the job.
string JobName { get; }
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.
string JobQueueArn { get; }
Property Value
System.String
Payload
The payload to be passed as parameters to the batch job.
virtual TaskInput Payload { get; }
Property Value
Remarks
Default: - No parameters are passed
Tags
The tags applied to the job request.
virtual IDictionary<string, string> Tags { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: {} - no tags