Package software.amazon.awscdk.services.apigateway

Class CfnDocumentationVersion

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.CfnDocumentationVersion

All Implemented Interfaces:

IInspectable, IDocumentationVersionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:30.221Z")
@Stability(Stable)
public class CfnDocumentationVersion
extends CfnResource
implements IInspectable, IDocumentationVersionRef

The AWS::ApiGateway::DocumentationVersion resource creates a snapshot of the documentation 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.*;
 CfnDocumentationVersion cfnDocumentationVersion = CfnDocumentationVersion.Builder.create(this, "MyCfnDocumentationVersion")
         .documentationVersion("documentationVersion")
         .restApiId("restApiId")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDocumentationVersion.Builder	A fluent builder for CfnDocumentationVersion.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IDocumentationVersionRef

IDocumentationVersionRef.Jsii$Default, IDocumentationVersionRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDocumentationVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDocumentationVersion(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDocumentationVersion(software.constructs.Construct scope, String id, CfnDocumentationVersionProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description about the new documentation snapshot.
String	getDocumentationVersion()	The version identifier of the to-be-updated documentation version.
DocumentationVersionReference	getDocumentationVersionRef()	A reference to a DocumentationVersion resource.
String	getRestApiId()	The string identifier of the associated RestApi.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	A description about the new documentation snapshot.
void	setDocumentationVersion(String value)	The version identifier of the to-be-updated documentation version.
void	setRestApiId(String value)	The string identifier of the associated RestApi.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnDocumentationVersion

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

CfnDocumentationVersion

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

CfnDocumentationVersion

@Stability(Stable)
public CfnDocumentationVersion(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnDocumentationVersionProps 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.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDocumentationVersionRef

@Stability(Stable)
@NotNull
public DocumentationVersionReference getDocumentationVersionRef()

A reference to a DocumentationVersion resource.

Specified by:

getDocumentationVersionRef in interface IDocumentationVersionRef

getDocumentationVersion

@Stability(Stable)
@NotNull
public String getDocumentationVersion()

The version identifier of the to-be-updated documentation version.

setDocumentationVersion

@Stability(Stable)
public void setDocumentationVersion(@NotNull
 String value)

The version identifier of the to-be-updated documentation version.

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.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description about the new documentation snapshot.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description about the new documentation snapshot.