![JAR search and dependency download from the Maven repository](/logo.png)
com.pulumi.awsnative.apigatewayv2.kotlin.outputs.GetApiResult.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.apigatewayv2.kotlin.outputs
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.collections.Map
/**
*
* @property apiEndpoint The default endpoint for an API. For example: `https://abcdef.execute-api.us-west-2.amazonaws.com` .
* @property apiId The API identifier.
* @property apiKeySelectionExpression An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
* @property corsConfiguration A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
* @property description The description of the API.
* @property disableExecuteApiEndpoint Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
* @property name The name of the API. Required unless you specify an OpenAPI definition for ``Body`` or ``S3BodyLocation``.
* @property routeSelectionExpression The route selection expression for the API. For HTTP APIs, the ``routeSelectionExpression`` must be ``${request.method} ${request.path}``. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
* @property tags The collection of tags. Each tag element is associated with a given resource.
* @property version A version identifier for the API.
*/
public data class GetApiResult(
public val apiEndpoint: String? = null,
public val apiId: String? = null,
public val apiKeySelectionExpression: String? = null,
public val corsConfiguration: ApiCors? = null,
public val description: String? = null,
public val disableExecuteApiEndpoint: Boolean? = null,
public val name: String? = null,
public val routeSelectionExpression: String? = null,
public val tags: Map? = null,
public val version: String? = null,
) {
public companion object {
public fun toKotlin(javaType: com.pulumi.awsnative.apigatewayv2.outputs.GetApiResult): GetApiResult = GetApiResult(
apiEndpoint = javaType.apiEndpoint().map({ args0 -> args0 }).orElse(null),
apiId = javaType.apiId().map({ args0 -> args0 }).orElse(null),
apiKeySelectionExpression = javaType.apiKeySelectionExpression().map({ args0 ->
args0
}).orElse(null),
corsConfiguration = javaType.corsConfiguration().map({ args0 ->
args0.let({ args0 ->
com.pulumi.awsnative.apigatewayv2.kotlin.outputs.ApiCors.Companion.toKotlin(args0)
})
}).orElse(null),
description = javaType.description().map({ args0 -> args0 }).orElse(null),
disableExecuteApiEndpoint = javaType.disableExecuteApiEndpoint().map({ args0 ->
args0
}).orElse(null),
name = javaType.name().map({ args0 -> args0 }).orElse(null),
routeSelectionExpression = javaType.routeSelectionExpression().map({ args0 -> args0 }).orElse(null),
tags = javaType.tags().map({ args0 -> args0.key.to(args0.value) }).toMap(),
version = javaType.version().map({ args0 -> args0 }).orElse(null),
)
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy