From 1fabc835af7612421a0ab58949b6961de9043213 Mon Sep 17 00:00:00 2001 From: wellsiau-aws Date: Thu, 6 Apr 2023 22:52:56 -0700 Subject: [PATCH 1/3] docs: add example for access-analyzer --- docs/resources/accessanalyzer_analyzer.md | 25 ++++++++++++-- .../account_analyzer.tf | 4 +++ .../organization_analyzer.tf | 8 +++++ .../resources/accessanalyzer_analyzer.md.tmpl | 34 +++++++++++++++++++ 4 files changed, 69 insertions(+), 2 deletions(-) create mode 100644 examples/resources/awscc_accessanalyzer_analyzer/account_analyzer.tf create mode 100644 examples/resources/awscc_accessanalyzer_analyzer/organization_analyzer.tf create mode 100644 templates/resources/accessanalyzer_analyzer.md.tmpl diff --git a/docs/resources/accessanalyzer_analyzer.md b/docs/resources/accessanalyzer_analyzer.md index 60fd936031..e01c2d327e 100644 --- a/docs/resources/accessanalyzer_analyzer.md +++ b/docs/resources/accessanalyzer_analyzer.md @@ -1,5 +1,4 @@ --- -# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_accessanalyzer_analyzer Resource - terraform-provider-awscc" subcategory: "" description: |- @@ -10,7 +9,29 @@ description: |- The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account +## Example Usage +### Single Account Analyzer +To use awscc_accessanalyzer_analyzer on single AWS account: +```terraform +resource "awscc_accessanalyzer_analyzer" "this" { + analyzer_name = "example" + type = ACCOUNT +} +``` + +### Organization Analyzer +To enable awscc_accessanalyzer_analyzer at the organization level, modify example below to match your AWS organization configuration. +```terraform +resource "aws_organizations_organization" "this" { + aws_service_access_principals = ["access-analyzer.amazonaws.com"] +} + +resource "awscc_accessanalyzer_analyzer" "this" { + analyzer_name = "example" + type = "ORGANIZATION" +} +``` ## Schema @@ -68,4 +89,4 @@ Import is supported using the following syntax: ```shell $ terraform import awscc_accessanalyzer_analyzer.example -``` +``` \ No newline at end of file diff --git a/examples/resources/awscc_accessanalyzer_analyzer/account_analyzer.tf b/examples/resources/awscc_accessanalyzer_analyzer/account_analyzer.tf new file mode 100644 index 0000000000..9cc713956d --- /dev/null +++ b/examples/resources/awscc_accessanalyzer_analyzer/account_analyzer.tf @@ -0,0 +1,4 @@ +resource "awscc_accessanalyzer_analyzer" "this" { + analyzer_name = "example" + type = ACCOUNT +} \ No newline at end of file diff --git a/examples/resources/awscc_accessanalyzer_analyzer/organization_analyzer.tf b/examples/resources/awscc_accessanalyzer_analyzer/organization_analyzer.tf new file mode 100644 index 0000000000..f3da31bd04 --- /dev/null +++ b/examples/resources/awscc_accessanalyzer_analyzer/organization_analyzer.tf @@ -0,0 +1,8 @@ +resource "aws_organizations_organization" "this" { + aws_service_access_principals = ["access-analyzer.amazonaws.com"] +} + +resource "awscc_accessanalyzer_analyzer" "this" { + analyzer_name = "example" + type = "ORGANIZATION" +} \ No newline at end of file diff --git a/templates/resources/accessanalyzer_analyzer.md.tmpl b/templates/resources/accessanalyzer_analyzer.md.tmpl new file mode 100644 index 0000000000..ab67e37642 --- /dev/null +++ b/templates/resources/accessanalyzer_analyzer.md.tmpl @@ -0,0 +1,34 @@ +--- +page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +subcategory: "" +description: |- +{{ .Description | plainmarkdown | trimspace | prefixlines " " }} +--- + +# {{.Name}} ({{.Type}}) + +{{ .Description | trimspace }} + +{{ if .HasExample -}} +## Example Usage + +### Single Account Analyzer +To use {{.Name}} on single AWS account: +{{ tffile (printf "examples/resources/%s/account_analyzer.tf" .Name)}} + +### Organization Analyzer +To enable {{.Name}} at the organization level, modify example below to match your AWS organization configuration. +{{ tffile (printf "examples/resources/%s/organization_analyzer.tf" .Name)}} + +{{- end }} + +{{ .SchemaMarkdown | trimspace }} +{{- if .HasImport }} + +## Import + +Import is supported using the following syntax: + +{{ codefile "shell" .ImportFile }} + +{{- end }} \ No newline at end of file From d39836170c04eb157adee8ecf27d8d7f4521648c Mon Sep 17 00:00:00 2001 From: Kit Ewbank Date: Thu, 13 Apr 2023 08:39:57 -0400 Subject: [PATCH 2/3] Run 'make docs'. --- docs/resources/accessanalyzer_analyzer.md | 24 +---------------------- 1 file changed, 1 insertion(+), 23 deletions(-) diff --git a/docs/resources/accessanalyzer_analyzer.md b/docs/resources/accessanalyzer_analyzer.md index e01c2d327e..691faa07f1 100644 --- a/docs/resources/accessanalyzer_analyzer.md +++ b/docs/resources/accessanalyzer_analyzer.md @@ -9,29 +9,7 @@ description: |- The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account -## Example Usage - -### Single Account Analyzer -To use awscc_accessanalyzer_analyzer on single AWS account: -```terraform -resource "awscc_accessanalyzer_analyzer" "this" { - analyzer_name = "example" - type = ACCOUNT -} -``` - -### Organization Analyzer -To enable awscc_accessanalyzer_analyzer at the organization level, modify example below to match your AWS organization configuration. -```terraform -resource "aws_organizations_organization" "this" { - aws_service_access_principals = ["access-analyzer.amazonaws.com"] -} - -resource "awscc_accessanalyzer_analyzer" "this" { - analyzer_name = "example" - type = "ORGANIZATION" -} -``` + ## Schema From 9effdacf5b4986182e51ee9d76ab55d7e99392cd Mon Sep 17 00:00:00 2001 From: Simon Davis Date: Thu, 13 Apr 2023 09:40:53 -0700 Subject: [PATCH 3/3] remove HasExample function and whitespace changes --- docs/resources/accessanalyzer_analyzer.md | 26 +++++++++++++++++++ .../resources/accessanalyzer_analyzer.md.tmpl | 7 ++--- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/docs/resources/accessanalyzer_analyzer.md b/docs/resources/accessanalyzer_analyzer.md index 691faa07f1..80bcee5251 100644 --- a/docs/resources/accessanalyzer_analyzer.md +++ b/docs/resources/accessanalyzer_analyzer.md @@ -9,7 +9,33 @@ description: |- The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account +## Example Usage +### Single Account Analyzer + +To use awscc_accessanalyzer_analyzer on single AWS account: + +```terraform +resource "awscc_accessanalyzer_analyzer" "this" { + analyzer_name = "example" + type = ACCOUNT +} +``` + +### Organization Analyzer + +To enable awscc_accessanalyzer_analyzer at the organization level, modify example below to match your AWS organization configuration. + +```terraform +resource "aws_organizations_organization" "this" { + aws_service_access_principals = ["access-analyzer.amazonaws.com"] +} + +resource "awscc_accessanalyzer_analyzer" "this" { + analyzer_name = "example" + type = "ORGANIZATION" +} +``` ## Schema diff --git a/templates/resources/accessanalyzer_analyzer.md.tmpl b/templates/resources/accessanalyzer_analyzer.md.tmpl index ab67e37642..6b1fe06ee0 100644 --- a/templates/resources/accessanalyzer_analyzer.md.tmpl +++ b/templates/resources/accessanalyzer_analyzer.md.tmpl @@ -9,18 +9,19 @@ description: |- {{ .Description | trimspace }} -{{ if .HasExample -}} ## Example Usage ### Single Account Analyzer + To use {{.Name}} on single AWS account: + {{ tffile (printf "examples/resources/%s/account_analyzer.tf" .Name)}} ### Organization Analyzer + To enable {{.Name}} at the organization level, modify example below to match your AWS organization configuration. -{{ tffile (printf "examples/resources/%s/organization_analyzer.tf" .Name)}} -{{- end }} +{{ tffile (printf "examples/resources/%s/organization_analyzer.tf" .Name)}} {{ .SchemaMarkdown | trimspace }} {{- if .HasImport }}