AWS CDK Reference

Appearance

v2.274.0

PipeTargetBatchJobParametersProperty Struct ​

The parameters for using an AWS Batch job as a target.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeTargetBatchJobParametersProperty: pipes.CfnPipe.PipeTargetBatchJobParametersProperty = {
  jobDefinition: 'jobDefinition',
  jobName: 'jobName',

  // the properties below are optional
  arrayProperties: {
    size: 123,
  },
  containerOverrides: {
    command: ['command'],
    environment: [{
      name: 'name',
      value: 'value',
    }],
    instanceType: 'instanceType',
    resourceRequirements: [{
      type: 'type',
      value: 'value',
    }],
  },
  dependsOn: [{
    jobId: 'jobId',
    type: 'type',
  }],
  parameters: {
    parametersKey: 'parameters',
  },
  retryStrategy: {
    attempts: 123,
  },
};

Properties ​

arrayPropertiesoptionalIResolvable | CfnPipe.BatchArrayPropertiesPropertyarray_propertiesoptionaltyping.Union[IResolvable, BatchArrayPropertiesProperty]arrayPropertiesoptionalIResolvableArrayPropertiesoptionalIResolvableArrayPropertiesoptionalinterface{}#
The array properties for the submitted job, such as the size of the array.

The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

containerOverridesoptionalIResolvable | CfnPipe.BatchContainerOverridesPropertycontainer_overridesoptionaltyping.Union[IResolvable, BatchContainerOverridesProperty]containerOverridesoptionalIResolvableContainerOverridesoptionalIResolvableContainerOverridesoptionalinterface{}#
The overrides that are sent to a container.
dependsOnoptionalIResolvable | IResolvable | CfnPipe.BatchJobDependencyProperty[]depends_onoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BatchJobDependencyProperty]]]dependsOnoptionalIResolvableDependsOnoptionalIResolvableDependsOnoptionalinterface{}#
A list of dependencies for the job.
notes

A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

jobDefinitionstringjob_definitionstrjobDefinitionStringJobDefinitionstringJobDefinition*stringrequired#
The job definition used by this job.

This value can be one of name , name:revision , or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

jobNamestringjob_namestrjobNameStringJobNamestringJobName*stringrequired#
The name of the job.

It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

parametersoptionalIResolvable | { [key: string]: string }parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]parametersoptionalIResolvableParametersoptionalIResolvableParametersoptionalinterface{}#
Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.

Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

retryStrategyoptionalIResolvable | CfnPipe.BatchRetryStrategyPropertyretry_strategyoptionaltyping.Union[IResolvable, BatchRetryStrategyProperty]retryStrategyoptionalIResolvableRetryStrategyoptionalIResolvableRetryStrategyoptionalinterface{}#
The retry strategy to use for failed jobs.

When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.