Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/

Overview

AWS Lambda is a serverless compute service that runs your code in response to events and automatically manages the underlying compute resources for you.

You can use AWS Lambda to extend other AWS services with custom logic, or create your own back-end services that operate at AWS scale, performance, and security.

AWS Lambda can automatically run code in response to multiple events, such as:

  • HTTP requests via Amazon API Gateway
  • Modifications to objects in Amazon S3 buckets
  • Table updates in Amazon DynamoDB
  • State transitions in AWS Step Functions

Lambda runs your code on high-availability compute infrastructure and performs all the administration of the compute resources, including:

  • Server and operating system maintenance
  • Capacity provisioning and automatic scaling
  • Code and security patch deployment
  • Code monitoring and logging.

All you need to do is supply the code.

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Software Requirements for Universal Template and Universal Task

Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.

Software Requirements for Universal Agent

Both Windows and Linux agents are supported:

  • Universal Agent for Windows x64 Version 7.0.0.0 and later with python options installed.
  • Universal Agent for Linux Version 7.0.0.0 and later with python options installed.

Software Requirements for Universal Controller

Universal Controller Version 7.0.0.0 and later.

Network and Connectivity Requirements

Extension's Universal Agent host should be able to reach AWS Lambda REST endpoints.

Key Features

This Universal Extension provides the following key features:

  • Trigger Lambda function Synchronously or Asynchronously.
  • Support authorization via IAM Role-Based Access Control (RBAC) strategy.
  • Support Proxy communication via HTTP/HTTPS protocol.

Import Universal Template

To use the Universal Template, you first must perform the following steps:

  1. This Universal Task requires the Resolvable Credentials feature, check that the Resolvable Credentials Permitted system property has been set to true.

  2. Download the provided ZIP file.

  3. In the Universal Controller UI, select Administration >Configuration > Universal Templates to display the current list of Universal Templates.

  4. Click Import Template.

  5. Select the template ZIP file and Import.

When the template has been imported successfully, the Universal Template will appear on the list, refresh your Navigation Tree to see these tasks in the Automation Center Menu.

Configure Universal Task

For the new Universal Task type AWS Lambda, create a new task, and enter the task-specific details that were created in the Universal Template.

Input Fields

The input fields for this Universal Extension are described below.

FieldInput typeDefault valueTypeDescription
ActionRequiredTrigger Lambda functionChoice

The action performed upon the task execution. Available action:

  • Trigger Lambda function
AWS RegionRequired-TextRegion for the Amazon Web Service. Find more information about the AWS Service endpoints and quotas here.
AWS CredentialsRequired-Credentials

The AWS account credentials.

They are comprised of:

  • AWS access key ID
  • AWS secret access key
Role Based AccessOptionalFalseBoolean

Special type of authorization is provided by Role Assumption where the client sends his own credentials and the role he wants to assume from another user.

If allowed, the client receives temporary credentials with limited time access to some resources.

Role ARNOptional-Text

Role Arn: Amazon Role, which is applied for the connection. Role ARN format: Example RoleArn: arn:aws:iam::119322085622:role.

Required when Role Based Access="True".

Function NameRequired-TextName of the Lambda function i.e my-function (name-only) or my-function:v1 (with alias) that will be triggered.
Invocation TypeRequiredRequest ResponseChoice

Type of execution for the function being triggered. Available choices are:

  • Request Response (Synchronously)
  • Event (Asynchronously)
Payload SourceOptionalNoneChoice

Source of payload to be sent.

  • None
  • Script
Payload ScriptOptional-Script Field

Script field where the payload can be entered. The scripts must evaluate to a proper JSON format.

Required when Payload Source = "Script".

Client Context SourceOptionalNoneChoice

Client context that's provided to Lambda function by the client application.

  • None
  • Script
Client Context ScriptOptional-Script

Script passing parameters using the ClientContext object. The scripts must evaluate to a proper JSON format.

Required when Client Context Source= "Script".

Use ProxyOptionalFalseBooleanFlag to indicate whether Proxy shall be used in the communication with AWS.
Proxy TypeOptionalHTTPChoiceType of proxy connection to be used. Available options are:
  • HTTP
  • HTTPS
  • HTTPS with Credentials

Visible only when Use Proxy = "True".

ProxyOptional-Text

Comma separated list of Proxy servers. Valid formats:
http://proxyip:port or http://proxyip:port,https://proxyip:port.

Required when Use Proxy is checked.

Proxy CA Bundle FileOptional-Text

The path to a custom certificate bundle to use when establishing SSL/TLS connections with proxy.

