An open API service indexing awesome lists of open source software.

https://github.com/workloads/web-redirects

URL Redirects.
https://github.com/workloads/web-redirects

aws terraform

Last synced: 5 months ago
JSON representation

URL Redirects.

Awesome Lists containing this project

README

          

# HCP Terraform Workspace `web-redirects`

> This repository manages URL redirects for [@workloads](https://github.com/workloads).

## Table of Contents

* [HCP Terraform Workspace `web-redirects`](#hcp-terraform-workspace-web-redirects)
* [Table of Contents](#table-of-contents)
* [Requirements](#requirements)
* [Development](#development)
* [Usage](#usage)
* [Inputs](#inputs)
* [Outputs](#outputs)
* [Notes](#notes)
* [Sensitive Data](#sensitive-data)
* [Contributors](#contributors)
* [License](#license)

## Requirements

- HashiCorp Terraform `1.9.x` or [newer](https://developer.hashicorp.com/terraform/downloads)

### Development

For development and testing of this repository:

- `terraform-docs` `0.18.0` or [newer](https://terraform-docs.io/user-guide/installation/)

## Usage

This repository uses a standard Terraform workflow (`init`, `plan`, `apply`).

For more information, including detailed usage guidelines, see the [Terraform documentation](https://developer.hashicorp.com/terraform/cli/commands).

### Inputs

| Name | Description | Type | Required |
|------|-------------|------|:--------:|
| management_region_aws | AWS-specific `Management` Region Identifier. | `string` | yes |
| domain | Parent Domain. | `string` | no |
| redirects | List of Redirect Objects. |

list(object({
name = string
target = string
utm_source = optional(string, "WKLDS_GO")
}))
| no |
| subdomain | Subdomain. | `string` | no |

### Outputs

| Name | Description |
|------|-------------|
| aws_cli_commands | AWS CLI Command for CloudFront operations. |
| aws_cloudfront_aliases | Exported Attributes for `module.web_redirects.aws_cloudfront_distribution.aliases`. |
| aws_cloudfront_domain_name | Exported Attribute for `module.web_redirects.aws_cloudfront_distribution.domain_name`. |
| aws_console_urls | AWS Console URLs. |
| aws_s3_bucket | Exported Attribute for `module.web_redirects.aws_s3_bucket`. |
| redirects | List of URL Redirects. |

## Notes

### Sensitive Data

Terraform state may contain [sensitive data](https://developer.hashicorp.com/terraform/language/state/sensitive-data). This workspace uses [HCP Terraform](https://developer.hashicorp.com/terraform/cloud-docs) to safely store state, and encrypt the data at rest.

## Contributors

For a list of current (and past) contributors to this repository, see [GitHub](https://github.com/workloads/web-redirects/graphs/contributors).

## License

Licensed under the Apache License, Version 2.0 (the "License").

You may download a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).

See the License for the specific language governing permissions and limitations under the License.