Package software.amazon.awscdk.services.apigateway

Class S3ApiDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.ApiDefinition
software.amazon.awscdk.services.apigateway.S3ApiDefinition
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:57.920Z") @Stability(Stable) public class S3ApiDefinition extends ApiDefinition
OpenAPI specification from an S3 archive.

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.*;
 import software.amazon.awscdk.interfaces.s3.*;
 IBucketRef bucketRef;
 S3ApiDefinition s3ApiDefinition = new S3ApiDefinition(bucketRef, "key", "objectVersion");

  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    S3ApiDefinition(IBucketRef bucket, String key)
     
     
    S3ApiDefinition(IBucketRef bucket, String key, String objectVersion)
     
    protected
    S3ApiDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    S3ApiDefinition(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    ApiDefinitionConfig
    bind(software.constructs.Construct _scope)
    Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.

    Methods inherited from class software.amazon.awscdk.services.apigateway.ApiDefinition

    bindAfterCreate, fromAsset, fromAsset, fromBucket, fromBucket, fromInline

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

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • S3ApiDefinition

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

    • S3ApiDefinition

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

    • S3ApiDefinition

      @Stability(Stable) public S3ApiDefinition(@NotNull IBucketRef bucket, @NotNull String key, @Nullable String objectVersion)
      Parameters:
      bucket - This parameter is required.
      key - This parameter is required.
      objectVersion -

    • S3ApiDefinition

      @Stability(Stable) public S3ApiDefinition(@NotNull IBucketRef bucket, @NotNull String key)
      Parameters:
      bucket - This parameter is required.
      key - This parameter is required.

  • Method Details

    • bind

      @Stability(Stable) @NotNull public ApiDefinitionConfig bind(@NotNull software.constructs.Construct _scope)
      Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.

      Specified by:
      bind in class ApiDefinition
      Parameters:
      _scope - This parameter is required.