@mapbox/cloudfriend

v8.1.0

Helper functions for assembling CloudFormation templates in JavaScript For more information about how to use this package see README

Latest version published 23 days ago

License: ISC

NPM

GitHub

Package Health Score

84 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
8.1.0	\|	03/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.0.0	\|	02/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.1.0	\|	08/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.0.0	\|	10/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.1.1	\|	04/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (34,087)

GitHub Stars: 66
Forks: 9
Contributors: 30

Direct Usage Popularity

The npm package @mapbox/cloudfriend receives a total of 34,087 downloads a week. As such, we scored @mapbox/cloudfriend popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @mapbox/cloudfriend, we found that it has been starred 66 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 30
Funding: No

With more than 10 contributors for the @mapbox/cloudfriend repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 13
Open PR: 0
Last Release: 23 days ago
Last Commit: 23 days ago

Further analysis of the maintenance status of @mapbox/cloudfriend based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @mapbox/cloudfriend demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=14

Age: 7 years
Dependencies: 3 Direct
Versions: 92
Install Size: 738 kB
Dist-tags: 2
# of Files: 117
Maintainers: 28
TS Typings: No

@mapbox/cloudfriend has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use @mapbox/cloudfriend?

To help you get started, we've collected the most common ways that @mapbox/cloudfriend is being used within popular public projects.

hotosm / tasking-manager / scripts / aws / cloudformation / tasking-manager.template.js View on Github

"02_config-amazon-cloudwatch-agent": {
          "files": {
            '/opt/aws/amazon-cloudwatch-agent/etc/amazon-cloudwatch-agent.json': {
              "content": cf.join("\n", [
                  "{\"logs\": {",
                  "\"logs_collected\": {",
                  "\"files\": {",
                  "\"collect_list\": [",
                  "{",
                  "\"file_path\": \"/opt/aws/amazon-cloudwatch-agent/logs/amazon-cloudwatch-agent.log\",",
                  cf.sub("\"log_group_name\": \"${AWS::StackName}.log\","),
                  cf.sub("\"log_stream_name\": \"${AWS::StackName}-cloudwatch-agent.log\","),
                  "\"timezone\": \"UTC\"",
                  "},",
                  "{",
                  cf.sub("\"file_path\": \"${TaskingManagerLogDirectory}/tasking-manager.log\","),
                  cf.sub("\"log_group_name\": \"${AWS::StackName}.log\","),
                  cf.sub("\"log_stream_name\": \"${AWS::StackName}.log\","),
                  "\"timezone\": \"UTC\"",
                  "}]}},",
                  cf.sub("\"log_stream_name\": \"${AWS::StackName}-logs\","),
                  "\"force_flush_interval\" : 15",
                  "}}"
              ])
            }
          }
        },
        // Invoke amazon-cloudwatch-agent-ctl to restart the AmazonCloudWatchAgent.
        "03_restart_amazon-cloudwatch-agent": {
          "commands": {
            "01_stop_service": {
              "command": "/opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a stop"

View more ways to use @mapbox/cloudfriend

cloudfriend

Helper functions for assembling CloudFormation templates in JavaScript.

Shortcuts

Cloudfriend contains a library of JS classes that reduce the amount of "boilerplate" CloudFormation that you need to write to setup a common set of AWS Resources. See the shortcuts readme for more information, or the shortcuts API documentation to look at shortcut-specific configuration.

Intrinsic functions and conditions

These are functions that you can use in place of various CloudFormation objects.

CloudFriend	CloudFormation
base64(value)	Fn::Base64
cidr(ipBlock, count, cidrBits)	Fn::Cidr
findInMap(mapping, key, attr)	Fn::FindInMap
forEach(uniqueLoopName, identifier, collection, outputKeyPrefix, outputValue)	Fn::ForEach
getAtt(obj, key)	Fn::GetAtt
getAzs(region)	Fn::GetAZs
join(delimiter, pieces)	Fn::Join
split(delimiter, string)	Fn::Split
select(index, list)	Fn::Select
ref(name)	Ref
userData(list)	Fn::Base64 and Fn::Join with `\n` delimiter
and(conditions)	Fn::And
equals(a, b)	Fn::Equals
if(condition, ifTrue, ifFalse)	Fn::If
not(condition)	Fn::Not
or(conditions)	Fn::Or
notEquals(a, b)	Fn::Not and Fn::Equals
sub(str, variables)	Fn::Sub
importValue(sharedValue)	Fn::ImportValue,
arn(service, suffix)	Fn::Sub designed for an ARN
transform(name, parameters)	Fn::Transform
contains(strings, s)	Fn::Contains
eachMemberEquals(strings, s)	Fn::EachMemberEquals
eachMemberIn(stringsToCheck, stringsToMatch)	Fn::EachMemberIn
refAll(parameterType)	Fn::RefAll
valueOf(parameterLogicalId, attribute)	Fn::ValueOf
valueOfAll(parameterType, attribute)	Fn::ValueOfAll

Pseudo parameters

These are static properties of cloudfriend that you can use to reference various CloudFormation objects.

CloudFriend	CloudFormation
accountId	AWS::AccountId
notificationArns	AWS::NotificationARNs
noValue	AWS::NoValue
region	AWS::Region
stackId	AWS::StackId
stackName	AWS::StackName
partition	AWS::Partition
urlSuffix	AWS::URLSuffix

Other helpers

method	description
build(file, opts)	Builds a template defined by a static JavaScript export, a synchronous or an asynchronous function.
validate(file)	Uses the `cloudformation:ValidateTemplate` API call to perform rudimentary template validation
merge(...template)	Merges templates together. Throws errors if logical names are reused. `Transform` macros from all template arguments are merged into a single array, in order of their appearance in the template arguments, and an error is thrown if any macro is repeated.

CLI tools

By installing cloudfriend globally, it can provide you with simple CLI tools for building and validating CloudFormation templates.

# either...
$ git clone https://github.com/mapbox/cloudfriend && cd cloudfriend && npm link
# ... or ...
$ npm install -g @mapbox/cloudfriend

Then, to build a template:

# Prints the template as JSON to stdout
$ build-template path/to/template.js

Or, to validate a template:

# Make sure that your shell is configured to make AWS requests
$ validate-template path/to/template.js

You may also specify a region for validation:

# Make sure that your shell is configured to make AWS requests
$ validate-template path/to/template.js us-east-1

@mapbox/cloudfriend dependencies

aws-sdk minimist redent

@mapbox/cloudfriend development dependencies

@mapbox/eslint-config-mapbox eslint eslint-plugin-node jsdoc-to-markdown nyc opener tap-spec tape

FAQs

What is @mapbox/cloudfriend?

Helper functions for assembling CloudFormation templates in JavaScript. Visit Snyk Advisor to see a full health score report for @mapbox/cloudfriend, including popularity, security, maintenance & community analysis.

Is @mapbox/cloudfriend popular?

The npm package @mapbox/cloudfriend receives a total of 34,087 weekly downloads. As such, @mapbox/cloudfriend popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @mapbox/cloudfriend well maintained?

We found that @mapbox/cloudfriend demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @mapbox/cloudfriend safe to use?

The npm package @mapbox/cloudfriend was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 19 April-2024, at 13:25 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP