-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(scheduler-targets): SqsSendMessage Target (#27774)
This PR adds `SqsSendMessage` Target for EventBridge Scheduler. Closes #27458. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
- Loading branch information
Showing
14 changed files
with
35,514 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
packages/@aws-cdk/aws-scheduler-targets-alpha/lib/sqs-send-message.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
import { ISchedule, IScheduleTarget, ScheduleTargetConfig } from '@aws-cdk/aws-scheduler-alpha'; | ||
import { Names, Token } from 'aws-cdk-lib'; | ||
import { IRole } from 'aws-cdk-lib/aws-iam'; | ||
import * as sqs from 'aws-cdk-lib/aws-sqs'; | ||
import { ScheduleTargetBase, ScheduleTargetBaseProps } from './target'; | ||
import { sameEnvDimension } from './util'; | ||
|
||
/** | ||
* Properties for a SQS Queue Target | ||
*/ | ||
export interface SqsSendMessageProps extends ScheduleTargetBaseProps { | ||
/** | ||
* 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 https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html#cfn-scheduler-schedule-sqsparameters-messagegroupid | ||
* | ||
* @default - no message group ID | ||
*/ | ||
readonly messageGroupId?: string; | ||
} | ||
|
||
/** | ||
* Use an Amazon SQS Queue as a target for AWS EventBridge Scheduler. | ||
*/ | ||
export class SqsSendMessage extends ScheduleTargetBase implements IScheduleTarget { | ||
constructor( | ||
private readonly queue: sqs.IQueue, | ||
private readonly props: SqsSendMessageProps, | ||
) { | ||
super(props, queue.queueArn); | ||
|
||
if (props.messageGroupId !== undefined) { | ||
if (!Token.isUnresolved(props.messageGroupId) && (props.messageGroupId.length < 1 || props.messageGroupId.length > 128)) { | ||
throw new Error(`messageGroupId length must be between 1 and 128, got ${props.messageGroupId.length}`); | ||
} | ||
if (!queue.fifo) { | ||
throw new Error('target must be a FIFO queue if messageGroupId is specified'); | ||
} | ||
if (!(queue.node.defaultChild as sqs.CfnQueue).contentBasedDeduplication) { | ||
throw new Error('contentBasedDeduplication must be true if the target is a FIFO queue'); | ||
} | ||
} else if (queue.fifo) { | ||
throw new Error('messageGroupId must be specified if the target is a FIFO queue'); | ||
} | ||
} | ||
|
||
protected addTargetActionToRole(schedule: ISchedule, role: IRole): void { | ||
if (!sameEnvDimension(this.queue.env.region, schedule.env.region)) { | ||
throw new Error(`Cannot assign queue in region ${this.queue.env.region} to the schedule ${Names.nodeUniqueId(schedule.node)} in region ${schedule.env.region}. Both the schedule and the queue must be in the same region.`); | ||
} | ||
|
||
if (!sameEnvDimension(this.queue.env.account, schedule.env.account)) { | ||
throw new Error(`Cannot assign queue in account ${this.queue.env.account} to the schedule ${Names.nodeUniqueId(schedule.node)} in account ${schedule.env.region}. Both the schedule and the queue must be in the same account.`); | ||
} | ||
|
||
if (this.props.role && !sameEnvDimension(this.props.role.env.account, this.queue.env.account)) { | ||
throw new Error(`Cannot grant permission to execution role in account ${this.props.role.env.account} to invoke target ${Names.nodeUniqueId(this.queue.node)} in account ${this.queue.env.account}. Both the target and the execution role must be in the same account.`); | ||
} | ||
|
||
this.queue.grantSendMessages(role); | ||
} | ||
|
||
protected bindBaseTargetConfig(_schedule: ISchedule): ScheduleTargetConfig { | ||
return { | ||
...super.bindBaseTargetConfig(_schedule), | ||
sqsParameters: { | ||
messageGroupId: this.props.messageGroupId, | ||
}, | ||
}; | ||
} | ||
} |
Oops, something went wrong.