@aws-cdk_aws-batch-alpha.JobDefinitionProps

interface JobDefinitionProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.JobDefinitionProps
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#JobDefinitionProps
Javasoftware.amazon.awscdk.services.batch.alpha.JobDefinitionProps
Pythonaws_cdk.aws_batch_alpha.JobDefinitionProps
TypeScript (source)@aws-cdk/aws-batch-alpha ยป JobDefinitionProps

Props common to all JobDefinitions.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as batch_alpha from '@aws-cdk/aws-batch-alpha';
import * as cdk from 'aws-cdk-lib';

declare const parameters: any;
declare const retryStrategy: batch_alpha.RetryStrategy;
const jobDefinitionProps: batch_alpha.JobDefinitionProps = {
  jobDefinitionName: 'jobDefinitionName',
  parameters: {
    parametersKey: parameters,
  },
  retryAttempts: 123,
  retryStrategies: [retryStrategy],
  schedulingPriority: 123,
  timeout: cdk.Duration.minutes(30),
};

Properties

NameTypeDescription
jobDefinitionName?๐Ÿ”นstringThe name of this job definition.
parameters?๐Ÿ”น{ [string]: any }The default parameters passed to the container These parameters can be referenced in the command that you give to the container.
retryAttempts?๐Ÿ”นnumberThe number of times to retry a job.
retryStrategies?๐Ÿ”นRetryStrategy[]Defines the retry behavior for this job.
schedulingPriority?๐Ÿ”นnumberThe priority of this Job.
timeout?๐Ÿ”นDurationThe timeout time for jobs that are submitted with this job definition.

jobDefinitionName?๐Ÿ”น

Type: string (optional, default: generated by CloudFormation)

The name of this job definition.


parameters?๐Ÿ”น

Type: { [string]: any } (optional, default: none)

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

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


retryAttempts?๐Ÿ”น

Type: number (optional, default: 1)

The number of times to retry a job.

The job is retried on failure the same number of attempts as the value.


retryStrategies?๐Ÿ”น

Type: RetryStrategy[] (optional, default: no RetryStrategy)

Defines the retry behavior for this job.


schedulingPriority?๐Ÿ”น

Type: number (optional, default: none)

The priority of this Job.

Only used in Fairshare Scheduling to decide which job to run first when there are multiple jobs with the same share identifier.


timeout?๐Ÿ”น

Type: Duration (optional, default: no timeout)

The timeout time for jobs that are submitted with this job definition.

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