AWS API Gateway Documentation Part

This page shows how to write Terraform and CloudFormation for API Gateway Documentation Part and write them securely.

code-icon

Fix issues in your cloud & app configurations

Test for misconfigurations of this resource in your cloud.

get-started-button

Terraform Example (aws_api_gateway_documentation_part)

Provides a settings of an API Gateway Documentation Part.

Parameters

Example Usage (from GitHub)

github-iconniveklabs/aws
resource "aws_api_gateway_documentation_part" "this" {
  properties  = var.properties
  rest_api_id = var.rest_api_id

  dynamic "location" {
    for_each = var.location
github-iconasrkata/SebastianUA-terraform
resource "aws_api_gateway_documentation_part" "api_gateway_documentation_part" {
  count = var.enable_api_gateway_documentation_part ? 1 : 0

  rest_api_id = var.api_gateway_documentation_part_rest_api_id != "" && !var.enable_api_gateway_rest_api ? var.api_gateway_documentation_part_rest_api_id : element(concat(aws_api_gateway_rest_api.api_gateway_rest_api.*.id, [""]), 0)
  properties  = var.api_gateway_documentation_part_properties

github-iconSebastianUA/terraform
resource "aws_api_gateway_documentation_part" "api_gateway_documentation_part" {
  count = var.enable_api_gateway_documentation_part ? 1 : 0

  rest_api_id = var.api_gateway_documentation_part_rest_api_id != "" && !var.enable_api_gateway_rest_api ? var.api_gateway_documentation_part_rest_api_id : element(concat(aws_api_gateway_rest_api.api_gateway_rest_api.*.id, [""]), 0)
  properties  = var.api_gateway_documentation_part_properties

CloudFormation Example (AWS::ApiGateway::DocumentationPart)

The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API. For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide.

Parameters

Frequently asked questions

What is AWS API Gateway Documentation Part?

AWS API Gateway Documentation Part 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 Part?

For Terraform, the niveklabs/aws, asrkata/SebastianUA-terraform and SebastianUA/terraform source code examples are useful. See the Terraform Example section for further details.