feat(aws-dynamodb): tags support (#814)

Adds support for tags for DynamoDB table
aws · Oct 8, 2018 · 644947a · 644947a
1 parent eb4bacf
commit 644947a
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 19 deletions.
diff --git a/packages/@aws-cdk/aws-dynamodb/lib/table.ts b/packages/@aws-cdk/aws-dynamodb/lib/table.ts
@@ -1,6 +1,6 @@
 import { cloudformation as applicationautoscaling } from '@aws-cdk/aws-applicationautoscaling';
 import { Role } from '@aws-cdk/aws-iam';
-import { Construct, PolicyStatement, PolicyStatementEffect, ServicePrincipal } from '@aws-cdk/cdk';
+import { Construct, PolicyStatement, PolicyStatementEffect, ServicePrincipal, TagManager, Tags } from '@aws-cdk/cdk';
 import { cloudformation as dynamodb } from './dynamodb.generated';
 
 const HASH_KEY_TYPE = 'HASH';
@@ -57,6 +57,12 @@ export interface TableProps {
    */
   streamSpecification?: StreamViewType;
 
+  /**
+   * The AWS resource tags to associate with the table.
+   * @default undefined
+   */
+  tags?: Tags;
+
   /**
    * The name of TTL attribute.
    * @default undefined, TTL is disabled
@@ -202,6 +208,7 @@ export class Table extends Construct {
       provisionedThroughput: { readCapacityUnits: props.readCapacity || 5, writeCapacityUnits: props.writeCapacity || 5 },
       sseSpecification: props.sseEnabled ? { sseEnabled: props.sseEnabled } : undefined,
       streamSpecification: props.streamSpecification ? { streamViewType: props.streamSpecification } : undefined,
+      tags: new TagManager(this, { initialTags: props.tags }),
       timeToLiveSpecification: props.ttlAttributeName ? { attributeName: props.ttlAttributeName, enabled: true } : undefined
     });
 

diff --git a/packages/@aws-cdk/aws-dynamodb/test/integ.dynamodb.expected.json b/packages/@aws-cdk/aws-dynamodb/test/integ.dynamodb.expected.json
@@ -20,7 +20,8 @@
           }
         ],
         "GlobalSecondaryIndexes": [],
-        "LocalSecondaryIndexes": []
+        "LocalSecondaryIndexes": [],
+        "Tags": []
       }
     },
     "TableWithGlobalAndLocalSecondaryIndexBC540710": {
@@ -259,6 +260,12 @@
         "StreamSpecification": {
           "StreamViewType": "KEYS_ONLY"
         },
+        "Tags": [
+          {
+            "Key": "Environment",
+            "Value": "Production"
+          }
+        ],
         "TimeToLiveSpecification": {
           "AttributeName": "timeToLive",
           "Enabled": true
@@ -306,7 +313,8 @@
             }
           }
         ],
-        "LocalSecondaryIndexes": []
+        "LocalSecondaryIndexes": [],
+        "Tags": []
       }
     },
     "TableWithLocalSecondaryIndex4DA3D08F": {
@@ -358,7 +366,8 @@
               "ProjectionType": "ALL"
             }
           }
-        ]
+        ],
+        "Tags": []
       }
     }
   }

diff --git a/packages/@aws-cdk/aws-dynamodb/test/integ.dynamodb.ts b/packages/@aws-cdk/aws-dynamodb/test/integ.dynamodb.ts
@@ -47,6 +47,7 @@ const tableWithGlobalAndLocalSecondaryIndex = new Table(stack, TABLE_WITH_GLOBAL
   pitrEnabled: true,
   sseEnabled: true,
   streamSpecification: StreamViewType.KeysOnly,
+  tags: { Environment: 'Production' },
   ttlAttributeName: 'timeToLive'
 });
 

diff --git a/packages/@aws-cdk/aws-dynamodb/test/test.dynamodb.ts b/packages/@aws-cdk/aws-dynamodb/test/test.dynamodb.ts
@@ -83,7 +83,8 @@ export = {
               KeySchema: [{ AttributeName: 'hashKey', KeyType: 'HASH' }],
               ProvisionedThroughput: { ReadCapacityUnits: 5, WriteCapacityUnits: 5 },
               GlobalSecondaryIndexes: [],
-              LocalSecondaryIndexes: []
+              LocalSecondaryIndexes: [],
+              Tags: []
             }
           }
         }
@@ -114,7 +115,8 @@ export = {
               ],
               ProvisionedThroughput: { ReadCapacityUnits: 5, WriteCapacityUnits: 5 },
               GlobalSecondaryIndexes: [],
-              LocalSecondaryIndexes: []
+              LocalSecondaryIndexes: [],
+              Tags: []
             }
           }
         }
@@ -145,7 +147,8 @@ export = {
               ],
               ProvisionedThroughput: { ReadCapacityUnits: 5, WriteCapacityUnits: 5 },
               GlobalSecondaryIndexes: [],
-              LocalSecondaryIndexes: []
+              LocalSecondaryIndexes: [],
+              Tags: []
             }
           }
         }
@@ -176,7 +179,8 @@ export = {
               ],
               ProvisionedThroughput: { ReadCapacityUnits: 5, WriteCapacityUnits: 5 },
               GlobalSecondaryIndexes: [],
-              LocalSecondaryIndexes: []
+              LocalSecondaryIndexes: [],
+              Tags: []
             }
           }
         }
@@ -207,7 +211,8 @@ export = {
               ],
               ProvisionedThroughput: { ReadCapacityUnits: 5, WriteCapacityUnits: 5 },
               GlobalSecondaryIndexes: [],
-              LocalSecondaryIndexes: []
+              LocalSecondaryIndexes: [],
+              Tags: []
             }
           }
         }
@@ -238,7 +243,8 @@ export = {
               ],
               ProvisionedThroughput: { ReadCapacityUnits: 5, WriteCapacityUnits: 5 },
               GlobalSecondaryIndexes: [],
-              LocalSecondaryIndexes: []
+              LocalSecondaryIndexes: [],
+              Tags: []
             }
           }
         }
@@ -276,7 +282,8 @@ export = {
               ProvisionedThroughput: { ReadCapacityUnits: 42, WriteCapacityUnits: 1337 },
               GlobalSecondaryIndexes: [],
               LocalSecondaryIndexes: [],
-              TableName: 'MyTable'
+              TableName: 'MyTable',
+              Tags: []
             }
           }
         }
@@ -314,7 +321,8 @@ export = {
                 { AttributeName: 'sortKey', AttributeType: 'N' }
               ],
               StreamSpecification: { StreamViewType: 'NEW_IMAGE' },
-              TableName: 'MyTable'
+              TableName: 'MyTable',
+              Tags: []
             }
           }
         }
@@ -352,7 +360,8 @@ export = {
                 { AttributeName: 'sortKey', AttributeType: 'N' }
               ],
               StreamSpecification: { StreamViewType: 'OLD_IMAGE' },
-              TableName: 'MyTable'
+              TableName: 'MyTable',
+              Tags: []
             }
           }
         }
@@ -371,6 +380,7 @@ export = {
       pitrEnabled: true,
       sseEnabled: true,
       streamSpecification: StreamViewType.KeysOnly,
+      tags: { Environment: 'Production' },
       ttlAttributeName: 'timeToLive'
     });
     table.addPartitionKey(TABLE_PARTITION_KEY);
@@ -400,6 +410,7 @@ export = {
             SSESpecification: { SSEEnabled: true },
             StreamSpecification: { StreamViewType: 'KEYS_ONLY' },
             TableName: 'MyTable',
+            Tags: [ { Key: 'Environment', Value: 'Production' } ],
             TimeToLiveSpecification: { AttributeName: 'timeToLive', Enabled: true }
           }
         }
@@ -448,6 +459,7 @@ export = {
               }
             ],
             LocalSecondaryIndexes: [],
+            Tags: []
           }
         }
       }
@@ -499,6 +511,7 @@ export = {
               }
             ],
             LocalSecondaryIndexes: [],
+            Tags: []
           }
         }
       }
@@ -548,6 +561,7 @@ export = {
               }
             ],
             LocalSecondaryIndexes: [],
+            Tags: []
           }
         }
       }
@@ -601,6 +615,7 @@ export = {
               }
             ],
             LocalSecondaryIndexes: [],
+            Tags: []
           }
         }
       }
@@ -771,6 +786,7 @@ export = {
               },
             ],
             LocalSecondaryIndexes: [],
+            Tags: []
           }
         }
       }
@@ -832,6 +848,7 @@ export = {
               }
             ],
             LocalSecondaryIndexes: [],
+            Tags: []
           }
         }
       }
@@ -877,6 +894,7 @@ export = {
                 Projection: { ProjectionType: 'ALL' },
               }
             ],
+            Tags: []
           }
         }
       }
@@ -923,6 +941,7 @@ export = {
                 Projection: { ProjectionType: 'KEYS_ONLY' },
               }
             ],
+            Tags: []
           }
         }
       }
@@ -972,6 +991,7 @@ export = {
                 Projection: { NonKeyAttributes: ['lsiNonKey0', 'lsiNonKey1'], ProjectionType: 'INCLUDE' },
               }
             ],
+            Tags: []
           }
         }
       }
@@ -1076,7 +1096,8 @@ export = {
           AttributeDefinitions:
            [ { AttributeName: 'hashKey', AttributeType: 'S' },
              { AttributeName: 'sortKey', AttributeType: 'N' } ],
-          TableName: 'MyTable' } },
+          TableName: 'MyTable',
+          Tags: [] } },
         MyTableReadAutoScalingRoleFEE68E49:
          { Type: 'AWS::IAM::Role',
          Properties:
@@ -1158,7 +1179,8 @@ export = {
           AttributeDefinitions:
            [ { AttributeName: 'hashKey', AttributeType: 'S' },
              { AttributeName: 'sortKey', AttributeType: 'N' } ],
-          TableName: 'MyTable' } },
+          TableName: 'MyTable',
+          Tags: [] } },
         MyTableReadAutoScalingRoleFEE68E49:
          { Type: 'AWS::IAM::Role',
          Properties:
@@ -1268,7 +1290,8 @@ export = {
           AttributeDefinitions:
            [ { AttributeName: 'hashKey', AttributeType: 'S' },
              { AttributeName: 'sortKey', AttributeType: 'N' } ],
-          TableName: 'MyTable' } },
+          TableName: 'MyTable',
+          Tags: [] } },
         MyTableReadAutoScalingRoleFEE68E49:
          { Type: 'AWS::IAM::Role',
          Properties:
@@ -1346,6 +1369,7 @@ export = {
           ProvisionedThroughput: { ReadCapacityUnits: 42, WriteCapacityUnits: 1337 },
           GlobalSecondaryIndexes: [],
           LocalSecondaryIndexes: [],
+          Tags: [],
           AttributeDefinitions:
            [ { AttributeName: 'hashKey', AttributeType: 'S' },
              { AttributeName: 'sortKey', AttributeType: 'N' } ] } },
@@ -1553,7 +1577,8 @@ export = {
           AttributeDefinitions:
            [ { AttributeName: 'hashKey', AttributeType: 'S' },
              { AttributeName: 'sortKey', AttributeType: 'N' } ],
-          TableName: 'MyTable' } },
+          TableName: 'MyTable',
+          Tags: [] } },
         MyTableWriteAutoScalingRoleDF7775DE:
          { Type: 'AWS::IAM::Role',
          Properties:
@@ -1635,7 +1660,8 @@ export = {
           AttributeDefinitions:
            [ { AttributeName: 'hashKey', AttributeType: 'S' },
              { AttributeName: 'sortKey', AttributeType: 'N' } ],
-          TableName: 'MyTable' } },
+          TableName: 'MyTable',
+          Tags: [] } },
         MyTableWriteAutoScalingRoleDF7775DE:
          { Type: 'AWS::IAM::Role',
          Properties:
@@ -1745,7 +1771,8 @@ export = {
           AttributeDefinitions:
            [ { AttributeName: 'hashKey', AttributeType: 'S' },
              { AttributeName: 'sortKey', AttributeType: 'N' } ],
-          TableName: 'MyTable' } },
+          TableName: 'MyTable',
+          Tags: [] } },
         MyTableWriteAutoScalingRoleDF7775DE:
          { Type: 'AWS::IAM::Role',
          Properties:
@@ -1823,6 +1850,7 @@ export = {
           ProvisionedThroughput: { ReadCapacityUnits: 42, WriteCapacityUnits: 1337 },
           GlobalSecondaryIndexes: [],
           LocalSecondaryIndexes:  [],
+          Tags: [],
           AttributeDefinitions:
            [ { AttributeName: 'hashKey', AttributeType: 'S' },
              { AttributeName: 'sortKey', AttributeType: 'N' } ] } },