Package software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins

Class CfnApiMappingPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.mixins.preview.core.Mixin
software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnApiMappingPropsMixin
All Implemented Interfaces:
IMixin, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:22.330Z") @Stability(Stable) public class CfnApiMappingPropsMixin extends Mixin implements IMixin
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.mixins.preview.mixins.*;
 import software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.*;
 CfnApiMappingPropsMixin cfnApiMappingPropsMixin = CfnApiMappingPropsMixin.Builder.create(CfnApiMappingMixinProps.builder()
         .apiId("apiId")
         .apiMappingKey("apiMappingKey")
         .domainName("domainName")
         .stage("stage")
         .build())
 .strategy(PropertyMergeStrategy.OVERRIDE)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnApiMappingPropsMixin

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

    • CfnApiMappingPropsMixin

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

    • CfnApiMappingPropsMixin

      @Stability(Stable) public CfnApiMappingPropsMixin(@NotNull CfnApiMappingMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::ApiGatewayV2::ApiMapping.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnApiMappingPropsMixin

      @Stability(Stable) public CfnApiMappingPropsMixin(@NotNull CfnApiMappingMixinProps props)
      Create a mixin to apply properties to AWS::ApiGatewayV2::ApiMapping.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) @NotNull public software.constructs.IConstruct applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnApiMappingMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected PropertyMergeStrategy getStrategy()