AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGateway::DocumentationPart

CfnDocumentationPart

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* .

Import

import { CfnDocumentationPart } from 'aws-cdk-lib/aws-apigateway';

Or use the module namespace:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnDocumentationPart

Properties

Configuration passed to the constructor as CfnDocumentationPartProps.

locationRequired
IResolvable | LocationProperty

The location of the targeted API entity of the to-be-created documentation part.

propertiesRequired
string

The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

restApiIdRequired
string | IRestApiRef

The string identifier of the associated RestApi.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ApiGateway::DocumentationPartView in CloudFormation Explorer

Get the Amazon API Gateway Cheat Sheet

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

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-apigateway
CFN TypeAWS::ApiGateway::DocumentationPart
Properties3

Related Constructs

Explore This Service

External Links