# AWS Lambda Custom Integration

AWS Lambda enables you to build and connect cloud services and internal web apps by writing single-purpose functions that are attached to events emitted from your cloud infrastructure and services.

Its serverless architecture frees you to write, test, and deploy functions quickly without having to manage infrastructure setup.

With this integration, you can connect your internal applications to AWS Lambda functions and manage access to those applications with Apono.

***

## Prerequisites

Before starting this integration, create the items listed in the following table.

<table><thead><tr><th width="209">Item</th><th>Description</th></tr></thead><tbody><tr><td><strong>Apono Connector</strong></td><td>On-prem <a href="../apono-connector-for-aws">connection</a> serving as a bridge between your AWS Lambda functions and Apono<br><br><strong>Minimum Required Version</strong>: 1.4.1<br><br>Use the following steps to <a href="../apono-connector-for-aws/updating-a-connector-in-aws">update an existing connector</a>.</td></tr><tr><td><strong>Lambda Function</strong></td><td><p>Named function set up within <a href="https://docs.aws.amazon.com/lambda/">AWS Lambda</a></p><p>When creating the Lambda function, apply the <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-tags.html">tag</a><br><code>apono-connector-access: "true"</code>.</p><p>See: <a href="#sample-lambda-function">Sample Lambda Function</a>.</p></td></tr></tbody></table>

<details>

<summary>Sample Lambda Function</summary>

```javascript
function listResources(params) {
  return {
    resources: [
      {
        'id': 'resource1',
        'name': 'Resource 1',
        'type': params.resource_type,
        'metadata': {
          'key1': 'value1'
        }
      },
      {
        'id': 'resource2',
        'name': 'Resource 2',
        'type': params.resource_type,
        'metadata': {
          'key2': 'value2'
        }
      },
      {
        'id': 'resource3',
        'name': 'Resource 3',
        'type': params.resource_type,
        'metadata': {
          'key3': 'value3'
        }
      },
    ],
    permissions: [
      {
        'id': 'admin',
        'name': 'Admin'
      },
      {
        'id': 'reader',
        'name': 'Reader'
      }
    ]
  };
}

function grantAccess(params) {
  const username = params.username;
  const grantId = params.grant_id;
  const resources = params.resources;
  const permission = params.permission;
  
  const param1 = params.custom_parameters.param1
  const param2 = params.custom_parameters.param2

  console.log(param1)
  console.log(param2)
  
  return {
    status: 'ok'
  };
}

function revokeAccess(params) {
  const username = params.username;
  const grantId = params.grant_id;
  const resources = params.resources;
  const permission = params.permission;

  const param1 = params.custom_parameters.param1
  const param2 = params.custom_parameters.param2
  
  return {
    status: 'ok'
  };
}

function createCredentials(params) {
  const username = params.username;
  const grantId = params.grant_id;
  const resources = params.resources;
  
  const param1 = params.custom_parameters.param1
  const param2 = params.custom_parameters.param2
  
  return {
    status: 'ok'
  };
}

export const handler = async (event) => {
  const params = event.params;
  
  switch (event.event_type) {
    case 'create-credentials':
      return createCredentials(params);
    case 'list-resources':
      return listResources(params);
    case 'grant-access':
      return grantAccess(params);
    case 'revoke-access':
      return revokeAccess(params);
    case 'create-credentials':
      return {
        status: 'ok',
        secret: 'created-credentials-secret'
      }
    case 'reset-credentials':
      return {
        status: 'ok',
        secret: 'reset-credentials-secret'
      }
    default:
      return {
        status: 'active'
      };
  }
};
```

listResources

<table><thead><tr><th width="249.625">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>resources[]</strong></td><td><p>Manageable resources to display in Apono that users can be granted access to</p><p>Each item represents a single object the integration can grant or revoke access to.</p></td></tr><tr><td><strong>permissions[]</strong></td><td>Permissions to resources that can be granted to users, such as <code>Read</code> and <code>Write</code></td></tr></tbody></table>

resources\[]

<table><thead><tr><th width="249.86724853515625">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td>Unique resource identifier in the source system (such as ARN) that you receive back in <code>grantAccess</code> or <code>revokeAccess</code></td></tr><tr><td><strong>name</strong></td><td>Human-readable resource name to show in Apono</td></tr><tr><td><strong>type</strong></td><td><p>Resource type or service</p><p>The value should always be the resource type (<code>params.resource_type</code>) that was passed in the request.</p></td></tr><tr><td><strong>metadata</strong></td><td><p>Tags or context associated with the resource<br></p><p><strong>Examples</strong>:</p><ul><li><code>"environment" = "prod"</code></li><li><code>"region" = "us-east-1"</code></li></ul></td></tr></tbody></table>

permissions\[]

<table><thead><tr><th width="250.30987548828125">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td>Integration-defined permission key you will receive back later in <code>grantAccess</code></td></tr><tr><td><strong>name</strong></td><td>Display name for the permission shown in Apono to the requester</td></tr></tbody></table>

grantAccess

<table><thead><tr><th width="249.51171875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>username</strong></td><td>The Grantee’s email</td></tr><tr><td><strong>grant_id</strong></td><td>Apono’s unique ID for the request</td></tr><tr><td><strong>resources</strong></td><td>Resource IDs selected by the requester</td></tr><tr><td><strong>permission</strong></td><td>Permission ID chosen by the requester</td></tr><tr><td><strong>custom_parameters.param1 custom_parameters.param2</strong></td><td>Custom parameters defined for the Apono integration</td></tr></tbody></table>

revokeAccess

