class EventBridgeSchedulerTarget
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Tasks.EventBridgeSchedulerTarget |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#EventBridgeSchedulerTarget |
![]() | software.amazon.awscdk.services.stepfunctions.tasks.EventBridgeSchedulerTarget |
![]() | aws_cdk.aws_stepfunctions_tasks.EventBridgeSchedulerTarget |
![]() | aws-cdk-lib » aws_stepfunctions_tasks » EventBridgeSchedulerTarget |
The target that EventBridge Scheduler will invoke.
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,
}),
});
Initializer
new EventBridgeSchedulerTarget(props: EventBridgeSchedulerTargetProps)
Parameters
Properties
Name | Type | Description |
---|---|---|
arn | string | The Amazon Resource Name (ARN) of the target. |
role | IRole | The IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. |
dead | IQueue | Dead letter queue for failed events. |
input? | string | The input to the target. |
retry | Retry | The retry policy settings. |
arn
Type:
string
The Amazon Resource Name (ARN) of the target.
role
Type:
IRole
The IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
deadLetterQueue?
Type:
IQueue
(optional)
Dead letter queue for failed events.
input?
Type:
string
(optional)
The input to the target.
retryPolicy?
Type:
Retry
(optional)
The retry policy settings.
Methods
Name | Description |
---|---|
render | return the target object for the EventBridge Scheduler. |
renderTargetObject()
public renderTargetObject(): any
Returns
any
return the target object for the EventBridge Scheduler.