AWS Lambda integration

AWS Lambda integrations enable you to trigger event-driven serverless compute functions when an event occurs in Ably. They are useful for integrating into various AWS services.

Create an AWS Lambda integration

Copied!

To create an AWS Lambda integration in your dashboard:

  1. Login and select the application you wish to integrate with AWS Lambda.
  2. Click the Integrations tab.
  3. Click the New Integration Rule button.
  4. Choose Webhook.
  5. Choose AWS Lambda.
  6. Configure the AWS Lambda settings.
  7. Click Create.

You can also create an AWS Lambda integration using the Control API.

Settings

Copied!

The following settings are available when creating an AWS Lambda integration:

Setting Description
AWS Region Specifies the region of your AWS Lambda.
Function Name The name of your AWS Lambda function.
AWS authentication scheme Choose the authentication method. Either AWS credentials or ARN of an assumable role.
AWS Credentials If using AWS credentials, enter the values in key:value format.
ARN of an assumable role If using ARN of an assumable role, enter the ARN of the role that Ably can assume to access your AWS Lambada function.
Qualifier The qualifier of your Lambda function, if set.
Source Specifies the event types being sent to your AWS Lambda function.
Channel filter Filters the source channels based on a regular expression.
Encoding Specifies the encoding format of messages. Either JSON or MsgPack.
Enveloped Checkbox to set whether messages should be enveloped or not. Enveloped is the default.

AWS authentication

Copied!

Delegate access to your AWS resources by creating an IAM role that the Ably AWS account can assume.

This approach follows AWS best practices, as it avoids sharing access keys directly. Specify the role’s ARN to grant Ably the necessary permissions in a secure manner.

Create a Lambda policy

Copied!

The following steps show you how to create a policy for an AWS Lambda.

  1. In the IAM console sidebar select Policies.
  2. Click Create Policy.
  3. Click the JSON tab and enter the following JSON to configure the policy:

{
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowInvokeLambdaFunction",
      "Effect": "Allow",
      "Action": [
        "lambda:InvokeAsync",
        "lambda:InvokeFunction"
      ],
      "Resource": [
        "arn:aws:lambda:<YOUR_AWS_REGION>:<YOUR_AWS_ACCOUNT>:function:<YOUR_FUNCTION_NAME>"
      ]
    }
  ]
}


Copied!

  1. Click Next: Tags. You don’t need to add any tags.
  2. Click Next: Review.
  3. Enter a suitable name for your policy.
  4. Click Create Policy.

You have created a policy that grants the permissions required to use a Kinesis stream. You must now attach it to the role that you’ll specify in your Ably integration rule.

Create a role

Copied!

Create an IAM role as follows:

  1. In the AWS IAM console, click Roles in the sidebar and then click Create Role.
  2. For type of trusted entity select Another AWS account.
  3. For Account ID specify 203461409171. This is the Ably AWS account.
  4. Click the Require external ID checkbox and then enter an external ID of <Your_Ably_Account_ID>.<Your_Ably_app_ID>.
  5. Click Next: Permissions.
  6. Now select the policy you created earlier to attach to this role. You can type the name of your policy into the Filter policies search box.

Then ensure the checkbox for the policy is selected.

  1. Click Next: Tags.
  2. You don’t need to add tags so click Next: Review.
  3. Enter a suitable name for your role.
  4. Click Create Role.
Select...