Interface ApiMappingProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.133Z") @Stability(Experimental) public interface ApiMappingProps extends
(experimental) Properties used to create the ApiMapping resource.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 IApi api;
 DomainName domainName;
 IStage stage;
 ApiMappingProps apiMappingProps = ApiMappingProps.builder()
         // the properties below are optional
  • Method Details

    • getApi

      @Stability(Experimental) @NotNull IApi getApi()
      (experimental) The Api to which this mapping is applied.
    • getDomainName

      @Stability(Experimental) @NotNull IDomainName getDomainName()
      (experimental) custom domain name of the mapping target.
    • getApiMappingKey

      @Stability(Experimental) @Nullable default String getApiMappingKey()
      (experimental) Api mapping key.

      The path where this stage should be mapped to on the domain

      Default: - undefined for the root path mapping.

    • getStage

      @Stability(Experimental) @Nullable default IStage getStage()
      (experimental) stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.

      Default: - Default stage of the passed API for HTTP API, required for WebSocket API

    • builder

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