Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Interface CfnDocumentationPartMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentationPartMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.452Z")
@Stability(Stable)
public interface CfnDocumentationPartMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnDocumentationPartPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigateway.*;
 CfnDocumentationPartMixinProps cfnDocumentationPartMixinProps = CfnDocumentationPartMixinProps.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	CfnDocumentationPartMixinProps.Builder	A builder for CfnDocumentationPartMixinProps
static final class	CfnDocumentationPartMixinProps.Jsii$Proxy	An implementation for CfnDocumentationPartMixinProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLocation

@Stability(Stable)
@Nullable
default Object getLocation()

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

Returns union: either IResolvable or CfnDocumentationPartPropsMixin.LocationProperty

See Also:

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

getProperties

@Stability(Stable)
@Nullable
default 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)
@Nullable
default Object getRestApiId()

The string identifier of the associated RestApi.

Returns union: either String or IRestApiRef

See Also:

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

builder

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

Returns:

a CfnDocumentationPartMixinProps.Builder of CfnDocumentationPartMixinProps