Get
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
Link copied to clipboard
constructor(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>)
Properties
Link copied to clipboard
Source of the API key for requests.
Link copied to clipboard
List of binary media types supported by the REST API.
Link copied to clipboard
Description of the REST API.
Link copied to clipboard
The endpoint configuration of this RestApi showing the endpoint types of the API.
Link copied to clipboard
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.
Link copied to clipboard
Minimum response size to compress for the REST API.
Link copied to clipboard
Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.