interface CfnDocumentationPartProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.CfnDocumentationPartProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDocumentationPartProps
Java	software.amazon.awscdk.services.apigateway.CfnDocumentationPartProps
Python	aws_cdk.aws_apigateway.CfnDocumentationPartProps
TypeScript	aws-cdk-lib » aws_apigateway » CfnDocumentationPartProps

Properties for defining a CfnDocumentationPart.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html

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

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	The string identifier of the associated RestApi.

---

location

Type: IResolvable | LocationProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties

---

restApiId

Type: string

The string identifier of the associated RestApi.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid