Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
add-custom-resource
Advanced tools
A helper library to add custom resources to a CloudFormation template
This is a library meant to be used in a Serverless plugin, when you need to add a custom resource. This allows you to execute arbitrary code within CloudFormation as part of deployment, allowing you do things like call the aws-sdk in cases where CloudFormation does not support the feature you need to deploy/configure.
Major version bump due to updated runtime.
my-plugin.js
const addCustomResource = require('add-custom-resource');
class MyPlugin {
constructor(serverless, options) {
this.serverless = serverless;
this.options = options;
this.hooks = {
'before:package': () => this.doStuff()
};
}
doStuff() {
const template = this.serverless.service.provider.compiledCloudFormationTemplate;
return addCustomResource(template, {
name: 'MyResource',
sourceCodePath: path.join(__dirname, 'my-source-code.js')
});
}
}
This will add four resources to your CloudFormation template:
Lambda::Function
(with my-source-code.js
inlined)IAM::Role
(for the Lambda functions permissions)Logs::LogGroup
(for any logs related to the Lambda function running)Custom::
resource (which is backed by your Lambda function)You source code can use the aws-sdk and the cf-response library, which are built in to Lambda. Other dependencies are not supported.
my-source-code.js
const aws = require('aws-sdk');
const response = require('cfn-response');
const s3 = new aws.S3();
module.exports.handler = function(event, context) {
Promise.resolve()
.then(() => {
switch (event.RequestType) {
case 'Create':
case 'Update':
return s3.doSomething().promise();
case 'Delete':
return s3.doSomethingElse().promise();
default:
return Promise.resolve('no action matched');
}
})
.then(() => {
response.send(event, context, response.SUCCESS, {});
})
.catch(() => {
response.send(event, context, response.FAILED, {});
});
};
If you configure a resourceName
in addition to name
, then multiple resources can be created while re-using the same function.
For example:
await addCustomResource(template, {
name: 'CustomThing',
resourceName: 'CustomThingFoo'
sourceCodePath: path.join(__dirname, 'my-source-code.js')
});
await addCustomResource(template, {
name: 'CustomThing',
resourceName: 'CustomThingBar'
sourceCodePath: path.join(__dirname, 'my-source-code.js')
});
This will only add the function, log group and role for CustomThing
once, while creating two separate custom resources: CustomThingFoo
and CustomThingBar
, each backed by the same Lambda function (CustomThingFunction
);
You can specify a roleArn
and this library will not create a role.
As of 3.0.0
, you can include dependencies in your Lambda resource and this library will use Rollup to bundle them.
The promise returned by addCustomResource
will resolve to the logicalId that the resource was added under.
const logicalId = await addCustomResource(...);
// you can use this elsewhere in your template, Fn::GetAtt: [logicalId, ... ]
FAQs
A helper library to add custom resources to a CloudFormation template
The npm package add-custom-resource receives a total of 1,181 weekly downloads. As such, add-custom-resource popularity was classified as popular.
We found that add-custom-resource demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.