Package software.amazon.awscdk.services.apigateway

Class CfnDocumentationPart

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigateway.CfnDocumentationPart
All Implemented Interfaces:
IInspectable, IDocumentationPartRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:31.400Z") @Stability(Stable) public class CfnDocumentationPart extends CfnResource implements IInspectable, IDocumentationPartRef
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.services.apigateway.*;
 CfnDocumentationPart cfnDocumentationPart = CfnDocumentationPart.Builder.create(this, "MyCfnDocumentationPart")
         .location(LocationProperty.builder()
                 .method("method")
                 .name("name")
                 .path("path")
                 .statusCode("statusCode")
                 .type("type")
                 .build())
         .properties("properties")
         .restApiId("restApiId")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDocumentationPart

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

    • CfnDocumentationPart

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

    • CfnDocumentationPart

      @Stability(Stable) public CfnDocumentationPart(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDocumentationPartProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDocumentationPartId

      @Stability(Stable) @NotNull public String getAttrDocumentationPartId()
      The ID for the documentation part.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDocumentationPartRef

      @Stability(Stable) @NotNull public DocumentationPartReference getDocumentationPartRef()
      A reference to a DocumentationPart resource.
      Specified by:
      getDocumentationPartRef in interface IDocumentationPartRef

    • getLocation

      @Stability(Stable) @NotNull public Object getLocation()
      The location of the targeted API entity of the to-be-created documentation part.

      Returns union: either IResolvable or CfnDocumentationPart.LocationProperty

    • setLocation

      @Stability(Stable) public void setLocation(@NotNull IResolvable value)
      The location of the targeted API entity of the to-be-created documentation part.

    • setLocation

      @Stability(Stable) public void setLocation(@NotNull CfnDocumentationPart.LocationProperty value)
      The location of the targeted API entity of the to-be-created documentation part.

    • getProperties

      @Stability(Stable) @NotNull public String getProperties()
      The new documentation content map of the targeted API entity.

    • setProperties

      @Stability(Stable) public void setProperties(@NotNull String value)
      The new documentation content map of the targeted API entity.

    • getRestApiId

      @Stability(Stable) @NotNull public String getRestApiId()
      The string identifier of the associated RestApi.

    • setRestApiId

      @Stability(Stable) public void setRestApiId(@NotNull String value)
      The string identifier of the associated RestApi.