We're hiring! Become a Backstage contributor

Roadie

Backstage AWS Lambda Plugin

See AWS Lambda functions for your components in Backstage

Getting started is simple

Before you start please make sure that you installed @roadiehq/backstage-plugin-aws-auth plugin first.

Install the plugin into Backstage.

yarn add @roadiehq/backstage-plugin-aws-lambda

Add plugin to the list of plugins.

// packages/app/src/plugins.ts
export { plugin as AWSLambdaWidget } from '@roadiehq/backstage-plugin-aws-lambda';

Add Widget API to your Backstage instance.

// packages/app/src/components/catalog/EntityPage.tsx
import {
  AWSLambdaOverviewWidget,
  isPluginApplicableToEntity as isLambdaWidgetAvailable,
} from '@roadiehq/backstage-plugin-aws-lambda';

  const OverviewContent = ({ entity }: { entity: Entity }) => (
    <Grid container spacing={3} alignItems="stretch">
      ...
      {isLambdaWidgetAvailable(entity) && (
        <Grid item md={6}>
          <AWSLambdaOverviewWidget entity={entity} />
        </Grid>
      )}
    </Grid>
  );

How it looks

A screenshot of the AWS Lambda. It is showing a AWS Lambda function details for a sample component.

Things to know

Authentication

In order to perform requests to AWS lambda plugin you must install @roadiehq/backstage-plugin-aws-auth backend plugin.

Then ask backend for temporary credentials via /api/aws/credentials.

You can select what functions will be shown in the table using your yaml config file:

metadata:
  annotations:
    aws.com/lambda-function-name: HelloWorld
    aws.com/lambda-region: us-east-1

Become a Backstage expert

To get the latest news, deep dives into Backstage features, and a roundup of recent open-source action, sign up for Roadie's Backstage Weekly. See recent editions.