AWS API Gateway Documentation Version
This page shows how to write Terraform and CloudFormation for API Gateway Documentation Version and write them securely.
aws_api_gateway_documentation_version (Terraform)
The Documentation Version in API Gateway can be configured in Terraform with the resource name aws_api_gateway_documentation_version
. The following sections describe 1 example of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_api_gateway_documentation_version" "this" {
description = var.description
rest_api_id = var.rest_api_id
version = var.version
}
Parameters
-
description
optional - string -
id
optional computed - string -
rest_api_id
required - string -
version
required - string
Explanation in Terraform Registry
Provides a resource to manage an API Gateway Documentation Version.
Tips: Best Practices for The Other AWS API Gateway Resources
In addition to the aws_api_gateway_method_settings, AWS API Gateway has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.
aws_api_gateway_method_settings
Ensure that API Gateway stage-level cache is encrypted
It is better to enable the stage-level cache encryption which reduces the risk of data leakage.
aws_api_gateway_domain_name
Ensure to use modern TLS protocols
It is better to adopt TLS v1.2+.
aws_api_gateway_stage
Ensure to enable access logging of your API Gateway stage (v1)
It is better to enable the access logging of your API Gateway stage (v1).
aws_api_gateway_method
Ensure that your API Gateway method blocks unwanted access
It is better that the API Gateway method does not allow public access.
AWS::ApiGateway::DocumentationVersion (CloudFormation)
The DocumentationVersion in ApiGateway can be configured in CloudFormation with the resource name AWS::ApiGateway::DocumentationVersion
. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
-
Description
optional - String -
DocumentationVersion
required - String -
RestApiId
required - String
Explanation in CloudFormation Registry
The
AWS::ApiGateway::DocumentationVersion
resource creates a snapshot of the documentation for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.
Frequently asked questions
What is AWS API Gateway Documentation Version?
AWS API Gateway Documentation Version is a resource for API Gateway of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS API Gateway Documentation Version?
For Terraform, the niveklabs/aws source code example is useful. See the Terraform Example section for further details.