https://github.com/jacob-meacham/serverless-plugin-aws-resolvers

:zap: A plugin for the serverless framework that resolves deployed AWS services to variables from ESS, RDS, EC2, dynamodb or Kinesis.
https://github.com/jacob-meacham/serverless-plugin-aws-resolvers

aws aws-lambda serverless serverless-framework serverless-plugin

Last synced: about 1 month ago
JSON representation

:zap: A plugin for the serverless framework that resolves deployed AWS services to variables from ESS, RDS, EC2, dynamodb or Kinesis.

• Host: GitHub
• URL: https://github.com/jacob-meacham/serverless-plugin-aws-resolvers
• Owner: jacob-meacham
• License: mit
• Created: 2017-07-19T02:05:10.000Z (over 7 years ago)
• Default Branch: develop
• Last Pushed: 2023-02-03T14:21:47.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T23:59:49.652Z (7 months ago)
• Topics: aws, aws-lambda, serverless, serverless-framework, serverless-plugin
• Language: JavaScript
• Homepage:
• Size: 2.8 MB
• Stars: 26
• Watchers: 18
• Forks: 8
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# serverless-plugin-aws-resolvers

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)

[![Coverage Status](https://coveralls.io/repos/github/jacob-meacham/serverless-plugin-aws-resolvers/badge.svg?branch=develop)](https://coveralls.io/github/jacob-meacham/serverless-plugin-aws-resolvers?branch=develop)

![Build Status](https://github.com/jacob-meacham/serverless-plugin-aws-resolvers/actions/workflows/ci.yml/badge.svg)

A plugin for the serverless framework that resolves deployed AWS services to variables from ESS, RDS, EC2, dynamodb or Kinesis.

# Usage

```yaml

custom:

  # See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ES.html#describeElasticsearchDomain-property

  ess: ${aws:ess:my_cluster_name:Endpoint}

  # See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/RDS.html#describeDBInstances-property

  rds: ${aws:rds:my_db_name:InstanceCreateTime}

  # See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/RDS.html#describeDBClusters-property

  rdsaurora: ${aws:rdsaurora:my_cluster_name:Endpoint}

  kinesis: ${aws:kinesis:my_kinesis_stream:StreamARN}

  dynamodb: ${aws:dynamodb:my_dynamodb_table:LatestStreamArn}

  securityGroup: ${aws:ec2:securityGroup:my_vpc_name-my_group_name:GroupId}

  subnet: ${aws:ec2:subnet:my_subnet_name:SubnetId}

  vpc: ${aws:ec2:vpc:my_vpc_name:VpcId}

  ecs: ${aws:ecs:cache_cluster_name:CacheClusterId}

  cf: ${aws:cf:stack_name`_`logical_resource_id:PhysicalResourceId}

  apigateway: ${aws:apigateway:my_api_name:id}

  apigatewayv2: ${aws:apigatewayv2:my_api_name:ApiId}

```

Given a service, a key, and a property, this plugin will resolve the variable directly from AWS. This uses the IAM role of the executor of the serverless binary.

This plugin also exposes a command to resolve a variable `sls resolveAwsKey --k aws:ess:my_cluster_name:Endpoint`

See our [webpage](https://jacob-meacham.github.io/serverless-plugin-aws-resolvers/) for full documentation.

## Array access

To access values in arrays (for example the ElastiCache Endpoint in CacheNodes), the `variableSyntax` of serverless needs to be amended.

```yaml

provider:

  variableSyntax: "\\${([ ~:a-zA-Z0-9._\\'\",\\-\\/\\(\\)\\[\\]]+?)}"

  environment:

    ECS_ADDRESS: ${aws:ecs:ecs-instance:CacheNodes[0].Endpoint.Address}

```

# Configurations

This plugin has one available configuration option at the moment.

```yaml

custom:

  awsResolvers:

    strict: true

```

Disabling strict mode allows values of non-existing infrastructure to be overwritten by other values. This is especially useful when the serverless configuration also contains the CloudFormation template to create this infrastructure. On the first run the value would not be available and would prevent the template from being applied.

Values can be overwritten like this:

```yaml

custom:

  awsResolvers:

    strict: false

  rds: ${aws:rds:my_db_name:InstanceCreateTime, 'not created yet'}

```

# Version History

* 2.1.0

  - Broad dependency update

  - Add Aurora clusters (thanks @kschusternetformic)

* 2.0.2

  - Dependency security update

  - Fix deprecation warning (Thanks @dnicolson)

* 2.0.1

  - Correctly depend on node >= 12

* 2.0.0

  - Large dependency upgrade, remove babel runtime dependency.

* 1.4.0

  - Add ability to get CF Physical Resource ID (thanks @supaggregator)

* 1.3.3

  - Update versions for dependabot secruity vulnerabilities

* 1.3.2

  - Fix security issue with lodash (thanks @rmbl)

* 1.3.1

  - Add support for elasticache resources (thanks @rmbl)

* 1.3.0

  - Add a strict mode flag and don't error on non-existing infrastructure when strict mode is not on (thanks @rmbl)

* 1.2.1

  - Allow object access for the variable name (thanks @rmbl)

* 1.2.0

  - Add support for DynamoDB stream ARN (thanks @geronimo-iia)

* 1.1.0

  - Add support for EC2 resources (thanks @kevgliss)

* 1.0.0

  - Initial release