From 984d56cca959b032dc8f051de847a91fc3b8ba98 Mon Sep 17 00:00:00 2001 From: Brian Flad Date: Wed, 10 Mar 2021 08:36:35 -0500 Subject: [PATCH] docs/provider: Attribute headers and byline fixes (A-C resources) Reference: https://github.com/hashicorp/terraform-provider-aws/issues/15842 Previously: ``` * website/docs/r/api_gateway_base_path_mapping.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/api_gateway_gateway_response.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/api_gateway_integration.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/api_gateway_integration_response.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/api_gateway_method.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/api_gateway_method_response.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/api_gateway_method_settings.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/appautoscaling_target.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/autoscaling_attachment.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/autoscaling_lifecycle_hook.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/cloudwatch_event_target.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/cloudwatch_log_destination_policy.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/cloudwatch_log_subscription_filter.html.markdown: error checking file contents: attributes section byline (No extra attributes are exported.) should be: "In addition to all arguments above, the following attributes are exported:" or "No additional attributes are exported." * website/docs/r/codebuild_project.html.markdown: error checking file contents: attributes section byline (In addition to the arguments above, the following attributes are exported:) should be: "In addition to all arguments above, the following attributes are exported:" or "No additional attributes are exported." * website/docs/r/codecommit_trigger.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/cognito_identity_provider.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/cognito_user_group.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/config_configuration_recorder_status.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/config_remediation_configuration.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference * website/docs/r/cur_report_definition.html.markdown: error checking file contents: missing attributes section: ## Attributes Reference ``` --- website/docs/r/api_gateway_base_path_mapping.html.markdown | 4 ++++ website/docs/r/api_gateway_gateway_response.markdown | 4 ++++ website/docs/r/api_gateway_integration.html.markdown | 4 ++++ .../docs/r/api_gateway_integration_response.html.markdown | 4 ++++ website/docs/r/api_gateway_method.html.markdown | 4 ++++ website/docs/r/api_gateway_method_response.html.markdown | 4 ++++ website/docs/r/api_gateway_method_settings.html.markdown | 4 ++++ website/docs/r/appautoscaling_target.html.markdown | 4 ++++ website/docs/r/autoscaling_attachment.html.markdown | 3 +++ website/docs/r/autoscaling_lifecycle_hook.html.markdown | 4 ++++ website/docs/r/cloudwatch_event_target.html.markdown | 4 ++++ .../docs/r/cloudwatch_log_destination_policy.html.markdown | 4 ++++ .../docs/r/cloudwatch_log_subscription_filter.html.markdown | 2 +- website/docs/r/codebuild_project.html.markdown | 2 +- website/docs/r/codecommit_trigger.html.markdown | 6 ++++++ website/docs/r/cognito_user_group.html.markdown | 4 ++++ .../r/config_configuration_recorder_status.html.markdown | 4 ++++ .../docs/r/config_remediation_configuration.html.markdown | 6 ++++++ website/docs/r/cur_report_definition.html.markdown | 4 ++++ 19 files changed, 73 insertions(+), 2 deletions(-) diff --git a/website/docs/r/api_gateway_base_path_mapping.html.markdown b/website/docs/r/api_gateway_base_path_mapping.html.markdown index 671be127304..1485d02a829 100644 --- a/website/docs/r/api_gateway_base_path_mapping.html.markdown +++ b/website/docs/r/api_gateway_base_path_mapping.html.markdown @@ -48,6 +48,10 @@ The following arguments are supported: * `stage_name` - (Optional) The name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path. * `base_path` - (Optional) Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain. +## Attributes Reference + +No additional attributes are exported. + ## Import `aws_api_gateway_base_path_mapping` can be imported by using the domain name and base path, e.g. diff --git a/website/docs/r/api_gateway_gateway_response.markdown b/website/docs/r/api_gateway_gateway_response.markdown index 1322b6dac30..f34202f4778 100644 --- a/website/docs/r/api_gateway_gateway_response.markdown +++ b/website/docs/r/api_gateway_gateway_response.markdown @@ -42,6 +42,10 @@ The following arguments are supported: * `response_templates` - (Optional) A map specifying the templates used to transform the response body. * `response_parameters` - (Optional) A map specifying the parameters (paths, query strings and headers) of the Gateway Response. +## Attributes Reference + +No additional attributes are exported. + ## Import `aws_api_gateway_gateway_response` can be imported using `REST-API-ID/RESPONSE-TYPE`, e.g. diff --git a/website/docs/r/api_gateway_integration.html.markdown b/website/docs/r/api_gateway_integration.html.markdown index 6f87ab65002..e6561fb25d0 100644 --- a/website/docs/r/api_gateway_integration.html.markdown +++ b/website/docs/r/api_gateway_integration.html.markdown @@ -237,6 +237,10 @@ The `tls_config` configuration block supports the following arguments: * `insecure_skip_verification` - (Optional) Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a [supported certificate authority](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.html). This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for `HTTP` and `HTTP_PROXY` integrations. +## Attributes Reference + +No additional attributes are exported. + ## Import `aws_api_gateway_integration` can be imported using `REST-API-ID/RESOURCE-ID/HTTP-METHOD`, e.g. diff --git a/website/docs/r/api_gateway_integration_response.html.markdown b/website/docs/r/api_gateway_integration_response.html.markdown index 9347801b5e5..16c74e1632c 100644 --- a/website/docs/r/api_gateway_integration_response.html.markdown +++ b/website/docs/r/api_gateway_integration_response.html.markdown @@ -84,6 +84,10 @@ The following arguments are supported: For example: `response_parameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }` * `content_handling` - (Optional) Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. +## Attributes Reference + +No additional attributes are exported. + ## Import `aws_api_gateway_integration_response` can be imported using `REST-API-ID/RESOURCE-ID/HTTP-METHOD/STATUS-CODE`, e.g. diff --git a/website/docs/r/api_gateway_method.html.markdown b/website/docs/r/api_gateway_method.html.markdown index 59917adb05d..3964bc39c3b 100644 --- a/website/docs/r/api_gateway_method.html.markdown +++ b/website/docs/r/api_gateway_method.html.markdown @@ -90,6 +90,10 @@ The following arguments are supported: * `request_parameters` - (Optional) A map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (`true`) or optional (`false`). For example: `request_parameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true}` would define that the header `X-Some-Header` and the query string `some-query-param` must be provided in the request. +## Attributes Reference + +No additional attributes are exported. + ## Import `aws_api_gateway_method` can be imported using `REST-API-ID/RESOURCE-ID/HTTP-METHOD`, e.g. diff --git a/website/docs/r/api_gateway_method_response.html.markdown b/website/docs/r/api_gateway_method_response.html.markdown index 2a4a51f970f..99cf469365e 100644 --- a/website/docs/r/api_gateway_method_response.html.markdown +++ b/website/docs/r/api_gateway_method_response.html.markdown @@ -59,6 +59,10 @@ The following arguments are supported: For example: `response_parameters = { "method.response.header.X-Some-Header" = true }` would define that the header `X-Some-Header` can be provided on the response. +## Attributes Reference + +No additional attributes are exported. + ## Import `aws_api_gateway_method_response` can be imported using `REST-API-ID/RESOURCE-ID/HTTP-METHOD/STATUS-CODE`, e.g. diff --git a/website/docs/r/api_gateway_method_settings.html.markdown b/website/docs/r/api_gateway_method_settings.html.markdown index d7f7a9d8f0f..3e60afa16aa 100644 --- a/website/docs/r/api_gateway_method_settings.html.markdown +++ b/website/docs/r/api_gateway_method_settings.html.markdown @@ -104,6 +104,10 @@ The following arguments are supported: * `require_authorization_for_cache_control` - (Optional) Specifies whether authorization is required for a cache invalidation request. * `unauthorized_cache_control_header_strategy` - (Optional) Specifies how to handle unauthorized requests for cache invalidation. The available values are `FAIL_WITH_403`, `SUCCEED_WITH_RESPONSE_HEADER`, `SUCCEED_WITHOUT_RESPONSE_HEADER`. +## Attributes Reference + +No additional attributes are exported. + ## Import `aws_api_gateway_method_settings` can be imported using `REST-API-ID/STAGE-NAME/METHOD-PATH`, e.g. diff --git a/website/docs/r/appautoscaling_target.html.markdown b/website/docs/r/appautoscaling_target.html.markdown index c3363716d20..2eda533698c 100644 --- a/website/docs/r/appautoscaling_target.html.markdown +++ b/website/docs/r/appautoscaling_target.html.markdown @@ -73,6 +73,10 @@ The following arguments are supported: * `scalable_dimension` - (Required) The scalable dimension of the scalable target. Documentation can be found in the `ScalableDimension` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) * `service_namespace` - (Required) The AWS service namespace of the scalable target. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) +## Attributes Reference + +No additional attributes are exported. + ## Import Application AutoScaling Target can be imported using the `service-namespace` , `resource-id` and `scalable-dimension` separated by `/`. diff --git a/website/docs/r/autoscaling_attachment.html.markdown b/website/docs/r/autoscaling_attachment.html.markdown index 6c6fc929f0a..8e898bc4569 100644 --- a/website/docs/r/autoscaling_attachment.html.markdown +++ b/website/docs/r/autoscaling_attachment.html.markdown @@ -62,3 +62,6 @@ The following arguments are supported: * `elb` - (Optional) The name of the ELB. * `alb_target_group_arn` - (Optional) The ARN of an ALB Target Group. +## Attributes Reference + +No additional attributes are exported. diff --git a/website/docs/r/autoscaling_lifecycle_hook.html.markdown b/website/docs/r/autoscaling_lifecycle_hook.html.markdown index c981b134bff..322616737f9 100644 --- a/website/docs/r/autoscaling_lifecycle_hook.html.markdown +++ b/website/docs/r/autoscaling_lifecycle_hook.html.markdown @@ -69,6 +69,10 @@ The following arguments are supported: * `notification_target_arn` - (Optional) The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. * `role_arn` - (Optional) The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. +## Attributes Reference + +No additional attributes are exported. + ## Import AutoScaling Lifecycle Hooks can be imported using the role autoscaling_group_name and name separated by `/`. diff --git a/website/docs/r/cloudwatch_event_target.html.markdown b/website/docs/r/cloudwatch_event_target.html.markdown index bb2d76f1480..5cc84cb295c 100644 --- a/website/docs/r/cloudwatch_event_target.html.markdown +++ b/website/docs/r/cloudwatch_event_target.html.markdown @@ -365,6 +365,10 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC * `arn` - (Optional) - ARN of the SQS queue specified as the target for the dead-letter queue. +## Attributes Reference + +No additional attributes are exported. + ## Import EventBridge Targets can be imported using `event_bus_name/rule-name/target-id` (if you omit `event_bus_name`, the `default` event bus will be used). diff --git a/website/docs/r/cloudwatch_log_destination_policy.html.markdown b/website/docs/r/cloudwatch_log_destination_policy.html.markdown index f191e49986a..f413f6f490b 100644 --- a/website/docs/r/cloudwatch_log_destination_policy.html.markdown +++ b/website/docs/r/cloudwatch_log_destination_policy.html.markdown @@ -54,6 +54,10 @@ The following arguments are supported: * `destination_name` - (Required) A name for the subscription filter * `access_policy` - (Required) The policy document. This is a JSON formatted string. +## Attributes Reference + +No additional attributes are exported. + ## Import CloudWatch Logs destination policies can be imported using the `destination_name`, e.g. diff --git a/website/docs/r/cloudwatch_log_subscription_filter.html.markdown b/website/docs/r/cloudwatch_log_subscription_filter.html.markdown index 94a412da8b6..d9516a828b1 100644 --- a/website/docs/r/cloudwatch_log_subscription_filter.html.markdown +++ b/website/docs/r/cloudwatch_log_subscription_filter.html.markdown @@ -36,7 +36,7 @@ The following arguments are supported: ## Attributes Reference -No extra attributes are exported. +No additional attributes are exported. ## Import diff --git a/website/docs/r/codebuild_project.html.markdown b/website/docs/r/codebuild_project.html.markdown index 29a631841f5..13074112877 100755 --- a/website/docs/r/codebuild_project.html.markdown +++ b/website/docs/r/codebuild_project.html.markdown @@ -367,7 +367,7 @@ This block is only valid when the `type` is `CODECOMMIT`, `GITHUB` or `GITHUB_EN ## Attributes Reference -In addition to the arguments above, the following attributes are exported: +In addition to all arguments above, the following attributes are exported: * `arn` - ARN of the CodeBuild project. * `badge_url` - URL of the build badge when `badge_enabled` is enabled. diff --git a/website/docs/r/codecommit_trigger.html.markdown b/website/docs/r/codecommit_trigger.html.markdown index 43e58723c01..945e6240f5d 100644 --- a/website/docs/r/codecommit_trigger.html.markdown +++ b/website/docs/r/codecommit_trigger.html.markdown @@ -38,3 +38,9 @@ The following arguments are supported: * `custom_data` - (Optional) Any custom data associated with the trigger that will be included in the information sent to the target of the trigger. * `branches` - (Optional) The branches that will be included in the trigger configuration. If no branches are specified, the trigger will apply to all branches. * `events` - (Required) The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon Simple Notification Service (SNS). If no events are specified, the trigger will run for all repository events. Event types include: `all`, `updateReference`, `createReference`, `deleteReference`. + +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `configuration_id` - System-generated unique identifier. diff --git a/website/docs/r/cognito_user_group.html.markdown b/website/docs/r/cognito_user_group.html.markdown index 3dd4bd65068..f4563a1a27f 100644 --- a/website/docs/r/cognito_user_group.html.markdown +++ b/website/docs/r/cognito_user_group.html.markdown @@ -64,6 +64,10 @@ The following arguments are supported: * `precedence` - (Optional) The precedence of the user group. * `role_arn` - (Optional) The ARN of the IAM role to be associated with the user group. +## Attributes Reference + +No additional attributes are exported. + ## Import Cognito User Groups can be imported using the `user_pool_id`/`name` attributes concatenated, e.g. diff --git a/website/docs/r/config_configuration_recorder_status.html.markdown b/website/docs/r/config_configuration_recorder_status.html.markdown index f0aa73bc5ce..4ce7f8a2472 100644 --- a/website/docs/r/config_configuration_recorder_status.html.markdown +++ b/website/docs/r/config_configuration_recorder_status.html.markdown @@ -91,6 +91,10 @@ The following arguments are supported: * `name` - (Required) The name of the recorder * `is_enabled` - (Required) Whether the configuration recorder should be enabled or disabled. +## Attributes Reference + +No additional attributes are exported. + ## Import Configuration Recorder Status can be imported using the name of the Configuration Recorder, e.g. diff --git a/website/docs/r/config_remediation_configuration.html.markdown b/website/docs/r/config_remediation_configuration.html.markdown index 9a58229e7db..cb93481e60c 100644 --- a/website/docs/r/config_remediation_configuration.html.markdown +++ b/website/docs/r/config_remediation_configuration.html.markdown @@ -69,6 +69,12 @@ You must select either a dynamic value or a static value. * `resource_value` - (Optional) The value is dynamic and changes at run-time. * `static_value` - (Optional) The value is static and does not change at run-time. +## Attributes Reference + +In addition to all arguments above, the following attributes are exported: + +* `arn` - Amazon Resource Name (ARN) of the Config Remediation Configuration. + ## Import Remediation Configurations can be imported using the name config_rule_name, e.g. diff --git a/website/docs/r/cur_report_definition.html.markdown b/website/docs/r/cur_report_definition.html.markdown index 615dfb3971f..e7e8544e866 100644 --- a/website/docs/r/cur_report_definition.html.markdown +++ b/website/docs/r/cur_report_definition.html.markdown @@ -45,6 +45,10 @@ The following arguments are supported: * `refresh_closed_reports` - (Optional) Set to true to update your reports after they have been finalized if AWS detects charges related to previous months. * `report_versioning` - (Optional) Overwrite the previous version of each report or to deliver the report in addition to the previous versions. Valid values are: CREATE_NEW_REPORT, OVERWRITE_REPORT +## Attributes Reference + +No additional attributes are exported. + ## Import Report Definitions can be imported using the `report_name`, e.g.