Used when Proxy Type is configured for "HTTPS" or "HTTPS With Credentials".

Proxy CredentialsOptional-Credentials

Credentials to be used for the proxy communication.They are comprised of:

  • username
  • password

Required when "Proxy Type" is configured for "HTTPS" or "HTTPS With Credentials".

QualifierOptional-Text

Version or alias to invoke a published version of the function. Example for version 1 Qualifier = "1".

If empty, default value is the latest version.

Extension Cancellation

When using a 7.0 or later template, we must ensure that the “Always Cancel On Force Finish” is checked. This is to minimize leaving “orphan” processes on the OS without the option for the agent to see they are running.

Task Examples

Trigger Lambda Synchronously with Log

Triggering a Lambda function Sychronously with Log Type equals "Tail".

Syncronously is set by Invocation Type equals "Request_Response".

Trigger Lambda Asynchronously with Role Based Access and HTTPS Proxy

Triggering Lambda function Asychronously, with Role Based Access enabled and "HTTPS Proxy connection".

Further input includes Payload Source and Client Context Source from JSON "script".

Also, Qualifier is set to "3", meaning the 3rd version of the Lambda function will be triggered.

Asyncronously is set by Invocation Type equals "Event". "Proxy" needs to be on the correct format and "Proxy CA Bundle File" on correct format and path.

Trigger Lambda Synchronously with HTTPS with Credentials Proxy

Triggering a Lambda function Sychronously with "HTTPS with Credentials Proxy" connection.

Note that the Log Type is set to "None" and Qualifier is blank, meaning that the latest version of the Lambda function will be called.

Exit Codes

The exit codes for AWS Lambda Extension are described in the following table.

Exit CodeStatus Classification CodeStatus Classification DescriptionStatus Description
0SUCCESSSuccessful ExecutionSUCCESS: Successful Task execution
1FAILFailed ExecutionFAIL: < Error Description >
2AUTHENTICATION_ERRORBad credentialsAUTHENTICATION_ERROR: Account cannot be authenticated.
3AUTHORIZATION_ERRORInsufficient PermissionsAUTHORIZATION_ERROR: Account is not authorized to perform the requested action.
10CONNECTION_ERRORBad connection data or connection timed outCONNECTION_ERROR: < Error Description >
11CONNECTION_ERRORExtension specific connection errorCONNECTION_ERROR: ProxyConnectionError: Failed to connect to proxy URL <url>
20DATA_VALIDATION_ERRORInput fields validation errorDATA_VALIDATION_ERROR: Some of the input fields cannot be validated. See STDOUT for more details.

Extension Output

The Extension Output for AWS Lambda Universal Task successful execution is described below.

{
  "exit_code": 0,
  "status_description": "SUCCESS: AWS Lambda function invoked successfully",
  "changed": true,
  "invocation": {
      "extension": "ue-aws-lambda",
      "version": "1.0.0",
      "fields": {
          "action": "Trigger Lambda Function",
          "credentials_user": "test-user",
          "credentials_password": "****",
          "region": "us-east-1",
          "role_based_access": false,
          "role_arn": null,
          "function_name": "test-function",
          "invocation_type": "RequestResponse",
          "payload_source": null,
          "payload_script": null,
          "client_context_source": null,
          "client_context_script": null,
          "log_type": null,
          "qualifier": null,
          "use_proxy": false,
          "proxy_type": null,
          "proxy": null,
          "proxy_credentials_user": null,
          "proxy_credentials_password": null,
          "proxy_ca_bundle_file": null
      }
  },
  "result": {
      "status_code": 200,
      "log_result": "Multiline Log text",
      "payload": "{\"statusCode\": 999, \"body\": {\"message\": \"Hello World\"}}",
      "executed_version": "$LATEST",
      "function_error": null,
    }
  }
}

Task Status

The task instance with Status equals to "Success" and Exit Code equals "0".

Document References

This document references the following documents:

NameLocationDescription
Universal Templateshttps://docs.stonebranch.com/confluence/display/U71x/Universal+TemplatesUser documentation for creating Universal Templates in the Universal Controller user interface.
Universal Taskshttps://docs.stonebranch.com/confluence/display/UC71x/Universal+TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
AWS Lambdahttps://docs.aws.amazon.com/lambda/?id=docs_gatewayDocumentation for AWS Lambda
IAM RBAC authorization modelhttps://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_attribute-based-access-control.html#introduction_attribute-based-access-control_compare-rbacUser Documentation for Comparing ABAC to the traditional RBAC model





  • No labels