<table><thead><tr><th width="250.06298828125">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>username</strong></td><td>The Grantee’s email</td></tr><tr><td><strong>grant_id</strong></td><td>Apono’s unique ID for the request</td></tr><tr><td><strong>resources</strong></td><td>Resources previously granted</td></tr><tr><td><strong>permission</strong></td><td>Permission to remove</td></tr><tr><td><strong>custom_parameters.param1 custom_parameters.param2</strong></td><td>Custom parameters defined for the Apono integration</td></tr></tbody></table>

createCredentials

<table><thead><tr><th width="249.89801025390625">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>username</strong></td><td>The Grantee’s email</td></tr><tr><td><strong>grant_id</strong></td><td>Apono’s unique ID for the grantee</td></tr><tr><td><strong>resources</strong></td><td>One or more target resources for which credentials should be created</td></tr><tr><td><strong>permission</strong></td><td>Permission to remove</td></tr><tr><td><strong>custom_parameters.param1 custom_parameters.param2</strong></td><td>Custom parameters defined for the Apono integration</td></tr></tbody></table>

</details>

***

### Integrate an AWS Lambda Custom Integration

<figure><img src="https://1094436629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv6MBfUGvblSdAz31yJXm%2Fuploads%2Fgit-blob-f7b62867ec7ce5b18f705d3fd78d0c9c967413e7%2FIntegration-aws-lambda-1.png?alt=media" alt="" width="563"><figcaption><p>AWS Lambda Custom Integration tile</p></figcaption></figure>

{% hint style="success" %}
You can also use the steps below to integrate with Apono using Terraform.

In step **8**, instead of clicking **Confirm**, follow the **Are you integrating with Apono using Terraform?** guidance.
{% endhint %}

Follow these steps to complete the integration:

1. On the [**Catalog**](https://app.apono.io/catalog?search=aws+lambda) tab, click **AWS Lambda Custom Integration**. The **Connect Integration** page appears.
2. Under **Discovery**, click **Next**. The **Apono connector** section expands.
3. From the dropdown menu, select a connector.

{% hint style="info" %}
If the desired connector is not listed, click **+ Add new connector** and follow the instructions for creating an [AWS connector](https://docs.apono.io/docs/apono-connector-for-aws#how-to-install-the-connector).
{% endhint %}

4. Click **Next**. The **Integration Config** section expands.
5. Define the **Integration Config** settings.

   <table><thead><tr><th width="215">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Integration Name</strong></td><td>Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow</td></tr><tr><td><strong>Custom Parameters</strong></td><td>Key-value pairs to send to the lambda function<br><br>For example, you can provide a lambda function with a redirect URL that is used for internal provisioning access and passed as part of the action requests.</td></tr><tr><td><strong>Region</strong></td><td>Region of the AWS Lambda instance</td></tr><tr><td><strong>Function Name</strong></td><td>Named of the AWS Lambda function</td></tr></tbody></table>
6. Click **Next**. The **Get more with Apono** section expands.
7. Define the **Get more with Apono** settings.

   <table><thead><tr><th width="215">Setting</th><th>Description</th></tr></thead><tbody><tr><td><strong>Credential Rotation</strong></td><td>(Optional) Number of days after which the database credentials must be rotated<br><br>Learn more about the <a href="../../architecture-and-security/credentials-rotation-policy">Credentials Rotation Policy</a>.</td></tr><tr><td><strong>User cleanup after access is revoked (in days)</strong></td><td><p>(Optional) Defines the number of days after access has been revoked that the user should be deleted</p><p><br>Learn more about <a href="../../architecture-and-security/periodic-user-cleanup-and-deletion">Periodic User Cleanup &#x26; Deletion</a>.</p></td></tr><tr><td><strong>Custom Access Details</strong></td><td>(Optional) Instructions explaining how to access this integration's resources<br><br>Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to <strong>400 characters</strong>.<br><br>To view the message as it appears to end users, click <strong>Preview</strong>.</td></tr><tr><td><strong>Integration Owner</strong></td><td><p>(Optional) Fallback approver if no <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owner</a> is found<br><br>Follow these steps to define one or several integration owners:</p><ol><li>From the <strong>Attribute</strong> dropdown menu, select <strong>User</strong> or <strong>Group</strong> under the relevant identity provider (IdP) platform.</li><li>From the <strong>Value</strong> dropdown menu, select one or multiple users or groups.</li></ol><p><br><strong>NOTE</strong>: When <strong>Resource Owner</strong> is defined, an <strong>Integration Owner</strong> must be defined.</p></td></tr><tr><td><strong>Resource Owner</strong></td><td><p>(Optional) Group or role responsible for managing access approvals or rejections for the resource<br><br>Follow these steps to define one or several <a href="../../access-flows/dynamic-access-management/resource-and-integration-owners">resource owners</a>:</p><ol><li>Enter a <strong>Key name</strong>. This value is the name of the tag created in your cloud environment.</li><li>From the <strong>Attribute</strong> dropdown menu, select an attribute under the IdP platform to which the key name is associated.<br><br>Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.</li></ol><p><br><strong>NOTE</strong>: When this setting is defined, an <strong>Integration Owner</strong> must also be defined.</p></td></tr></tbody></table>
8. Click **Confirm**.

<details>

<summary>💡Are you integrating with Apono using Terraform?</summary>

If you want to integrate with Apono using Terraform, follow these steps instead of clicking **Confirm**:

1. At the top of the screen, click **View as Code**. A modal appears with the completed Terraform configuration code.
2. Click to copy the code.
3. Make any additional edits.
4. Deploy the code in your Terraform.

Refer to [Integration Config Metadata](https://docs.apono.io/metadata-for-integration-config/integration-metadata/aws-lambda-custom-integration) for more details about the schema definition.

</details>

Now that you have completed this integration, you can [create access flows](https://docs.apono.io/docs/access-flows/access-flows) that grant permission to your AWS Lambda function.