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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.103Z")
 @Stability(value=Stable)
public class CfnDocumentationVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::DocumentationVersion`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDocumentationVersion(software.constructs.Construct scope, String id, CfnDocumentationVersionProps props) Create a new `AWS::ApiGateway::DocumentationVersion`.
protected	CfnDocumentationVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDocumentationVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the API documentation snapshot.
void	setDocumentationVersion(String value) The version identifier of the API documentation snapshot.
void	setRestApiId(String value) The identifier of the API.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDocumentationVersion

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

CfnDocumentationVersion

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

CfnDocumentationVersion

@Stability(value=Stable)
public CfnDocumentationVersion(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @NotNull
                                                        CfnDocumentationVersionProps props)

Create a new `AWS::ApiGateway::DocumentationVersion`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDocumentationVersion

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

The version identifier of the API documentation snapshot.

setDocumentationVersion

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

The version identifier of the API documentation snapshot.

getRestApiId

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

The identifier of the API.

setRestApiId

@Stability(value=Stable)
public void setRestApiId(@NotNull
                                                  String value)

The identifier of the API.

getDescription

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

The description of the API documentation snapshot.

setDescription

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

The description of the API documentation snapshot.