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

GetApiResult

data class GetApiResult(val apiEndpoint: String, val apiId: String, val apiKeySelectionExpression: String, val arn: String, val corsConfigurations: List<GetApiCorsConfiguration>, val description: String, val disableExecuteApiEndpoint: Boolean, val executionArn: String, val id: String, val name: String, val protocolType: String, val routeSelectionExpression: String, val tags: Map<String, String>, val version: String)

A collection of values returned by getApi.

Constructors

GetApiResult

fun GetApiResult(apiEndpoint: String, apiId: String, apiKeySelectionExpression: String, arn: String, corsConfigurations: List<GetApiCorsConfiguration>, description: String, disableExecuteApiEndpoint: Boolean, executionArn: String, id: String, name: String, protocolType: String, routeSelectionExpression: String, tags: Map<String, String>, version: String)

Types

Companion

object Companion

Properties

apiEndpoint

val apiEndpoint: String

URI of the API, of the form https://{api-id}.execute-api.{region}.amazonaws.com for HTTP APIs and wss://{api-id}.execute-api.{region}.amazonaws.com for WebSocket APIs.

apiId

val apiId: String

apiKeySelectionExpression

val apiKeySelectionExpression: String

An API key selection expression. Applicable for WebSocket APIs.

arn

val arn: String

ARN of the API.

corsConfigurations

val corsConfigurations: List<GetApiCorsConfiguration>

Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.

description

val description: String

Description of the API.

disableExecuteApiEndpoint

val disableExecuteApiEndpoint: Boolean

Whether clients can invoke the API by using the default execute-api endpoint.

executionArn

val executionArn: String

ARN prefix to be used in an aws.lambda.Permission's source_arn attribute or in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details.

val id: String

The provider-assigned unique ID for this managed resource.

name

val name: String

Name of the API.

protocolType

val protocolType: String

API protocol.

routeSelectionExpression

val routeSelectionExpression: String

The route selection expression for the API.