Merge pull request #1947 from awsdannyc/d-improve-awscc_elasticbeanst…

…alk_configuration_template docs: added example for awscc_elasticbeanstalk_configuration_template
hashicorp · Aug 22, 2024 · 8009208 · 8009208
2 parents 6e0b4f3 + e1a6db2
commit 8009208
Show file tree

Hide file tree

Showing 3 changed files with 114 additions and 3 deletions.
diff --git a/docs/resources/elasticbeanstalk_configuration_template.md b/docs/resources/elasticbeanstalk_configuration_template.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "awscc_elasticbeanstalk_configuration_template Resource - terraform-provider-awscc"
 subcategory: ""
 description: |-
@@ -10,7 +9,52 @@ description: |-
 
 Resource Type definition for AWS::ElasticBeanstalk::ConfigurationTemplate
 
-
+## Example Usage
+
+### Basic usage with Python platform
+
+In this example, we create an AWS Elastic Beanstalk configuration template using the Python platform, a t3 medium instance and an Immutable deployment policy. This example assumes that you have deployed an environment with high availability and that you are using a dedicated Application Load Balancer. Please refer to [Python platform history](https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platform-history-python.html) and use the current platform version and solution stack name. Replace the `testRoleEC2` with your existing [instance profile](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-instanceprofile.html).
+```terraform
+resource "awscc_elasticbeanstalk_application" "example" {
+  application_name = "example"
+  description      = "example"
+}
+resource "awscc_elasticbeanstalk_configuration_template" "example" {
+  application_name    = awscc_elasticbeanstalk_application.example.application_name
+  description         = "My sample configuration template"
+  solution_stack_name = "64bit Amazon Linux 2023 v4.1.2 running Python 3.11"
+  option_settings = [{
+    namespace   = "aws:autoscaling:launchconfiguration"
+    option_name = "IamInstanceProfile"
+    value       = "testRoleEC2"
+    },
+    {
+      namespace   = "aws:autoscaling:launchconfiguration"
+      option_name = "InstanceType"
+      value       = "t3.large"
+    },
+    {
+      namespace   = "aws:elasticbeanstalk:command"
+      option_name = "DeploymentPolicy"
+      value       = "Immutable"
+    },
+    {
+      namespace   = "aws:elasticbeanstalk:environment"
+      option_name = "LoadBalancerType"
+      value       = "application"
+    },
+    {
+      namespace   = "aws:elbv2:loadbalancer"
+      option_name = "AccessLogsS3Enabled"
+      value       = "false"
+    },
+    {
+      namespace   = "aws:elasticbeanstalk:environment"
+      option_name = "LoadBalancerIsShared"
+      value       = "false"
+  }]
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
@@ -71,4 +115,4 @@ Import is supported using the following syntax:
 
 ```shell
 $ terraform import awscc_elasticbeanstalk_configuration_template.example "application_name|template_name"
-```
+```
diff --git a/.../awscc_elasticbeanstalk_configuration_template/elasticbeanstalk_configuration_template.tf b/.../awscc_elasticbeanstalk_configuration_template/elasticbeanstalk_configuration_template.tf
@@ -0,0 +1,39 @@
+resource "awscc_elasticbeanstalk_application" "example" {
+  application_name = "example"
+  description      = "example"
+}
+resource "awscc_elasticbeanstalk_configuration_template" "example" {
+  application_name    = awscc_elasticbeanstalk_application.example.application_name
+  description         = "My sample configuration template"
+  solution_stack_name = "64bit Amazon Linux 2023 v4.1.2 running Python 3.11"
+  option_settings = [{
+    namespace   = "aws:autoscaling:launchconfiguration"
+    option_name = "IamInstanceProfile"
+    value       = "testRoleEC2"
+    },
+    {
+      namespace   = "aws:autoscaling:launchconfiguration"
+      option_name = "InstanceType"
+      value       = "t3.large"
+    },
+    {
+      namespace   = "aws:elasticbeanstalk:command"
+      option_name = "DeploymentPolicy"
+      value       = "Immutable"
+    },
+    {
+      namespace   = "aws:elasticbeanstalk:environment"
+      option_name = "LoadBalancerType"
+      value       = "application"
+    },
+    {
+      namespace   = "aws:elbv2:loadbalancer"
+      option_name = "AccessLogsS3Enabled"
+      value       = "false"
+    },
+    {
+      namespace   = "aws:elasticbeanstalk:environment"
+      option_name = "LoadBalancerIsShared"
+      value       = "false"
+  }]
+}
diff --git a/templates/resources/elasticbeanstalk_configuration_template.md.tmpl b/templates/resources/elasticbeanstalk_configuration_template.md.tmpl
@@ -0,0 +1,28 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+
+### Basic usage with Python platform
+
+In this example, we create an AWS Elastic Beanstalk configuration template using the Python platform, a t3 medium instance and an Immutable deployment policy. This example assumes that you have deployed an environment with high availability and that you are using a dedicated Application Load Balancer. Please refer to [Python platform history](https://docs.aws.amazon.com/elasticbeanstalk/latest/platforms/platform-history-python.html) and use the current platform version and solution stack name. Replace the `testRoleEC2` with your existing [instance profile](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-instanceprofile.html).
+{{ tffile (printf "examples/resources/%s/elasticbeanstalk_configuration_template.tf" .Name)}}
+
+{{ .SchemaMarkdown | trimspace }}
+{{- if .HasImport }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" .ImportFile }}
+
+{{- end }}