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< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? target, Input<String?> ? version}) -
Creates a new ApiState.
apiEndpointURI of the API, of the formhttps://{api-id}.execute-api.{region}.amazonaws.comfor HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.comfor 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.arnARN of the API.bodyOpenAPI specification that defines the set of routes and integrations to create as part of the HTTP APIs. Supported only for HTTP APIs.corsConfigurationCross-origin resource sharing (CORS) configuration. Applicable for HTTP APIs. SeecorsConfigurationBlock below.credentialsArnPart of quick create. Specifies any credentials required for the integration. Applicable for HTTP APIs.descriptionDescription of the API. Must be less than or equal to 1024 characters in length.disableExecuteApiEndpointWhether clients can invoke the API by using the defaultexecute-apiendpoint. 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.executionArnARN prefix to be used in anaws.lambda.Permission'ssourceArnattribute or in anaws.iam.Policyto authorize access to the@connectionsAPI. See the Amazon API Gateway Developer Guide for details.failOnWarningsWhether warnings should return an error while API Gateway is creating or updating the resource using an OpenAPI specification. Defaults tofalse. Applicable for HTTP APIs.ipAddressTypeIP address types that can invoke the API. Valid values:ipv4,dualstack. Useipv4to allow only IPv4 addresses to invoke your API, or usedualstackto allow both IPv4 and IPv6 addresses to invoke your API. Defaults toipv4.nameName of the API. Must be less than or equal to 128 characters in length.protocolTypeAPI protocol. Valid values:HTTP,WEBSOCKET.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.routeKeyPart of quick create. Specifies any route key. Applicable for HTTP APIs. routeSelectionExpression Route selection expression for the API. Defaults to$request.method $request.path.tagsMap of tags to assign to the API. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.targetPart 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 beHTTP_PROXYorAWS_PROXY, respectively. Applicable for HTTP APIs.versionVersion 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.comfor HTTP APIs andwss://{api-id}.execute-api.{region}.amazonaws.comfor 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
corsConfigurationBlock 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-apiendpoint. 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'ssourceArnattribute or in anaws.iam.Policyto authorize access to the@connectionsAPI. 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. Useipv4to allow only IPv4 addresses to invoke your API, or usedualstackto allow both IPv4 and IPv6 addresses to invoke your API. Defaults toipv4.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
-
Map of tags to assign to the API. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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_PROXYorAWS_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