AWS API Gateway Lambda Trigger

Trigger Settings

Note:

For overriding app properties, use the FLOGO_APP_PROPS_JSON environment variable only. You cannot override app properties using the FLOGO_APP_PROPS_ENV environment variable.
You can have only one Gateway trigger in an app. An app that has a Gateway trigger cannot contain any other triggers including another Gateway trigger. The Gateway trigger supports multiple handlers (flows), so you can have multiple flows in the app that are attached to the same Gateway trigger. You can also have blank flows in the app, which can serve as subflows for the flows that are attached to the Gateway trigger.

Field	Description
AWS Connection Name	(Mandatory) Name of the AWS connection that you want to use for deploying the flow as a Lambda connection.
Execution Role Name	Permission of the Lambda function to execute. The role must be assumable by Lambda and must have CloudWatch logs permission execution role. A default role with the AWS predefined `AWSLambdaBasicExecutionRole` permission is created if you do not specify anything in this field. By default, Cloud watching is enabled.
API Deploy Stage	Name of the API Gateway deployment stage. Note: Spaces and special characters are not allowed. You can use this field to create different deployment stages such as Testing, Production, and so on. You can also create this stage on the AWS console after deployment.
Method	The operation which the flow implements. For example - GET, PUT, POST, or DELETE. You can select only one method at a time.
Path	The resource path for the operation. By default, the path displayed here is the resource path you had entered when you created the flow.
Output Validation	When set to True, the incoming data (body, headers, and query parameters) is validated against the configured JSON schema. Default: False

Output Settings

Field Description

Query Parameters

Field	Description
Query Parameters	Query parameters to be appended to the path. To add the query parameters, click and press Enter to save your changes. parameterName: Name of the query parameter. type: The data type of the query parameter. Supported types are string, number, or boolean. repeating: Set to True if more than one value is expected for the query parameter. required: Set to True if the query parameter is a required configuration. The trigger reports an error if no value(s) are provided to the required query parameter. Note: By default, query parameters are not mandatory. When you create an API Gateway, you must explicitly navigate to the API Gateway console and change the settings.
Path Parameters	Path parameters are appended to the resource path. Add the path parameters by using '`{ }`' in the Path field in the trigger configuration as follows: /path/{pathparam1}/{pathparam2} Path parameters are of the `string` data type only.
Headers	Header values for the trigger. To add the header parameters, click and press Enter to save your changes. parameterName: Name of the header parameter. type: The data type of the header parameter. Supported types are string, number, or boolean. repeating: Set to True if more than one value is expected for the HTTP header. required: Set to True if the header parameter is a required configuration. The trigger reports an error if no value(s) are provided to the required header parameter. Note: By default, header parameters are not mandatory. When you create an API Gateway, you must explicitly navigate to the API Gateway console and change the settings.

Query parameters to be appended to the path. To add the query parameters, click

and press Enter to save your changes.

parameterName: Name of the query parameter.

type: The data type of the query parameter. Supported types are string, number, or boolean.

repeating: Set to True if more than one value is expected for the query parameter.

required: Set to True if the query parameter is a required configuration. The trigger reports an error if no value(s) are provided to the required query parameter.

Note: By default, query parameters are not mandatory. When you create an API Gateway, you must explicitly navigate to the API Gateway console and change the settings.

Path Parameters

Path parameters are appended to the resource path. Add the path parameters by using '{ }' in the Path field in the trigger configuration as follows:

/path/{pathparam1}/{pathparam2}

Path parameters are of the string data type only.

Headers

Header values for the trigger. To add the header parameters, click

and press Enter to save your changes.

parameterName: Name of the header parameter.

type: The data type of the header parameter. Supported types are string, number, or boolean.

repeating: Set to True if more than one value is expected for the HTTP header.

required: Set to True if the header parameter is a required configuration. The trigger reports an error if no value(s) are provided to the required header parameter.

Note: By default, header parameters are not mandatory. When you create an API Gateway, you must explicitly navigate to the API Gateway console and change the settings.

Map to Flow Inputs

Map the trigger output to the flow input on this tab.

Field	Description
Function	Information about the Lambda function
Context	Envelope information about this invocation
Identity	Identity for the invoking users
ClientApp	Metadata about the calling app
API Gateway Request	API Gateway default schema which can be mapped with the schema of AWS API Gateway Lambda trigger

Reply Settings

Field	Description
Reply Data Schema	The schema is used for the reply data of the trigger. Be sure to use straight quotes for element names and values in the schema.

Map from Flow Outputs

Map the flow output to the trigger reply on this tab.

Field	Description
code	HTTP code
body	Body of the reply