# CfnDocumentationPartProps

Properties for defining a `CfnDocumentationPart`.

Extends: CfnDocumentationPartProps
Used as props by: CfnDocumentationPart

- Source: Generated code
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

```ts
// 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

- `location`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDocumentationPart.LocationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.CfnDocumentationPart.LocationProperty.html) (required) — The location of the targeted API entity of the to-be-created documentation part.

- `properties`: string (required) — 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`: string | [IRestApiRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_apigateway.IRestApiRef.html) (required) — The string identifier of the associated RestApi.