Package software.amazon.awscdk.services.apigatewayv2

Class CfnApiMapping

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnApiMapping
All Implemented Interfaces:
IInspectable, IApiMappingRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:13.448Z") @Stability(Stable) public class CfnApiMapping extends CfnResource implements IInspectable, IApiMappingRef
The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see CreateApiMapping in the Amazon API Gateway V2 API Reference .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 CfnApiMapping cfnApiMapping = CfnApiMapping.Builder.create(this, "MyCfnApiMapping")
         .apiId("apiId")
         .domainName("domainName")
         .stage("stage")
         // the properties below are optional
         .apiMappingKey("apiMappingKey")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApiMapping

      protected CfnApiMapping(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnApiMapping

      protected CfnApiMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnApiMapping

      @Stability(Stable) public CfnApiMapping(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApiMappingProps props)
      Create a new AWS::ApiGatewayV2::ApiMapping.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnApiMapping

      @Stability(Stable) @NotNull public static Boolean isCfnApiMapping(@NotNull Object x)
      Checks whether the given object is a CfnApiMapping.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getApiMappingRef

      @Stability(Stable) @NotNull public ApiMappingReference getApiMappingRef()
      A reference to a ApiMapping resource.
      Specified by:
      getApiMappingRef in interface IApiMappingRef

    • getAttrApiMappingId

      @Stability(Stable) @NotNull public String getAttrApiMappingId()
      The API mapping resource ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The API identifier.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The API identifier.

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The domain name.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The domain name.

    • getStage

      @Stability(Stable) @NotNull public String getStage()
      The API stage.

    • setStage

      @Stability(Stable) public void setStage(@NotNull String value)
      The API stage.

    • getApiMappingKey

      @Stability(Stable) @Nullable public String getApiMappingKey()
      The API mapping key.

    • setApiMappingKey

      @Stability(Stable) public void setApiMappingKey(@Nullable String value)
      The API mapping key.