interface CfnDocumentationVersionMixinProps

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway.CfnDocumentationVersionMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsapigateway#CfnDocumentationVersionMixinProps`
Java	`software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDocumentationVersionMixinProps`
Python	`aws_cdk.cfn_property_mixins.aws_apigateway.CfnDocumentationVersionMixinProps`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_apigateway` » `CfnDocumentationVersionMixinProps`

Properties for CfnDocumentationVersionPropsMixin.

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/cfn-property-mixins';
const cfnDocumentationVersionMixinProps: apigateway.CfnDocumentationVersionMixinProps = {
  description: 'description',
  documentationVersion: 'documentationVersion',
  restApiId: 'restApiId',
};

Properties

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

description?

Type: string (optional)

A description about the new documentation snapshot.

documentationVersion?

Type: string (optional)

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

restApiId?

Type: string | IRestApiRef (optional)

The string identifier of the associated RestApi.

AWS CDK