interface CfnDocumentationPartMixinProps

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

Properties for CfnDocumentationPartPropsMixin.

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 cfnDocumentationPartMixinProps: apigateway.CfnDocumentationPartMixinProps = {
  location: {
    method: 'method',
    name: 'name',
    path: 'path',
    statusCode: 'statusCode',
    type: 'type',
  },
  properties: 'properties',
  restApiId: 'restApiId',
};

Properties

Name	Type	Description
location?	`IResolvable` `\|` `LocationProperty`	The location of the targeted API entity of the to-be-created documentation part.
properties?	`string`	The new documentation content map of the targeted API entity.
restApiId?	`string \|` `IRestApiRef`	The string identifier of the associated RestApi.

location?

Type: IResolvable | LocationProperty (optional)

The location of the targeted API entity of the to-be-created documentation part.

properties?

Type: string (optional)

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.

restApiId?

Type: string | IRestApiRef (optional)

The string identifier of the associated RestApi.

AWS CDK