README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name : Terraform AWS Cloudwatch Event Rule

# License of this project
license: "MIT"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-cloudwatch-event-rule

# Badges to display
badges:
  - name: "Terraform"
    image: "https://img.shields.io/badge/terraform-v0.13-green"
    url: "https://www.terraform.io"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-MIT-blue.svg"
    url: "LICENSE.md"

#  description of this project
description: |-
  Terraform module to create cloudwatch event rule on AWS.

# extra content
include:
  - "terraform.md"

# How to use this project
usage : |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
      module "event-rule" {
        source              = "clouddrove/cloudwatch-event-rule/aws"
        version             = "0.13.0"
        name                = "event-rule"
        application         = "clouddrove"
        environment         = "test"
        label_order         = ["environment", "name", "application"]
        description         = "Event Rule."
        schedule_expression = "cron(0/5 * * * ? *)"
        target_id           = "test"
        arn                 = "arn:aws:lambda:eu-west-1:866067750630:function:test"
      }
  ```