interface ScheduleTargetBaseProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Scheduler.Targets.Alpha.ScheduleTargetBaseProps |
![]() | github.com/aws/aws-cdk-go/awscdkschedulertargetsalpha/v2#ScheduleTargetBaseProps |
![]() | software.amazon.awscdk.services.scheduler.targets.alpha.ScheduleTargetBaseProps |
![]() | aws_cdk.aws_scheduler_targets_alpha.ScheduleTargetBaseProps |
![]() | @aws-cdk/aws-scheduler-targets-alpha ยป ScheduleTargetBaseProps |
Base properties for a Schedule Target.
Example
import * as sns from 'aws-cdk-lib/aws-sns';
const topic = new sns.Topic(this, 'Topic');
const payload = {
message: 'Hello scheduler!',
};
const target = new targets.SnsPublish(topic, {
input: ScheduleTargetInput.fromObject(payload),
});
new Schedule(this, 'Schedule', {
schedule: ScheduleExpression.rate(Duration.hours(1)),
target,
});
Properties
Name | Type | Description |
---|---|---|
dead | IQueue | The SQS queue to be used as deadLetterQueue. |
input? | Schedule | Input passed to the target. |
max | Duration | The maximum age of a request that Scheduler sends to a target for processing. |
retry | number | The maximum number of times to retry when the target returns an error. |
role? | IRole | An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf. |
deadLetterQueue?
Type:
IQueue
(optional, default: no dead-letter queue)
The SQS queue to be used as deadLetterQueue.
The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.
input?
Type:
Schedule
(optional, default: no input.)
Input passed to the target.
maxEventAge?
Type:
Duration
(optional, default: Duration.hours(24))
The maximum age of a request that Scheduler sends to a target for processing.
Minimum value of 60. Maximum value of 86400.
retryAttempts?
Type:
number
(optional, default: 185)
The maximum number of times to retry when the target returns an error.
Minimum value of 0. Maximum value of 185.
role?
Type:
IRole
(optional, default: created by target)
An execution role is an IAM role that EventBridge Scheduler assumes in order to interact with other AWS services on your behalf.
If none provided templates target will automatically create an IAM role with all the minimum necessary permissions to interact with the templated target. If you wish you may specify your own IAM role, then the templated targets will grant minimal required permissions.