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-key-pair

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - security
  - ssh-keygen
  - ssh-keys

# Categories of this project
categories:
  - terraform-modules/security

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

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-key-pair

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-key-pair.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-key-pair/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-key-pair.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-key-pair/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: "github-authorized-keys"
    description: "Use GitHub teams to manage system user accounts and authorized_keys"
    url: "https://github.com/cloudposse/github-authorized-keys"
  - name: "sudosh"
    description: "Shell wrapper to run a login shell with `sudo` as the current user for the purpose of audit logging"
    url: "https://github.com/cloudposse/sudosh"
  - name: "terraform-tls-ssh-key-pair"
    description: "Terraform module for generating an SSH public/private key file."
    url: "https://github.com/cloudposse/terraform-tls-ssh-key-pair"

# Short description of this project
description: |-
  Terraform module for generating or importing an SSH public key file into AWS.

# How to use this project
usage: |-
  ```hcl
  module "ssh_key_pair" {
    source = "cloudposse/key-pair/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"
    namespace             = "eg"
    stage                 = "prod"
    name                  = "app"
    ssh_public_key_path   = "/secrets"
    generate_ssh_key      = "true"
    private_key_extension = ".pem"
    public_key_extension  = ".pub"
  }
  ```

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

# Contributors to this project
contributors: []