Package software.amazon.awscdk.cfnpropertymixins.services.apigateway

Class CfnDocumentationVersionPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnDocumentationVersionPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:55.454Z") @Stability(Stable) public class CfnDocumentationVersionPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.apigateway.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnDocumentationVersionPropsMixin cfnDocumentationVersionPropsMixin = CfnDocumentationVersionPropsMixin.Builder.create(CfnDocumentationVersionMixinProps.builder()
         .description("description")
         .documentationVersion("documentationVersion")
         .restApiId("restApiId")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnDocumentationVersionPropsMixin

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

    • CfnDocumentationVersionPropsMixin

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

    • CfnDocumentationVersionPropsMixin

      @Stability(Stable) public CfnDocumentationVersionPropsMixin(@NotNull CfnDocumentationVersionMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::ApiGateway::DocumentationVersion.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDocumentationVersionPropsMixin

      @Stability(Stable) public CfnDocumentationVersionPropsMixin(@NotNull CfnDocumentationVersionMixinProps props)
      Create a mixin to apply properties to AWS::ApiGateway::DocumentationVersion.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnDocumentationVersionMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()