Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yvele/aws-cfn-custom-resource-lambda-edge

🏗 AWS CloudFormation custom resource that allows deploying Lambda@Edge from any region
https://github.com/yvele/aws-cfn-custom-resource-lambda-edge

amazon-web-services aws aws-cloudformation aws-cloudfront aws-lambda-edge cloudformation infrastructure-as-code

Last synced: 21 days ago
JSON representation

🏗 AWS CloudFormation custom resource that allows deploying Lambda@Edge from any region

Host: GitHub
URL: https://github.com/yvele/aws-cfn-custom-resource-lambda-edge
Owner: yvele
License: apache-2.0
Created: 2020-06-15T22:40:09.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2021-09-29T12:40:17.000Z (about 3 years ago)
Last Synced: 2024-07-30T19:11:25.027Z (5 months ago)
Topics: amazon-web-services, aws, aws-cloudformation, aws-cloudfront, aws-lambda-edge, cloudformation, infrastructure-as-code
Language: JavaScript
Homepage:
Size: 46.9 KB
Stars: 19
Watchers: 4
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# aws-cfn-custom-resource-lambda-edge

> This project provides a `Custom::Resource` for AWS CloudFormation that copies a provided Lambda to the `us-east-1` standard region. This is specially useful to deploy [Lambda@Edge](https://aws.amazon.com/lambda/edge/) from other regions than the standard one.

[![Node](https://img.shields.io/badge/node-v12.x-blue.svg)](https://nodejs.org)

## Motivation

- https://github.com/awslabs/serverless-application-model/issues/635
- https://twitter.com/prestomation/status/971256051516485632

## Installation

Clone the repository.

[Setup your AWS CLI credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) then run the install script that deploys the CloudFormation [custom resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) and it's dependencies.

Use the `--region` parameter to specify where you want your custom resource to be deployed:

```sh
./install.sh --region eu-west-1
```

The script deploys 3 CloudFormation stacks.

Note that [the first stack](https://github.com/yvele/aws-cfn-custom-resource-lambda-edge/tree/master/stacks/package-bucket) is a prerequisite that deploys an S3 bucket required by CloudFormation to [upload local artifacts](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-cli-package.html). If you already have such bucket, you can skip installing it by providing the optional `--package-bucket` parameter:

```sh
./install.sh --region eu-west-1 --package-bucket my-package-bucket
```

## Usage

### With the default execution role

```yaml
AWSTemplateFormatVersion: 2010-09-09
Transform: AWS::Serverless-2016-10-31
Resources:

# CloudFront distribution
Distribution:
Type: AWS::CloudFront::Distribution
Properties:
DistributionConfig:
DefaultCacheBehavior:
LambdaFunctionAssociations:
- EventType: origin-request
LambdaFunctionARN: !GetAtt EdgeOriginRequest.FunctionVersion

# Unused Lambda function only to get `CodeUri` working
EdgeOriginRequestSource:
Type: AWS::Serverless::Function
Properties:
CodeUri: ./src
AutoPublishAlias: live # Required to get `Version` parameter and force publication

# Custom resource to "copy" the Lambda in the standard region (us-east-1)
EdgeOriginRequest:
Type: Custom::LambdaEdge
Properties:
ServiceToken: !ImportValue CustomResourceLambdaEdgeServiceToken
Parameters:
LambdaSourceArn: !Ref EdgeOriginRequestSource.Version
```

### With a custom execution role

```yaml
AWSTemplateFormatVersion: 2010-09-09
Transform: AWS::Serverless-2016-10-31
Resources:

# Custom execution role
EdgeOriginRequestRole:
Type: AWS::IAM::Role
Properties:
AssumeRolePolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Action: sts:AssumeRole
Principal:
Service:
- lambda.amazonaws.com
- edgelambda.amazonaws.com
ManagedPolicyArns:
- arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
- arn:aws:iam::aws:policy/AWSXRayDaemonWriteAccess
Policies:
- PolicyName: CustomPolicy
PolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Resource: "*"
Action: lambda:InvokeFunction
```

## License