chore(tools/generate-docs): improve auto-generated docs tool

Author: ekristen

tools/generate-docs/docs.go

@@ -59,8 +59,17 @@ func execute(c *cli.Context) error { //nolint:funlen,gocyclo
 			continue
 		}
 
+		name := reg.Name
+		description := ""
+		if strings.HasPrefix(name, "AWS::") {
+			description = `This is a resource that is access and controlled via the Cloud Control API, as such it's name
+and properties do not match the standard format for aws-nuke resources. Furthermore, the resource properties are
+dynamically populated and therefore cannot be documented here.`
+		}
+
 		data := TemplateData{
-			Name:                reg.Name,
+			Name:                name,
+			Description:         description,
 			Properties:          docs.GeneratePropertiesMap(reg.Resource),
 			Settings:            reg.Settings,
 			DependsOn:           reg.DependsOn,
@@ -92,7 +101,7 @@ func execute(c *cli.Context) error { //nolint:funlen,gocyclo
 		}
 
 		if c.Bool("write-to-disk") {
-			filename := KebabCase(strings.ToLower(SplitCamelCase(reg.Name)))
+			filename := KebabCase(strings.ToLower(SplitCamelCase(name)))
 			filename = strings.Replace(filename, "io-t", "iot-", 1)
 			filename = strings.Replace(filename, "iamsaml-", "iam-saml-", 1)
 			filename = strings.Replace(filename, "wa-fv2-", "wafv2-", 1)

tools/generate-docs/files/resource.gomd

@@ -14,9 +14,11 @@ generated: true
 {{ if .AlternativeResource -}}
 ### Alternative Resource
 
-!!! note - Cloud Control API - Alternative Resource
-    This resource can also be controlled and used via Cloud Control API. Please refer to the documentation for
-    [Cloud Control Resources](../config-cloud-control.md) for more information.
+!!! warning - Cloud Control API - Alternative Resource
+    This resource conflicts with an alternative resource that can be controlled and used via Cloud Control API. If you
+    use this alternative resource, please note that any properties listed on this page may not be valid. You will need
+    run the tool to determine what properties are available for the alternative resource via the Cloud Control API.
+    Please refer to the documentation for [Cloud Control Resources](../config-cloud-control.md) for more information.
 
 ```text
 {{ .AlternativeResource }}
@@ -29,7 +31,6 @@ generated: true
 {{ range $key, $value := .Properties }}
 - `{{ $key }}`: {{ if ne $value "" }}{{ $value }}{{ else }}No Description{{ end }}
 {{- end }}
-{{- end }}
 
 !!! note - Using Properties
     Properties are what [Filters](../config-filtering.md) are written against in your configuration. You use the property
@@ -42,6 +43,7 @@ resources support properties. To write a filter against the string representatio
 the filter.
 
 The string value is always what is used in the output of the log format when a resource is identified.
+{{- end }}
 
 {{ if .Settings -}}
 ## Settings