Enhance configuration API

[sbstjn]

• table property supports string and array as value(s)
• Support for index property to scale GlobalSecondaryIndexes Apply same settings to global secondary indexes #2

Tasks

• Rewrite index support
• Rewrite DependsOn handling
• Update README.md
• Add info about CloudWatch API rate limits
• Add stage to naming schema
• Extend tests for names.js

This branch supports flexible Auto Scaling for tables and/or global secondary indexes with the following configurations:

custom:
  capacities:
    - table: CustomTableA
      index: custom-index-global
      indexOnly: true
      read:
        minimum: 1
        maximum: 123
        usage: 0.80
      write:
        minimum: 10
        maximum: 100
        usage: 0.50
    - table: CustomTableB
      read:
        minimum: 1
        maximum: 123
        usage: 0.80
      write:
        minimum: 10
        maximum: 100
        usage: 0.50
    - table:
        - CustomTableC
        - CustomTableD
        - CustomTableE
      index:
        - custom-index
      read:
        minimum: 1
        maximum: 123
        usage: 0.80
      write:
        minimum: 10
        maximum: 100
        usage: 0.50

[charleswhchan]

1. Is indexOnly applicable for the "string style" only? (I am guessing not, but just want to be clear) To eliminate the need for this parameter, is it possibly to simply provide the index name as the resource without table name?
2. The array format looks interesting and useful, but may become confusing when there are lots of tables and indexes. I supposed as long as your indexes follows some form of consistent naming format wrt to the table name it should't lead to readability problems.

Thanks @sbstjn 👍

[sbstjn]

Thanks for the feedback. Based on the CloudFormation resource I think the global secondary index has no CloudFormation resource identifier. They seem to be always referenced by the combination of the table resource/name and the name of the index:

    CustomTableC:
      Type: AWS::DynamoDB::Table
      Properties:
        TableName: custom-table-C
        GlobalSecondaryIndexes:
          - IndexName: custom-index
            KeySchema:
              - AttributeName: key
                KeyType: HASH
            Projection:
              ProjectionType: ALL
            ProvisionedThroughput:
              ReadCapacityUnits: 5
              WriteCapacityUnits: 5

Based on this, I think it's not possible to just provide an index without table.

The indexOnly property should be used if you only want to apply autoscaling on the index, and not on the table. I don't know if this is real use case ;)

[sbstjn]

I have extended the README.md with information about the indexOnly parameter. The list-support is working and tested, but to avoid irritation I'll skip explaining the feature in the readme ;)

[charleswhchan]

... as well as separate configuration sets for read and write

[charleswhchan]

Not Auto Scaling configuration found

[sbstjn]

👍

[charleswhchan]

typo: object

[charleswhchan]

Thanks, @sbstjn. Except for a couple of typos, changes looks good 👍

[sbstjn]

Thanks for checking 👍

[nasirumair]

@sbstjn Is there any support for scaling tables in other stacks at all? I am trying to autoscale a table that is currently existing but not in the stack