Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
clouddrove-ci committed Apr 24, 2024
1 parent 9133d9a commit 2ffbf45
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 114 deletions.
158 changes: 44 additions & 114 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
<!-- This file was automatically generated by the `geine`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->


[![Banner](https://github.com/clouddrove/terraform-gcp-vpc/blob/master/docs/CloudDrove.png)][website]
<h1 align="center">
Terraform AWS eventbridge
</h1>

<p align="center" style="font-size: 1.2rem;">
Terraform module is used to create eventbridge resource on AWS for network connectivity..
</p>
<p align="center" style="font-size: 1.2rem;">
With our comprehensive DevOps toolkit - streamline operations, automate workflows, enhance collaboration and, most importantly, deploy with confidence.
</p>


<p align="center">

<a href="https://www.terraform.io">
<img src="https://img.shields.io/badge/Terraform-v1.1.7-green" alt="Terraform">
<a href="https://github.com/clouddrove//terraform-aws-eventbridge/releases/latest">
<img src="https://img.shields.io/github/release/clouddrove//terraform-aws-eventbridge.svg" alt="Latest Release">
</a>
<a href="https://github.com/clouddrove//terraform-aws-eventbridge/actions/workflows/tfsec.yml">
<img src="https://github.com/clouddrove//terraform-aws-eventbridge/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
</a>
<a href="LICENSE.md">
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
</a>
<a href="https://github.com/clouddrove/terraform-aws-eventbridge/actions/workflows/tfsec.yml">
<img src="https://github.com/clouddrove/terraform-aws-eventbridge/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
</a>
<a href="https://github.com/clouddrove/terraform-aws-eventbridge/actions/workflows/terraform.yml">
<img src="https://github.com/clouddrove/terraform-aws-eventbridge/actions/workflows/terraform.yml/badge.svg" alt="static-checks">
<a href="CHANGELOG.md">
<img src="https://img.shields.io/badge/Changelog-blue" alt="Changelog">
</a>


Expand All @@ -31,6 +31,9 @@
<a href='https://facebook.com/sharer/sharer.php?u=https://github.com/clouddrove/terraform-aws-eventbridge'>
<img title="Share on Facebook" src="https://user-images.githubusercontent.com/50652676/62817743-4f64cb80-bb59-11e9-90c7-b057252ded50.png" />
</a>
<a href='https://www.instagram.com/cloud_drove?igsh=cHJqaDY3bGtnYmh3' title="Follow On Instagram">
<img src="https://github.com/gauravghongde/social-icons/blob/master/SVG/Color/Instagram.svg" width="23" height="23" />
</a>
<a href='https://www.linkedin.com/shareArticle?mini=true&title=Terraform+AWS+eventbridge&url=https://github.com/clouddrove/terraform-aws-eventbridge'>
<img title="Share on LinkedIn" src="https://user-images.githubusercontent.com/50652676/62817742-4e339e80-bb59-11e9-87b9-a1f68cae1049.png" />
</a>
Expand All @@ -45,149 +48,76 @@



## Prerequisites
## Prerequisites and Providers

This module has a few dependencies:
This table contains both Prerequisites and Providers:

| Description | Name | Version |
|:-------------:|:-------------------------------------------:|:---------:|
| **Prerequisite** | [Terraform](https://learn.hashicorp.com/terraform/getting-started/install.html) | >= 1.6.6 |
| **Provider** | [aws](https://aws.amazon.com/) | >= 5.31.0 |







**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-aws-eventbridge/releases).

<!--
### event_bus_archive
Here is an example of how you can use this module in your inventory structure:
```hcl
module "eventbridge_archive" {
create_bus = true
create_archives = true
name = "bus"
environment = "test"
label_order = ["name", "environment"]
archives = {
"launch-archive-existing-bus" = {
description = "launch-archive",
retention_days = 1
event_pattern = jsonencode(
{
"source" : ["aws.autoscaling"],
"detail-type" : ["EC2 Instance Launch Successful"]
}
)
}
}
}
```
### event_rule_target
```hcl
module "eventbridge" {
name = "subnets"
environment = "test"
label_order = ["name", "environment"]
rules = {
orders = {
description = "Capture all order data"
event_pattern = jsonencode({ "source" : ["myapp.orders"] })
enabled = true
role_arn = module.iam-role.arn
}
emails = {
description = "Capture all emails data"
event_pattern = jsonencode({ "source" : ["myapp.emails"] })
enabled = true
}
}
targets = {
orders = [
{
name = "send-orders-to-sqs-wth-dead-letter"
arn = aws_sqs_queue.queue.arn
dead_letter_arn = aws_sqs_queue.dlq.arn
},
{
name = "send-orders-to-sqs"
arn = aws_sqs_queue.queue.arn
}
]
emails = [
{
name = "send-orders-to-kinesis"
dead_letter_arn = aws_sqs_queue.dlq.arn
arn = aws_sqs_queue.dlq.arn
}
]
}
}
```
## Feedback
Spot a bug or have thoughts to share with us? Let's squash it together! Log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-eventbridge/issues), feel free to drop us an email at [[email protected]](mailto:[email protected]).
## Inputs
Show some love with a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-eventbridge)! if our work has brightened your day! – your feedback fuels our journey!
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| archives | A map of objects with the EventBridge Archive definitions. | `map(any)` | `{}` | no |
| create | Controls whether resources should be created | `bool` | `true` | no |
| create\_archives | Controls whether EventBridge Archive resources should be created | `bool` | `false` | no |
| create\_bus | Controls whether EventBridge Bus resource should be created | `bool` | `true` | no |
| create\_permissions | Controls whether EventBridge Permission resources should be created | `bool` | `true` | no |
| create\_role | Controls whether IAM role for Lambda Function should be created | `bool` | `true` | no |
| create\_rules | Controls whether EventBridge Rule resources should be created | `bool` | `true` | no |
| create\_targets | Controls whether EventBridge Target resources should be created | `bool` | `true` | no |
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
| permissions | A map of objects with EventBridge Permission definitions. | `map(any)` | `{}` | no |
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-eventbridge"` | no |
| rules | A map of objects with EventBridge Rule definitions. | `map(any)` | `{}` | no |
| tags | A map of tags to assign to resources. | `map(string)` | `{}` | no |
| targets | A map of objects with EventBridge Target definitions. | `any` | `{}` | no |

## Outputs

| Name | Description |
|------|-------------|
| eventbridge\_archive\_arns | The EventBridge Archive Arns created |
| eventbridge\_bus\_arn | The EventBridge Bus Arn |
| eventbridge\_rule\_arns | The EventBridge Rule ARNs created |
| eventbridge\_rule\_ids | The EventBridge Rule IDs created |
| tags | A mapping of tags to assign to the resource. |
## Join Our Slack Community
Join our vibrant open-source slack community and embark on an ever-evolving journey with CloudDrove; helping you in moving upwards in your career path.
Join our vibrant Open Source Slack Community and embark on a learning journey with CloudDrove. Grow with us in the world of DevOps and set your career on a path of consistency.
🌐💬What you'll get after joining this Slack community:
## Feedback
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-eventbridge/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).
- 🚀 Encouragement to upgrade your best version.
- 🌈 Learning companionship with our DevOps squad.
- 🌱 Relentless growth with daily updates on new advancements in technologies.
Join our tech elites [Join Now][slack] 🚀
## Explore Our Blogs
If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-eventbridge)!
Click [here][blog] :books: :star2:
## About us
## Tap into our capabilities
We provide a platform for organizations to engage with experienced top-tier DevOps & Cloud services. Tap into our pool of certified engineers and architects to elevate your DevOps and Cloud Solutions.
At [CloudDrove][website], 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.
At [CloudDrove][website], has extensive experience in designing, building & migrating environments, securing, consulting, monitoring, optimizing, automating, and maintaining complex and large modern systems. With remarkable client footprints in American & European corridors, our certified architects & engineers are ready to serve you as per your requirements & schedule. Write to us at [[email protected]](mailto:[email protected]).
<p align="center">We are <b> The Cloud Experts!</b></p>
<hr />
<p align="center">We ❤️ <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://github.com/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p>
<p align="center">We ❤️ <a href="https://github.com/clouddrove">Open Source</a> and you can check out <a href="https://registry.terraform.io/namespaces/clouddrove">our other modules</a> to get help with your new Cloud ideas.</p>
[website]: https://clouddrove.com
[blog]: https://blog.clouddrove.com
[slack]: https://www.launchpass.com/devops-talks
[github]: https://github.com/clouddrove
[linkedin]: https://cpco.io/linkedin
[twitter]: https://twitter.com/clouddrove/
Expand Down
31 changes: 31 additions & 0 deletions docs/io.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| archives | A map of objects with the EventBridge Archive definitions. | `map(any)` | `{}` | no |
| create | Controls whether resources should be created | `bool` | `true` | no |
| create\_archives | Controls whether EventBridge Archive resources should be created | `bool` | `false` | no |
| create\_bus | Controls whether EventBridge Bus resource should be created | `bool` | `true` | no |
| create\_permissions | Controls whether EventBridge Permission resources should be created | `bool` | `true` | no |
| create\_role | Controls whether IAM role for Lambda Function should be created | `bool` | `true` | no |
| create\_rules | Controls whether EventBridge Rule resources should be created | `bool` | `true` | no |
| create\_targets | Controls whether EventBridge Target resources should be created | `bool` | `true` | no |
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
| permissions | A map of objects with EventBridge Permission definitions. | `map(any)` | `{}` | no |
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-eventbridge"` | no |
| rules | A map of objects with EventBridge Rule definitions. | `map(any)` | `{}` | no |
| tags | A map of tags to assign to resources. | `map(string)` | `{}` | no |
| targets | A map of objects with EventBridge Target definitions. | `any` | `{}` | no |

## Outputs

| Name | Description |
|------|-------------|
| eventbridge\_archive\_arns | The EventBridge Archive Arns created |
| eventbridge\_bus\_arn | The EventBridge Bus Arn |
| eventbridge\_rule\_arns | The EventBridge Rule ARNs created |
| eventbridge\_rule\_ids | The EventBridge Rule IDs created |
| tags | A mapping of tags to assign to the resource. |

0 comments on commit 2ffbf45

Please sign in to comment.