Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacob-meacham/serverless-plugin-bind-deployment-id
:link: Serverless plugin to bind the randomly generated deployment id to custom resources
https://github.com/jacob-meacham/serverless-plugin-bind-deployment-id
Last synced: about 1 month ago
JSON representation
:link: Serverless plugin to bind the randomly generated deployment id to custom resources
- Host: GitHub
- URL: https://github.com/jacob-meacham/serverless-plugin-bind-deployment-id
- Owner: jacob-meacham
- License: mit
- Created: 2017-01-15T23:33:23.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-06T15:51:52.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T13:15:42.609Z (7 months ago)
- Language: JavaScript
- Size: 1.83 MB
- Stars: 33
- Watchers: 3
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# serverless-plugin-bind-deployment-id
[](https://coveralls.io/github/jacob-meacham/serverless-plugin-bind-deployment-id?branch=develop)
[](https://travis-ci.org/jacob-meacham/serverless-plugin-bind-deployment-id)
Bind the serverless deployment to your custom resources like magic! Simply use `__deployment__` in place of anywhere you want the deployment to show up.
# Usage
```yaml
custom:
myVariable: bar
resources:
Resources:
PathMapping:
Type: AWS::ApiGateway::BasePathMapping
DependsOn: ApiGatewayStage
Properties:
BasePath: basePath
DomainName: ${self:provider.domain}
RestApiId:
Ref: ApiGatewayRestApi
Stage: ${self:provider.stage}
__deployment__:
Properties:
Description: This is my deployment
ApiGatewayStage:
Type: AWS::ApiGateway::Stage
Properties:
DeploymentId:
Ref: __deployment__
RestApiId:
Ref: ApiGatewayRestApi
StageName : ${self:provider.stage}
MethodSettings:
- DataTraceEnabled: true
HttpMethod: "*"
LoggingLevel: INFO
ResourcePath: "/*"
MetricsEnabled: true
ApiGatewayStage2:
Type: AWS::ApiGateway::Stage
Properties:
DeploymentId:
Ref: __deployment__
RestApiId:
Ref: ApiGatewayRestApi
StageName : myOtherStage
Variables: [${self:custom.myVariable}]
plugins:
- serverless-plugin-bind-deployment-id
```
When built, this will merge the custom properties set above with the default CloudFormation template, allowing you to apply custom properties to your Deployment or Stage. This will even allow you to add multiple Stages!
### Compatibility Note
If you are using Serverless 0.12+, please use the 1.x.x plugin. For previous Serverless versions, use the 0.1.x plugin.
## Advanced Usage
By default `__deployment__` is the sentinel value which is replaced by the API Deployment Id. This is configurable. If you'd like to use a different value, you can set:
```yaml
custom:
deploymentId:
variableSyntax: ApiGatewayDeployment
```
In this example, any instance of ApiGatewayDeployment in your custom resources will be replaced with the true deployment Id.
## Known Issues
Because the deployment id is not stable across CloudFormation stack updates, you cannot make changes to the default stage with the StageDescription property. If you attempt to do so, you will see an error:
```
An error occurred while provisioning your stack: ApiGatewayDeployment1490846212163
- StageDescription cannot be specified when stage referenced
by StageName already exists.
```
The easiest way to get around this is to leave the default stage unused, and create a new stage that you actually use. By default, we name this default stage __unused_stage__, but you could change it to something else by setting:
```yaml
__deployment__:
Properties:
StageName: myUnusedStage
```
## Release Notes
* 2.0.3 - Dependency security updates
* 2.0.2 - Fix default export breaking change
* 2.0.1 - Remove serverless peer dependency (thanks [@johnmee](https://github.com/johnmee))
* 2.0.0 - Major dependency upgrades, force node >= 12.
* 1.2.0 - The Serverless framework has added support for the resources.extensions block, which has slightly-more-formalized merge behaviour. 1.2.0 adds support for replacing the deployment ID in the extensions
block. (thanks [@glb](https://github.com/glb))
* 1.1.1 - Dependency upgrades from dependabot
* 1.1.0 - Dependency upgrade (thanks [@ericsorensen](https://github.com/ericsorenson))
* 1.0.2 - Update lodash to fix known security issue (thanks [@brownjava](https://github.com/brownjava))
* 1.0.1 - Fix peer dependency
* 1.0.0 - Fix an incompatibility with serverless 1.12
* 0.1.0 - Initial release
## Contributors
* [Jacob Meacham](https://github.com/jacob-meacham)
* [ajkerr](https://github.com/ajkerr)