CfnDocumentationPartProps Struct
Properties for defining a CfnDocumentationPart.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnDocumentationPartProps: apigateway.CfnDocumentationPartProps = {
location: {
method: 'method',
name: 'name',
path: 'path',
statusCode: 'statusCode',
type: 'type',
},
properties: 'properties',
restApiId: 'restApiId',
};
Properties
locationIResolvable | CfnDocumentationPart.LocationPropertylocationtyping.Union[IResolvable, LocationProperty]locationIResolvableLocationIResolvableLocationinterface{}required#The location of the targeted API entity of the to-be-created documentation part.
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.
restApiIdstring | IRestApiRefrest_api_idtyping.Union[str, IRestApiRef]restApiIdStringRestApiIdstringRestApiIdinterface{}required#The string identifier of the associated RestApi.