interface CfnDocumentationVersionProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnDocumentationVersionProps
Java	software.amazon.awscdk.services.apigateway.CfnDocumentationVersionProps
Python	aws_cdk.aws_apigateway.CfnDocumentationVersionProps
TypeScript	@aws-cdk/aws-apigateway » CfnDocumentationVersionProps

Properties for defining a CfnDocumentationVersion.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';
const cfnDocumentationVersionProps: apigateway.CfnDocumentationVersionProps = {
  documentationVersion: 'documentationVersion',
  restApiId: 'restApiId',

  // the properties below are optional
  description: 'description',
};

Properties

Name	Type	Description
documentationVersion	string	The version identifier of the to-be-updated documentation version.
restApiId	string	The string identifier of the associated RestApi.
description?	string	A description about the new documentation snapshot.

---

documentationVersion

Type: string

The version identifier of the to-be-updated documentation version.

---

restApiId

Type: string

The string identifier of the associated RestApi.

---

description?

Type: string (optional)

A description about the new documentation snapshot.