Package software.amazon.awscdk.services.apigateway

Interface CfnDocumentationPartProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentationPartProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:31.402Z")
@Stability(Stable)
public interface CfnDocumentationPartProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.apigateway.*;
 CfnDocumentationPartProps cfnDocumentationPartProps = CfnDocumentationPartProps.builder()
         .location(LocationProperty.builder()
                 .method("method")
                 .name("name")
                 .path("path")
                 .statusCode("statusCode")
                 .type("type")
                 .build())
         .properties("properties")
         .restApiId("restApiId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDocumentationPartProps.Builder	A builder for CfnDocumentationPartProps
static final class	CfnDocumentationPartProps.Jsii$Proxy	An implementation for CfnDocumentationPartProps

Method Summary

Modifier and Type	Method	Description
static CfnDocumentationPartProps.Builder	builder()
Object	getLocation()	The location of the targeted API entity of the to-be-created documentation part.
String	getProperties()	The new documentation content map of the targeted API entity.
String	getRestApiId()	The string identifier of the associated RestApi.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLocation

@Stability(Stable)
@NotNull
Object getLocation()

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

Returns union: either IResolvable or CfnDocumentationPart.LocationProperty

See Also:

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

getProperties

@Stability(Stable)
@NotNull
String getProperties()

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

getRestApiId

@Stability(Stable)
@NotNull
String getRestApiId()

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

builder

@Stability(Stable)
static CfnDocumentationPartProps.Builder builder()

Returns:

a CfnDocumentationPartProps.Builder of CfnDocumentationPartProps