All Implemented Interfaces:
IConstruct, IDependable, IResource, IApiMapping,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.131Z") @Stability(Experimental) public class ApiMapping extends Resource implements IApiMapping
(experimental) Create a new API mapping for API Gateway API endpoint.


 // 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;
 ApiMapping apiMapping = ApiMapping.Builder.create(this, "MyApiMapping")
         // the properties below are optional
  • Constructor Details

    • ApiMapping

      protected ApiMapping( objRef)
    • ApiMapping

      protected ApiMapping( initializationMode)
    • ApiMapping

      @Stability(Experimental) public ApiMapping(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ApiMappingProps props)
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.
  • Method Details

    • fromApiMappingAttributes

      @Stability(Experimental) @NotNull public static IApiMapping fromApiMappingAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull ApiMappingAttributes attrs)
      (experimental) import from API ID.

      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.
    • getApiMappingId

      @Stability(Experimental) @NotNull public String getApiMappingId()
      (experimental) ID of the API Mapping.
      Specified by:
      getApiMappingId in interface IApiMapping
    • getDomainName

      @Stability(Experimental) @NotNull public IDomainName getDomainName()
      (experimental) API domain name.
    • getMappingKey

      @Stability(Experimental) @Nullable public String getMappingKey()
      (experimental) API Mapping key.