Interface IBatchSubmitJobJsonPathProps
Properties for BatchSubmitJob using JSONPath.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBatchSubmitJobJsonPathProps : ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptionsSyntax (vb)
Public Interface IBatchSubmitJobJsonPathProps
Inherits ITaskStateJsonPathBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptionsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
var assign;
InstanceType instanceType;
var resultSelector;
Size size;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
var batchSubmitJobJsonPathProps = new BatchSubmitJobJsonPathProps {
JobDefinitionArn = "jobDefinitionArn",
JobName = "jobName",
JobQueueArn = "jobQueueArn",
// the properties below are optional
ArraySize = 123,
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Attempts = 123,
Comment = "comment",
ContainerOverrides = new BatchContainerOverrides {
Command = new [] { "command" },
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
},
GpuCount = 123,
InstanceType = instanceType,
Memory = size,
Vcpus = 123
},
Credentials = new Credentials {
Role = taskRole
},
DependsOn = new [] { new BatchJobDependency {
JobId = "jobId",
Type = "type"
} },
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
OutputPath = "outputPath",
Payload = taskInput,
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
StateName = "stateName",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TaskTimeout = timeout,
Timeout = Duration.Minutes(30)
};Synopsis
Properties
| Array |
The array size can be between 2 and 10,000. |
| Attempts | The number of times to move a job to the RUNNABLE status. |
| Container |
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. |
| Depends |
A list of dependencies for the job. |
| Job |
The arn of the job definition used by this job. |
| Job |
The name of the job. |
| Job |
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.
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.
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.
JobName
The name of the job.
string JobName { get; }Property Value
System.
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.
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.
Remarks
Default: {} - no tags