AWS::ApiGateway::DocumentationVersion

ApiGateway DocumentationVersion

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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.

Properties

3 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`DocumentationVersion`	`string`	RequiredCreate-only
`RestApiId`	`string`	RequiredCreate-only
`Description`	`string`

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGateway::DocumentationVersion

Resources:
  MyResource:
    Type: AWS::ApiGateway::DocumentationVersion
    Properties:
      DocumentationVersion: "value"
      RestApiId: "my-restapiid"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

apigateway:GETapigateway:POST

read

apigateway:GET

update

apigateway:GETapigateway:PATCH

delete

apigateway:DELETE

list

apigateway:GET

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway

Properties3

Required2

TaggingNot supported

Primary IDDocumentationVersion

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DocumentationVersionRestApiId

Related Resources

External Links

AWS Documentation