RouteArgs class

The set of arguments for Route. The set of arguments for Route.

Constructors

RouteArgs({required Input<String> apiId, Input<bool?>? apiKeyRequired, Input<List<String>?>? authorizationScopes, Input<String?>? authorizationType, Input<String?>? authorizerId, Input<String?>? modelSelectionExpression, Input<String?>? operationName, Input<String?>? region, Input<Map<String, String>?>? requestModels, Input<List<RouteRequestParameter>?>? requestParameters, required Input<String> routeKey, Input<String?>? routeResponseSelectionExpression, Input<String?>? target})
Creates a new RouteArgs. apiId API identifier. apiKeyRequired Whether an API key is required for the route. Defaults to false. Supported only for WebSocket APIs. authorizationScopes Authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation. authorizationType Authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. Defaults to NONE. authorizerId Identifier of the aws.apigatewayv2.Authorizer resource to be associated with this route. modelSelectionExpression Model selection expression for the route. Supported only for WebSocket APIs. operationName Operation name for the route. Must be between 1 and 64 characters in length. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. requestModels Request models for the route. Supported only for WebSocket APIs. requestParameters Request parameters for the route. Supported only for WebSocket APIs. See requestParameter Block below. routeKey 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. routeResponseSelectionExpression Route response selection expression for the route. Supported only for WebSocket APIs. target Target for the route, of the form integrations/IntegrationID, where IntegrationID is the identifier of an aws.apigatewayv2.Integration resource.
const
RouteArgs.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
authorizationScopes → Input<List<String>?>?
Authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation.
final
authorizationType → Input<String?>?
Authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. Defaults to NONE.
final
authorizerId → Input<String?>?
Identifier of the aws.apigatewayv2.Authorizer resource 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 requestParameter Block 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, where IntegrationID is the identifier of an aws.apigatewayv2.Integration resource.
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