aws-cdk-lib.aws_stepfunctions_tasks.RetryPolicy

RetryPolicy Struct

The information about the retry policy settings.

Source

aws-stepfunctions-tasks/lib/eventbridge-scheduler/create-schedule.ts

Type last changed

v2.168.0 · 20 Nov 2024

Example

import * as scheduler from 'aws-cdk-lib/aws-scheduler';
import * as kms from 'aws-cdk-lib/aws-kms';

declare const key: kms.Key;
declare const scheduleGroup: scheduler.CfnScheduleGroup;
declare const targetQueue: sqs.Queue;
declare const deadLetterQueue: sqs.Queue;

const schedulerRole = new iam.Role(this, 'SchedulerRole', {
  assumedBy: new iam.ServicePrincipal('scheduler.amazonaws.com'),
});
// To send the message to the queue
// This policy changes depending on the type of target.
schedulerRole.addToPrincipalPolicy(new iam.PolicyStatement({
  actions: ['sqs:SendMessage'],
  resources: [targetQueue.queueArn],
}));

const createScheduleTask1 = new tasks.EventBridgeSchedulerCreateScheduleTask(this, 'createSchedule', {
  scheduleName: 'TestSchedule',
  actionAfterCompletion: tasks.ActionAfterCompletion.NONE,
  clientToken: 'testToken',
  description: 'TestDescription',
  startDate: new Date(),
  endDate: new Date(new Date().getTime() + 1000 * 60 * 60),
  flexibleTimeWindow: Duration.minutes(5),
  groupName: scheduleGroup.ref,
  kmsKey: key,
  schedule: tasks.Schedule.rate(Duration.minutes(5)),
  timezone: 'UTC',
  enabled: true,
  target: new tasks.EventBridgeSchedulerTarget({
    arn: targetQueue.queueArn,
    role: schedulerRole,
    retryPolicy: {
      maximumRetryAttempts: 2,
      maximumEventAge: Duration.minutes(5),
    },
    deadLetterQueue,
  }),
});

Properties

maximumEventAgeDurationmaximum_event_ageDurationmaximumEventAgeDurationMaximumEventAgeDurationMaximumEventAgeDurationrequired#

The maximum amount of time to continue to make retry attempts.

maximumRetryAttemptsnumbermaximum_retry_attemptsint | floatmaximumRetryAttemptsNumberMaximumRetryAttemptsdoubleMaximumRetryAttempts*float64required#

The maximum number of retry attempts to make before the request fails.