docs(readme): add terraform-docs (#2)

terraform-aws-modules · Mar 22, 2021 · a091470 · a091470
1 parent 48eeb94
commit a091470
Show file tree

Hide file tree

Showing 9 changed files with 406 additions and 2 deletions.
diff --git a/examples/api-gateway-event-source/README.md b/examples/api-gateway-event-source/README.md
@@ -14,3 +14,52 @@ $ terraform apply
 
 Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
 
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.14.0 |
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| api_gateway | terraform-aws-modules/apigateway-v2/aws | 0.14.0 |
+| apigateway_put_events_to_eventbridge_policy | terraform-aws-modules/iam/aws//modules/iam-policy | 3.13.0 |
+| apigateway_put_events_to_eventbridge_role | terraform-aws-modules/iam/aws//modules/iam-assumable-role | 3.13.0 |
+| eventbridge | ../../ |  |
+
+## Resources
+
+| Name |
+|------|
+| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
+| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) |
+| [aws_sqs_queue_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue_policy) |
+| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
+
+## Inputs
+
+No input.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| eventbridge\_role\_arn | The ARN of the IAM role created for EventBridge |
+| eventbridge\_role\_name | The name of the IAM role created for EventBridge |
+| this\_eventbridge\_bus\_arn | The EventBridge Bus Arn |
+| this\_eventbridge\_bus\_name | The EventBridge Bus Name |
+| this\_eventbridge\_rule\_arns | The EventBridge Rule ARNs created |
+| this\_eventbridge\_rule\_ids | The EventBridge Rule IDs created |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/cloudwatch-target/README.md b/examples/cloudwatch-target/README.md
@@ -0,0 +1,55 @@
+# EventBridge Cloudwatch Example
+
+Configuration in this directory creates EventBridge resource configuration.
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```
+
+Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.14.0 |
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| eventbridge | ../../ |  |
+
+## Resources
+
+| Name |
+|------|
+| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) |
+| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
+
+## Inputs
+
+No input.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| eventbridge\_bus\_arn | The EventBridge Bus ARN |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/complete/README.md b/examples/complete/README.md
@@ -13,3 +13,49 @@ $ terraform apply
 ```
 
 Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.14.0 |
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| eventbridge | ../../ |  |
+
+## Resources
+
+| Name |
+|------|
+| [aws_cloudwatch_log_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) |
+| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
+| [aws_kinesis_stream](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kinesis_stream) |
+| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) |
+| [aws_sqs_queue_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue_policy) |
+| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
+
+## Inputs
+
+No input.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| eventbridge\_bus\_arn | The EventBridge Bus ARN |
+| eventbridge\_rule\_arns | The EventBridge Rule ARNs |
+| eventbridge\_rule\_ids | The EventBridge Rule IDs |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/simple/README.md b/examples/simple/README.md
@@ -14,3 +14,40 @@ $ terraform apply
 
 Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
 
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.14.0 |
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| random | >= 0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| eventbridge | ../../ |  |
+
+## Resources
+
+| Name |
+|------|
+| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
+
+## Inputs
+
+No input.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| eventbridge\_bus\_arn | The EventBridge Bus ARN |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/sqs-target/README.md b/examples/sqs-target/README.md
@@ -14,4 +14,47 @@ $ terraform apply
 
 Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
 
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.14.0 |
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| eventbridge | ../../ |  |
+
+## Resources
+
+| Name |
+|------|
+| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
+| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) |
+| [aws_sqs_queue_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue_policy) |
+| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
+
+## Inputs
+
+No input.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| eventbridge\_bus\_arn | The EventBridge Bus ARN |
+| eventbridge\_rule\_arns | The EventBridge Rule ARNs |
+| eventbridge\_rule\_ids | The EventBridge Rule IDs |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
diff --git a/examples/step-function-target/README.md b/examples/step-function-target/README.md
@@ -0,0 +1,55 @@
+# EventBridge StepFunction Example
+
+Configuration in this directory creates EventBridge resource configuration.
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```
+
+Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.14.0 |
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| random | >= 0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| eventbridge | ../../ |  |
+| step_function | terraform-aws-modules/step-functions/aws | 1.2.0 |
+
+## Resources
+
+| Name |
+|------|
+| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
+
+## Inputs
+
+No input.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| eventbridge\_bus\_arn | The EventBridge Bus ARN |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
diff --git a/examples/transform-input/README.md b/examples/transform-input/README.md
@@ -14,4 +14,44 @@ $ terraform apply
 
 Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
 
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
 
+| Name | Version |
+|------|---------|
+| terraform | >= 0.14.0 |
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| eventbridge | ../../ |  |
+
+## Resources
+
+| Name |
+|------|
+| [aws_iam_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) |
+| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) |
+| [aws_sqs_queue_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue_policy) |
+| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
+
+## Inputs
+
+No input.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| eventbridge\_bus\_arn | The EventBridge Bus ARN |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/with-archive/README.md b/examples/with-archive/README.md
@@ -1,4 +1,4 @@
-# EventBridge Simple Example
+# EventBridge Archive Example
 
 Configuration in this directory creates EventBridge resource configuration.
 
@@ -14,3 +14,44 @@ $ terraform apply
 
 Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
 
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.14.0 |
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | >= 3.19 |
+| random | >= 0 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| eventbridge | ../../ |  |
+| eventbridge_archive_only | ../../ |  |
+
+## Resources
+
+| Name |
+|------|
+| [aws_cloudwatch_event_bus](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_event_bus) |
+| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
+
+## Inputs
+
+No input.
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| eventbridge\_archive\_arns | The EventBridge Archive ARNs |
+| eventbridge\_bus\_arn | The EventBridge Bus ARN |
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->