software.amazon.awscdk.services.apigateway

Interface CfnDocumentationVersionProps

All Known Implementing Classes:

CfnDocumentationVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:34.634Z")
public interface CfnDocumentationVersionProps

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 java.lang.String	getDescription() The description of the API documentation snapshot.
java.lang.String	getDocumentationVersion() The version identifier of the API documentation snapshot.
java.lang.String	getRestApiId() The identifier of the API.

Method Detail

getDocumentationVersion

java.lang.String getDocumentationVersion()

The version identifier of the API documentation snapshot.

getRestApiId

java.lang.String getRestApiId()

The identifier of the API.

getDescription

default java.lang.String getDescription()

The description of the API documentation snapshot.

builder

static CfnDocumentationVersionProps.Builder builder()

Returns:

a CfnDocumentationVersionProps.Builder of CfnDocumentationVersionProps