https://github.com/launchbynttdata/tf-aws-module_primitive-aws_scheduler_schedule

Last synced: 15 days ago
JSON representation
Host: GitHub
URL: https://github.com/launchbynttdata/tf-aws-module_primitive-aws_scheduler_schedule
Owner: launchbynttdata
License: apache-2.0
Created: 2025-01-31T16:03:15.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2026-04-06T14:01:56.000Z (3 months ago)
Last Synced: 2026-04-06T15:40:12.550Z (3 months ago)
Language: HCL
Size: 129 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Notice: NOTICE
Awesome Lists containing this project

README

          # tf-aws-module_primitive-aws_scheduler_schedule

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![License: CC BY-NC-ND 4.0](https://img.shields.io/badge/License-CC_BY--NC--ND_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc-nd/4.0/)

## Overview

Provides an EventBridge Scheduler resource that can trigger actions on a schedule. This resource utilizes [universal targets](https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html) rather than service-specific configuration.

## Pre-Commit hooks

[.pre-commit-config.yaml](.pre-commit-config.yaml) file defines certain `pre-commit` hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.

`commitlint` hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:

- **fix**: a commit of the type `fix` patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).

- **feat**: a commit of the type `feat` introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).

- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.

footers other than BREAKING CHANGE:  may be provided and follow a convention similar to git trailer format.

- **build**: a commit of the type `build` adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)

- **chore**: a commit of the type `chore` adds changes that don't modify src or test files

- **ci**: a commit of the type `ci` adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)

- **docs**: a commit of the type `docs` adds documentation only changes

- **perf**: a commit of the type `perf` adds code change that improves performance

- **refactor**: a commit of the type `refactor` adds code change that neither fixes a bug nor adds a feature

- **revert**: a commit of the type `revert` reverts a previous commit

- **style**: a commit of the type `style` adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

- **test**: a commit of the type `test` adds missing tests or correcting existing tests

Base configuration used for this project is [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)

If you are a developer using vscode, [this](https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint) plugin may be helpful.

`detect-secrets-hook` prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS

In order for `pre-commit` hooks to work properly

