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-ec2-bastion-server

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

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-ec2-bastion-server

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-bastion-server.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-ec2-bastion-server/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ec2-bastion-server.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-ec2-bastion-server/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: "bastion"
    description: "🔒Secure Bastion implemented as Docker Container running Alpine Linux with Google Authenticator & DUO MFA support"
    url: "https://github.com/cloudposse/bastion"
  - name: "terraform-aws-ec2-instance"
    description: "Terraform module for providing a general EC2 instance provisioned by Ansible"
    url: "https://github.com/cloudposse/terraform-aws-ec2-instance"
  - name: "terraform-aws-ec2-ami-backup"
    description: "Terraform module for automatic & scheduled AMI creation"
    url: "https://github.com/cloudposse/terraform-aws-ec2-ami-backup"

# Short description of this project
description: |-
  Terraform module to define a generic Bastion host with parameterized `user_data` and support for AWS SSM Session Manager for remote access with IAM authentication.

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

# Contributors to this project
contributors: []