Class BasePathMapping

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.apigateway.BasePathMapping
All Implemented Interfaces:
IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-02-23T02:06:27.392Z") @Stability(Stable) public class BasePathMapping extends Resource
This resource creates a base path that clients who call your API must use in the invocation URL.

Unless you're importing a domain with DomainName.fromDomainNameAttributes(), you can use DomainName.addBasePathMapping() to define mappings.

Example:

 RestApi api;
 IDomainName domainName = DomainName.fromDomainNameAttributes(this, "DomainName", DomainNameAttributes.builder()
         .domainName("domainName")
         .domainNameAliasHostedZoneId("domainNameAliasHostedZoneId")
         .domainNameAliasTarget("domainNameAliasTarget")
         .build());
 BasePathMapping.Builder.create(this, "BasePathMapping")
         .domainName(domainName)
         .restApi(api)
         .build();
 
  • Constructor Details

    • BasePathMapping

      protected BasePathMapping(software.amazon.jsii.JsiiObjectRef objRef)
    • BasePathMapping

      protected BasePathMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • BasePathMapping

      @Stability(Stable) public BasePathMapping(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull BasePathMappingProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.