ApiMappingArgs

data class ApiMappingArgs(val apiId: Output<String>? = null, val apiMappingKey: Output<String>? = null, val domainName: Output<String>? = null, val stage: Output<String>? = null) : ConvertibleToJava<ApiMappingArgs>

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.

Constructors

Link copied to clipboard
constructor(apiId: Output<String>? = null, apiMappingKey: Output<String>? = null, domainName: Output<String>? = null, stage: Output<String>? = null)

Properties

Link copied to clipboard
val apiId: Output<String>? = null

The identifier of the API.

Link copied to clipboard
val apiMappingKey: Output<String>? = null

The API mapping key.

Link copied to clipboard
val domainName: Output<String>? = null

The domain name.

Link copied to clipboard
val stage: Output<String>? = null

The API stage.

Functions

Link copied to clipboard
open override fun toJava(): ApiMappingArgs