Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
serverless-apigateway-log-retention
Advanced tools
A plugin for the Serverless framework which configures ApiGateway access adn execution log retention.
Control the retention of your ApiGateway access logs and execution logs.
From your target serverless project, run:
npm install serverless-apigateway-log-retention
Add the plugin to your serverless.yml:
plugins:
- serverless-apigateway-log-retention
Configuration happens 'globally' via custom.apigatewayLogRetention
.
The plugin uses AWS profile configured under provider.profile
or defaults to AWS credentials set in the environment.
If you can't directly connect to the internet, the plugin supports proxy which you can set via any of the following environment variables:
- HTTP_PROXY
- HTTPS_PROXY
- FTP_PROXY
- WSS_PROXY
- WS_PROXY
By default the plugin assumes the API name format to be [STAGE]-[SERVICE_NAME]
. If your API name format is [SERVICE_NAME]-[STAGE]
, set provider.apiGateway.shouldStartNameWithService
to true like so:
provider:
name: aws
apigateway:
shouldStartNameWithService: true
If you want to use a custom API name, set it via provider.apiName
like so:
provider:
name: aws
apiName: 'my-custom-api-name'
PLEASE NOTE THAT THE PLUGIN REQUIRES THE FOLLOWING AWS PERMISSIONS:
CloudWatch Logs
ApiGateway
Plugin Options
accessLogging.enabled
(optional) - Whether or not to update access logging retention policy. Set to false by default.
accessLogging.days
(required) - Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653 and 'never expire'.
executionLogging.enabled
(optional) - Whether or not to update execution logging retention policy. Set to false by default.
executionLogging.days
(required) - Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653 and 'never expire'.
serverless.yml
- Enabled for execution logging and disabled for access logging:
service: sample
plugins:
- serverless-apigateway-log-retention
provider:
name: aws
custom:
apigatewayLogRetention:
executionLogging:
enabled: true
days: 'never expire'
serverless.yml
- Enabled for access logging and execution logging:
service: sample
plugins:
- serverless-apigateway-log-retention
provider:
name: aws
custom:
apigatewayLogRetention:
executionLogging:
enabled: true
days: 14
accessLogging:
enabled: true
days: 7
FAQs
A plugin for the Serverless framework which configures ApiGateway access adn execution log retention.
The npm package serverless-apigateway-log-retention receives a total of 5,925 weekly downloads. As such, serverless-apigateway-log-retention popularity was classified as popular.
We found that serverless-apigateway-log-retention demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.