terraform-examples/products/property/bulk-creation/.terraform-docs.yaml at main · akamai/terraform-examples · GitHub

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
68
69
70
71
72
73
74
75
76
header-from: main.tf
footer-from: ""
formatter: markdown table
recursive:
  enabled: false
  path: ""
content: |-

  {{ .Header }}

  # Usage
  Basic usage of this module is as follows:

  ```hcl
  module "example" {
    {{"\t"}} source  = "<module-location>"
  {{- if .Module.RequiredInputs }}
    {{"\n\t"}} # Required variables
    {{- range .Module.RequiredInputs }}
    {{"\t"}} {{ .Name }}  = <{{ .Type }}>
    {{- end }}
    {{- end }}
  {{- if .Module.OptionalInputs }}
    {{"\n\t"}} # Optional variables
    {{- range .Module.OptionalInputs }}
    {{"\t"}} {{ .Name }}  = <{{ .Type }}> | default: {{ .GetValue | printf "%s" }}
    {{- end }}
    {{- end }}
  }
   ```

  {{ .Requirements }}

  {{ .Resources }}

  {{ .Modules }}

  {{ .Inputs }}

  {{ .Outputs }}

  ## Resources
  - [Akamai API Credentials](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials)
  - [Akamai Terraform Provider](https://techdocs.akamai.com/terraform/docs)
  - [Akamai CLI for Terraform](https://github.com/akamai/cli-terraform)
  - [Linode Object Storage](https://www.linode.com/lp/object-storage/)
  - [Akamai Developer Youtube Channel](https://www.youtube.com/c/AkamaiDeveloper)
  - [Akamai Github](https://github.com/akamai)

output:
  file: README.md
  mode: inject
  template: |-
    <!-- BEGIN_TF_DOCS -->
    {{ .Content }}
    <!-- END_TF_DOCS -->
output-values:
  enabled: false
  from: ""
sort:
  enabled: true
  by: required
settings:
  anchor: true
  color: true
  default: true
  description: true
  escape: true
  hide-empty: false
  html: true
  indent: 2
  lockfile: true
  read-comments: true
  required: true
  sensitive: true
  type: true