https://github.com/aws-samples/aws-lambda-layer-awscli

AWS Lambda Layer for AWS CLI
https://github.com/aws-samples/aws-lambda-layer-awscli

Last synced: 12 days ago
JSON representation

AWS Lambda Layer for AWS CLI

• Host: GitHub
• URL: https://github.com/aws-samples/aws-lambda-layer-awscli
• Owner: aws-samples
• License: apache-2.0
• Archived: true
• Created: 2019-04-16T15:49:00.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-04-04T00:14:56.000Z (over 2 years ago)
• Last Synced: 2024-08-02T06:13:35.050Z (3 months ago)
• Language: TypeScript
• Size: 14.9 MB
• Stars: 151
• Watchers: 9
• Forks: 47
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-layers - `aws-samples/aws-lambda-layer-awscli`

README

        
[![build](https://github.com/aws-samples/aws-lambda-layer-awscli/actions/workflows/build.yml/badge.svg)](https://github.com/aws-samples/aws-lambda-layer-awscli/actions/workflows/build.yml)

# lambda-layer-awscli

AWS CDK(Cloud Development Kit) comes with [lambda-layer-awscli](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/lambda-layer-awscli) which allows you to build your private AWS Lambda layer with AWS CLI executable. This repository demonstrates how to create your own AWS Lambda layer with AWS CLI in AWS CDK.

## Basic Usage

```ts

import { App, CfnOutput, Construct, Stack, StackProps } from '@aws-cdk/core';

import * as layer from '@aws-cdk/lambda-layer-awscli';

export class MyStack extends Stack {

  constructor(scope: Construct, id: string, props: StackProps = {}) {

    super(scope, id, props);

    const awscliLayer = new layer.AwsCliLayer(this, 'AwsCliLayer');

    new CfnOutput(this, 'LayerVersionArn', { value: awscliLayer.layerVersionArn })

  }

}

const devEnv = {

  account: process.env.CDK_DEFAULT_ACCOUNT,

  region: process.env.CDK_DEFAULT_REGION,

};

const app = new App();

new MyStack(app, 'awscli-layer-stack', { env: devEnv });

app.synth();

```

After deployment, the AWS Lambda layer version ARN will be returned and you can use this ARN in your Lambda functions in the same AWS region.

```

Outputs:

awscli-layer-stack.LayerVersionArn = arn:aws:lambda:us-east-1:123456789012:layer:AwsCliLayerF44AAF94:34

```

## Customize your layer

The [AwsCliLayer](https://github.com/aws/aws-cdk/blob/6e2a3e0f855221df98f78f6465586d5524f5c7d5/packages/%40aws-cdk/lambda-layer-awscli/lib/awscli-layer.ts#L10-L20) from AWS CDK upstream does not allow you to pass custom Dockerfile(see the [built-in Dockerfile](https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/lambda-layer-awscli/layer/Dockerfile)). To customize the layer, we simply create our own `AwsCliLayer` construct class in our CDK application with our custom `Dockerfile`.

```sh

cd src/custom-layer

# edit and customize the Dockerfile under the `custom-layer` directory

# login ECR public

aws ecr-public get-login-password --region us-east-1 | docker login --username AWS --password-stdin public.ecr.aws

# generate the layer.zip from Dockerfile

bash build.sh

```

Now prepare your custom `AwsCliLayer` construct class and run `cdk deploy` to generate your own layer.

```ts

import { App, CfnOutput, Construct, Stack, StackProps } from '@aws-cdk/core';

import * as layer from '@aws-cdk/lambda-layer-awscli';

import * as customlayer from './custom-layer/custom-layer';

export class CustomLayerStack extends Stack {

  constructor(scope: Construct, id: string, props: StackProps = {}) {

    super(scope, id, props);

    const awscliLayer = new customlayer.AwsCliLayer(this, 'CustomAwsCliLayer');

    new CfnOutput(this, 'LayerVersionArn', { value: awscliLayer.layerVersionArn });

  }

}

// for development, use account/region from cdk cli

const devEnv = {

  account: process.env.CDK_DEFAULT_ACCOUNT,

  region: process.env.CDK_DEFAULT_REGION,

};

const app = new App();

new CustomLayerStack(app, 'custom-awscli-layer-stack', { env: devEnv });

app.synth();

```

## License Summary

This sample code is made available under the MIT-0 license. See the LICENSE file.