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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.103Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDocumentationPartProps.Builder	builder()
Object	getLocation() The location of the API entity that the documentation applies to.
String	getProperties() The documentation content map of the targeted API entity.
String	getRestApiId() The identifier of the targeted API entity.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getLocation

@Stability(value=Stable)
 @NotNull
Object getLocation()

The location of the API entity that the documentation applies to.

getProperties

@Stability(value=Stable)
 @NotNull
String getProperties()

The documentation content map of the targeted API entity.

getRestApiId

@Stability(value=Stable)
 @NotNull
String getRestApiId()

The identifier of the targeted API entity.

builder

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

Returns:

a CfnDocumentationPartProps.Builder of CfnDocumentationPartProps