Skip to content

Commit

Permalink
Initial complete commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
skyzyx committed Mar 22, 2024
1 parent 052c152 commit 62910c2
Showing 1 changed file with 22 additions and 24 deletions.
46 changes: 22 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<!--
<div align="center"><img src="tf-modules-stable.png" alt="Terraform Modules: Stable" width="500"><br></div>
<div align="center"><img src="https://github.com/northwood-labs/mod-template/raw/main/tofu-modules-lightmode.png#gh-light-mode-only" alt="Seal of Approval" width="500"><img src="https://github.com/northwood-labs/mod-template/raw/main/tofu-modules-darkmode.png#gh-dark-mode-only" alt="Seal of Approval" width="500"><br></div>

---
-->

# AWS Resource Tags Module

Expand Down Expand Up @@ -40,37 +38,37 @@ module "aws_resource_tags" {
<!-- BEGIN_TF_DOCS -->
## Requirements

| Name | Provider | Version |
|------|----------|---------|
| `terraform` | | `~> 1.6` |
| `aws` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | `~> 5.0` |
| Name | Provider | Version |
|-------------|------------------------------------------------------------------------------------|----------|
| `terraform` | | `~> 1.6` |
| `aws` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) | `~> 5.0` |

## Inputs

| Req | Variable | Type | Description | Default |
|:---:|----------|------|-------------|---------|
| :white_check_mark: | `app` | [`string`](https://opentofu.org/docs/language/expressions/types/) | The `app` tag. Lowercase and hyphenated. | |
| :white_check_mark: | `env` | [`string`](https://opentofu.org/docs/language/expressions/types/) | The `env` tag. Lowercase. | |
| | `extra` | [`map`](https://opentofu.org/docs/language/expressions/types/) | Additional (ad hoc) tags to apply. | `{}` |
| Req | Variable | Type | Description | Default |
|:------------------:|----------|-------------------------------------------------------------------|------------------------------------------|---------|
| :white_check_mark: | `app` | [`string`](https://opentofu.org/docs/language/expressions/types/) | The `app` tag. Lowercase and hyphenated. | |
| :white_check_mark: | `env` | [`string`](https://opentofu.org/docs/language/expressions/types/) | The `env` tag. Lowercase. | |
| | `extra` | [`map`](https://opentofu.org/docs/language/expressions/types/) | Additional (ad hoc) tags to apply. | `{}` |

## Outputs

| Name | Description |
|------|-------------|
| `app` | The value of the `app` input variable. |
| `common_tags` | Most services support simple `key = value` pairs. |
| `deployed_at` | The [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) at which the resources were deployed. |
| `deployed_by` | The ARN of the assumed role which performed the deployment. |
| `env` | The value of the `env` input variable. |
| `launch_template_resource_tags` | Tags formatted for use with _Launch Templates_. |
| `region` | The AWS region in which the resources are being created. |
| Name | Description |
|---------------------------------|-----------------------------------------------------------------------------------------------------|
| `app` | The value of the `app` input variable. |
| `common_tags` | Most services support simple `key = value` pairs. |
| `deployed_at` | The [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) at which the resources were deployed. |
| `deployed_by` | The ARN of the assumed role which performed the deployment. |
| `env` | The value of the `env` input variable. |
| `launch_template_resource_tags` | Tags formatted for use with _Launch Templates_. |
| `region` | The AWS region in which the resources are being created. |

## Resources

| Kind | Source | Name | Provider |
|------|--------|------|----------|
| Kind | Source | Name | Provider |
|-------------|------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------------------------------------------------------------------|
| data source | [`data.aws_caller_identity`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | `current` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) |
| data source | [`data.aws_region`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | `current` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) |
| data source | [`data.aws_region`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | `current` | [hashicorp/aws](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) |
<!-- END_TF_DOCS -->

## Testing
Expand Down

0 comments on commit 62910c2

Please sign in to comment.