-
Notifications
You must be signed in to change notification settings - Fork 0
/
module.yml
385 lines (385 loc) · 14.6 KB
/
module.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
---
# Copyright 2018 widdix GmbH
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
AWSTemplateFormatVersion: '2010-09-09'
Description: 'cfn-modules: AWS DynamoDB table'
# cfn-modules:implements(ExposeArn, ExposeName, LambdaDependency)
Parameters:
AlertingModule:
Description: 'Optional but recommended stack name of alerting module.'
Type: String
Default: ''
KmsKeyModule:
Description: 'Optional but recommended stack name of kms-key module.'
Type: String
Default: ''
TableName:
Description: 'Optional name of the table (auto generated if not set).'
Type: String
Default: ''
PartitionKeyName:
Description: 'Name of the partition key.'
Type: String
Default: id
PartitionKeyType:
Description: 'Type of the partition key.'
Type: String
Default: S
AllowedValues: [S, N, B]
SortKeyName:
Description: 'Optional name of the sort key.'
Type: String
Default: ''
SortKeyType:
Description: 'Type of the sort key (if SortKeyName is set).'
Type: String
Default: N
AllowedValues: [S, N, B]
BillingAndScalingMode:
Description: 'Specify how you are charged for read and write throughput and how you manage capacity.'
Type: String
Default: PROVISIONED
AllowedValues: [PROVISIONED, ONDEMAND]
MaxWriteCapacityUnits:
Description: 'Maximum write capacity units used during auto scaling (ignored when BillingAndScalingMode := ONDEMAND).'
Type: Number
Default: 1
MinWriteCapacityUnits:
Description: 'Minimum write capacity units used during auto scaling (ignored when BillingAndScalingMode := ONDEMAND).'
Type: Number
Default: 1
WriteCapacityUnitsUtilizationTarget:
Description: 'Target write capacity utilization (in percent) that auto scaling tries to achieve (if you have spiky writes, a lower number is better; ignored when BillingAndScalingMode := ONDEMAND).'
Type: Number
Default: 80
MaxReadCapacityUnits:
Description: 'Maximum read capacity units used during auto scaling (ignored when BillingAndScalingMode := ONDEMAND).'
Type: Number
Default: 1
MinReadCapacityUnits:
Description: 'Minimum read capacity units used during auto scaling (ignored when BillingAndScalingMode := ONDEMAND).'
Type: Number
Default: 1
ReadCapacityUnitsUtilizationTarget:
Description: 'Target read capacity utilization (in percent) that auto scaling tries to achieve (if you have spiky reads, a lower number is better; ignored when BillingAndScalingMode := ONDEMAND).'
Type: Number
Default: 80
Encryption:
Description: 'Deprecated in v1, will be removed in v3, use KmsKeyModule instead! Enable server side encryption using KMS (AWS managed) CMK.'
Type: String
Default: false
AllowedValues: [aws, false]
StreamViewType:
Description: 'Determines the information that the stream captures when an item in the table is modified.'
Type: String
Default: DISABLED
AllowedValues: [DISABLED, KEYS_ONLY, NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES]
TtlAttributeName:
Description: 'Optional name of the TTL attribute that stores the expiration time for items in the table. The name can be 1–255 characters long, and has no character restrictions. (TTL is disabled if not set)'
Type: String
Default: ''
BackupRetentionPeriod:
Description: 'The number of days to keep backups of the table (set to 0 to disable).'
Type: Number
MinValue: 0
MaxValue: 35
Default: 30
BackupScheduleExpression:
Description: 'A CRON expression specifying when AWS Backup initiates a backup job.'
Type: String
Default: 'cron(0 5 ? * * *)'
PointInTimeRecoveryEnabled:
Description: 'Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.'
Type: String
Default: true
AllowedValues: [true, false]
Conditions:
HasAlertingModule: !Not [!Equals [!Ref AlertingModule, '']]
HasKmsKeyModule: !Not [!Equals [!Ref KmsKeyModule, '']]
HasSortKey: !Not [!Equals [!Ref SortKeyName, '']]
HasTableName: !Not [!Equals [!Ref TableName, '']]
HasAwsManagedEncryption: !Equals [!Ref Encryption, aws]
HasStream: !Not [!Equals [!Ref StreamViewType, 'DISABLED']]
HasBillingAndScalingModeProvisioned: !Equals [!Ref BillingAndScalingMode, PROVISIONED]
HasTtlAttributeName: !Not [!Equals [!Ref TtlAttributeName, '']]
HasBackupRetentionPeriod: !Not [!Equals [!Ref BackupRetentionPeriod, 0]]
Resources:
Table:
Type: 'AWS::DynamoDB::Table'
Properties:
AttributeDefinitions: !If
- HasSortKey
- - AttributeName: !Ref PartitionKeyName
AttributeType: !Ref PartitionKeyType
- AttributeName: !Ref SortKeyName
AttributeType: !Ref SortKeyType
- - AttributeName: !Ref PartitionKeyName
AttributeType: !Ref PartitionKeyType
BillingMode: !If [HasBillingAndScalingModeProvisioned, PROVISIONED, PAY_PER_REQUEST]
KeySchema: !If
- HasSortKey
- - AttributeName: !Ref PartitionKeyName
KeyType: HASH
- AttributeName: !Ref SortKeyName
KeyType: RANGE
- - AttributeName: !Ref PartitionKeyName
KeyType: HASH
PointInTimeRecoverySpecification:
PointInTimeRecoveryEnabled: !Ref PointInTimeRecoveryEnabled
ProvisionedThroughput: !If [HasBillingAndScalingModeProvisioned, {ReadCapacityUnits: !Ref MinReadCapacityUnits, WriteCapacityUnits: !Ref MinWriteCapacityUnits}, !Ref 'AWS::NoValue']
SSESpecification:
KMSMasterKeyId: !If [HasKmsKeyModule, {'Fn::ImportValue': !Sub '${KmsKeyModule}-Arn'}, !Ref 'AWS::NoValue']
SSEEnabled: !If [HasKmsKeyModule, true, !If [HasAwsManagedEncryption, true, false]]
SSEType: !If [HasKmsKeyModule, KMS, !If [HasAwsManagedEncryption, KMS, !Ref 'AWS::NoValue']]
StreamSpecification: !If [HasStream, {StreamViewType: !Ref StreamViewType}, !Ref 'AWS::NoValue']
TableName: !If [HasTableName, !Ref TableName, !Ref 'AWS::NoValue']
TimeToLiveSpecification: !If [HasTtlAttributeName, {AttributeName: !Ref TtlAttributeName, Enabled: true}, !Ref 'AWS::NoValue']
RoleScaling:
Condition: HasBillingAndScalingModeProvisioned
Type: 'AWS::IAM::Role'
Properties:
AssumeRolePolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Principal:
Service: 'application-autoscaling.amazonaws.com'
Action: 'sts:AssumeRole'
Policies:
- PolicyName: scaling
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- 'dynamodb:DescribeTable'
- 'dynamodb:UpdateTable'
- 'cloudwatch:PutMetricAlarm'
- 'cloudwatch:DescribeAlarms'
- 'cloudwatch:GetMetricStatistics'
- 'cloudwatch:SetAlarmState'
- 'cloudwatch:DeleteAlarms'
Resource: '*'
WriteScalableTarget:
Condition: HasBillingAndScalingModeProvisioned
Type: 'AWS::ApplicationAutoScaling::ScalableTarget'
Properties:
MaxCapacity: !Ref MaxWriteCapacityUnits
MinCapacity: !Ref MinWriteCapacityUnits
ResourceId: !Sub 'table/${Table}'
RoleARN: !GetAtt 'RoleScaling.Arn'
ScalableDimension: 'dynamodb:table:WriteCapacityUnits'
ServiceNamespace: dynamodb
ReadScalableTarget:
Condition: HasBillingAndScalingModeProvisioned
Type: 'AWS::ApplicationAutoScaling::ScalableTarget'
Properties:
MaxCapacity: !Ref MaxReadCapacityUnits
MinCapacity: !Ref MinReadCapacityUnits
ResourceId: !Sub 'table/${Table}'
RoleARN: !GetAtt 'RoleScaling.Arn'
ScalableDimension: 'dynamodb:table:ReadCapacityUnits'
ServiceNamespace: dynamodb
WriteScalingPolicy:
Condition: HasBillingAndScalingModeProvisioned
Type: 'AWS::ApplicationAutoScaling::ScalingPolicy'
Properties:
PolicyName: !Sub '${Table}-WriteScalingPolicy'
PolicyType: TargetTrackingScaling
ScalingTargetId: !Ref WriteScalableTarget
TargetTrackingScalingPolicyConfiguration:
TargetValue: !Ref WriteCapacityUnitsUtilizationTarget
ScaleInCooldown: 600
ScaleOutCooldown: 60
PredefinedMetricSpecification:
PredefinedMetricType: DynamoDBWriteCapacityUtilization
ReadScalingPolicy:
Condition: HasBillingAndScalingModeProvisioned
Type: 'AWS::ApplicationAutoScaling::ScalingPolicy'
Properties:
PolicyName: !Sub '${Table}-ReadScalingPolicy'
PolicyType: TargetTrackingScaling
ScalingTargetId: !Ref ReadScalableTarget
TargetTrackingScalingPolicyConfiguration:
TargetValue: !Ref ReadCapacityUnitsUtilizationTarget
ScaleInCooldown: 600
ScaleOutCooldown: 60
PredefinedMetricSpecification:
PredefinedMetricType: DynamoDBReadCapacityUtilization
ReadThrottleEventsAlarm:
Condition: HasAlertingModule
Type: 'AWS::CloudWatch::Alarm'
Properties:
AlarmDescription: 'Reads are throttled. Lower ReadCapacityUnitsUtilizationTarget or increase MaxReadCapacityUnits.'
Namespace: 'AWS/DynamoDB'
MetricName: ReadThrottleEvents
Dimensions:
- Name: TableName
Value: !Ref Table
Statistic: Sum
Period: 60
EvaluationPeriods: 1
Threshold: 1
ComparisonOperator: GreaterThanOrEqualToThreshold
AlarmActions:
- 'Fn::ImportValue': !Sub '${AlertingModule}-Arn'
OKActions:
- 'Fn::ImportValue': !Sub '${AlertingModule}-Arn'
TreatMissingData: notBreaching
WriteThrottleEventsAlarm:
Condition: HasAlertingModule
Type: 'AWS::CloudWatch::Alarm'
Properties:
AlarmDescription: 'Writes are throttled. Lower WriteCapacityUnitsUtilizationTarget or increase MaxWriteCapacityUnits.'
Namespace: 'AWS/DynamoDB'
MetricName: WriteThrottleEvents
Dimensions:
- Name: TableName
Value: !Ref Table
Statistic: Sum
Period: 60
EvaluationPeriods: 1
Threshold: 1
ComparisonOperator: GreaterThanOrEqualToThreshold
AlarmActions:
- 'Fn::ImportValue': !Sub '${AlertingModule}-Arn'
OKActions:
- 'Fn::ImportValue': !Sub '${AlertingModule}-Arn'
TreatMissingData: notBreaching
UserErrorsAlarm:
Condition: HasAlertingModule
Type: 'AWS::CloudWatch::Alarm'
Properties:
AlarmDescription: 'User errors'
Namespace: 'AWS/DynamoDB'
MetricName: UserErrors
Dimensions:
- Name: TableName
Value: !Ref Table
Statistic: Sum
Period: 60
EvaluationPeriods: 1
Threshold: 1
ComparisonOperator: GreaterThanOrEqualToThreshold
AlarmActions:
- 'Fn::ImportValue': !Sub '${AlertingModule}-Arn'
OKActions:
- 'Fn::ImportValue': !Sub '${AlertingModule}-Arn'
TreatMissingData: notBreaching
SystemErrorsAlarm:
Condition: HasAlertingModule
Type: 'AWS::CloudWatch::Alarm'
Properties:
AlarmDescription: 'System errors'
Namespace: 'AWS/DynamoDB'
MetricName: SystemErrors
Dimensions:
- Name: TableName
Value: !Ref Table
Statistic: Sum
Period: 60
EvaluationPeriods: 1
Threshold: 1
ComparisonOperator: GreaterThanOrEqualToThreshold
AlarmActions:
- 'Fn::ImportValue': !Sub '${AlertingModule}-Arn'
OKActions:
- 'Fn::ImportValue': !Sub '${AlertingModule}-Arn'
TreatMissingData: notBreaching
BackupVault: # cannot be deleted with data
Condition: HasBackupRetentionPeriod
Type: 'AWS::Backup::BackupVault'
Properties:
BackupVaultName: !Ref 'AWS::StackName'
Notifications: !If [HasAlertingModule, {BackupVaultEvents: [BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RECOVERY_POINT_MODIFIED], SNSTopicArn: {'Fn::ImportValue': !Sub '${AlertingModule}-Arn'}}, !Ref 'AWS::NoValue']
BackupPlan:
Condition: HasBackupRetentionPeriod
Type: 'AWS::Backup::BackupPlan'
Properties:
BackupPlan:
BackupPlanName: !Ref 'AWS::StackName'
BackupPlanRule:
- CompletionWindowMinutes: 1440
Lifecycle:
DeleteAfterDays: !Ref BackupRetentionPeriod
RuleName: !Ref 'AWS::StackName'
ScheduleExpression: !Ref BackupScheduleExpression
StartWindowMinutes: 60
TargetBackupVault: !Ref BackupVault
BackupRole:
Condition: HasBackupRetentionPeriod
Type: 'AWS::IAM::Role'
Properties:
AssumeRolePolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Principal:
Service: 'backup.amazonaws.com'
Action: 'sts:AssumeRole'
Policies:
- PolicyName: backup # https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- 'dynamodb:DescribeTable'
- 'dynamodb:CreateBackup'
- 'dynamodb:ListTagsOfResource'
- 'dynamodb:StartAwsBackupJob'
Resource: !GetAtt 'Table.Arn'
- Effect: Allow
Action:
- 'dynamodb:DescribeBackup'
- 'dynamodb:DeleteBackup'
Resource: !Sub '${Table.Arn}/backup/*'
BackupSelection:
Condition: HasBackupRetentionPeriod
Type: 'AWS::Backup::BackupSelection'
Properties:
BackupPlanId: !Ref BackupPlan
BackupSelection:
IamRoleArn: !GetAtt 'BackupRole.Arn'
Resources:
- !GetAtt 'Table.Arn'
SelectionName: !Ref 'AWS::StackName'
Outputs:
ModuleId:
Value: 'dynamodb-table'
ModuleVersion:
Value: '1.6.1'
StackName:
Value: !Ref 'AWS::StackName'
Arn:
Value: !GetAtt Table.Arn
Export:
Name: !Sub '${AWS::StackName}-Arn'
IamActions:
Value: 'dynamodb:Batch*Item,dynamodb:DeleteItem,dynamodb:GetItem,dynamodb:PutItem,dynamodb:Query,dynamodb:Scan,dynamodb:UpdateItem'
Export:
Name: !Sub '${AWS::StackName}-IamActions'
IamResources:
Value: !GetAtt Table.Arn
Export:
Name: !Sub '${AWS::StackName}-IamResources'
Name:
Value: !Ref Table
Export:
Name: !Sub '${AWS::StackName}-Name'
StreamArn:
Condition: HasStream
Value: !GetAtt 'Table.StreamArn'
Export:
Name: !Sub '${AWS::StackName}-StreamArn'