lambda-update-alias

Update or create a AWS lambda alias

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
lambda-update-alias
1.0.08 years ago8 years agoMinified + gzip package size for lambda-update-alias in KB

Readme

lambda-update-alias
Build Status Coverage Status
Update or create a AWS lambda alias

Install

$ npm install --save lambda-update-alias

Usage

const updateAlias = require('lambda-update-alias');

updateAlias('myLambdaFunction', 'v1'}).then(result => {
	console.log(result);
	/*
	{
		AliasArn: 'arn:aws:lambda:us-west-1:123456789012:function:myLambdaFunction:v1',
		Name: 'v1',
		FunctionVersion: '3',
		Description: 'My lambda function description'
	}
	*/
});

API

updateAlias(name, alias, options)

Returns a promise for the result object.

name

Type: string
Name of the lambda function.

alias

Type: string
Name of the alias that should be attached to the lambda function.

options

version
Type: string
Default: latest
Name of the version where the alias should be attached to. If not provided, the alias will be attached to the version with the highest number. $LATEST is treated as version 0.
awsProfile
Type: string
AWS Profile. The user related to the profile should have admin access to API Gateway and should be able to invoke lambda:AddPermission.
Can be overridden globally with the AWS_PROFILE environment variable.
awsFilename
Type: string
Filename to use when loading credentials.
awsRegion
Type: string
Default: us-west-1
AWS region.

User Policy

The profile creating or updating the alias should be able to list the versions of the function and create and update the aliases.
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "Stmt1454507191000",
            "Effect": "Allow",
            "Action": [
                "lambda:CreateAlias",
                "lambda:ListVersionsByFunction",
                "lambda:UpdateAlias"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

Related

License

MIT © Sam Verschueren