Class RunBatchJobProps
(deprecated) Properties for RunBatchJob.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public class RunBatchJobProps : Object, IRunBatchJobProps
Syntax (vb)
Public Class RunBatchJobProps
Inherits Object
Implements IRunBatchJobProps
Remarks
Stability: Deprecated
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.AWS.EC2;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;
using Amazon.CDK;
InstanceType instanceType;
var payload;
var runBatchJobProps = new RunBatchJobProps {
JobDefinitionArn = "jobDefinitionArn",
JobName = "jobName",
JobQueueArn = "jobQueueArn",
// the properties below are optional
ArraySize = 123,
Attempts = 123,
ContainerOverrides = new ContainerOverrides {
Command = new [] { "command" },
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
},
GpuCount = 123,
InstanceType = instanceType,
Memory = 123,
Vcpus = 123
},
DependsOn = new [] { new JobDependency {
JobId = "jobId",
Type = "type"
} },
IntegrationPattern = ServiceIntegrationPattern.FIRE_AND_FORGET,
Payload = new Dictionary<string, object> {
{ "payloadKey", payload }
},
Timeout = Duration.Minutes(30)
};
Synopsis
Constructors
RunBatchJobProps() |
Properties
ArraySize | (deprecated) The array size can be between 2 and 10,000. |
Attempts | (deprecated) The number of times to move a job to the RUNNABLE status. |
ContainerOverrides | (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. |
DependsOn | (deprecated) A list of dependencies for the job. |
IntegrationPattern | (deprecated) The service integration pattern indicates different ways to call TerminateCluster. |
JobDefinitionArn | (deprecated) The arn of the job definition used by this job. |
JobName | (deprecated) The name of the job. |
JobQueueArn | (deprecated) The arn of the job queue into which the job is submitted. |
Payload | (deprecated) The payload to be passed as parametrs to the batch job. |
Timeout | (deprecated) The timeout configuration for this SubmitJob operation. |
Constructors
RunBatchJobProps()
public RunBatchJobProps()
Properties
ArraySize
(deprecated) 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
Stability: Deprecated
Attempts
(deprecated) 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
Stability: Deprecated
ContainerOverrides
(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.
public IContainerOverrides ContainerOverrides { get; set; }
Property Value
Remarks
Default: - No container overrides
Stability: Deprecated
DependsOn
(deprecated) A list of dependencies for the job.
public IJobDependency[] DependsOn { get; set; }
Property Value
Remarks
A job can depend upon a maximum of 20 jobs.
Default: - No dependencies
Stability: Deprecated
IntegrationPattern
(deprecated) The service integration pattern indicates different ways to call TerminateCluster.
public Nullable<ServiceIntegrationPattern> IntegrationPattern { get; set; }
Property Value
System.Nullable<ServiceIntegrationPattern>
Remarks
The valid value is either FIRE_AND_FORGET or SYNC.
Default: SYNC
Stability: Deprecated
JobDefinitionArn
(deprecated) The arn of the job definition used by this job.
public string JobDefinitionArn { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
JobName
(deprecated) 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.
Stability: Deprecated
JobQueueArn
(deprecated) The arn of the job queue into which the job is submitted.
public string JobQueueArn { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
Payload
(deprecated) The payload to be passed as parametrs to the batch job.
public IDictionary<string, object> Payload { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Default: - No parameters are passed
Stability: Deprecated
Timeout
(deprecated) The timeout configuration for this SubmitJob operation.
public Duration Timeout { get; set; }
Property Value
Remarks
The minimum value for the timeout is 60 seconds.
Default: - No timeout
Stability: Deprecated