Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Interface CfnApiMappingMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiMappingMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-19T12:55:16.436Z")
@Stability(Stable)
public interface CfnApiMappingMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnApiMappingPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.*;
 CfnApiMappingMixinProps cfnApiMappingMixinProps = CfnApiMappingMixinProps.builder()
         .apiId("apiId")
         .apiMappingKey("apiMappingKey")
         .domainName("domainName")
         .stage("stage")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApiMappingMixinProps.Builder	A builder for CfnApiMappingMixinProps
static final class	CfnApiMappingMixinProps.Jsii$Proxy	An implementation for CfnApiMappingMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnApiMappingMixinProps.Builder	builder()
default Object	getApiId()	The API identifier.
default String	getApiMappingKey()	The API mapping key.
default Object	getDomainName()	The domain name.
default String	getStage()	The API stage.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@Nullable
default Object getApiId()

The API identifier.

Returns union: either String or IRestApiRef or IApiRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid

getApiMappingKey

@Stability(Stable)
@Nullable
default String getApiMappingKey()

The API mapping key.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey

getDomainName

@Stability(Stable)
@Nullable
default Object getDomainName()

The domain name.

Returns union: either String or IDomainNameRef or IDomainNameRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname

getStage

@Stability(Stable)
@Nullable
default String getStage()

The API stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage

builder

@Stability(Stable)
static CfnApiMappingMixinProps.Builder builder()

Returns:

a CfnApiMappingMixinProps.Builder of CfnApiMappingMixinProps