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

f/generate import example for resources #1959

Merged
merged 10 commits into from
Aug 19, 2024
Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion GNUmakefile
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ tools: prereq-go
cd tools && $(GO_VER) install golang.org/x/tools/cmd/goimports@latest

docs: prereq-go
$(GO_VER) run internal/provider/generators/import-examples/main.go
$(GO_VER) generate internal/provider/import_examples.go
rm -f docs/data-sources/*.md
rm -f docs/resources/*.md
@tfplugindocs generate
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/accessanalyzer_analyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,5 +115,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_accessanalyzer_analyzer.example <resource ID>
$ terraform import awscc_accessanalyzer_analyzer.example "arn"
```
2 changes: 1 addition & 1 deletion docs/resources/acmpca_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,5 +249,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_acmpca_certificate.example <resource ID>
$ terraform import awscc_acmpca_certificate.example "arn|certificate_authority_arn"
```
2 changes: 1 addition & 1 deletion docs/resources/acmpca_certificate_authority.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,5 +327,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_acmpca_certificate_authority.example <resource ID>
$ terraform import awscc_acmpca_certificate_authority.example "arn"
```
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ Used to install the certificate authority certificate and update the certificate
Import is supported using the following syntax:

```shell
$ terraform import awscc_acmpca_certificate_authority_activation.example <resource ID>
$ terraform import awscc_acmpca_certificate_authority_activation.example "certificate_authority_arn"
```
2 changes: 1 addition & 1 deletion docs/resources/acmpca_permission.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ resource "awscc_acmpca_certificate_authority" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_acmpca_permission.example <resource ID>
$ terraform import awscc_acmpca_permission.example "certificate_authority_arn|principal"
```
2 changes: 1 addition & 1 deletion docs/resources/amplify_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,5 +278,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_amplify_app.example <resource ID>
$ terraform import awscc_amplify_app.example "arn"
```
2 changes: 1 addition & 1 deletion docs/resources/amplify_branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,5 +174,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_amplify_branch.example <resource ID>
$ terraform import awscc_amplify_branch.example "arn"
```
2 changes: 1 addition & 1 deletion docs/resources/amplify_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,5 +108,5 @@ Read-Only:
Import is supported using the following syntax:

```shell
$ terraform import awscc_amplify_domain.example <resource ID>
$ terraform import awscc_amplify_domain.example "arn"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_account.example <resource ID>
$ terraform import awscc_apigateway_account.example "id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_api_key.example <resource ID>
$ terraform import awscc_apigateway_api_key.example "api_key_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_authorizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ The ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_authorizer.example <resource ID>
$ terraform import awscc_apigateway_authorizer.example "rest_api_id|authorizer_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_base_path_mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clien
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_base_path_mapping.example <resource ID>
$ terraform import awscc_apigateway_base_path_mapping.example "domain_name|base_path"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_client_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_client_certificate.example <resource ID>
$ terraform import awscc_apigateway_client_certificate.example "client_certificate_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,5 +152,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_deployment.example <resource ID>
$ terraform import awscc_apigateway_deployment.example "deployment_id|rest_api_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_documentation_part.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_documentation_part.example <resource ID>
$ terraform import awscc_apigateway_documentation_part.example "documentation_part_id|rest_api_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_documentation_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ resource "awscc_apigateway_rest_api" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_documentation_version.example <resource ID>
$ terraform import awscc_apigateway_documentation_version.example "documentation_version|rest_api_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_domain_name.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_domain_name.example <resource ID>
$ terraform import awscc_apigateway_domain_name.example "domain_name"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_gateway_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ resource "awscc_apigateway_gateway_response" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_gateway_response.example <resource ID>
$ terraform import awscc_apigateway_gateway_response.example "id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,5 +206,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_method.example <resource ID>
$ terraform import awscc_apigateway_method.example "rest_api_id|resource_id|http_method"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ resource "awscc_apigateway_rest_api" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_model.example <resource ID>
$ terraform import awscc_apigateway_model.example "rest_api_id|name"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_request_validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ resource "awscc_apigateway_request_validator" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_request_validator.example <resource ID>
$ terraform import awscc_apigateway_request_validator.example "rest_api_id|request_validator_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ resource "awscc_apigateway_resource" "DemoAPIGatewayResource" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_resource.example <resource ID>
$ terraform import awscc_apigateway_resource.example "rest_api_id|resource_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,5 +162,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_rest_api.example <resource ID>
$ terraform import awscc_apigateway_rest_api.example "rest_api_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_stage.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,5 +151,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_stage.example <resource ID>
$ terraform import awscc_apigateway_stage.example "rest_api_id|stage_name"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_usage_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,5 +145,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_usage_plan.example <resource ID>
$ terraform import awscc_apigateway_usage_plan.example "id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_usage_plan_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,5 +104,5 @@ resource "awscc_apigateway_rest_api" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_usage_plan_key.example <resource ID>
$ terraform import awscc_apigateway_usage_plan_key.example "id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigateway_vpc_link.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigateway_vpc_link.example <resource ID>
$ terraform import awscc_apigateway_vpc_link.example "vpc_link_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,5 +95,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_api.example <resource ID>
$ terraform import awscc_apigatewayv2_api.example "api_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_api_mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ resource "awscc_apigatewayv2_api" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_api_mapping.example <resource ID>
$ terraform import awscc_apigatewayv2_api_mapping.example "api_mapping_id|domain_name"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_authorizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_authorizer.example <resource ID>
$ terraform import awscc_apigatewayv2_authorizer.example "authorizer_id|api_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ resource "awscc_apigatewayv2_deployment" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_deployment.example <resource ID>
$ terraform import awscc_apigatewayv2_deployment.example "api_id|deployment_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_domain_name.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_domain_name.example <resource ID>
$ terraform import awscc_apigatewayv2_domain_name.example "domain_name"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_integration_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,5 @@ resource "awscc_apigatewayv2_integration_response" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_integration_response.example <resource ID>
$ terraform import awscc_apigatewayv2_integration_response.example "api_id|integration_id|integration_response_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,5 @@ resource "awscc_apigatewayv2_api" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_model.example <resource ID>
$ terraform import awscc_apigatewayv2_model.example "api_id|model_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_route.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ resource "awscc_apigatewayv2_route" "example_http_route" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_route.example <resource ID>
$ terraform import awscc_apigatewayv2_route.example "api_id|route_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_route_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_route_response.example <resource ID>
$ terraform import awscc_apigatewayv2_route_response.example "api_id|route_id|route_response_id"
```
2 changes: 1 addition & 1 deletion docs/resources/apigatewayv2_vpc_link.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ resource "awscc_apigatewayv2_vpc_link" "example" {
Import is supported using the following syntax:

```shell
$ terraform import awscc_apigatewayv2_vpc_link.example <resource ID>
$ terraform import awscc_apigatewayv2_vpc_link.example "vpc_link_id"
```
2 changes: 1 addition & 1 deletion docs/resources/appconfig_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appconfig_application.example <resource ID>
$ terraform import awscc_appconfig_application.example "application_id"
```
2 changes: 1 addition & 1 deletion docs/resources/appconfig_configuration_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appconfig_configuration_profile.example <resource ID>
$ terraform import awscc_appconfig_configuration_profile.example "application_id|configuration_profile_id"
```
2 changes: 1 addition & 1 deletion docs/resources/appconfig_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appconfig_environment.example <resource ID>
$ terraform import awscc_appconfig_environment.example "application_id|environment_id"
```
2 changes: 1 addition & 1 deletion docs/resources/appconfig_extension_association.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appconfig_extension_association.example <resource ID>
$ terraform import awscc_appconfig_extension_association.example "id"
```
2 changes: 1 addition & 1 deletion docs/resources/appconfig_hosted_configuration_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ Resource Type definition for AWS::AppConfig::HostedConfigurationVersion
Import is supported using the following syntax:

```shell
$ terraform import awscc_appconfig_hosted_configuration_version.example <resource ID>
$ terraform import awscc_appconfig_hosted_configuration_version.example "application_id|configuration_profile_id|version_number"
```
2 changes: 1 addition & 1 deletion docs/resources/appflow_connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appflow_connector.example <resource ID>
$ terraform import awscc_appflow_connector.example "connector_label"
```
2 changes: 1 addition & 1 deletion docs/resources/appflow_connector_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -594,5 +594,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appflow_connector_profile.example <resource ID>
$ terraform import awscc_appflow_connector_profile.example "connector_profile_name"
```
2 changes: 1 addition & 1 deletion docs/resources/appflow_flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -781,5 +781,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appflow_flow.example <resource ID>
$ terraform import awscc_appflow_flow.example "flow_name"
```
2 changes: 1 addition & 1 deletion docs/resources/appintegrations_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appintegrations_application.example <resource ID>
$ terraform import awscc_appintegrations_application.example "application_arn"
```
2 changes: 1 addition & 1 deletion docs/resources/appintegrations_event_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_appintegrations_event_integration.example <resource ID>
$ terraform import awscc_appintegrations_event_integration.example "name"
```
2 changes: 1 addition & 1 deletion docs/resources/applicationautoscaling_scalable_target.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,5 +201,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_applicationautoscaling_scalable_target.example <resource ID>
$ terraform import awscc_applicationautoscaling_scalable_target.example "resource_id|scalable_dimension|service_namespace"
```
2 changes: 1 addition & 1 deletion docs/resources/applicationautoscaling_scaling_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,5 +219,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_applicationautoscaling_scaling_policy.example <resource ID>
$ terraform import awscc_applicationautoscaling_scaling_policy.example "arn|scalable_dimension"
```
2 changes: 1 addition & 1 deletion docs/resources/applicationinsights_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -542,5 +542,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_applicationinsights_application.example <resource ID>
$ terraform import awscc_applicationinsights_application.example "application_arn"
```
Original file line number Diff line number Diff line change
Expand Up @@ -158,5 +158,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_applicationsignals_service_level_objective.example <resource ID>
$ terraform import awscc_applicationsignals_service_level_objective.example "arn"
```
2 changes: 1 addition & 1 deletion docs/resources/apprunner_auto_scaling_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ Optional:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apprunner_auto_scaling_configuration.example <resource ID>
$ terraform import awscc_apprunner_auto_scaling_configuration.example "auto_scaling_configuration_arn"
```
2 changes: 1 addition & 1 deletion docs/resources/apprunner_observability_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ Required:
Import is supported using the following syntax:

```shell
$ terraform import awscc_apprunner_observability_configuration.example <resource ID>
$ terraform import awscc_apprunner_observability_configuration.example "observability_configuration_arn"
```
Loading
Loading