Get
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
Link copied to clipboard
constructor(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)
Properties
Link copied to clipboard
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.
Link copied to clipboard
An API key selection expression. Applicable for WebSocket APIs.
Link copied to clipboard
Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs.
Link copied to clipboard
Description of the API.
Link copied to clipboard
Whether clients can invoke the API by using the default execute-api endpoint.
Link copied to clipboard
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.
Link copied to clipboard
API protocol.
Link copied to clipboard
The route selection expression for the API.