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 workspace

# License of this project
license: "APACHE"

# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-workspace

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/clouddrove/terraform-aws-workspace.svg"
    url: "https://github.com/clouddrove/terraform-aws-workspace/releases/latest"
  - name: "tfsec"
    image: "https://github.com/clouddrove/terraform-aws-workspace/actions/workflows/tfsec.yml/badge.svg"
    url: "https://github.com/clouddrove/terraform-aws-workspace/actions/workflows/tfsec.yml"
  - name: "Licence"
    image: "https://img.shields.io/badge/License-APACHE-blue.svg"
    url: "LICENSE.md"
  - name: "Changelog"
    image: "https://img.shields.io/badge/Changelog-blue"
    url: "CHANGELOG.md"

prerequesties:
  - name: Terraform
    url: https://learn.hashicorp.com/terraform/getting-started/install.html
    version: ">= 1.6.6"

providers:
  - name: aws
    url: https://aws.amazon.com/
    version: ">= 5.31.0"

module_dependencies: 
  - name: Labels Module
    url: https://github.com/clouddrove/terraform-aws-labels
    description: Provides resource tagging.

#  description of this project
description: |-
  AWS WorkSpaces service requires workspaces_DefaultRole IAM role to operate normally.

# How to use this project
# How to use this project
usage : |-
  ### Simple Example
  Here is an example of how you can use this module in your inventory structure:
  ```hcl
      module "workspace" {
      source       = "clouddrove/workspace/aws"
      version     = "1.0.1"
      name         = "workspace"
      environment  = "test"
      enabled      =  true

      workspace_username = "Administrator"
      label_order        = ["name", "environment"]
      bundle_id          = "wsb-8pmj7b7pq"
      directory_id       = module.ad.directory_id
      }

  ```