Skip to content
v2.278.0

DocumentationPartReference Struct ​

A reference to a DocumentationPart resource.

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 interfaces_apigateway } from 'aws-cdk-lib/interfaces';
const documentationPartReference: interfaces_apigateway.DocumentationPartReference = {
  documentationPartId: 'documentationPartId',
  restApiId: 'restApiId',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.interfaces import aws_apigateway as interfaces_apigateway

documentation_part_reference = interfaces_apigateway.DocumentationPartReference(
    documentation_part_id="documentationPartId",
    rest_api_id="restApiId"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.interfaces.apigateway.*;

DocumentationPartReference documentationPartReference = DocumentationPartReference.builder()
        .documentationPartId("documentationPartId")
        .restApiId("restApiId")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Interfaces.APIGateway;

var documentationPartReference = new DocumentationPartReference {
    DocumentationPartId = "documentationPartId",
    RestApiId = "restApiId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

documentationPartReference := &DocumentationPartReference{
	DocumentationPartId: jsii.String("documentationPartId"),
	RestApiId: jsii.String("restApiId"),
}

Properties ​

documentationPartIdstringdocumentation_part_idstrdocumentationPartIdStringDocumentationPartIdstringDocumentationPartId*string required #
The DocumentationPartId of the DocumentationPart resource.
restApiIdstringrest_api_idstrrestApiIdStringRestApiIdstringRestApiId*string required #
The RestApiId of the DocumentationPart resource.