|
| 1 | +# Kestra AWS Plugin |
| 2 | + |
| 3 | +## What |
| 4 | + |
| 5 | +AWS plugin for Kestra Exposes 43 plugin components (tasks, triggers, and/or conditions). |
| 6 | + |
| 7 | +## Why |
| 8 | + |
| 9 | +Enables Kestra workflows to interact with AWS, allowing orchestration of AWS-based operations as part of data pipelines and automation workflows. |
| 10 | + |
| 11 | +## How |
| 12 | + |
| 13 | +### Architecture |
| 14 | + |
| 15 | +Single-module plugin. Source packages under `io.kestra.plugin`: |
| 16 | + |
| 17 | +- `aws` |
| 18 | + |
| 19 | +### Key Plugin Classes |
| 20 | + |
| 21 | +- `io.kestra.plugin.aws.athena.Query` |
| 22 | +- `io.kestra.plugin.aws.auth.EksToken` |
| 23 | +- `io.kestra.plugin.aws.cli.AwsCLI` |
| 24 | +- `io.kestra.plugin.aws.cloudformation.Create` |
| 25 | +- `io.kestra.plugin.aws.cloudformation.Delete` |
| 26 | +- `io.kestra.plugin.aws.cloudwatch.Push` |
| 27 | +- `io.kestra.plugin.aws.cloudwatch.Query` |
| 28 | +- `io.kestra.plugin.aws.cloudwatch.Trigger` |
| 29 | +- `io.kestra.plugin.aws.dynamodb.DeleteItem` |
| 30 | +- `io.kestra.plugin.aws.dynamodb.GetItem` |
| 31 | +- `io.kestra.plugin.aws.dynamodb.PutItem` |
| 32 | +- `io.kestra.plugin.aws.dynamodb.Query` |
| 33 | +- `io.kestra.plugin.aws.dynamodb.Scan` |
| 34 | +- `io.kestra.plugin.aws.ecr.GetAuthToken` |
| 35 | +- `io.kestra.plugin.aws.emr.CreateClusterAndSubmitSteps` |
| 36 | +- `io.kestra.plugin.aws.emr.CreateServerlessApplicationAndStartJob` |
| 37 | +- `io.kestra.plugin.aws.emr.DeleteCluster` |
| 38 | +- `io.kestra.plugin.aws.emr.DeleteServerlessApplication` |
| 39 | +- `io.kestra.plugin.aws.emr.StartServerlessJobRun` |
| 40 | +- `io.kestra.plugin.aws.emr.SubmitSteps` |
| 41 | +- `io.kestra.plugin.aws.eventbridge.PutEvents` |
| 42 | +- `io.kestra.plugin.aws.glue.GetJobRun` |
| 43 | +- `io.kestra.plugin.aws.glue.StartJobRun` |
| 44 | +- `io.kestra.plugin.aws.glue.StopJobRun` |
| 45 | +- `io.kestra.plugin.aws.kinesis.Consume` |
| 46 | +- `io.kestra.plugin.aws.kinesis.PutRecords` |
| 47 | +- `io.kestra.plugin.aws.kinesis.RealtimeTrigger` |
| 48 | +- `io.kestra.plugin.aws.kinesis.Trigger` |
| 49 | +- `io.kestra.plugin.aws.lambda.Invoke` |
| 50 | +- `io.kestra.plugin.aws.s3.Copy` |
| 51 | +- `io.kestra.plugin.aws.s3.CreateBucket` |
| 52 | +- `io.kestra.plugin.aws.s3.Delete` |
| 53 | +- `io.kestra.plugin.aws.s3.DeleteList` |
| 54 | +- `io.kestra.plugin.aws.s3.Download` |
| 55 | +- `io.kestra.plugin.aws.s3.Downloads` |
| 56 | +- `io.kestra.plugin.aws.s3.List` |
| 57 | +- `io.kestra.plugin.aws.s3.Trigger` |
| 58 | +- `io.kestra.plugin.aws.s3.Upload` |
| 59 | +- `io.kestra.plugin.aws.sns.Publish` |
| 60 | +- `io.kestra.plugin.aws.sqs.Consume` |
| 61 | +- `io.kestra.plugin.aws.sqs.Publish` |
| 62 | +- `io.kestra.plugin.aws.sqs.RealtimeTrigger` |
| 63 | +- `io.kestra.plugin.aws.sqs.Trigger` |
| 64 | + |
| 65 | +### Project Structure |
| 66 | + |
| 67 | +``` |
| 68 | +plugin-aws/ |
| 69 | +├── src/main/java/io/kestra/plugin/aws/sqs/ |
| 70 | +├── src/test/java/io/kestra/plugin/aws/sqs/ |
| 71 | +├── build.gradle |
| 72 | +└── README.md |
| 73 | +``` |
| 74 | + |
| 75 | +### Important Commands |
| 76 | + |
| 77 | +```bash |
| 78 | +# Build the plugin |
| 79 | +./gradlew shadowJar |
| 80 | + |
| 81 | +# Run tests |
| 82 | +./gradlew test |
| 83 | + |
| 84 | +# Build without tests |
| 85 | +./gradlew shadowJar -x test |
| 86 | +``` |
| 87 | + |
| 88 | +### Configuration |
| 89 | + |
| 90 | +All tasks and triggers accept standard Kestra plugin properties. Credentials should use |
| 91 | +`{{ secret('SECRET_NAME') }}` — never hardcode real values. |
| 92 | + |
| 93 | +## Agents |
| 94 | + |
| 95 | +**IMPORTANT:** This is a Kestra plugin repository (prefixed by `plugin-`, `storage-`, or `secret-`). You **MUST** delegate all coding tasks to the `kestra-plugin-developer` agent. Do NOT implement code changes directly — always use this agent. |
0 commit comments