aws-cdk-lib.aws_apigateway.CfnDocumentationVersionProps

interface CfnDocumentationVersionProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnDocumentationVersionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDocumentationVersionProps
Javasoftware.amazon.awscdk.services.apigateway.CfnDocumentationVersionProps
Pythonaws_cdk.aws_apigateway.CfnDocumentationVersionProps
TypeScript aws-cdk-lib » 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 { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnDocumentationVersionProps: apigateway.CfnDocumentationVersionProps = {
  documentationVersion: 'documentationVersion',
  restApiId: 'restApiId',

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

Properties

NameTypeDescription
documentationVersionstringThe version identifier of the to-be-updated documentation version.
restApiIdstringThe string identifier of the associated RestApi.
description?stringA 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.