pulumi-aws-kotlin/com.pulumi.aws.apigateway.kotlin.outputs/GetRestApiResult

GetRestApiResult

data class GetRestApiResult(val apiKeySource: String, val arn: String, val binaryMediaTypes: List<String>, val description: String, val endpointConfigurations: List<GetRestApiEndpointConfiguration>, val executionArn: String, val id: String, val minimumCompressionSize: Int, val name: String, val policy: String, val rootResourceId: String, val tags: Map<String, String>)

A collection of values returned by getRestApi.

Constructors

GetRestApiResult

fun GetRestApiResult(apiKeySource: String, arn: String, binaryMediaTypes: List<String>, description: String, endpointConfigurations: List<GetRestApiEndpointConfiguration>, executionArn: String, id: String, minimumCompressionSize: Int, name: String, policy: String, rootResourceId: String, tags: Map<String, String>)

Types

Companion

object Companion

Properties

apiKeySource

val apiKeySource: String

Source of the API key for requests.

arn

val arn: String

ARN of the REST API.

binaryMediaTypes

val binaryMediaTypes: List<String>

List of binary media types supported by the REST API.

description

val description: String

Description of the REST API.

endpointConfigurations

val endpointConfigurations: List<GetRestApiEndpointConfiguration>

The endpoint configuration of this RestApi showing the endpoint types of the API.

executionArn

val executionArn: String

Execution ARN part to be used in lambda_permission's source_arn when allowing API Gateway to invoke a Lambda function, e.g., arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j, which can be concatenated with allowed stage, method and resource path.

val id: String

The provider-assigned unique ID for this managed resource.

minimumCompressionSize

val minimumCompressionSize: Int

Minimum response size to compress for the REST API.

name

val name: String

policy

val policy: String

JSON formatted policy document that controls access to the API Gateway.

rootResourceId

val rootResourceId: String

Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.