Interface BasePathMappingOptions

All Superinterfaces:
All Known Subinterfaces:
All Known Implementing Classes:
BasePathMappingOptions.Jsii$Proxy, BasePathMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:13.606Z") @Stability(Stable) public interface BasePathMappingOptions extends

 DomainName domain;
 RestApi api1;
 RestApi api2;
 domain.addBasePathMapping(api1, BasePathMappingOptions.builder().basePath("go-to-api1").build());
 domain.addBasePathMapping(api2, BasePathMappingOptions.builder().basePath("boom").build());
  • Method Details

    • getAttachToStage

      @Stability(Stable) @Nullable default Boolean getAttachToStage()
      Whether to attach the base path mapping to a stage.

      Use this property to create a base path mapping without attaching it to the Rest API default stage. This property is ignored if stage is provided.

      Default: - true

    • getBasePath

      @Stability(Stable) @Nullable default String getBasePath()
      The base path name that callers of the API must provide in the URL after the domain name (e.g. If you specify this property, it can't be an empty string.

      Default: - map requests from the domain root (e.g. ``). If this is undefined, no additional mappings will be allowed on this domain name.

    • getStage

      @Stability(Stable) @Nullable default Stage getStage()
      The Deployment stage of API [disable-awslint:ref-via-interface].

      Default: - map to deploymentStage of restApi otherwise stage needs to pass in URL

    • builder

      @Stability(Stable) static BasePathMappingOptions.Builder builder()
      a BasePathMappingOptions.Builder of BasePathMappingOptions