Class CfnDocumentationVersion

All Implemented Interfaces:
IConstruct, IDependable, IInspectable,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.797Z") @Stability(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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnDocumentationVersion cfnDocumentationVersion = CfnDocumentationVersion.Builder.create(this, "MyCfnDocumentationVersion")
         // the properties below are optional
  • Field Details


      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnDocumentationVersion

      protected CfnDocumentationVersion( objRef)
    • CfnDocumentationVersion

      protected CfnDocumentationVersion( initializationMode)
    • CfnDocumentationVersion

      @Stability(Stable) public CfnDocumentationVersion(@NotNull Construct scope, @NotNull String id, @NotNull CfnDocumentationVersionProps props)
      Create a new AWS::ApiGateway::DocumentationVersion.

      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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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)
      renderProperties in class CfnResource
      props - This parameter is required.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      getCfnProperties in class CfnResource
    • 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.