-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.yaml
67 lines (57 loc) · 2.17 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name : Terraform AWS Active Directory
# License of this project
license: "APACHE"
# Canonical GitHub repo
github_repo: clouddrove/terraform-aws-active-directory
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/clouddrove/terraform-aws-active-directory.svg"
url: "https://github.com/clouddrove/terraform-aws-active-directory/releases/latest"
- name: "tfsec"
image: "https://github.com/clouddrove/terraform-aws-active-directory/actions/workflows/tfsec.yml/badge.svg"
url: "https://github.com/clouddrove/terraform-aws-active-directory/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: |-
Get attributes of AWS Directory Service directory (SimpleAD, Managed AD, AD Connector). It's especially useful to refer AWS Managed AD or on-premise AD in AD Connector configuration.
# 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 "ad" {
source = "clouddrove/active-directory/aws"
versions = "1.0.0"
name = "adclouddrove"
label_order = ["name", "environment"]
subnet_ids = module.subnets.public_subnet_id
vpc_settings = { vpc_id : module.vpc.vpc_id, subnet_ids : join(",", module.subnets.public_subnet_id) }
ad_name = "clouddrovepoc.example.com"
ad_password = "xyz123@abc"
ip_whitelist = ["51.79.69.69/32"]
}
```