Interface IJobDefinition
Represents a JobDefinition.
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IJobDefinition : IResource
Syntax (vb)
Public Interface IJobDefinition
Inherits IResource, IConstruct, IDependable
Synopsis
Properties
JobDefinitionArn | The ARN of this job definition. |
JobDefinitionName | The name of this job definition. |
Parameters | The default parameters passed to the container These parameters can be referenced in the |
RetryAttempts | The number of times to retry a job. |
RetryStrategies | Defines the retry behavior for this job. |
SchedulingPriority | The priority of this Job. |
Timeout | The timeout time for jobs that are submitted with this job definition. |
Methods
AddRetryStrategy(RetryStrategy) | Add a RetryStrategy to this JobDefinition. |
Properties
JobDefinitionArn
The ARN of this job definition.
string JobDefinitionArn { get; }
Property Value
System.String
Remarks
Attribute: true
JobDefinitionName
The name of this job definition.
string JobDefinitionName { get; }
Property Value
System.String
Remarks
Attribute: true
Parameters
The default parameters passed to the container These parameters can be referenced in the command
that you give to the container.
virtual IDictionary<string, object> Parameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
RetryAttempts
The number of times to retry a job.
virtual Nullable<double> RetryAttempts { get; }
Property Value
System.Nullable<System.Double>
Remarks
The job is retried on failure the same number of attempts as the value.
Default: 1
RetryStrategies
Defines the retry behavior for this job.
RetryStrategy[] RetryStrategies { get; }
Property Value
Remarks
Default: - no RetryStrategy
SchedulingPriority
The priority of this Job.
virtual Nullable<double> SchedulingPriority { get; }
Property Value
System.Nullable<System.Double>
Remarks
Only used in Fairshare Scheduling to decide which job to run first when there are multiple jobs with the same share identifier.
Default: none
Timeout
The timeout time for jobs that are submitted with this job definition.
virtual Duration Timeout { get; }
Property Value
Remarks
After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
Default: - no timeout
Methods
AddRetryStrategy(RetryStrategy)
Add a RetryStrategy to this JobDefinition.
void AddRetryStrategy(RetryStrategy strategy)
Parameters
- strategy RetryStrategy