agent-claw: automated task changes
This commit is contained in:
daniel
391
cdk/node_modules/aws-cdk-lib/aws-scheduler-targets/README.md
generated
vendored
Normal file
391
cdk/node_modules/aws-cdk-lib/aws-scheduler-targets/README.md
generated
vendored
Normal file
@@ -0,0 +1,391 @@
|
||||
# Amazon EventBridge Scheduler Targets Construct Library
|
||||
|
||||
[Amazon EventBridge Scheduler](https://aws.amazon.com/blogs/compute/introducing-amazon-eventbridge-scheduler/) is a feature from Amazon EventBridge
|
||||
that allows you to create, run, and manage scheduled tasks at scale. With EventBridge Scheduler, you can schedule millions of one-time or recurring tasks across various AWS services without provisioning or managing underlying infrastructure.
|
||||
|
||||
This library contains integration classes for Amazon EventBridge Scheduler to call any
|
||||
number of supported AWS Services.
|
||||
|
||||
The following targets are supported:
|
||||
|
||||
1. `targets.LambdaInvoke`: [Invoke an AWS Lambda function](#invoke-a-lambda-function)
|
||||
2. `targets.StepFunctionsStartExecution`: [Start an AWS Step Function](#start-an-aws-step-function)
|
||||
3. `targets.CodeBuildStartBuild`: [Start a CodeBuild job](#start-a-codebuild-job)
|
||||
4. `targets.SqsSendMessage`: [Send a Message to an Amazon SQS Queue](#send-a-message-to-an-sqs-queue)
|
||||
5. `targets.SnsPublish`: [Publish messages to an Amazon SNS topic](#publish-messages-to-an-amazon-sns-topic)
|
||||
6. `targets.EventBridgePutEvents`: [Put Events on EventBridge](#send-events-to-an-eventbridge-event-bus)
|
||||
7. `targets.InspectorStartAssessmentRun`: [Start an Amazon Inspector assessment run](#start-an-amazon-inspector-assessment-run)
|
||||
8. `targets.KinesisStreamPutRecord`: [Put a record to an Amazon Kinesis Data Stream](#put-a-record-to-an-amazon-kinesis-data-stream)
|
||||
9. `targets.FirehosePutRecord`: [Put a record to an Amazon Data Firehose](#put-a-record-to-an-amazon-data-firehose)
|
||||
10. `targets.CodePipelineStartPipelineExecution`: [Start a CodePipeline execution](#start-a-codepipeline-execution)
|
||||
11. `targets.SageMakerStartPipelineExecution`: [Start a SageMaker pipeline execution](#start-a-sagemaker-pipeline-execution)
|
||||
12. `targets.EcsRunTask`: [Start a new ECS task](#schedule-an-ecs-task-run)
|
||||
13. `targets.Universal`: [Invoke a wider set of AWS API](#invoke-a-wider-set-of-aws-api)
|
||||
|
||||
## Invoke a Lambda function
|
||||
|
||||
Use the `LambdaInvoke` target to invoke a lambda function.
|
||||
|
||||
The code snippet below creates an event rule with a Lambda function as a target
|
||||
called every hour by EventBridge Scheduler with a custom payload. You can optionally attach a
|
||||
[dead letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html).
|
||||
|
||||
```ts
|
||||
import * as lambda from 'aws-cdk-lib/aws-lambda';
|
||||
|
||||
const fn = new lambda.Function(this, 'MyFunc', {
|
||||
runtime: lambda.Runtime.NODEJS_LATEST,
|
||||
handler: 'index.handler',
|
||||
code: lambda.Code.fromInline(`exports.handler = handler.toString()`),
|
||||
});
|
||||
|
||||
const dlq = new sqs.Queue(this, "DLQ", {
|
||||
queueName: 'MyDLQ',
|
||||
});
|
||||
|
||||
const target = new targets.LambdaInvoke(fn, {
|
||||
deadLetterQueue: dlq,
|
||||
maxEventAge: Duration.minutes(1),
|
||||
retryAttempts: 3,
|
||||
input: ScheduleTargetInput.fromObject({
|
||||
'payload': 'useful'
|
||||
}),
|
||||
});
|
||||
|
||||
const schedule = new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.hours(1)),
|
||||
target
|
||||
});
|
||||
```
|
||||
|
||||
## Start an AWS Step Function
|
||||
|
||||
Use the `StepFunctionsStartExecution` target to start a new execution on a StepFunction.
|
||||
|
||||
The code snippet below creates an event rule with a Step Function as a target
|
||||
called every hour by EventBridge Scheduler with a custom payload.
|
||||
|
||||
```ts
|
||||
import * as sfn from 'aws-cdk-lib/aws-stepfunctions';
|
||||
import * as tasks from 'aws-cdk-lib/aws-stepfunctions-tasks';
|
||||
|
||||
const payload = {
|
||||
Name: "MyParameter",
|
||||
Value: '🌥️',
|
||||
};
|
||||
|
||||
const putParameterStep = new tasks.CallAwsService(this, 'PutParameter', {
|
||||
service: 'ssm',
|
||||
action: 'putParameter',
|
||||
iamResources: ['*'],
|
||||
parameters: {
|
||||
"Name.$": '$.Name',
|
||||
"Value.$": '$.Value',
|
||||
Type: 'String',
|
||||
Overwrite: true,
|
||||
},
|
||||
});
|
||||
|
||||
const stateMachine = new sfn.StateMachine(this, 'StateMachine', {
|
||||
definitionBody: sfn.DefinitionBody.fromChainable(putParameterStep)
|
||||
});
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.hours(1)),
|
||||
target: new targets.StepFunctionsStartExecution(stateMachine, {
|
||||
input: ScheduleTargetInput.fromObject(payload),
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
## Start a CodeBuild job
|
||||
|
||||
Use the `CodeBuildStartBuild` target to start a new build run on a CodeBuild project.
|
||||
|
||||
The code snippet below creates an event rule with a CodeBuild project as target which is
|
||||
called every hour by EventBridge Scheduler.
|
||||
|
||||
```ts
|
||||
import * as codebuild from 'aws-cdk-lib/aws-codebuild';
|
||||
|
||||
declare const project: codebuild.Project;
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(60)),
|
||||
target: new targets.CodeBuildStartBuild(project),
|
||||
});
|
||||
```
|
||||
|
||||
## Send a Message To an SQS Queue
|
||||
|
||||
Use the `SqsSendMessage` target to send a message to an SQS Queue.
|
||||
|
||||
The code snippet below creates an event rule with an SQS Queue as a target
|
||||
called every hour by EventBridge Scheduler with a custom payload.
|
||||
|
||||
Contains the `messageGroupId` to use when the target is a FIFO queue. If you specify
|
||||
a FIFO queue as a target, the queue must have content-based deduplication enabled.
|
||||
|
||||
```ts
|
||||
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
|
||||
});
|
||||
```
|
||||
|
||||
## Publish messages to an Amazon SNS topic
|
||||
|
||||
Use the `SnsPublish` target to publish messages to an Amazon SNS topic.
|
||||
|
||||
The code snippets below create an event rule with a Amazon SNS topic as a target.
|
||||
It's called every hour by Amazon EventBridge Scheduler with a custom payload.
|
||||
|
||||
```ts
|
||||
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,
|
||||
});
|
||||
```
|
||||
|
||||
## Send events to an EventBridge event bus
|
||||
|
||||
Use the `EventBridgePutEvents` target to send events to an EventBridge event bus.
|
||||
|
||||
The code snippet below creates an event rule with an EventBridge event bus as a target
|
||||
called every hour by EventBridge Scheduler with a custom event payload.
|
||||
|
||||
```ts
|
||||
import * as events from 'aws-cdk-lib/aws-events';
|
||||
|
||||
const eventBus = new events.EventBus(this, 'EventBus', {
|
||||
eventBusName: 'DomainEvents',
|
||||
});
|
||||
|
||||
const eventEntry: targets.EventBridgePutEventsEntry = {
|
||||
eventBus,
|
||||
source: 'PetService',
|
||||
detail: ScheduleTargetInput.fromObject({ Name: 'Fluffy' }),
|
||||
detailType: '🐶',
|
||||
};
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.hours(1)),
|
||||
target: new targets.EventBridgePutEvents(eventEntry),
|
||||
});
|
||||
```
|
||||
|
||||
## Start an Amazon Inspector assessment run
|
||||
|
||||
Use the `InspectorStartAssessmentRun` target to start an Inspector assessment run.
|
||||
|
||||
The code snippet below creates an event rule with an assessment template as the target which is
|
||||
called every hour by EventBridge Scheduler.
|
||||
|
||||
```ts
|
||||
import * as inspector from 'aws-cdk-lib/aws-inspector';
|
||||
|
||||
declare const cfnAssessmentTemplate: inspector.CfnAssessmentTemplate;
|
||||
|
||||
const assessmentTemplate = inspector.AssessmentTemplate.fromCfnAssessmentTemplate(this, 'MyAssessmentTemplate', cfnAssessmentTemplate);
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(60)),
|
||||
target: new targets.InspectorStartAssessmentRun(assessmentTemplate),
|
||||
});
|
||||
```
|
||||
|
||||
## Put a record to an Amazon Kinesis Data Stream
|
||||
|
||||
Use the `KinesisStreamPutRecord` target to put a record to an Amazon Kinesis Data Stream.
|
||||
|
||||
The code snippet below creates an event rule with a stream as the target which is
|
||||
called every hour by EventBridge Scheduler.
|
||||
|
||||
```ts
|
||||
import * as kinesis from 'aws-cdk-lib/aws-kinesis';
|
||||
|
||||
const stream = new kinesis.Stream(this, 'MyStream');
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(60)),
|
||||
target: new targets.KinesisStreamPutRecord(stream, {
|
||||
partitionKey: 'key',
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
## Put a record to an Amazon Data Firehose
|
||||
|
||||
Use the `FirehosePutRecord` target to put a record to an Amazon Data Firehose delivery stream.
|
||||
|
||||
The code snippet below creates an event rule with a delivery stream as a target
|
||||
called every hour by EventBridge Scheduler with a custom payload.
|
||||
|
||||
```ts
|
||||
import * as firehose from 'aws-cdk-lib/aws-kinesisfirehose';
|
||||
declare const deliveryStream: firehose.IDeliveryStream;
|
||||
|
||||
const payload = {
|
||||
Data: "record",
|
||||
};
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(60)),
|
||||
target: new targets.FirehosePutRecord(deliveryStream, {
|
||||
input: ScheduleTargetInput.fromObject(payload),
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
## Start a CodePipeline execution
|
||||
|
||||
Use the `CodePipelineStartPipelineExecution` target to start a new execution for a CodePipeline pipeline.
|
||||
|
||||
The code snippet below creates an event rule with a CodePipeline pipeline as the target which is
|
||||
called every hour by EventBridge Scheduler.
|
||||
|
||||
```ts
|
||||
import * as codepipeline from 'aws-cdk-lib/aws-codepipeline';
|
||||
|
||||
declare const pipeline: codepipeline.Pipeline;
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(60)),
|
||||
target: new targets.CodePipelineStartPipelineExecution(pipeline),
|
||||
});
|
||||
```
|
||||
|
||||
## Start a SageMaker pipeline execution
|
||||
|
||||
Use the `SageMakerStartPipelineExecution` target to start a new execution for a SageMaker pipeline.
|
||||
|
||||
The code snippet below creates an event rule with a SageMaker pipeline as the target which is
|
||||
called every hour by EventBridge Scheduler.
|
||||
|
||||
```ts
|
||||
import * as sagemaker from 'aws-cdk-lib/aws-sagemaker';
|
||||
|
||||
declare const pipeline: sagemaker.IPipeline;
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(60)),
|
||||
target: new targets.SageMakerStartPipelineExecution(pipeline, {
|
||||
pipelineParameterList: [{
|
||||
name: 'parameter-name',
|
||||
value: 'parameter-value',
|
||||
}],
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
## Schedule an ECS task run
|
||||
|
||||
Use the `EcsRunTask` target to schedule an ECS task run for a cluster.
|
||||
|
||||
The code snippet below creates an event rule with a Fargate task definition and cluster as the target which is called every hour by EventBridge Scheduler.
|
||||
|
||||
```ts
|
||||
import * as ecs from 'aws-cdk-lib/aws-ecs';
|
||||
|
||||
declare const cluster: ecs.ICluster;
|
||||
declare const taskDefinition: ecs.FargateTaskDefinition;
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(cdk.Duration.minutes(60)),
|
||||
target: new targets.EcsRunFargateTask(cluster, {
|
||||
taskDefinition,
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
The code snippet below creates an event rule with a EC2 task definition and cluster as the target which is called every hour by EventBridge Scheduler.
|
||||
|
||||
```ts
|
||||
import * as ecs from 'aws-cdk-lib/aws-ecs';
|
||||
|
||||
declare const cluster: ecs.ICluster;
|
||||
declare const taskDefinition: ecs.Ec2TaskDefinition;
|
||||
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(cdk.Duration.minutes(60)),
|
||||
target: new targets.EcsRunEc2Task(cluster, {
|
||||
taskDefinition,
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
## Invoke a wider set of AWS API
|
||||
|
||||
Use the `Universal` target to invoke AWS API. See <https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html>
|
||||
|
||||
The code snippet below creates an event rule with AWS API as the target which is
|
||||
called at midnight every day by EventBridge Scheduler.
|
||||
|
||||
```ts
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.cron({
|
||||
minute: '0',
|
||||
hour: '0',
|
||||
}),
|
||||
target: new targets.Universal({
|
||||
service: 'rds',
|
||||
action: 'stopDBCluster',
|
||||
input: ScheduleTargetInput.fromObject({
|
||||
DbClusterIdentifier: 'my-db',
|
||||
}),
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
The `service` must be in lowercase and the `action` must be in camelCase.
|
||||
|
||||
By default, an IAM policy for the Scheduler is extracted from the API call. The action in the policy is constructed using the `service` and `action` prop.
|
||||
Re-using the example above, the action will be `rds:stopDBCluster`. Note that not all IAM actions follow the same pattern. In such scenario, please use the
|
||||
`policyStatements` prop to override the policy:
|
||||
|
||||
```ts
|
||||
new Schedule(this, 'Schedule', {
|
||||
schedule: ScheduleExpression.rate(Duration.minutes(60)),
|
||||
target: new targets.Universal({
|
||||
service: 'sqs',
|
||||
action: 'sendMessage',
|
||||
policyStatements: [
|
||||
new iam.PolicyStatement({
|
||||
actions: ['sqs:SendMessage'],
|
||||
resources: ['arn:aws:sqs:us-east-1:123456789012:my_queue'],
|
||||
}),
|
||||
new iam.PolicyStatement({
|
||||
actions: ['kms:Decrypt', 'kms:GenerateDataKey*'],
|
||||
resources: ['arn:aws:kms:us-east-1:123456789012:key/0987dcba-09fe-87dc-65ba-ab0987654321'],
|
||||
}),
|
||||
],
|
||||
}),
|
||||
});
|
||||
```
|
||||
|
||||
> Note: The default policy uses `*` in the resources field as CDK does not have a straight forward way to auto-discover the resources permission required.
|
||||
> It is recommended that you scope the field down to specific resources to have a better security posture.
|
||||
Reference in New Issue
Block a user