Package software.amazon.awscdk.services.apigateway

Interface StepFunctionsRestApiProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, ResourceOptions, RestApiBaseProps, RestApiProps
All Known Implementing Classes:
StepFunctionsRestApiProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:30.411Z") @Stability(Stable) public interface StepFunctionsRestApiProps extends software.amazon.jsii.JsiiSerializable, RestApiProps
Properties for StepFunctionsRestApi.

Example: 

 IStateMachine machine;
 StepFunctionsRestApi.Builder.create(this, "StepFunctionsRestApi")
         .stateMachine(machine)
         .useDefaultMethodResponses(false)
         .build();

  • Method Details

    • getStateMachine

      @Stability(Stable) @NotNull IStateMachine getStateMachine()
      The default State Machine that handles all requests from this API.

      This stateMachine will be used as a the default integration for all methods in this API, unless specified otherwise in addMethod.

    • getAuthorizer

      @Stability(Stable) @Nullable default Boolean getAuthorizer()
      If the whole authorizer object, including custom context values should be in the execution input.

      The execution input will include a new key authorizer:

      { "body": {}, "authorizer": { "key": "value" } }

      Default: false

    • getHeaders

      @Stability(Stable) @Nullable default Boolean getHeaders()
      Check if header is to be included inside the execution input.

      The execution input will include a new key headers:

      { "body": {}, "headers": { "header1": "value", "header2": "value" } }

      Default: false

    • getPath

      @Stability(Stable) @Nullable default Boolean getPath()
      Check if path is to be included inside the execution input.

      The execution input will include a new key path:

      { "body": {}, "path": { "resourceName": "resourceValue" } }

      Default: true

    • getQuerystring

      @Stability(Stable) @Nullable default Boolean getQuerystring()
      Check if querystring is to be included inside the execution input.

      The execution input will include a new key queryString:

      { "body": {}, "querystring": { "key": "value" } }

      Default: true

    • getRequestContext

      @Stability(Stable) @Nullable default RequestContext getRequestContext()
      Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.

      The execution input will include a new key requestContext:

      { "body": {}, "requestContext": { "key": "value" } }

      Default: - all parameters within request context will be set as false

    • getRole

      @Stability(Stable) @Nullable default IRole getRole()
      An IAM role that API Gateway will assume to start the execution of the state machine.

      Default: - a new role is created

    • getUseDefaultMethodResponses

      @Stability(Stable) @Nullable default Boolean getUseDefaultMethodResponses()
      Whether to add default response models with 200, 400, and 500 status codes to the method.

      Default: true

    • builder

      @Stability(Stable) static StepFunctionsRestApiProps.Builder builder()
      Returns:
      a StepFunctionsRestApiProps.Builder of StepFunctionsRestApiProps