ApiState class

Input properties used for looking up and filtering Api resources.

Constructors

ApiState({Input<String?>? apiEndpoint, Input<String?>? apiKeySelectionExpression, Input<String?>? arn, Input<String?>? body, Input<ApiCorsConfiguration?>? corsConfiguration, Input<String?>? credentialsArn, Input<String?>? description, Input<bool?>? disableExecuteApiEndpoint, Input<String?>? executionArn, Input<bool?>? failOnWarnings, Input<String?>? ipAddressType, Input<String?>? name, Input<String?>? protocolType, Input<String?>? region, Input<String?>? routeKey, Input<String?>? routeSelectionExpression, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? target, Input<String?>? version})
Creates a new ApiState. apiEndpoint 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. apiKeySelectionExpression API key selection expression. Valid values: $context.authorizer.usageIdentifierKey, $request.header.x-api-key. Defaults to $request.header.x-api-key. Applicable for WebSocket APIs. arn ARN of the API. body OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs. corsConfiguration Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs. See corsConfiguration Block below. credentialsArn Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs. description Description of the API. Must be less than or equal to 1024 characters in length. disableExecuteApiEndpoint Whether clients can invoke the API by using the default execute-api endpoint. By default, clients can invoke the API with the default {api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. executionArn ARN prefix to be used in an aws.lambda.Permission's sourceArn attribute or in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details. failOnWarnings Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to false. Applicable for HTTP APIs. ipAddressType IP address types that can invoke the API. Valid values: ipv4, dualstack. Use ipv4 to allow only IPv4 addresses to invoke your API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your API. Defaults to ipv4. name Name of the API. Must be less than or equal to 128 characters in length. protocolType API protocol. Valid values: HTTP, WEBSOCKET. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. routeKey Part of quick create. Specifies any route key. Applicable for HTTP APIs. routeSelectionExpression Route selection expression for the API. Defaults to $request.method $request.path. tags Map of tags to assign to the API. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. target Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Applicable for HTTP APIs. version Version identifier for the API. Must be between 1 and 64 characters in length.
const
ApiState.fromMap(Map<String, dynamic> map)
factory

Properties

apiEndpoint → Input<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.
final
apiKeySelectionExpression → Input<String?>?
API key selection expression. Valid values: $context.authorizer.usageIdentifierKey, $request.header.x-api-key. Defaults to $request.header.x-api-key. Applicable for WebSocket APIs.
final
arn → Input<String?>?
ARN of the API.
final
body → Input<String?>?
OpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.
final
corsConfiguration → Input<ApiCorsConfiguration?>?
Cross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs. See corsConfiguration Block below.
final
credentialsArn → Input<String?>?
Part of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.
final
description → Input<String?>?
Description of the API. Must be less than or equal to 1024 characters in length.
final
disableExecuteApiEndpoint → Input<bool?>?
Whether clients can invoke the API by using the default execute-api endpoint. By default, clients can invoke the API with the default {api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint.
final
executionArn → Input<String?>?
ARN prefix to be used in an aws.lambda.Permission's sourceArn attribute or in an aws.iam.Policy to authorize access to the @connections API. See the Amazon API Gateway Developer Guide for details.
final
failOnWarnings → Input<bool?>?
Whether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults to false. Applicable for HTTP APIs.
final
hashCode → int
The hash code for this object.
no setterinherited
ipAddressType → Input<String?>?
IP address types that can invoke the API. Valid values: ipv4, dualstack. Use ipv4 to allow only IPv4 addresses to invoke your API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your API. Defaults to ipv4.
final
name → Input<String?>?
Name of the API. Must be less than or equal to 128 characters in length.
final
protocolType → Input<String?>?
API protocol. Valid values: HTTP, WEBSOCKET.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
routeKey → Input<String?>?
Part of quick create. Specifies any route key. Applicable for HTTP APIs.
final
routeSelectionExpression → Input<String?>?
Route selection expression for the API. Defaults to $request.method $request.path.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
Map of tags to assign to the API. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
target → Input<String?>?
Part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Applicable for HTTP APIs.
final
version → Input<String?>?
Version identifier for the API. Must be between 1 and 64 characters in length.
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