Package software.amazon.awscdk.services.apigatewayv2

Interface CfnApiMappingProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApiMappingProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:44.484Z")
@Stability(Stable)
public interface CfnApiMappingProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApiMapping.

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.*;
 CfnApiMappingProps cfnApiMappingProps = CfnApiMappingProps.builder()
         .apiId("apiId")
         .domainName("domainName")
         .stage("stage")
         // the properties below are optional
         .apiMappingKey("apiMappingKey")
         .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	CfnApiMappingProps.Builder	A builder for CfnApiMappingProps
static final class	CfnApiMappingProps.Jsii$Proxy	An implementation for CfnApiMappingProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The API identifier.

See Also:

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

getDomainName

@Stability(Stable)
@NotNull
String getDomainName()

The domain name.

See Also:

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

getStage

@Stability(Stable)
@NotNull
String getStage()

The API stage.

See Also:

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

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

builder

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

Returns:

a CfnApiMappingProps.Builder of CfnApiMappingProps