AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::DocumentationPart

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](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. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
Location
Location
RequiredCreate-only
Properties
string
Required
RestApiId
string
RequiredCreate-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
DocumentationPartIdstring-

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::DocumentationPart

Resources:
  MyResource:
    Type: AWS::ApiGateway::DocumentationPart
    Properties:
      Location: "value"
      Properties: "value"
      RestApiId: "my-restapiid"

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
Properties4
Required3
TaggingNot supported
Primary IDDocumentationPartId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

LocationRestApiId

Related Resources

External Links