Skip to content

Latest commit

 

History

History
154 lines (99 loc) · 7.53 KB

README.md

File metadata and controls

154 lines (99 loc) · 7.53 KB
Raw

Terraform AWS Cloudwatch Event Rule

Terraform module to create cloudwatch event rule on AWS.

Terraform Licence

We eat, drink, sleep and most importantly love DevOps. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure.

This module is basically combination of Terraform open source and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.

We have fifty plus terraform modules. A few of them are comepleted and are available for open source usage while a few others are in progress.

Prerequisites

This module has a few dependencies:

Examples

IMPORTANT: Since the master branch used in source varies based on new modifications, we suggest that you use the release versions here.

Simple Example

Here is an example of how you can use this module in your inventory structure:

    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"
    }

Inputs

Name Description Type Default Required
application Application (e.g. cd or clouddrove). string "" no
arn The Amazon Resource Name (ARN) associated with the role that is used for target invocation. string "" no
description The description for the rule. string "" no
enabled Enable event. bool true no
environment Environment (e.g. prod, dev, staging). string "" no
event_pattern (schedule_expression isn't specified) Event pattern described a JSON object. See full documentation of CloudWatch Events and Event Patterns for details. any null no
input_path The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. string "" no
is_enabled Whether the rule should be enabled (defaults to true). bool true no
label_order Label order, e.g. name,application. list [] no
managedby ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. string "anmol@clouddrove.com" no
name Name (e.g. app or cluster). string "" no
role_arn The Amazon Resource Name (ARN) associated with the role that is used for target invocation. string "" no
schedule_expression (if event_pattern isn't specified) The scheduling expression. For example, cron(0 20 * * ? *) or rate(5 minutes). any null no
target_id The Amazon Resource Name (ARN) associated with the role that is used for target invocation. string "" no
target_role_arn The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. Required if ecs_target is used. string "" no

Outputs

Name Description
arn The ARN of the cloudwatch metric alarm.
id The ID of the health check.
tags A mapping of tags to assign to the resource.

Testing

In this module testing is performed with terratest and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a GO environment in your system.

You need to run the following command in the testing folder:

  go test -run Test

Feedback

If you come accross a bug or have any feedback, please log it in our issue tracker, or feel free to drop us an email at hello@clouddrove.com.

If you have found it worth your time, go ahead and give us a ★ on our GitHub!

About us

At CloudDrove, we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering.

We are The Cloud Experts!

We ❤️ Open Source and you can check out our other modules to get help with your new Cloud ideas.