https://github.com/aligent/serverless-export-resources
https://github.com/aligent/serverless-export-resources
serverless
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/aligent/serverless-export-resources
- Owner: aligent
- License: gpl-3.0
- Created: 2023-11-16T22:20:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-23T13:14:09.000Z (9 months ago)
- Last Synced: 2026-01-29T21:27:05.867Z (2 months ago)
- Topics: serverless
- Language: TypeScript
- Size: 395 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Serverless Export Resources
A [Serverless framework](https://www.serverless.com) plugin for creating custom Outputs and export them.
## Serverless configuration
- Though does not requires in the serverless configuration, this plugin will throw errors if the description of the exported resources are not available.
- Lambda Function description can be set in the function declaration like so:
```yaml
functions:
hello:
handler: src/hello.handler
description: >-
This is a long dummy description of this Hello Lambda service to test the limitation of this export value.
It can contain up to 256 characters.
```
- Step Function supports setting `Comment` which can be used as description:
```yaml
stepFunctions:
stateMachines:
stateMachine:
name: ${self:service}-${self:provider.stage}-stateMachine
definition:
Comment: >-
This is a very long dummy description of this State Machine service to test the limitation of this export value.
It can contain nearly 500 characters.
```
- The plugin is configured within the `serverless.yaml` by providing configuration values as the example below
```yaml
custom:
exportResources:
functions: [hello, world]
stateMachines:
- helloWorld
```
### Variables
| Variable | Usage |
| ------------- | ------------------------------------------------------------------------------------ |
| functions | Array of logical names of Lambda functions to export. |
| stateMachines | Array of logical names of Step Functions to export. |
| prefix | A prefix for export names. If not provide, export names will be prefixed with `aser` |