Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add example for awscc_vpclattice_resource_gateway #2148

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/resources/vpclattice_resource_gateway.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_vpclattice_resource_gateway Resource - terraform-provider-awscc"
subcategory: ""
description: |-
Expand All @@ -10,7 +9,17 @@ description: |-

Creates a resource gateway for a service.

## Example Usage

### Basic Usage
```terraform
resource "awscc_vpclattice_resource_gateway" "example" {
name = "example-gateway"
vpc_identifier = awscc_ec2_vpc.example.id
subnet_ids = [awscc_ec2_subnet.example.id]
ip_address_type = "IPV4"
}
```

<!-- schema generated by tfplugindocs -->
## Schema
Expand Down Expand Up @@ -44,4 +53,4 @@ Import is supported using the following syntax:

```shell
$ terraform import awscc_vpclattice_resource_gateway.example "arn"
```
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
resource "awscc_vpclattice_resource_gateway" "example" {
name = "example-gateway"
vpc_identifier = awscc_ec2_vpc.example.id
subnet_ids = [awscc_ec2_subnet.example.id]
ip_address_type = "IPV4"
}
26 changes: 26 additions & 0 deletions templates/resources/vpclattice_resource_gateway.md.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
subcategory: ""
description: |-
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
---

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

{{ .Description | trimspace }}

## Example Usage

### Basic Usage
{{ tffile (printf "examples/resources/%s/awscc_vpclattice_resource_gateway_ipv4.tf" .Name)}}

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

## Import

Import is supported using the following syntax:

{{ codefile "shell" .ImportFile }}

{{- end }}