docs : add example for awscc_stepfunctions_state_machine_version

hashicorp · Aug 13, 2024 · 9ca6d56 · 9ca6d56
1 parent fca777a
commit 9ca6d56
Show file tree

Hide file tree

Showing 3 changed files with 116 additions and 1 deletion.
diff --git a/docs/resources/stepfunctions_state_machine_version.md b/docs/resources/stepfunctions_state_machine_version.md
@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "awscc_stepfunctions_state_machine_version Resource - terraform-provider-awscc"
 subcategory: ""
 description: |-
@@ -10,7 +9,54 @@ description: |-
 
 Resource schema for StateMachineVersion
 
+## Example Usage
+In this example, we create a version of a state machine. The example includes the necessary code to create a basic state machine.
+```terraform
+resource "awscc_iam_role" "main" {
+  description = "AWS IAM role for a step function"
+  assume_role_policy_document = jsonencode({
+    Version = "2012-10-17"
+    Statement = [
+      {
+        Action = "sts:AssumeRole"
+        Effect = "Allow"
+        Sid    = ""
+        Principal = {
+          Service = "states.amazonaws.com"
+        }
+      },
+    ]
+  })
+}
 
+resource "awscc_stepfunctions_state_machine" "sfn_stepmachine" {
+  role_arn           = awscc_iam_role.main.arn
+  state_machine_type = "STANDARD"
+  definition_string  = <<EOT
+    {
+      "StartAt": "FirstState",
+      "States": {
+        "FirstState": {
+          "Type": "Pass",
+          "Result": "Hello World!",
+          "End": true
+        }
+      }
+    }
+  EOT
+  tags = [
+    {
+      key   = "Modified By"
+      value = "AWSCC"
+    }
+  ]
+}
+
+resource "awscc_stepfunctions_state_machine_version" "version" {
+  description = "State machine version description"
+  state_machine_arn = awscc_stepfunctions_state_machine.sfn_stepmachine.arn
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

diff --git a/...esources/awscc_stepfunctions_state_machine_version/stepfunctions_state_machine_version.tf b/...esources/awscc_stepfunctions_state_machine_version/stepfunctions_state_machine_version.tf
@@ -0,0 +1,44 @@
+resource "awscc_iam_role" "main" {
+  description = "AWS IAM role for a step function"
+  assume_role_policy_document = jsonencode({
+    Version = "2012-10-17"
+    Statement = [
+      {
+        Action = "sts:AssumeRole"
+        Effect = "Allow"
+        Sid    = ""
+        Principal = {
+          Service = "states.amazonaws.com"
+        }
+      },
+    ]
+  })
+}
+
+resource "awscc_stepfunctions_state_machine" "sfn_stepmachine" {
+  role_arn           = awscc_iam_role.main.arn
+  state_machine_type = "STANDARD"
+  definition_string  = <<EOT
+    {
+      "StartAt": "FirstState",
+      "States": {
+        "FirstState": {
+          "Type": "Pass",
+          "Result": "Hello World!",
+          "End": true
+        }
+      }
+    }
+  EOT
+  tags = [
+    {
+      key   = "Modified By"
+      value = "AWSCC"
+    }
+  ]
+}
+
+resource "awscc_stepfunctions_state_machine_version" "version" {
+  description = "State machine version description"
+  state_machine_arn = awscc_stepfunctions_state_machine.sfn_stepmachine.arn
+}
diff --git a/templates/resources/stepfunctions_state_machine_version.md.tmpl b/templates/resources/stepfunctions_state_machine_version.md.tmpl
@@ -0,0 +1,25 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+## Example Usage
+In this example, we create a version of a state machine. The example includes the necessary code to create a basic state machine.
+{{ tffile (printf "examples/resources/%s/stepfunctions_state_machine_version.tf" .Name)}}
+
+{{ .SchemaMarkdown | trimspace }}
+{{- if .HasImport }}
+
+## Import
+
+Import is supported using the following syntax:
+
+{{ codefile "shell" .ImportFile }}
+
+{{- end }}