%global _empty_manifest_terminate_build 0
Name: python-cdk-lambda-bash
Version: 2.0.326
Release: 1
Summary: Deploy Bash Lambda Functions with AWS CDK
License: Apache-2.0
URL: https://github.com/pahud/cdk-lambda-bash.git
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/94/1d/d52d1277619c296986d8f8ca7b92645fecc80048e041e4d4c373a50d2b69/cdk-lambda-bash-2.0.326.tar.gz
BuildArch: noarch
Requires: python3-aws-cdk-lib
Requires: python3-constructs
Requires: python3-jsii
Requires: python3-publication
Requires: python3-typeguard
%description
[](https://badge.fury.io/js/cdk-lambda-bash)
[](https://badge.fury.io/py/cdk-lambda-bash)
[](https://github.com/pahud/cdk-lambda-bash/actions/workflows/release.yml)
# cdk-lambda-bash
Deploy Bash Lambda Functions with AWS CDK
# Why
AWS Lambda has the [docker container image support](https://aws.amazon.com/tw/blogs/aws/new-for-aws-lambda-container-image-support/) since AWS re:Invent 2020 which allows you to run your Lambda code in a custom container image. Inspired by [nikovirtala/cdk-eks-experiment](https://github.com/nikovirtala/cdk-eks-experiment/), `cdk-lambda-bash` allows you to specify a local shell script and bundle it up as a custom resource in your cdk stack. On cdk deployment, your shell script will be executed in a Lambda container environment.
# BashExecFunction
At this moment, we are offering `BashExecFunction` construct class which is a high-level abstraction of `lambda.Function`. By defining the `script` property which poins to your local shell script, on `cdk deploy`, this script will be bundled into a custom docker image and published as a `lambda.DockerImageFunction`.
If you `fn.run()`, a custom resource will be created and the `lambda.DockerImageFunction` will be executed on deployment.
# Install
Use the npm dist tag to opt in CDKv1 or CDKv2:
```sh
// for CDKv2
npm install cdk-lambda-bash
or
npm install cdk-lambda-bash@latest
// for CDKv1
npm install cdk-lambda-bash@cdkv1
```
# Sample
```python
const app = new cdk.App();
const stack = new cdk.Stack(app, 'my-stack');
// bundle your Lambda function to execute the local demo.sh in container
const fn = new BashExecFunction(stack, 'Demo', {
script: path.join(__dirname, '../demo.sh'),
})
// run it as custom resource on deployment
fn.run();
```
## Re-execution on assets update
By default, if you update your shell script or Dockerfile and re-deploy your CDK application, the `BashExecFunction`
will not be re-executed. Use `runOnUpdate` to enable the re-execution on update.
```python
fn.run({ runOnUpdate: true });
```
## Custom Dockerfile
In some cases, you may customize your own `Dockerfile`, for instances:
1. You need extra tools or utilities such as `kubectl` or `helm`
2. You need build from your own base image
In these cases, create a custom `Dockerfile` as below and add extra utilities i.e. `kubectl`:
click and view custom Dockerfile sample
```bash
FROM public.ecr.aws/lambda/provided:al2
RUN yum install -y unzip jq
# install aws-cli v2
RUN curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" && \
unzip awscliv2.zip && \
./aws/install
# install kubectl
RUN curl -o kubectl https://amazon-eks.s3.us-west-2.amazonaws.com/1.19.6/2021-01-05/bin/linux/amd64/kubectl && \
chmod +x kubectl && \
mv kubectl /usr/local/bin/kubectl
COPY bootstrap /var/runtime/bootstrap
COPY function.sh /var/task/function.sh
COPY main.sh /var/task/main.sh
RUN chmod +x /var/runtime/bootstrap /var/task/function.sh /var/task/main.sh
WORKDIR /var/task
CMD [ "function.sh.handler" ]
```
Click and view the sample code
```sh
#!/bin/bash
# implement your business logic below
function onCreate() {
echo "running kubectl apply -f ..."
}
function onUpdate() {
echo "do nothing on update"
}
function onDelete() {
echo "running kubectl delete -f ..."
}
function getRequestType() {
echo $1 | jq -r .RequestType
}
function conditionalExec() {
requestType=$(getRequestType $EVENT_DATA)
# determine the original request type
case $requestType in
'Create') onCreate $1 ;;
'Update') onUpdate $1 ;;
'Delete') onDelete $1 ;;
esac
}
echo "Hello cdk lambda bash!!"
conditionalExec
exit 0
```
click and view custom Dockerfile sample
```bash
FROM public.ecr.aws/lambda/provided:al2
RUN yum install -y unzip jq
# install aws-cli v2
RUN curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" && \
unzip awscliv2.zip && \
./aws/install
# install kubectl
RUN curl -o kubectl https://amazon-eks.s3.us-west-2.amazonaws.com/1.19.6/2021-01-05/bin/linux/amd64/kubectl && \
chmod +x kubectl && \
mv kubectl /usr/local/bin/kubectl
COPY bootstrap /var/runtime/bootstrap
COPY function.sh /var/task/function.sh
COPY main.sh /var/task/main.sh
RUN chmod +x /var/runtime/bootstrap /var/task/function.sh /var/task/main.sh
WORKDIR /var/task
CMD [ "function.sh.handler" ]
```
Click and view the sample code
```sh
#!/bin/bash
# implement your business logic below
function onCreate() {
echo "running kubectl apply -f ..."
}
function onUpdate() {
echo "do nothing on update"
}
function onDelete() {
echo "running kubectl delete -f ..."
}
function getRequestType() {
echo $1 | jq -r .RequestType
}
function conditionalExec() {
requestType=$(getRequestType $EVENT_DATA)
# determine the original request type
case $requestType in
'Create') onCreate $1 ;;
'Update') onUpdate $1 ;;
'Delete') onDelete $1 ;;
esac
}
echo "Hello cdk lambda bash!!"
conditionalExec
exit 0
```
click and view custom Dockerfile sample
```bash
FROM public.ecr.aws/lambda/provided:al2
RUN yum install -y unzip jq
# install aws-cli v2
RUN curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip" && \
unzip awscliv2.zip && \
./aws/install
# install kubectl
RUN curl -o kubectl https://amazon-eks.s3.us-west-2.amazonaws.com/1.19.6/2021-01-05/bin/linux/amd64/kubectl && \
chmod +x kubectl && \
mv kubectl /usr/local/bin/kubectl
COPY bootstrap /var/runtime/bootstrap
COPY function.sh /var/task/function.sh
COPY main.sh /var/task/main.sh
RUN chmod +x /var/runtime/bootstrap /var/task/function.sh /var/task/main.sh
WORKDIR /var/task
CMD [ "function.sh.handler" ]
```
Click and view the sample code
```sh
#!/bin/bash
# implement your business logic below
function onCreate() {
echo "running kubectl apply -f ..."
}
function onUpdate() {
echo "do nothing on update"
}
function onDelete() {
echo "running kubectl delete -f ..."
}
function getRequestType() {
echo $1 | jq -r .RequestType
}
function conditionalExec() {
requestType=$(getRequestType $EVENT_DATA)
# determine the original request type
case $requestType in
'Create') onCreate $1 ;;
'Update') onUpdate $1 ;;
'Delete') onDelete $1 ;;
esac
}
echo "Hello cdk lambda bash!!"
conditionalExec
exit 0
```