- You need to have the pre-commit package manager installed. [Here](https://pre-commit.com/#install) are the installation instructions.

- `pre-commit` would install all the hooks when commit message is added by default except for `commitlint` hook. `commitlint` hook would need to be installed manually using the command below

```

pre-commit install --hook-type commit-msg

```

## To test the resource group module locally

1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the `configure` target in the project's [`Makefile`](./Makefile). Before you can run `configure`, familiarize yourself with the variables in the `Makefile` and ensure they're pointing to the right places.

```

make configure

```

This adds in several files and directories that are ignored by `git`. They expose many new Make targets.

2. _THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP._ The first target you care about is `env`. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.

`make configure` command will bring down `azure_env.sh` file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.

These environment variables are used by `terratest` integration suit.

Service principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.

```

"Microsoft.Resources/subscriptions/resourceGroups/write"

"Microsoft.Resources/subscriptions/resourceGroups/read"

"Microsoft.Resources/subscriptions/resourceGroups/delete"

```

Then run this make target to set the environment variables on developer workstation.

```

make env

```

3. The first target you care about is `check`.

**Pre-requisites**

Before running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are `azure` specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.

- A file named `provider.tf` with contents below

```

provider "azurerm" {

  features {}

}

```

- A file named `terraform.tfvars` which contains key value pair of variables used.

Note that since these files are added in `gitignore` they would not be checked in into primitive/segment's git repo.

After creating these files, for running tests associated with the primitive/segment, run

```

make check

```

If `make check` target is successful, developer is good to commit the code to primitive/segment's git repo.

`make check` target

- runs `terraform commands` to `lint`,`validate` and `plan` terraform code.

- runs `conftests`. `conftests` make sure `policy` checks are successful.

- runs `terratest`. This is integration test suit.

- runs `opa` tests

## Requirements

| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | ~> 1.5 |

|  [aws](#requirement\_aws) | ~> 5.0 |

## Providers

| Name | Version |

|------|---------|

|  [aws](#provider\_aws) | 5.84.0 |

## Modules

No modules.

## Resources

| Name | Type |

|------|------|

| [aws_scheduler_schedule.schedule](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/scheduler_schedule) | resource |

## Inputs

| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [name](#input\_name) | The name of the schedule. Changing this value will force creation of a new resource. | `string` | n/a | yes |

|  [description](#input\_description) | The description of the schedule. | `string` | `null` | no |

|  [group\_name](#input\_group\_name) | Name of the schedule group to associate with this schedule. If not
    specified, the `default` schedule group is used. | `string` | `"default"` | no |

|  [state](#input\_state) | Specifies whether the schedule is `ENABLED` or `DISABLED`. | `string` | `"ENABLED"` | no |

|  [start\_date](#input\_start\_date) | The date, in UTC, after which the schedule can begin invoking its target.
    Depending on the schedule's recurrence expression, invocations might occur
    on, or after, the start date you specify. EventBridge Scheduler ignores the
    start date for one-time schedules. Omitting this value will allow for
    immediate execution. Example: `2030-01-01T01:00:00Z` | `string` | `null` | no |

|  [end\_date](#input\_end\_date) | The date, in UTC, before which the schedule can invoke its target.
    Depending on the schedule's recurrence expression, invocations might stop
    on, or before, the end date you specify. EventBridge Scheduler ignores the
    end date for one-time schedules. Omitting this value will allow the
    schedule to run indefinitely. Example: `2030-01-01T01:00:00Z`. | `string` | `null` | no |

|  [schedule\_expression](#input\_schedule\_expression) | Defines when the schedule runs. For more information on schedule types,
    as well as details on timezones and DST handling, see Schedule Types:
    https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html
    Examples: `cron(0 20 * * ? *)`, `rate(5 minutes)`, `at(2025-01-01T00:00:00)`. | `string` | n/a | yes |

|  [schedule\_expression\_timezone](#input\_schedule\_expression\_timezone) | The timezone for the schedule. If not specified, the default timezone is `UTC`.
    For more information on timezones and DST handling, see Schedule Types:
    https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html | `string` | `"UTC"` | no |

|  [input](#input\_input) | Optional text or well-formed JSON, passed to the target. The parameters
    and shape of the JSON you set are determined by the service API your
    schedule invokes. To find this information, see the API reference for the
    service you want to target. | `string` | `null` | no |

|  [flexible\_time\_window\_minutes](#input\_flexible\_time\_window\_minutes) | The maximum amount of time, in minutes, that the schedule can delay the
    invocation of its target. The value must be between 1 and 1440 minutes.
    If not specified, the schedule will run immediately at its scheduled time. | `number` | `null` | no |

|  [target\_arn](#input\_target\_arn) | The ARN of the target to invoke. This uses the Universal Target ARN format,
    not the standard ARN of the resource itself. For more details on constructing
    a universal target ARN, see:
    https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets-universal.html#supported-universal-targets.

    Example: `arn:aws:scheduler:::aws-sdk::` | `string` | n/a | yes |

|  [target\_role\_arn](#input\_target\_role\_arn) | The ARN of the IAM role to assume when invoking the target. This role must
    have the necessary permissions to invoke the target. For more information on
    creating a role for EventBridge Scheduler, see:
    https://docs.aws.amazon.com/scheduler/latest/UserGuide/setting-up.html#setting-up-execution-role.

    When creating an IAM role to handle execution of services from a schedule,
    you should scope the policy to avoid the confused deputy problem:
    https://docs.aws.amazon.com/scheduler/latest/UserGuide/cross-service-confused-deputy-prevention.html

    Example: `arn:aws:iam::123456789012:role/service-role/MySchedulerRole` | `string` | n/a | yes |

|  [dead\_letter\_arn](#input\_dead\_letter\_arn) | ARN of the SQS queue specified as the destination for the dead-letter queue. | `string` | `null` | no |

|  [maximum\_event\_age\_in\_seconds](#input\_maximum\_event\_age\_in\_seconds) | The maximum age of a message in seconds that the schedule can retry.
    If the message is older than this value, the schedule will not retry the
    message. The value ranges between 60 and 86400 seconds (default) | `number` | `null` | no |

|  [maximum\_retry\_attempts](#input\_maximum\_retry\_attempts) | The number of times the schedule will retry the invocation in case of
    failure. The value ranges between 0 and 185 (default). | `number` | `null` | no |

## Outputs

| Name | Description |

|------|-------------|

|  [id](#output\_id) | n/a |

|  [arn](#output\_arn) | n/a |

|  [group\_name](#output\_group\_name) | n/a |
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/launchbynttdata/tf-aws-module_primitive-aws_scheduler_schedule

Awesome Lists containing this project

README
