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-aws-api-gateway

# Tags of this project
tags:
  - terraform
  - terraform-modules
  - api-gateway
  - rest-api
# Categories of this project
categories:
  - terraform-modules/api-gateway

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

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-api-gateway

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-api-gateway.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-api-gateway/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-api-gateway.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-api-gateway/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: "terraform-yaml-config"
    description: "Terraform module to convert local and remote YAML configuration templates into Terraform lists and maps"
    url: "https://github.com/cloudposse/terraform-yaml-config"

# Short description of this project
description: |-
  Terraform module to provision API Gatway resources.

  The root module creates an API Gateway [REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html) 
  along with configuring tracing, logging, and metrics.

  The module also consists of the following submodules:

    - [account-settings](modules/account-settings) - to provision account-level settings for logging and metrics for API Gateway

introduction: |-
  A set of modules for configuring an API Gateway

references:
  - name: "API Gateway CloudWatch Logging"
    description: "To enable CloudWatch Logs, you must grant API Gateway permission to read and write logs to CloudWatch for your account."
    url: "https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html"

  - name: "Create a monitor"
    description: "Create datadog monitors"
    url: "https://docs.datadoghq.com/api/v1/monitors/#create-a-monitor"

  - name: "Terraform Datadog role resources"
    description: "Provides a Datadog role resource. Used to create and manage Datadog roles"
    url: "https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/role"

  - name: "Datadog permissions"
    description: "Use this data source to retrieve the list of Datadog permissions by name and their corresponding ID, for use in the role resource"
    url: "https://registry.terraform.io/providers/DataDog/datadog/latest/docs/data-sources/permissions"

  - name: "Role Based Access Control"
    description: "Roles categorize users and define what account permissions those users have, such as what data they can read or what account assets they can modify"
    url: "https://docs.datadoghq.com/account_management/rbac"

  - name: "Managing Multiple-Organization Accounts"
    description: "It is possible to manage multiple child-organizations from one parent-organization account. This is typically used by Managed Service Providers that have customers which should not have access to each others' data"
    url: "https://docs.datadoghq.com/account_management/multi_organization"

# How to use this project
usage: |2-

  Setup the account-level settings for logging and metrics for API Gateway:

  ```hcl
  module "api_gateway_account_settings" {
    source  = "cloudposse/api-gateway/aws//modules/account-settings"
    # version = "x.x.x"

    context = module.this.context
  }
  ```

examples: |-
  Review the [examples](examples) folder to see how to use the API Gateway modules.

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []