Skip to content

Commit

Permalink
Merge pull request #1111 from davecrumbacher/d-improve-awscc_timestre…
Browse files Browse the repository at this point in the history
…am_table

docs: add example for awscc_timestream_table
  • Loading branch information
marcosentino authored Aug 9, 2023
2 parents 5e96e2a + ab0df41 commit 79dc3b1
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/resources/timestream_table.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_timestream_table Resource - terraform-provider-awscc"
subcategory: ""
description: |-
Expand All @@ -10,7 +9,20 @@ description: |-

The AWS::Timestream::Table resource creates a Timestream Table.


## Example Usage

### Create Table
Create a Timestream table in a database named "MyTimestreamDB"
```terraform
resource "awscc_timestream_table" "this" {
database_name = "MyTimestreamDB"
table_name = "MyTimestreamTable"
tags = [{
key = "Managed By"
value = "AWSCC"
}]
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down
8 changes: 8 additions & 0 deletions examples/resources/awscc_timestream_table/table.tf
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
resource "awscc_timestream_table" "this" {
database_name = "MyTimestreamDB"
table_name = "MyTimestreamTable"
tags = [{
key = "Managed By"
value = "AWSCC"
}]
}
27 changes: 27 additions & 0 deletions templates/resources/timestream_table.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

# {{.Name}} ({{.Type}})

{{ .Description | trimspace }}

## Example Usage

### Create Table
Create a Timestream table in a database named "MyTimestreamDB"
{{ tffile (printf "examples/resources/%s/table.tf" .Name)}}

{{ .SchemaMarkdown | trimspace }}
{{- if .HasImport }}

## Import

Import is supported using the following syntax:

{{ codefile "shell" .ImportFile }}

{{- end }}

0 comments on commit 79dc3b1

Please sign in to comment.