com.pulumi.awsnative.apigatewayv2.kotlin.ApiMappingArgs.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 1.24.0.0

Show newest version

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.apigatewayv2.kotlin

import com.pulumi.awsnative.apigatewayv2.ApiMappingArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * 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](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname-apimappings.html#CreateApiMapping) in the *Amazon API Gateway V2 API Reference*.
 * @property apiId The identifier of the API.
 * @property apiMappingKey The API mapping key.
 * @property domainName The domain name.
 * @property stage The API stage.
 */
public data class ApiMappingArgs(
    public val apiId: Output? = null,
    public val apiMappingKey: Output? = null,
    public val domainName: Output? = null,
    public val stage: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.apigatewayv2.ApiMappingArgs =
        com.pulumi.awsnative.apigatewayv2.ApiMappingArgs.builder()
            .apiId(apiId?.applyValue({ args0 -> args0 }))
            .apiMappingKey(apiMappingKey?.applyValue({ args0 -> args0 }))
            .domainName(domainName?.applyValue({ args0 -> args0 }))
            .stage(stage?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ApiMappingArgs].
 */
@PulumiTagMarker
public class ApiMappingArgsBuilder internal constructor() {
    private var apiId: Output? = null

    private var apiMappingKey: Output? = null

    private var domainName: Output? = null

    private var stage: Output? = null

    /**
     * @param value The identifier of the API.
     */
    @JvmName("vlbjrjbpmrcdtnsa")
    public suspend fun apiId(`value`: Output) {
        this.apiId = value
    }

    /**
     * @param value The API mapping key.
     */
    @JvmName("vairktdcoixihuyj")
    public suspend fun apiMappingKey(`value`: Output) {
        this.apiMappingKey = value
    }

    /**
     * @param value The domain name.
     */
    @JvmName("vsbengflcdickdgb")
    public suspend fun domainName(`value`: Output) {
        this.domainName = value
    }

    /**
     * @param value The API stage.
     */
    @JvmName("fmualryhxxbjlsmg")
    public suspend fun stage(`value`: Output) {
        this.stage = value
    }

    /**
     * @param value The identifier of the API.
     */
    @JvmName("mfnwldedqjmykxec")
    public suspend fun apiId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.apiId = mapped
    }

    /**
     * @param value The API mapping key.
     */
    @JvmName("buebjnisnwpnfqlx")
    public suspend fun apiMappingKey(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.apiMappingKey = mapped
    }

    /**
     * @param value The domain name.
     */
    @JvmName("dxujmosmagxanlfk")
    public suspend fun domainName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.domainName = mapped
    }

    /**
     * @param value The API stage.
     */
    @JvmName("entuwvlifmrdbunm")
    public suspend fun stage(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.stage = mapped
    }

    internal fun build(): ApiMappingArgs = ApiMappingArgs(
        apiId = apiId,
        apiMappingKey = apiMappingKey,
        domainName = domainName,
        stage = stage,
    )
}