serverless-plugin-dynamo-autoscaling

KO | EN

gitlite — search

#javascript #react #golang #android #machine-learning #linux #docker #macos #java #windows #cli #vue #mcp #open-source

serverless-plugin-dynamo-autoscaling

(★ 14)

Serverless Plugin for Amazon DynamoDB Auto Scaling using cloudformation.

serverless-plugin-dynamo-autoscaling Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ⚡️ Serverless Plugin for DynamoDB Auto Scaling

[![Build Status][travis-image]][travis-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![Coverage Status][coverage-image]][coverage-url]
[![npm][npm-image]][npm-url]
[![GitHub license][license-image]][license-url]
[![dependencies Status][dependencies-image]][dependencies-url]
[![LGTM Status][lgtm-image]][lgtm-url]

Serverless Plugin to enable autoscaling for dynamodb tables and its GSI.

## Installation

```bash
# Via yarn
$ yarn add serverless-plugin-dynamo-autoscaling

# Via npm
$ npm install serverless-plugin-dynamo-autoscaling
```

Add the plugin to your `serverless.yml`:

```yaml
plugins:
  - serverless-plugin-dynamo-autoscaling
```

## Configuration

```yaml
custom:
  autoscaling:
    - table: CustomTable  # DynamoDB Resource
      read:
        minimum: 5        # Minimum read capacity
        maximum: 1000     # Maximum read capacity
        targetUsage: 75   # Targeted usage percentage
      write:
        minimum: 40       # Minimum write capacity
        maximum: 200      # Maximum write capacity
        targetUsage: 50   # Targeted usage percentage
```

### Defaults

```yaml
maximum: 200
minimum: 5
targetUsage: 75
```

If no `roleArn` is specified, plugin will automatically create one and use it.

### Index Only

If you only want to enable Auto Scaling for the index, use `indexOnly: true` to skip Auto Scaling for the general DynamoDB table.

## Examples

```yaml
custom:
  autoscaling:
  
    # Autoscaling for table and index
    - table: CustomTable  
      index:              # List or single index name
        - custom-index-name
      read:
        minimum: 5        
        maximum: 1000     
        targetUsage: 75   
      write:
        minimum: 40       
        maximum: 200      
        targetUsage: 50   
        
    # Using with custom role
    - table: CustomTable  # DynamoDB Resource
      roleArn:            # Arn of the role to be associated - Optional
      read:
        minimum: 5       
        maximum: 1000     
        targetUsage: 75   
      write:
        minimum: 40       
        maximum: 200      
        targetUsage: 50   
        
    # Autoscaling for index only
    - table: IndexOnlyTable  
      index:              
        - custom-index-name
      indexOnly: true     # autoscaling for index only
      read:
        minimum: 5        
        maximum: 1000     
        targetUsage: 75  
      write:
        minimum: 40       
        maximum: 200      
        targetUsage: 50   
```

## DynamoDB

The example serverless configuration above works fine for a DynamoDB table CloudFormation resource like this:

```yaml
resources:
  Resources:
    CustomTable:
      Type: AWS::DynamoDB::Table
      Properties:
        TableName: custom-table
        AttributeDefinitions:
          - AttributeName: key
            AttributeType: S
        KeySchema:
          - AttributeName: key
            KeyType: HASH
        ProvisionedThroughput:
          ReadCapacityUnits: 5
          WriteCapacityUnits: 5
        GlobalSecondaryIndexes:
          - IndexName: custom-index-name
            KeySchema:
              - AttributeName: key
                KeyType: HASH
            Projection:
              ProjectionType: ALL
            ProvisionedThroughput:
              ReadCapacityUnits: 5
              WriteCapacityUnits: 5
```

## Thanks

- [Sebastian Müller](https://github.com/sbstjn) This repo is rewrite of Sebastian's [serverless plugin](https://github.com/sbstjn/serverless-dynamodb-autoscaling).

## License

Feel free to use the code, it's released using the [MIT license](LICENSE.md).

[npm-image]:https://img.shields.io/npm/v/serverless-plugin-dynamo-autoscaling.svg
[npm-url]:https://www.npmjs.com/package/serverless-plugin-dynamo-autoscaling
[license-image]:https://img.shields.io/github/license/ACloudGuru/serverless-plugin-dynamo-autoscaling.svg
[license-url]:https://github.com/ACloudGuru/serverless-plugin-dynamo-autoscaling/blob/master/LICENSE
[travis-image]: https://travis-ci.org/ACloudGuru/serverless-plugin-dynamo-autoscaling.svg?branch=master
[travis-url]: https://travis-ci.org/ACloudGuru/serverless-plugin-dynamo-autoscaling
[dependencies-image]:https://david-dm.org/ACloudGuru/serverless-plugin-dynamo-autoscaling/status.svg
[dependencies-url]:https://david-dm.org/ACloudGuru/serverless-plugin-dynamo-autoscaling
[coverage-image]:https://coveralls.io/repos/github/ACloudGuru/serverless-plugin-dynamo-autoscaling/badge.svg?branch=master
[coverage-url]:https://coveralls.io/github/ACloudGuru/serverless-plugin-dynamo-autoscaling?branch=master
[codacy-image]:https://api.codacy.com/project/badge/Grade/1a7404b4669c4a2696bba05cfcc83dc6
[codacy-url]:https://app.codacy.com/app/subash.adhikari/serverless-plugin-dynamo-autoscaling?utm_source=github.com&utm_medium=referral&utm_content=ACloudGuru/serverless-plugin-dynamo-autoscaling&utm_campaign=Badge_Grade_Dashboard
[lgtm-image]:https://img.shields.io/lgtm/grade/javascript/g/ACloudGuru/serverless-plugin-dynamo-autoscaling.svg?logo=lgtm&logoWidth=18
[lgtm-url]:https://lgtm.com/projects/g/ACloudGuru/serverless-plugin-dynamo-autoscaling/context:javascript

serverless-plugin-dynamo-autoscaling

serverless-plugin-dynamo-autoscaling Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

serverless-plugin-dynamo-autoscaling

serverless-plugin-dynamo-autoscaling Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README