Resource: aws_api_gateway_documentation_part

Provides a settings of an API Gateway Documentation Part.

Example Usage

resource "aws_api_gateway_documentation_part" "example" {
  location {
    type   = "METHOD"
    method = "GET"
    path   = "/example"
  }

  properties  = "{\"description\":\"Example description\"}"
  rest_api_id = aws_api_gateway_rest_api.example.id
}

resource "aws_api_gateway_rest_api" "example" {
  name = "example_api"
}

Argument Reference

This resource supports the following arguments:

Nested fields

location

See supported entity types for each field in the official docs.

Attribute Reference

This resource exports the following attributes in addition to the arguments above:

Import

In Terraform v1.5.0 and later, use an import block to import API Gateway documentation_parts using REST-API-ID/DOC-PART-ID. For example:

import {
  to = aws_api_gateway_documentation_part.example
  id = "5i4e1ko720/3oyy3t"
}

Using terraform import, import API Gateway documentation_parts using REST-API-ID/DOC-PART-ID. For example:

% terraform import aws_api_gateway_documentation_part.example 5i4e1ko720/3oyy3t