Interface HttpApiProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.250Z") @Stability(Experimental) public interface HttpApiProps extends
(experimental) Properties to initialize an instance of HttpApi.


 ApplicationLoadBalancer lb;
 ApplicationListener listener = lb.addListener("listener", BaseApplicationListenerProps.builder().port(80).build());
 listener.addTargets("target", AddApplicationTargetsProps.builder()
 HttpApi httpEndpoint = HttpApi.Builder.create(this, "HttpProxyPrivateApi")
         .defaultIntegration(HttpAlbIntegration.Builder.create("DefaultIntegration", listener)
                 .parameterMapping(new ParameterMapping().custom("myKey", "myValue"))
  • Method Details

    • getApiName

      @Stability(Experimental) @Nullable default String getApiName()
      (experimental) Name for the HTTP API resource.

      Default: - id of the HttpApi construct.

    • getCorsPreflight

      @Stability(Experimental) @Nullable default CorsPreflightOptions getCorsPreflight()
      (experimental) Specifies a CORS configuration for an API.

      Default: - CORS disabled.

      See Also:
    • getCreateDefaultStage

      @Stability(Experimental) @Nullable default Boolean getCreateDefaultStage()
      (experimental) Whether a default stage and deployment should be automatically created.

      Default: true

    • getDefaultAuthorizationScopes

      @Stability(Experimental) @Nullable default List<String> getDefaultAuthorizationScopes()
      (experimental) Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.

      Default: - no default authorization scopes

    • getDefaultAuthorizer

      @Stability(Experimental) @Nullable default IHttpRouteAuthorizer getDefaultAuthorizer()
      (experimental) Default Authorizer to applied to all routes in the gateway.

      Default: - No authorizer

    • getDefaultDomainMapping

      @Stability(Experimental) @Nullable default DomainMappingOptions getDefaultDomainMapping()
      (experimental) Configure a custom domain with the API mapping resource to the HTTP API.

      Default: - no default domain mapping configured. meaningless if `createDefaultStage` is `false`.

    • getDefaultIntegration

      @Stability(Experimental) @Nullable default HttpRouteIntegration getDefaultIntegration()
      (experimental) An integration that will be configured on the catch-all route ($default).

      Default: - none

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) The description of the API.

      Default: - none

    • getDisableExecuteApiEndpoint

      @Stability(Experimental) @Nullable default Boolean getDisableExecuteApiEndpoint()
      (experimental) Specifies whether clients can invoke your API using the default endpoint.

      By default, clients can invoke your API with the default https://{api_id}.execute-api.{region} endpoint. Enable this if you would like clients to use your custom domain name.

      Default: false execute-api endpoint enabled.

    • builder

      @Stability(Experimental) static HttpApiProps.Builder builder()
      a HttpApiProps.Builder of HttpApiProps