Interface IJobDefinitionProps

Props common to all JobDefinitions.

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IJobDefinitionProps

Syntax (vb)

Public Interface IJobDefinitionProps

Remarks

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.Batch;

            var parameters;
            RetryStrategy retryStrategy;

            var jobDefinitionProps = new JobDefinitionProps {
                JobDefinitionName = "jobDefinitionName",
                Parameters = new Dictionary<string, object> {
                    { "parametersKey", parameters }
                },
                RetryAttempts = 123,
                RetryStrategies = new [] { retryStrategy },
                SchedulingPriority = 123,
                Timeout = Duration.Minutes(30)
            };

Synopsis

Properties

JobDefinitionName	The name of this job definition.
Parameters	The default parameters passed to the container These parameters can be referenced in the command that you give to the container.
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.

Properties

JobDefinitionName

The name of this job definition.

string? JobDefinitionName { get; }

Property Value

string

Remarks

Default: - generated by CloudFormation

Parameters

The default parameters passed to the container These parameters can be referenced in the command that you give to the container.

IDictionary<string, object>? Parameters { get; }

Property Value

IDictionary<string, object>

Remarks

Default: none

See: https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html#parameters

RetryAttempts

The number of times to retry a job.

double? RetryAttempts { get; }

Property Value

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

RetryStrategy[]

Remarks

Default: - no RetryStrategy

SchedulingPriority

The priority of this Job.

double? SchedulingPriority { get; }

Property Value

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.

Duration? Timeout { get; }

Property Value

Duration

Remarks

After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

Default: - no timeout