Package software.amazon.awscdk.services.apigateway

Class AssetApiDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.ApiDefinition
software.amazon.awscdk.services.apigateway.AssetApiDefinition
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:31.365Z") @Stability(Stable) public class AssetApiDefinition extends ApiDefinition
OpenAPI specification from a local file.

Example: 

 AssetApiDefinition myApiDefinition = ApiDefinition.fromAsset("path-to-file.json");
 SpecRestApi specRestApi = SpecRestApi.Builder.create(this, "my-specrest-api")
         .deploy(false)
         .apiDefinition(myApiDefinition)
         .build();
 // Use `stageName` to deploy to an existing stage
 Deployment deployment = Deployment.Builder.create(this, "my-deployment")
         .api(specRestApi)
         .stageName("dev")
         .retainDeployments(true)
         .build();
 // Trigger a new deployment on OpenAPI definition updates
 deployment.addToLogicalId(myApiDefinition);

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AssetApiDefinition.Builder
    A fluent builder for AssetApiDefinition.

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    AssetApiDefinition(String path)
     
     
    AssetApiDefinition(String path, AssetOptions options)
     
    protected
    AssetApiDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    AssetApiDefinition(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.
    void
    bindAfterCreate(software.constructs.Construct scope, IRestApiRef restApi)
    Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it.

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

    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

    • AssetApiDefinition

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

    • AssetApiDefinition

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

    • AssetApiDefinition

      @Stability(Stable) public AssetApiDefinition(@NotNull String path, @Nullable AssetOptions options)
      Parameters:
      path - This parameter is required.
      options -

    • AssetApiDefinition

      @Stability(Stable) public AssetApiDefinition(@NotNull String path)
      Parameters:
      path - 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.

    • bindAfterCreate

      @Stability(Stable) public void bindAfterCreate(@NotNull software.constructs.Construct scope, @NotNull IRestApiRef restApi)
      Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it.

      Specifically it's required to allow assets to add metadata for tooling like SAM CLI to be able to find their origins.

      Overrides:
      bindAfterCreate in class ApiDefinition
      Parameters:
      scope - This parameter is required.
      restApi - This parameter is required.