Route

public struct Route : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can’t modify the $default route key.

    Declaration

    Swift

    public let apiGatewayManaged: Bool?

  • Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

    Declaration

    Swift

    public let apiKeyRequired: Bool?

  • A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

    Declaration

    Swift

    public let authorizationScopes: [String]?

  • The 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.

    Declaration

    Swift

    public let authorizationType: AuthorizationType?

  • The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

    Declaration

    Swift

    public let authorizerId: String?

  • The model selection expression for the route. Supported only for WebSocket APIs.

    Declaration

    Swift

    public let modelSelectionExpression: String?

  • The operation name for the route.

    Declaration

    Swift

    public let operationName: String?

  • The request models for the route. Supported only for WebSocket APIs.

    Declaration

    Swift

    public let requestModels: [String : String]?

  • The request parameters for the route. Supported only for WebSocket APIs.

    Declaration

    Swift

    public let requestParameters: [String : ParameterConstraints]?

  • The route ID.

    Declaration

    Swift

    public let routeId: String?

  • The route key for the route.

    Declaration

    Swift

    public let routeKey: String

  • The route response selection expression for the route. Supported only for WebSocket APIs.

    Declaration

    Swift

    public let routeResponseSelectionExpression: String?

  • The target for the route.

    Declaration

    Swift

    public let target: String?

  • Undocumented

    Declaration

    Swift

    public init(apiGatewayManaged: Bool? = nil, apiKeyRequired: Bool? = nil, authorizationScopes: [String]? = nil, authorizationType: AuthorizationType? = nil, authorizerId: String? = nil, modelSelectionExpression: String? = nil, operationName: String? = nil, requestModels: [String : String]? = nil, requestParameters: [String : ParameterConstraints]? = nil, routeId: String? = nil, routeKey: String, routeResponseSelectionExpression: String? = nil, target: String? = nil)