README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-provider-awsutils

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "MPL-2.0"

# Copyrights
copyrights:
  - name: "Cloud Posse, LLC"
    url: "https://cloudposse.com"
    year: "2021"

# Canonical GitHub repo
github_repo: cloudposse/terraform-provider-awsutils

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-provider-awsutils.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-awsutils/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-provider-awsutils.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-provider-awsutils/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "Cloud Posse Terraform Utils Provider"
    description: |-
      Terraform provider for various utilities (deep merging, stack configuration management), and to add additional
      missing functionality to Terraform
    url: "https://github.com/cloudposse/terraform-provider-awsutils"

# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
references:
  - name: "Terraform Plugins"
    description: "Terraform is logically split into two main parts: Terraform Core and Terraform Plugins. Each plugin exposes an implementation for a specific service, such as the AWS provider or the cloud-init provider."
    url: "https://www.terraform.io/docs/extend/plugin-types.html#providers"

# Short description of this project
description: |-
  Terraform provider for performing various tasks that cannot be performed with the official
  [AWS Terraform Provider](https://github.com/hashicorp/terraform-provider-aws) from Hashicorp.

  This provider is derived in large parts from the official HashiCorp AWS provider. We copied all the boilerplate
  functionality so that it follows the `terraform-provider-aws` conventions, but then removed all the standard resources
  and added in our own. This module is intended to be used as an escape hatch to accomplish all the hard things that
  will never be supported by the official provider due to strong (and valid) opinions of how providers should manage the
  lifecycle of a resource. Unfortunately, in the real-world we have to make tradeoffs to get stuff done. That's this
  provider in a nutshell.

#introduction: |-
#  This is an introduction.

# How to use this module. Should be an easy example to copy and paste.
usage: |-
  Here is how to use this provider in your own Terraform code:

  ```hcl
  terraform {
    required_providers {
      awsutils = {
        source = "cloudposse/awsutils"
        version = ">= 0.1.0"
      }
    }
  }

  provdier "awsutils" {
    region = "us-east-2"
  }
  ```
  See the [Docs](./docs) for additional information.

# Example usage
examples: |-
  Here is an example of using this provider:

  ```hcl
  terraform {
    required_providers {
      awsutils = {
        source = "cloudposse/awsutils"
      }
    }
  }
  ```

  Here are some additional examples:

  - [`examples/resources/awsutils_default_vpc_deletion`](/examples/resources/awsutils_default_vpc_deletion/)

include:
  - "docs/developer.md"

# Contributors to this project
contributors: []