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.101.0 (build b95fe5d)", date="2024-07-22T22:42:46.559Z") @Stability(Stable) public class CfnDocumentationVersion extends CfnResource implements IInspectable
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:
  • 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
    • 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.