interface BatchParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Events.CfnRule.BatchParametersProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnRule_BatchParametersProperty`
Java	`software.amazon.awscdk.services.events.CfnRule.BatchParametersProperty`
Python	`aws_cdk.aws_events.CfnRule.BatchParametersProperty`
TypeScript	`aws-cdk-lib` » `aws_events` » `CfnRule` » `BatchParametersProperty`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const batchParametersProperty: events.CfnRule.BatchParametersProperty = {
  jobDefinition: 'jobDefinition',
  jobName: 'jobName',

  // the properties below are optional
  arrayProperties: {
    size: 123,
  },
  retryStrategy: {
    attempts: 123,
  },
};

Properties

Name	Type	Description
jobDefinition	`string`	The ARN or name of the job definition to use if the event target is an AWS Batch job.
jobName	`string`	The name to use for this execution of the job, if the target is an AWS Batch job.
arrayProperties?	`IResolvable` `\|` `BatchArrayPropertiesProperty`	The array properties for the submitted job, such as the size of the array.
retryStrategy?	`IResolvable` `\|` `BatchRetryStrategyProperty`	The retry strategy to use for failed jobs, if the target is an AWS Batch job.

jobDefinition

Type: string

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.

jobName

Type: string

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

arrayProperties?

Type: IResolvable | BatchArrayPropertiesProperty (optional)

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.

retryStrategy?

Type: IResolvable | BatchRetryStrategyProperty (optional)

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.