interface SqsSendMessageProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Scheduler.Targets.Alpha.SqsSendMessageProps
Go	github.com/aws/aws-cdk-go/awscdkschedulertargetsalpha/v2#SqsSendMessageProps
Java	software.amazon.awscdk.services.scheduler.targets.alpha.SqsSendMessageProps
Python	aws_cdk.aws_scheduler_targets_alpha.SqsSendMessageProps
TypeScript (source)	@aws-cdk/aws-scheduler-targets-alpha » SqsSendMessageProps

Properties for a SQS Queue Target.

Example

const payload = 'test';
const messageGroupId = 'id';
const queue = new sqs.Queue(this, 'MyQueue', {
  fifo: true,
  contentBasedDeduplication: true,
});

const target = new targets.SqsSendMessage(queue, {
    input: ScheduleTargetInput.fromText(payload),
    messageGroupId,
});

new Schedule(this, 'Schedule', {
    schedule: ScheduleExpression.rate(Duration.minutes(1)),
    target
});

Properties

Name	Type	Description
deadLetterQueue?🔹	IQueue	The SQS queue to be used as deadLetterQueue.
input?🔹	ScheduleTargetInput	Input passed to the target.
maxEventAge?🔹	Duration	The maximum age of a request that Scheduler sends to a target for processing.
messageGroupId?🔹	string	The FIFO message group ID to use as the target.
retryAttempts?🔹	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: ScheduleTargetInput (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.

---

messageGroupId?🔹

Type: string (optional, default: no message group ID)

The FIFO message group ID to use as the target.

This must be specified when the target is a FIFO queue. If you specify a FIFO queue as a target, the queue must have content-based deduplication enabled.

A length of messageGroupId must be between 1 and 128.

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html#cfn-scheduler-schedule-sqsparameters-messagegroupid

---

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.