AWS::Pipes::Pipe PipeTargetBatchJobParameters

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ArrayProperties" : BatchArrayProperties,
  "ContainerOverrides" : BatchContainerOverrides,
  "DependsOn" : [ BatchJobDependency, ... ],
  "JobDefinition" : String,
  "JobName" : String,
  "Parameters" : {Key: Value, ...},
  "RetryStrategy" : BatchRetryStrategy
}

YAML

  ArrayProperties: 
    BatchArrayProperties
  ContainerOverrides: 
    BatchContainerOverrides
  DependsOn: 
    - BatchJobDependency
  JobDefinition: String
  JobName: String
  Parameters: 
    Key: Value
  RetryStrategy: 
    BatchRetryStrategy

Properties

ArrayProperties

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.

Required: No

Type: BatchArrayProperties

Update requires: No interruption

ContainerOverrides

The overrides that are sent to a container.

Required: No

Type: BatchContainerOverrides

Update requires: No interruption

DependsOn

A list of dependencies for the job. 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.

Required: No

Type: Array of BatchJobDependency

Minimum: 0

Maximum: 20

Update requires: No interruption

JobDefinition

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.

Required: Yes

Type: String

Update requires: No interruption

JobName

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 (_).

Required: Yes

Type: String

Update requires: No interruption

Parameters

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.

Required: No

Type: Object of String

Pattern: .+

Update requires: No interruption

RetryStrategy

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.

Required: No

Type: BatchRetryStrategy

Update requires: No interruption