Package software.amazon.awscdk.mixins.preview.services.apigateway.mixins

Class CfnDocumentationPartPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.mixins.preview.core.Mixin

software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDocumentationPartPropsMixin

All Implemented Interfaces:

IMixin, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:22.284Z")
@Stability(Stable)
public class CfnDocumentationPartPropsMixin
extends Mixin
implements IMixin

The AWS::ApiGateway::DocumentationPart resource creates a documentation part for an API.

For more information, see Representation of API Documentation in API Gateway in the API Gateway Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.mixins.*;
 import software.amazon.awscdk.mixins.preview.services.apigateway.mixins.*;
 CfnDocumentationPartPropsMixin cfnDocumentationPartPropsMixin = CfnDocumentationPartPropsMixin.Builder.create(CfnDocumentationPartMixinProps.builder()
         .location(LocationProperty.builder()
                 .method("method")
                 .name("name")
                 .path("path")
                 .statusCode("statusCode")
                 .type("type")
                 .build())
         .properties("properties")
         .restApiId("restApiId")
         .build())
 .strategy(PropertyMergeStrategy.OVERRIDE)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDocumentationPartPropsMixin.Builder	A fluent builder for CfnDocumentationPartPropsMixin.
static interface	CfnDocumentationPartPropsMixin.LocationProperty	The Location property specifies the location of the Amazon API Gateway API entity that the documentation applies to.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.core.IMixin

IMixin.Jsii$Default, IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnDocumentationPartPropsMixin(CfnDocumentationPartMixinProps props)	Create a mixin to apply properties to AWS::ApiGateway::DocumentationPart.
	CfnDocumentationPartPropsMixin(CfnDocumentationPartMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ApiGateway::DocumentationPart.
protected	CfnDocumentationPartPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDocumentationPartPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
software.constructs.IConstruct	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnDocumentationPartMixinProps	getProps()
protected PropertyMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.mixins.preview.core.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnDocumentationPartPropsMixin

protected CfnDocumentationPartPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnDocumentationPartPropsMixin

protected CfnDocumentationPartPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDocumentationPartPropsMixin

@Stability(Stable)
public CfnDocumentationPartPropsMixin(@NotNull
 CfnDocumentationPartMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ApiGateway::DocumentationPart.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnDocumentationPartPropsMixin

@Stability(Stable)
public CfnDocumentationPartPropsMixin(@NotNull
 CfnDocumentationPartMixinProps props)

Create a mixin to apply properties to AWS::ApiGateway::DocumentationPart.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
@NotNull
public software.constructs.IConstruct applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnDocumentationPartMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected PropertyMergeStrategy getStrategy()