aws-cdk-lib.aws_apigateway.CfnDocumentationPartProps

interface CfnDocumentationPartProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnDocumentationPartProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDocumentationPartProps
Javasoftware.amazon.awscdk.services.apigateway.CfnDocumentationPartProps
Pythonaws_cdk.aws_apigateway.CfnDocumentationPartProps
TypeScript aws-cdk-lib » aws_apigateway » CfnDocumentationPartProps

Properties for defining a CfnDocumentationPart.

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

Properties

NameTypeDescription
locationIResolvable | LocationPropertyThe location of the targeted API entity of the to-be-created documentation part.
propertiesstringThe new documentation content map of the targeted API entity.
restApiIdstringThe string identifier of the associated RestApi.

location

Type: IResolvable | LocationProperty

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


properties

Type: string

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

The string identifier of the associated RestApi.