software.amazon.awscdk.services.apigateway

Interface CfnDocumentationVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDocumentationVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.104Z")
 @Stability(value=Stable)
public interface CfnDocumentationVersionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDocumentationVersion`.

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.*;
 CfnDocumentationVersionProps cfnDocumentationVersionProps = CfnDocumentationVersionProps.builder()
         .documentationVersion("documentationVersion")
         .restApiId("restApiId")
         // the properties below are optional
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDocumentationVersionProps.Builder	builder()
default String	getDescription() The description of the API documentation snapshot.
String	getDocumentationVersion() The version identifier of the API documentation snapshot.
String	getRestApiId() The identifier of the API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDocumentationVersion

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

The version identifier of the API documentation snapshot.

getRestApiId

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

The identifier of the API.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

The description of the API documentation snapshot.

builder

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

Returns:

a CfnDocumentationVersionProps.Builder of CfnDocumentationVersionProps