CfnDocumentationVersionProps Struct
Properties for defining a CfnDocumentationVersion.
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 cfnDocumentationVersionProps: apigateway.CfnDocumentationVersionProps = {
documentationVersion: 'documentationVersion',
restApiId: 'restApiId',
// the properties below are optional
description: 'description',
};
Properties
A description about the new documentation snapshot.
documentationVersionstringdocumentation_versionstrdocumentationVersionStringDocumentationVersionstringDocumentationVersion*stringrequired#The version identifier of the to-be-updated documentation version.
restApiIdstring | IRestApiRefrest_api_idtyping.Union[str, IRestApiRef]restApiIdStringRestApiIdstringRestApiIdinterface{}required#The string identifier of the associated RestApi.