GetRestApiResult class

Result data returned by getRestApi.

Constructors

GetRestApiResult({String? apiKeySource, String? arn, List<String>? binaryMediaTypes, String? description, String? endpointAccessMode, List<GetRestApiEndpointConfiguration>? endpointConfigurations, String? executionArn, String? id, String? minimumCompressionSize, String? name, String? policy, String? region, String? rootResourceId, String? securityPolicy, Map<String, String>? tags})
Creates a new GetRestApiResult. apiKeySource Source of the API key for requests. arn ARN of the REST API. binaryMediaTypes List of binary media types supported by the REST API. description Description of the REST API. endpointAccessMode Endpoint access mode for the REST API. endpointConfigurations Endpoint configuration of this REST API showing the endpoint types of the API. See below. executionArn Execution ARN part to be used in lambdaPermission's sourceArn 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. id The provider-assigned unique ID for this managed resource. minimumCompressionSize Minimum response size to compress for the REST API. name Optional. policy JSON formatted policy document that controls access to the API Gateway. region Optional. rootResourceId Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'. securityPolicy TLS version + cipher suite for the REST API's default execute-api endpoint. tags Key-value map of resource tags.
const
GetRestApiResult.fromMap(Map<String, dynamic> map)
factory

Properties

apiKeySource → String?
Source of the API key for requests.
final
arn → String?
ARN of the REST API.
final
binaryMediaTypes → List<String>?
List of binary media types supported by the REST API.
final
description → String?
Description of the REST API.
final
endpointAccessMode → String?
Endpoint access mode for the REST API.
final
endpointConfigurations → List<GetRestApiEndpointConfiguration>?
Endpoint configuration of this REST API showing the endpoint types of the API. See below.
final
executionArn → String?
Execution ARN part to be used in lambdaPermission's sourceArn 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.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The provider-assigned unique ID for this managed resource.
final
minimumCompressionSize → String?
Minimum response size to compress for the REST API.
final
name → String?
final
policy → String?
JSON formatted policy document that controls access to the API Gateway.
final
region → String?
final
rootResourceId → String?
Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityPolicy → String?
TLS version + cipher suite for the REST API's default execute-api endpoint.
final
tags → Map<String, String>?
Key-value map of resource tags.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited