...
The goal of the tutorial is to deploy the function code using the Archive file from the Artifact directory and publish the function version. We will use the Function code and Environment file present at the git repository. We are going to add secured variables also and to encrypt these variables, we will use the AWS KMS key.
configuration of the properties e.g. Cloud account, and CLI path.
cloning the function code and create the Archive file.
cloning the environment file from Git repository
deploy the function code and adding the environment variables to the Lamba function.
verify the function code.
...
Checklist | Description |
AWS Access Key | AWS Access Key of the user. |
AWS Secret Key | Password for the Access Key |
AWS Default Region | Default region can be set. eg. ap-south-1 |
AWS CLI installation | AWS CLI needs to be installed where the plugin operation shall run (FlexDeploy server) |
AWS CLI in class path | AWS CLI should be added to the class path on the FlexDeploy Server. Else the path can also be set under FlexDeploy environment level property |
AWS Lambda Function | AWS Lambda Function should be already present. |
AWS KMS Key | AWS KMS key to secured the environment variable. |
Configure Cloud
...
Account
To connect with AWS Lambda Function, we required to configure Cloud account, with credentials details. Configure AWS Cloud Account under Integration. FlexDeploy will connect to the Lambda Function and add the environment variables.
...
Detail of the AWS Lambda function which we have created and going to use for this tutorial:
...
In above function if we see the Environment variables details under the Configuration, there is no If we check the Code details of the function, then we found we have sample code. We will update the code using our AWS plugin operation.
...
On testing the code, using the Test option provided by AWS Lambda we will get this response:
...
If we check the Environment variables details under the Configuration, there is no environment variables are present. Once successful execution of the operation we should be able to see some environment variables.
...
Create AWS KMS Key
AWS Key Management Service (AWS KMS) is a managed service that makes it easy for us to create and control the cryptographic keys that are used to protect our data. Please refer to the link for more information https://aws.amazon.com/kms/
...
We can use Key ID or Key ARN value in the project to encrypt the variables, both are accepted.
Git
...
Repository Structure
The Git repository contains the Environment file.
The Sample Git repository structure is given below.
...
Environment Variable File Structure
This is the example of environment file with json structure, please refer the document to get more details about environment variables' acceptable structure.
...
Pre-requisite
Configure IAM user
...
For more information about IAM user please ref. IAM users - AWS Identity and Access Management
...
CLI
...
Installation
AWS CLI should be installed in the m/c where the plugin is to be executed. Preferably add AWS CLI path in m/c classpath.
...
Input Name | Input Code | Type | Required | Description |
Additional Arguments | FDAWS_LAMBDA_INP_ADD_ENV_VAR_ADDITIONAL_ARG | String | No | Literal key and value pairs. e.g. --region=us-east-1 And for boolean type arguments give the option without any value. e.g --publish --debug |
Environment Variables | FDAWS_LAMBDA_INP_ENV_VAR | String | No | Environment Variables in acceptable format. |
Publish new version | FDAWS_LAMBDA_INP_PUBLISH_VERSION | Boolean | No | Select to publish a new version. Default value is false. |
Project
...
Configuration
Navigate to the Project tab and create a Project with a logical name(AWS-Deploy-Lambda-Function-Code)
...
Configure the Build and Deploy workflow that has been created in previous steps as shown below.
...
Source Control
Configure the Source SCM repository under Source Control as shown below.
...
The AWS Cloud account needs to be set here from the drop-down. It will show all Cloud Accounts configured under Topology, which we have already mentioned earlier.
...
CLI
...
Path
AWS CLI path can be set as environment property, if it’s not set then by default plugin will check for CLI in system classpath.
...
Override
...
Properties at Project level
Let assume a scenario, where we want to change Cloud account for any specific project. Apart from setting at environment level, it can also be set at project properties by using Override Property. Please check below mentioned steps.
...
Once the updateLambdaFunctionCode operation successful we can see the updated code and published version, from the plugin output and version from the plugin output and AWS Lambda console.
Updated code details from AWS Lambda console.
...
Published version detail from AWS Lambda console.
...
...
Published version detail from the plugin output.
...
We can see the variable details on the AWS Lambda Function console.
...
Sample code to
...
Retrieve the
...
Secured Variables
We have also added some non-secured variables ( Password and Mysql_Connection_String ) to the Lambda Function and to encrypt these variables we have used AWS KMS key, to get the values of secured variables we can use the sample code provided by AWS Lambda according to the Function code language. In our case we are using java script, below is the sample code to get the value of secured and non-secured variables and creating the response to print the values.
...
We can use the test option of the AWS-Lambda to test our function code, in our case test response will be:
...
Please refer to the link, for more details about encryption and decryption of the secured variables AWS KMS --encryption-context understanding