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.

Sign up for GitHub

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: added example for awscc_vpclattice_resource_configuration #2149

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+60 −3
Open

docs: added example for awscc_vpclattice_resource_configuration #2149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8503399
docs: added example for awscc_vpclattice_resource_configuration
emnedre Jan 8, 2025
c085b33
add .md file
emnedre Jan 8, 2025
7da7785
fixed typo in .md.tmpl
emnedre Jan 9, 2025
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
23 changes: 20 additions & 3 deletions docs/resources/vpclattice_resource_configuration.md
View file
Open in desktop
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_configuration Resource - terraform-provider-awscc"
subcategory: ""
description: |-
Expand All @@ -10,7 +9,25 @@ description: |-

VpcLattice ResourceConfiguration CFN resource


## Example Usage

### Basic Usage
To use awscc_vpclattice_resource_configuration on single AWS account:
```terraform
resource "awscc_vpclattice_resource_configuration" "example" {
name = "example-resource-configuration"
port_ranges = ["80"]
protocol_type = "TCP"
resource_gateway_id = awscc_vpclattice_resource_gateway.example.id
resource_configuration_type = "SINGLE"
resource_configuration_definition = {
dns_resource = {
domain_name = "example.com"
ip_address_type = "IPV4"
}
}
}
```

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

```shell
$ terraform import awscc_vpclattice_resource_configuration.example "arn"
```
```
13 changes: 13 additions & 0 deletions .../awscc_vpclattice_resource_configuration/awscc_vpclattice_resource_configuration_basic.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
resource "awscc_vpclattice_resource_configuration" "example" {
name = "example-resource-configuration"
port_ranges = ["80"]
protocol_type = "TCP"
resource_gateway_id = awscc_vpclattice_resource_gateway.example.id
resource_configuration_type = "SINGLE"
resource_configuration_definition = {
dns_resource = {
domain_name = "example.com"
ip_address_type = "IPV4"
}
}
}
27 changes: 27 additions & 0 deletions templates/resources/vpclattice_resource_configuration.md.tmpl
View file
Open in desktop
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

### Basic Usage
To use {{.Name}} on single AWS account:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the resource name will stand out a bit more once rendered on the registry.

Suggested change
To use {{.Name}} on single AWS account:
To use `{{.Name}}` on single AWS account:

{{ tffile (printf "examples/resources/%s/awscc_vpclattice_resource_configuration_basic.tf" .Name)}}

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

## Import

Import is supported using the following syntax:

{{ codefile "shell" .ImportFile }}

{{- end }}
Loading