From ad6337e23408dbb8e4656bc920b4a2883c1c0e98 Mon Sep 17 00:00:00 2001 From: vivekthangamuthu Date: Tue, 28 May 2024 12:30:55 +0000 Subject: [PATCH] docs: added example for awscc_sagemaker_user_profile --- docs/resources/sagemaker_user_profile.md | 15 +++++++++-- .../sagemaker_user_profile.tf | 8 ++++++ .../resources/sagemaker_user_profile.md.tmpl | 26 +++++++++++++++++++ 3 files changed, 47 insertions(+), 2 deletions(-) create mode 100644 examples/resources/awscc_sagemaker_user_profile/sagemaker_user_profile.tf create mode 100644 templates/resources/sagemaker_user_profile.md.tmpl diff --git a/docs/resources/sagemaker_user_profile.md b/docs/resources/sagemaker_user_profile.md index e3831d2a72..b760be6b04 100644 --- a/docs/resources/sagemaker_user_profile.md +++ b/docs/resources/sagemaker_user_profile.md @@ -1,5 +1,4 @@ --- -# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_sagemaker_user_profile Resource - terraform-provider-awscc" subcategory: "" description: |- @@ -10,7 +9,19 @@ description: |- Resource Type definition for AWS::SageMaker::UserProfile - +## Example Usage + +To create a SageMaker user profile resource. +```terraform +resource "awscc_sagemaker_user_profile" "example" { + domain_id = awscc_sagemaker_domain.example.id + user_profile_name = "example" + tags = [{ + key = "Modified By" + value = "AWSCC" + }] +} +``` ## Schema diff --git a/examples/resources/awscc_sagemaker_user_profile/sagemaker_user_profile.tf b/examples/resources/awscc_sagemaker_user_profile/sagemaker_user_profile.tf new file mode 100644 index 0000000000..7cb3ccca79 --- /dev/null +++ b/examples/resources/awscc_sagemaker_user_profile/sagemaker_user_profile.tf @@ -0,0 +1,8 @@ +resource "awscc_sagemaker_user_profile" "example" { + domain_id = awscc_sagemaker_domain.example.id + user_profile_name = "example" + tags = [{ + key = "Modified By" + value = "AWSCC" + }] +} \ No newline at end of file diff --git a/templates/resources/sagemaker_user_profile.md.tmpl b/templates/resources/sagemaker_user_profile.md.tmpl new file mode 100644 index 0000000000..8285d92cff --- /dev/null +++ b/templates/resources/sagemaker_user_profile.md.tmpl @@ -0,0 +1,26 @@ +--- +page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +subcategory: "" +description: |- +{{ .Description | plainmarkdown | trimspace | prefixlines " " }} +--- + +# {{.Name}} ({{.Type}}) + +{{ .Description | trimspace }} + +## Example Usage + +To create a SageMaker user profile resource. +{{ tffile (printf "examples/resources/%s/sagemaker_user_profile.tf" .Name)}} + +{{ .SchemaMarkdown | trimspace }} +{{- if .HasImport }} + +## Import + +Import is supported using the following syntax: + +{{ codefile "shell" .ImportFile }} + +{{- end }}