AWS::Events::Rule BatchParameters

The custom parameters to be used when the target is an AWS Batch job.

Syntax

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

JSON

{
  "ArrayProperties" : BatchArrayProperties,
  "JobDefinition" : String,
  "JobName" : String,
  "RetryStrategy" : BatchRetryStrategy
}

YAML

  ArrayProperties: 
    BatchArrayProperties
  JobDefinition: String
  JobName: String
  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

JobDefinition

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Required: Yes

Type: String

Update requires: No interruption

JobName

The name to use for this execution of the job, if the target is an AWS Batch job.

Required: Yes

Type: String

Update requires: No interruption

RetryStrategy

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Required: No

Type: BatchRetryStrategy

Update requires: No interruption

Examples

Set the BatchParameters parameters

The following example sets the BatchParameters parameter for a job that has 950 objects and will be tried 8 times.

JSON

"BatchParameters": {
  "ArrayProperties": {
      "Size": 950
   },
  "JobDefinition": "NewBatchJobDefinition",
  "JobName": "Job1",
  "RetryStrategy": {
      "Attempts": 8
   }
}

YAML

BatchParameters:
  ArrayProperties:
    Size: 950
  JobDefinition: NewBatchJobDefinition
  JobName: Job1
  RetryStrategy:
    Attempts: 8