From ec7e65dfd2600a4b3eb280dfece8e4be5c6c35fb Mon Sep 17 00:00:00 2001 From: Scott Sickles Date: Tue, 26 Mar 2024 12:19:31 -0400 Subject: [PATCH] make the env vars unique and update the README --- README.md | 11 +++++++++-- outputs.tf | 4 ++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9b78fc7..6da4f1e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ -# aws-eventbus -Nullstone module to create an AWS EventBus +This capability provides the necessary env variables in order to create schedules for the connected AWS EventBridge EventBus. + +The env variables injected are: +| Variable | Description | +| --- | --- | +| `EVENTBUS_ARN` | The arn of the AWS EventBridge EventBus. | +| `EVENTBUS_NAME` | The name of the AWS EventBridge EventBus. | +| `EVENTBUS_SCHEDULER_GROUP_NAME` | The name of the scheduler group used as the landing zone for creating schedules. | +| `EVENTBUS_SCHEDULER_ROLE_ARN` | The arn of the IamRole to use when creating schedules. This role has all the permissions required to create a schedule. | diff --git a/outputs.tf b/outputs.tf index 878288b..af5520b 100644 --- a/outputs.tf +++ b/outputs.tf @@ -9,11 +9,11 @@ output "env" { value = local.eventbus_name }, { - name = "SCHEDULER_GROUP_NAME" + name = "EVENTBUS_SCHEDULER_GROUP_NAME" value = local.scheduler_group_name }, { - name = "SCHEDULER_ROLE_ARN" + name = "EVENTBUS_SCHEDULER_ROLE_ARN" value = local.scheduler_role_arn }, ]