From 6c144bf186fb8bf416f43bcedf864f4df730f771 Mon Sep 17 00:00:00 2001 From: vivekthangamuthu Date: Fri, 24 May 2024 16:13:05 +0000 Subject: [PATCH] Added docs for sagemaker app image config. --- docs/resources/sagemaker_app_image_config.md | 44 ++++++++++++++++++- .../sagemaker_app_image_config.tf | 13 ++++++ .../sagemaker_app_image_config_file_system.tf | 18 ++++++++ .../sagemaker_app_image_config.md.tmpl | 33 ++++++++++++++ 4 files changed, 107 insertions(+), 1 deletion(-) create mode 100644 examples/resources/awscc_sagemaker_app_image_config/sagemaker_app_image_config.tf create mode 100644 examples/resources/awscc_sagemaker_app_image_config/sagemaker_app_image_config_file_system.tf create mode 100644 templates/resources/sagemaker_app_image_config.md.tmpl diff --git a/docs/resources/sagemaker_app_image_config.md b/docs/resources/sagemaker_app_image_config.md index 0a89320395..e617d96042 100644 --- a/docs/resources/sagemaker_app_image_config.md +++ b/docs/resources/sagemaker_app_image_config.md @@ -1,5 +1,4 @@ --- -# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "awscc_sagemaker_app_image_config Resource - terraform-provider-awscc" subcategory: "" description: |- @@ -10,7 +9,50 @@ description: |- Resource Type definition for AWS::SageMaker::AppImageConfig +## Example Usage +To create a SageMaker app image config resource. + +Basic usage + +```terraform +resource "awscc_sagemaker_app_image_config" "example" { + app_image_config_name = "example" + + kernel_gateway_image_config = { + kernel_specs = [{ + name = "example" + }] + } + tags = [{ + key = "Modified By" + value = "AWSCC" + }] +} +``` + +Default File System Config + +```terraform +resource "awscc_sagemaker_app_image_config" "example" { + app_image_config_name = "example" + + kernel_gateway_image_config = { + kernel_specs = [{ + name = "example" + }] + file_system_config = { + default_gid = 100 + default_uid = 1000 + } + } + + tags = [{ + key = "Modified By" + value = "AWSCC" + }] +} +``` ## Schema diff --git a/examples/resources/awscc_sagemaker_app_image_config/sagemaker_app_image_config.tf b/examples/resources/awscc_sagemaker_app_image_config/sagemaker_app_image_config.tf new file mode 100644 index 0000000000..a28c01ed8b --- /dev/null +++ b/examples/resources/awscc_sagemaker_app_image_config/sagemaker_app_image_config.tf @@ -0,0 +1,13 @@ +resource "awscc_sagemaker_app_image_config" "example" { + app_image_config_name = "example" + + kernel_gateway_image_config = { + kernel_specs = [{ + name = "example" + }] + } + tags = [{ + key = "Modified By" + value = "AWSCC" + }] +} diff --git a/examples/resources/awscc_sagemaker_app_image_config/sagemaker_app_image_config_file_system.tf b/examples/resources/awscc_sagemaker_app_image_config/sagemaker_app_image_config_file_system.tf new file mode 100644 index 0000000000..d6f09489af --- /dev/null +++ b/examples/resources/awscc_sagemaker_app_image_config/sagemaker_app_image_config_file_system.tf @@ -0,0 +1,18 @@ +resource "awscc_sagemaker_app_image_config" "example" { + app_image_config_name = "example" + + kernel_gateway_image_config = { + kernel_specs = [{ + name = "example" + }] + file_system_config = { + default_gid = 100 + default_uid = 1000 + } + } + + tags = [{ + key = "Modified By" + value = "AWSCC" + }] +} diff --git a/templates/resources/sagemaker_app_image_config.md.tmpl b/templates/resources/sagemaker_app_image_config.md.tmpl new file mode 100644 index 0000000000..eea373b36b --- /dev/null +++ b/templates/resources/sagemaker_app_image_config.md.tmpl @@ -0,0 +1,33 @@ +--- +page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +subcategory: "" +description: |- +{{ .Description | plainmarkdown | trimspace | prefixlines " " }} +--- + +# {{.Name}} ({{.Type}}) + +{{ .Description | trimspace }} + +## Example Usage + +To create a SageMaker app image config resource. + +Basic usage + +{{ tffile (printf "examples/resources/%s/sagemaker_app_image_config.tf" .Name)}} + +Default File System Config + +{{ tffile (printf "examples/resources/%s/sagemaker_app_image_config_file_system.tf" .Name)}} + +{{ .SchemaMarkdown | trimspace }} +{{- if .HasImport }} + +## Import + +Import is supported using the following syntax: + +{{ codefile "shell" .ImportFile }} + +{{- end }}