RouteState class
Input properties used for looking up and filtering Route resources.
Constructors
-
RouteState({Input<
String?> ? apiId, Input<bool?> ? apiKeyRequired, Input<List< ? authorizationScopes, Input<String> ?>String?> ? authorizationType, Input<String?> ? authorizerId, Input<String?> ? modelSelectionExpression, Input<String?> ? operationName, Input<String?> ? region, Input<Map< ? requestModels, Input<String, String> ?>List< ? requestParameters, Input<RouteRequestParameter> ?>String?> ? routeKey, Input<String?> ? routeResponseSelectionExpression, Input<String?> ? target}) -
Creates a new RouteState.
apiIdAPI identifier.apiKeyRequiredWhether an API key is required for the route. Defaults tofalse. Supported only for WebSocket APIs.authorizationScopesAuthorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation.authorizationTypeAuthorization type for the route. For WebSocket APIs, valid values areNONEfor open access,AWS_IAMfor using AWS IAM permissions, andCUSTOMfor using a Lambda authorizer. For HTTP APIs, valid values areNONEfor open access,JWTfor using JSON Web Tokens,AWS_IAMfor using AWS IAM permissions, andCUSTOMfor using a Lambda authorizer. Defaults toNONE.authorizerIdIdentifier of theaws.apigatewayv2.Authorizerresource to be associated with this route. modelSelectionExpression Model selection expression for the route. Supported only for WebSocket APIs.operationNameOperation name for the route. Must be between 1 and 64 characters in length.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requestModelsRequest models for the route. Supported only for WebSocket APIs.requestParametersRequest parameters for the route. Supported only for WebSocket APIs. SeerequestParameterBlock below.routeKeyRoute key for the route. For HTTP APIs, the route key can be either$default, or a combination of an HTTP method and resource path, for example,GET /pets. routeResponseSelectionExpression Route response selection expression for the route. Supported only for WebSocket APIs.targetTarget for the route, of the formintegrations/IntegrationID, whereIntegrationIDis the identifier of anaws.apigatewayv2.Integrationresource.const -
RouteState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
apiId
→ Input<
String?> ? -
API identifier.
final
-
apiKeyRequired
→ Input<
bool?> ? -
Whether an API key is required for the route. Defaults to
false. Supported only for WebSocket APIs.final -
Authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation.
final
-
Authorization type for the route. For WebSocket APIs, valid values are
NONEfor open access,AWS_IAMfor using AWS IAM permissions, andCUSTOMfor using a Lambda authorizer. For HTTP APIs, valid values areNONEfor open access,JWTfor using JSON Web Tokens,AWS_IAMfor using AWS IAM permissions, andCUSTOMfor using a Lambda authorizer. Defaults toNONE.final -
Identifier of the
aws.apigatewayv2.Authorizerresource to be associated with this route.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
modelSelectionExpression
→ Input<
String?> ? -
Model selection expression for the route. Supported only for WebSocket APIs.
final
-
operationName
→ Input<
String?> ? -
Operation name for the route. Must be between 1 and 64 characters in length.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
requestModels
→ Input<
Map< ?String, String> ?> -
Request models for the route. Supported only for WebSocket APIs.
final
-
requestParameters
→ Input<
List< ?RouteRequestParameter> ?> -
Request parameters for the route. Supported only for WebSocket APIs. See
requestParameterBlock below.final -
routeKey
→ Input<
String?> ? -
Route key for the route. For HTTP APIs, the route key can be either
$default, or a combination of an HTTP method and resource path, for example,GET /pets.final -
routeResponseSelectionExpression
→ Input<
String?> ? -
Route response selection expression for the route. Supported only for WebSocket APIs.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
target
→ Input<
String?> ? -
Target for the route, of the form
integrations/IntegrationID, whereIntegrationIDis the identifier of anaws.apigatewayv2.Integrationresource.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