pulumi-aws-native-kotlin/com.pulumi.awsnative.apigatewayv2.kotlin.outputs/GetApiResult

GetApiResult

data class GetApiResult(val apiEndpoint: String? = null, val apiId: String? = null, val apiKeySelectionExpression: String? = null, val corsConfiguration: ApiCors? = null, val description: String? = null, val disableExecuteApiEndpoint: Boolean? = null, val name: String? = null, val routeSelectionExpression: String? = null, val tags: Map<String, String>? = null, val version: String? = null)

Constructors

GetApiResult

constructor(apiEndpoint: String? = null, apiId: String? = null, apiKeySelectionExpression: String? = null, corsConfiguration: ApiCors? = null, description: String? = null, disableExecuteApiEndpoint: Boolean? = null, name: String? = null, routeSelectionExpression: String? = null, tags: Map<String, String>? = null, version: String? = null)

Types

Companion

object Companion

Properties

apiEndpoint

val apiEndpoint: String? = null

The default endpoint for an API. For example: https://abcdef.execute-api.us-west-2.amazonaws.com .

apiId

val apiId: String? = null

The API identifier.

apiKeySelectionExpression

val apiKeySelectionExpression: String? = null

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

corsConfiguration

val corsConfiguration: ApiCors? = null

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

description

val description: String? = null

The description of the API.

disableExecuteApiEndpoint

val disableExecuteApiEndpoint: Boolean? = null

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.

name

val name: String? = null

The name of the API. Required unless you specify an OpenAPI definition for `Body` or `S3BodyLocation`.

routeSelectionExpression

val routeSelectionExpression: String? = null

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.