forked from Harvard-University-iCommons/canvas-data-2-aws
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtemplate.yaml
More file actions
1855 lines (1752 loc) · 70 KB
/
template.yaml
File metadata and controls
1855 lines (1752 loc) · 70 KB
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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
AWSTemplateFormatVersion: '2010-09-09'
Transform:
- AWS::Serverless-2016-10-31
Description: >
canvas-data-2
This template contains infrastructure for maintaining a Postgresql database containing
data sourced from Canvas Data 2. It uses the higher-level `dap` functionality from
instructure to maintain the local tables.
A Step Function is used to orchestrate the synchronization operations.
Parameters:
EnvironmentParameter:
Type: String
Description: Name of the environment. Allowed values are dev, stg, prod.
AllowedValues:
- "dev"
- "stg"
- "prod"
Default: "dev"
LogLevel:
Type: String
Description: Logging level. Allowed values are DEBUG, INFO, WARN, ERROR.
AllowedValues:
- 'DEBUG'
- 'INFO'
- 'WARN'
- 'ERROR'
Default: INFO
SkipTablesParameter:
Type: String
Description: List of Canvas Data 2 tables not to initialize/sync. Leave empty to load all tables.
VpcIdParameter:
Type: AWS::EC2::VPC::Id
Description: The ID of the VPC to deploy the database and Lambda functions into.
LambdaSubnetListParameter:
Type: List<AWS::EC2::Subnet::Id>
Description: The list of one or more subnets to deploy the Lambda functions into.
DatabaseSubnetListParameter:
Type: List<AWS::EC2::Subnet::Id>
Description: The list of one or more subnets to deploy the database into.
SsmPathParameter:
Type: String
Description: Path to DAP client ID and secret.
Default: canvas_data_2
DatabaseAdminUserParameter:
Type: String
Description: Username for the admin database user.
DatabaseCd2UserParameter:
Type: String
Description: Username for the canvas database user.
DatabaseMinCapacityParameter:
Type: Number
Description: Serverless Aurora minimum capacity.
Default: 0.5
DatabaseMaxCapacityParameter:
Type: Number
Description: Serverless Aurora maximum capacity.
Default: 4
# Task sizing:
# https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size
TaskCpuParameter:
Type: Number
Description: CPUs allocted to Fargate tasks.
Default: 1024
TaskMemoryParameter:
Type: Number
Description: Memory allocated to Fargate tasks (MB).
Default: 8192
TaskStorageParameter:
Type: Number
Description: Ephemeral storage allocated to Fargate tasks (GB).
Default: 80
ResourcePrefixParameter:
Type: String
Description: Prefix for resource names.
TagNameParameter:
Type: String
Description: Cost tag name.
TagValueParameter:
Type: String
Description: Cost tag value.
EcrAccountNumberParameter:
Type: String
Description: AWS Account ID for an ECR repository.
LogRetentionParameter:
Type: Number
Description: Number of days to retain logs.
Default: 90
YourRoleArnParameter:
Type: String
Description: The ARN for the IAM role creating/updating this stack.
DatabaseClusterArnParameter:
Type: String
Description: (Optional) An existing Aurora database cluster ARN. Leave empty to create a new Aurora database cluster.
Default: ''
# Default value is an ARN because it's referenced in the stack within a conditional statement.
# It must resolve as an ARN for the template to be valid.
DatabaseAdminSecretArnParameter:
Type: String
Description: (Optional) An existing database admin secret ARN. Use default value if DatabaseClusterArnParameter is empty.
Default: arn:aws:secretsmanager:region:123456789123:secret:placeholder
DatabaseSecurityGroupParameter:
Type: String
Description: (Optional) A security group ID for the database. Leave empty to create a new security group.
Default: ''
DatabaseClientSecurityGroupParameter:
Type: String
Description: (Optional) A security group ID for the DatabaseClient. Leave empty to create a new security group.
Default: ''
ListTablesFunctionSecurityGroupParameter:
Type: String
Description: (Optional) A security group ID for the ListTables Lambda function. Leave empty to create a new security group.
Default: ''
AthenaConnectorParameter:
Type: String
Description: (Optional) Create an Athena connector for PostgreSQL. Default is false. Must be false when values are set for DatabaseAdminSecretArnParameter and DatabaseSecurityGroupParameter.
AllowedValues: [true, false]
Default: false
AthenaConnectorLambdaNameParameter:
Type: String
Description: (Optional) Name of Athena Connector Lambda. Unused if AthenaConnectorParameter is set to false.
Default: athena_postgresql_connector_cd2
NotificationTopicParameter:
Type: String
Description: (Optional) SNS topic to send notifications. Leave empty to create a new topic.
Default: ''
FalconSensorParameter:
Type: String
Description: (Optional) Configure CrowdStrike Falcon container sensor. Default is false.
AllowedValues: [true, false]
Default: false
FalconSensorRepoParameter:
Type: String
Description: (Optional) Repo for CrowdStrike Falcon container sensor image. Leave empty if FalconSensorParameter is false.
Default: ''
FalconSensorOptionsParameter:
Type: String
Description: (Optional) SSM Parameter Store key for Falcon sensor options. Leave empty if FalconSensorParameter is false.
Default: ''
SlackWebHookURLSecretNameParameter:
Type: String
Description: The secret name for Slack Incoming Webhook URL for the notification
Default: ''
SecretsKmsKeyIDParameter:
Type: String
Description: (Optional) The key ID for existing SecretsKmsKey. Leave empty to create a new KMS key.
Default: ''
DataKmsKeyIDParameter:
Type: String
Description: (Optional) The Key ID for DataKmsKey. Leave empty to create a new KMS key.
Default: ''
MainCD2StackNameParameter:
Type: String
Description: (Optional) The Cloudformation stack name of the main Canvas Data 2 Stack.
Default: 'ubcla-canvas-data-2'
NamespaceImportListParameter:
Type: String
Description: Comma delimited string to list Canvas namespaces to import
Default: "canvas"
Conditions:
# Conditions for Bring Your Own Aurora Database Cluster
# Requires both DatabaseClusterArnParameter and DatabaseAdminSecretArnParameter to be specified
ExistingDatabase: !Not [!Equals [!Ref DatabaseClusterArnParameter, '']]
ExistingDatabaseAdminSecret: !Not [!Equals [!Ref DatabaseAdminSecretArnParameter, 'arn:aws:secretsmanager:region:123456789123:secret:placeholder']]
CreateDatabase: !Not
- !Or
- Condition: ExistingDatabase
- Condition: ExistingDatabaseAdminSecret
# Conditions for Bring Your Own Data Security Group
ExistingDatabaseSecurityGroup: !Not [!Equals [!Ref DatabaseSecurityGroupParameter, '']]
CreateDatabaseSecurityGroup: !Equals [!Ref DatabaseSecurityGroupParameter, '']
# Conditions for Bring Your Own Database Client Security Group
ExistingDatabaseClientSecurityGroup: !Not [!Equals [!Ref DatabaseClientSecurityGroupParameter, '']]
CreateDatabaseClientSecurityGroup: !Equals [!Ref DatabaseClientSecurityGroupParameter, '']
# Conditions for Bring Your Own ListTables Lambda Function Security Group
ExistingListTablesFunctionSecurityGroup: !Not [!Equals [!Ref ListTablesFunctionSecurityGroupParameter, '']]
CreateListTablesFunctionSecurityGroup: !Equals [!Ref ListTablesFunctionSecurityGroupParameter, '']
# Conditions for Bring Your Own Notification Topic
ExistingNotificationTopic: !Not [!Equals [!Ref NotificationTopicParameter, '']]
CreateNotificationTopic: !Equals [!Ref NotificationTopicParameter, '']
# Condition for optional CrowdStrike Falcon sensor
# Configures an additional container task that injects the Falcon sensor into Fargate tasks
# For more info: https://github.com/CrowdStrike/Container-Security/blob/0d2ae005be852aae403df3feb11e3bf2fd1f5258/aws-ecs/ecs-fargate-guide.md
ConfigureFalconSensor: !Equals [true, !Ref FalconSensorParameter]
# Conditions for optional Athena connector
# Creates an Athena data source allowing CD2 data to be joined with other data sources
# Requires CreateDatabase condition to be true to ensure cluster endpoint and port exist
AthenaConnector: !Equals [true, !Ref AthenaConnectorParameter]
CreatePrimaryCanvasAthenaConnector: !And
- Condition: AthenaConnector
- Condition: CreateDatabase
IsCatalogNamespaceIncluded: !Or
- !Equals [ !Ref NamespaceImportListParameter, "catalog" ]
- !Equals [ !Ref NamespaceImportListParameter, "canvas,catalog" ]
- !Equals [ !Ref NamespaceImportListParameter, "catalog,canvas" ]
CreateAdditionalPrimaryCanvasAthenaConnector: !And
- Condition: ExistingDatabase
- Condition: AthenaConnector
CreateAthenaConnector: !Or
- Condition: CreatePrimaryCanvasAthenaConnector
- Condition: CreateAdditionalPrimaryCanvasAthenaConnector
CreateCatalogAthenaConnector: !And
- Condition: ExistingDatabase
- Condition: IsCatalogNamespaceIncluded
Resources:
SecretsKmsKey:
Type: AWS::KMS::Key
Condition: CreateDatabase
Properties:
Description: Key for encrypting Canvas Data 2 secrets
Enabled: true
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
SecretsKeyAlias:
Type: AWS::KMS::Alias
Condition: CreateDatabase
Properties:
AliasName: !Sub alias/${AWS::StackName}-cd2-secrets
TargetKeyId: !Ref SecretsKmsKey
DataKmsKey:
Type: AWS::KMS::Key
Condition: CreateDatabase
Properties:
Description: Key for encrypting Canvas Data 2 data
Enabled: true
KeyPolicy:
Version: '2012-10-17'
Statement:
- Sid: Allow root account admistration of key
Effect: Allow
Principal:
AWS: !Sub arn:aws:iam::${AWS::AccountId}:root
Action: kms:*
Resource: '*'
- Sid: Allow generate data key access for Fargate tasks.
Effect: Allow
Principal:
Service: fargate.amazonaws.com
Action:
- kms:GenerateDataKeyWithoutPlaintext
Condition:
StringEquals:
"kms:EncryptionContext:aws:ecs:clusterAccount":
- !Sub ${AWS::AccountId}
ForAnyValue:StringEquals:
"kms:EncryptionContext:aws:ecs:clusterName":
- !Sub ${AWS::StackName}-cd2-cluster
- !Sub ${AWS::StackName}-catalog-cd2-cluster
Resource: '*'
- Sid: Allow grant creation permission for Fargate tasks.
Effect: Allow
Principal:
Service: fargate.amazonaws.com
Action:
- kms:CreateGrant
Condition:
StringEquals:
"kms:EncryptionContext:aws:ecs:clusterAccount":
- !Sub ${AWS::AccountId}
ForAnyValue:StringEquals:
"kms:EncryptionContext:aws:ecs:clusterName":
- !Sub ${AWS::StackName}-cd2-cluster
- !Sub ${AWS::StackName}-catalog-cd2-cluster
ForAllValues:StringEquals:
"kms:GrantOperations":
- "Decrypt"
Resource: '*'
- Sid: Allow describe key permission for cluster operator - CreateCluster and UpdateCluster.
Effect: Allow
Principal:
AWS: !Ref YourRoleArnParameter
Action:
- kms:DescribeKey
Resource: '*'
- Sid: Allow RDS to use the key to encrypt the cluster
Effect: Allow
Principal:
Service: rds.amazonaws.com
Action:
- kms:Encrypt
- kms:Decrypt
- kms:ReEncrypt*
- kms:GenerateDataKey*
- kms:DescribeKey
Resource: '*'
# Removing condition to avoid circular dependency
# Condition:
# StringEquals:
# "rds:db-cluster-id": !Sub ${AuroraDatabaseCluster}
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
DataKeyAlias:
Type: AWS::KMS::Alias
Condition: CreateDatabase
Properties:
AliasName: !Sub alias/${AWS::StackName}-cd2-data
TargetKeyId: !Ref DataKmsKey
# Create a secret for the CD2 app "canvas" user
DatabaseUserSecretCanvas:
Type: AWS::SecretsManager::Secret
Properties:
Name: !Sub ${AWS::StackName}-cd2-db-user-${EnvironmentParameter}-${DatabaseCd2UserParameter}
Description: Database user for Canvas Data 2 canvas user
GenerateSecretString:
SecretStringTemplate: !Sub '{"username": "${DatabaseCd2UserParameter}"}'
GenerateStringKey: password
PasswordLength: 24
ExcludePunctuation: true
KmsKeyId: !If [CreateDatabase, !Ref SecretsKmsKey, !Ref SecretsKmsKeyIDParameter]
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
# Attach Canvas database user Secret to the cluster
DatabaseUserSecretAttachmentCanvas:
Type: AWS::SecretsManager::SecretTargetAttachment
Properties:
SecretId: !Ref DatabaseUserSecretCanvas
TargetId: !If [ExistingDatabase, !Select [ "6", !Split [ ":" , !Ref DatabaseClusterArnParameter ] ], !Ref AuroraDatabaseCluster]
TargetType: AWS::RDS::DBCluster
DatabaseSubnetGroup:
Type: AWS::RDS::DBSubnetGroup
Condition: CreateDatabase
Properties:
DBSubnetGroupDescription: !Sub ${ResourcePrefixParameter}-cd2-subnetgroup-${EnvironmentParameter}
SubnetIds: !Ref DatabaseSubnetListParameter
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
DatabaseClientSecurityGroup:
Type: AWS::EC2::SecurityGroup
Condition: CreateDatabaseClientSecurityGroup
Properties:
GroupDescription: !Sub ${ResourcePrefixParameter}-cd2-database-client-sg-${EnvironmentParameter}
GroupName: Canvas Data 2 Database Client
VpcId: !Ref VpcIdParameter
SecurityGroupEgress:
- IpProtocol: tcp
FromPort: 443
ToPort: 443
CidrIp: 0.0.0.0/0
Tags:
- Key: Name
Value: Canvas Data 2 Database Client
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
ListTablesFunctionSecurityGroup:
Type: AWS::EC2::SecurityGroup
Condition: CreateListTablesFunctionSecurityGroup
Properties:
GroupDescription: !Sub ${ResourcePrefixParameter}-cd2-list-tables-function-sg-${EnvironmentParameter}
GroupName: Canvas Data 2 ListTablesFunction
VpcId: !Ref VpcIdParameter
SecurityGroupEgress:
- IpProtocol: tcp
FromPort: 443
ToPort: 443
CidrIp: 0.0.0.0/0
Tags:
- Key: Name
Value: Canvas Data 2 ListTablesFunction
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
DatabaseSecurityGroup:
Type: AWS::EC2::SecurityGroup
Condition: CreateDatabaseSecurityGroup
Properties:
GroupDescription: !Sub ${ResourcePrefixParameter}-cd2-database-sg-${EnvironmentParameter}
GroupName: Canvas Data 2 Database
VpcId: !Ref VpcIdParameter
SecurityGroupIngress:
- IpProtocol: tcp
FromPort: 5432
ToPort: 5432
SourceSecurityGroupId: !If [ExistingDatabaseClientSecurityGroup, !Ref DatabaseClientSecurityGroupParameter, !Ref DatabaseClientSecurityGroup]
# TODO: add more ingress rules based on parameter(s)
Tags:
- Key: Name
Value: Canvas Data 2 Database
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
DatabaseClientEgressToDatabase:
Type: AWS::EC2::SecurityGroupEgress
Condition: CreateDatabaseSecurityGroup
Properties:
GroupId: !If [ExistingDatabaseClientSecurityGroup, !Ref DatabaseClientSecurityGroupParameter, !Ref DatabaseClientSecurityGroup]
IpProtocol: tcp
FromPort: 5432
ToPort: 5432
DestinationSecurityGroupId: !GetAtt DatabaseSecurityGroup.GroupId
DatabaseClientEgressToExistingDatabase:
Type: AWS::EC2::SecurityGroupEgress
Condition: CreateDatabaseClientSecurityGroup
Properties:
GroupId: !If [ExistingDatabaseClientSecurityGroup, !Ref DatabaseClientSecurityGroupParameter, !Ref DatabaseClientSecurityGroup]
IpProtocol: tcp
FromPort: 5432
ToPort: 5432
DestinationSecurityGroupId: !Ref DatabaseSecurityGroupParameter
AuroraDatabaseCluster:
Type: AWS::RDS::DBCluster
Condition: CreateDatabase
Properties:
Engine: aurora-postgresql
EngineVersion: 15.5
MasterUsername: !Sub ${DatabaseAdminUserParameter}
ManageMasterUserPassword: true
MasterUserSecret:
KmsKeyId: !Ref SecretsKmsKey
DBSubnetGroupName: !Ref DatabaseSubnetGroup
VpcSecurityGroupIds:
- !If [ExistingDatabaseSecurityGroup, !Ref DatabaseSecurityGroupParameter, !Ref DatabaseSecurityGroup]
Port: 5432
DatabaseName: cd2
ServerlessV2ScalingConfiguration:
MinCapacity: !Ref DatabaseMinCapacityParameter
MaxCapacity: !Ref DatabaseMaxCapacityParameter
DeletionProtection: false
EnableHttpEndpoint: true
BackupRetentionPeriod: 7
StorageEncrypted: true
KmsKeyId: !GetAtt DataKmsKey.Arn
DBClusterParameterGroupName: !Ref DatabaseClusterParameterGroup
EnableCloudwatchLogsExports:
- postgresql
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
DatabaseClusterParameterGroup:
Type: AWS::RDS::DBClusterParameterGroup
Properties:
Description: PostgreSQL parameter group for Canvas Data 2
Family: aurora-postgresql15
Parameters:
rds.force_ssl: 1
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
AuroraDatabaseInstance:
Type: AWS::RDS::DBInstance
Condition: CreateDatabase
Properties:
Engine: aurora-postgresql
DBInstanceClass: db.serverless
DBClusterIdentifier: !Ref AuroraDatabaseCluster
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
DatabasePostgresqlLogGroup:
Type: AWS::Logs::LogGroup
Condition: CreateDatabase
Properties:
LogGroupName: !Sub /aws/rds/cluster/${AuroraDatabaseCluster}/postgresql
RetentionInDays: !Ref LogRetentionParameter
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
ListTablesFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: list_tables/
Handler: app.lambda_handler
Runtime: python3.11
Architectures:
- x86_64
Policies:
- SSMParameterReadPolicy:
ParameterName: !Sub '${EnvironmentParameter}/${SsmPathParameter}*'
Environment:
Variables:
ENV: !Ref EnvironmentParameter
POWERTOOLS_METRICS_NAMESPACE: canvas-data-2
POWERTOOLS_SERVICE_NAME: list_tables
LOG_LEVEL: !Ref LogLevel
SKIP_TABLES: !Ref SkipTablesParameter
SLACK_WEBHOOK_SECRET_NAME: !Sub ${SlackWebHookURLSecretNameParameter}
STACK_NAME: !Sub ${AWS::StackName}
SSM_PARAMETER_NAME: !Sub ${SsmPathParameter}
DB_CD2_USER: !Sub ${DatabaseCd2UserParameter}
Timeout: 120
MemorySize: 256
VpcConfig:
SecurityGroupIds:
- !If [ExistingListTablesFunctionSecurityGroup, !Ref ListTablesFunctionSecurityGroupParameter, !Ref ListTablesFunctionSecurityGroup]
SubnetIds: !Ref LambdaSubnetListParameter
LoggingConfig:
LogGroup: !Ref ListTablesLogGroup
Role: !GetAtt ListTablesRole.Arn
Layers:
- !Ref LambdaLayer
ListTablesLogGroup:
Type: AWS::Logs::LogGroup
Properties:
LogGroupName: !Sub ${AWS::StackName}/lambda/ListTables
RetentionInDays: !Ref LogRetentionParameter
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
ListTablesRole:
Type: AWS::IAM::Role
Properties:
AssumeRolePolicyDocument:
Statement:
- Effect: Allow
Principal:
Service: lambda.amazonaws.com
Action: sts:AssumeRole
Path: '/'
Policies:
- PolicyName: parameter-store
PolicyDocument:
Statement:
- Effect: Allow
Action:
- ssm:DescribeParameters
Resource: '*'
- Effect: Allow
Action:
- ssm:GetParameters
- ssm:GetParameter
- ssm:GetParametersByPath
Resource:
- !Sub arn:aws:ssm:ca-central-1:${AWS::AccountId}:parameter/${EnvironmentParameter}/${SsmPathParameter}*
- PolicyName: SecretsManagerPolicy
PolicyDocument:
Version: "2012-10-17"
Statement:
- Effect: Allow
Action:
- secretsmanager:GetSecretValue
Resource: !Sub arn:aws:secretsmanager:${AWS::Region}:${AWS::AccountId}:secret:${SlackWebHookURLSecretNameParameter}*
- PolicyName: logging
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- logs:CreateLogGroup
Resource: !Sub arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:*
- Effect: Allow
Action:
- logs:CreateLogStream
- logs:PutLogEvents
Resource: !Sub arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:/${AWS::StackName}/lambda/ListTables*
ManagedPolicyArns:
- arn:aws:iam::aws:policy/service-role/AWSLambdaVPCAccessExecutionRole
FargateCluster:
Type: AWS::ECS::Cluster
Properties:
ClusterName: !Sub ${AWS::StackName}-cd2-cluster
Configuration:
ManagedStorageConfiguration:
FargateEphemeralStorageKmsKeyId: !If [CreateDatabase, !GetAtt DataKmsKey.Arn, !Sub "arn:aws:kms:${AWS::Region}:${AWS::AccountId}:key/${DataKmsKeyIDParameter}"]
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
FargateExecutionRole:
Type: AWS::IAM::Role
Properties:
AssumeRolePolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- sts:AssumeRole
Principal:
Service:
- ecs-tasks.amazonaws.com
- events.amazonaws.com
Path: '/'
ManagedPolicyArns:
- arn:aws:iam::aws:policy/service-role/AmazonECSTaskExecutionRolePolicy
Policies:
- PolicyName: iam_pass_role
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- iam:PassRole
Resource:
- !Sub ${TaskRole.Arn}
- PolicyName: kms_for_data
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- kms:*
Resource:
- !If [CreateDatabase, !GetAtt DataKmsKey.Arn, !Sub "arn:aws:kms:${AWS::Region}:${AWS::AccountId}:key/${DataKmsKeyIDParameter}"]
- !If
- ConfigureFalconSensor
- PolicyName: falcon_parameter_store
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- ssm:DescribeParameters
Resource: '*'
- Effect: Allow
Action:
- ssm:GetParameters
- ssm:GetParameter
- ssm:GetParametersByPath
Resource:
- !Sub "arn:aws:ssm:ca-central-1:${AWS::AccountId}:parameter${FalconSensorOptionsParameter}*"
- !Ref "AWS::NoValue"
TaskRole:
Type: AWS::IAM::Role
Properties:
AssumeRolePolicyDocument:
Statement:
- Effect: Allow
Action:
- sts:AssumeRole
Principal:
Service:
- ecs-tasks.amazonaws.com
- events.amazonaws.com
Path: '/'
Policies:
- PolicyName: parameter-store
PolicyDocument:
Statement:
- Effect: Allow
Action:
- ssm:DescribeParameters
Resource: '*'
- Effect: Allow
Action:
- ssm:GetParameters
- ssm:GetParameter
- ssm:GetParametersByPath
Resource:
- !Sub arn:aws:ssm:ca-central-1:${AWS::AccountId}:parameter/${EnvironmentParameter}/${SsmPathParameter}*
- !If [ConfigureFalconSensor, !Sub "arn:aws:ssm:ca-central-1:${AWS::AccountId}:parameter${FalconSensorOptionsParameter}*", !Ref "AWS::NoValue"]
- PolicyName: secrets
PolicyDocument:
Statement:
- Effect: Allow
Action:
- secretsmanager:GetSecretValue
Resource:
- !Ref DatabaseUserSecretCanvas
- !If [ExistingDatabaseAdminSecret, !Ref DatabaseAdminSecretArnParameter, !GetAtt AuroraDatabaseCluster.MasterUserSecret.SecretArn]
- PolicyName: kms
PolicyDocument:
Statement:
- Effect: Allow
Action:
- kms:Decrypt
Resource: !If [CreateDatabase, !GetAtt SecretsKmsKey.Arn, !Sub "arn:aws:kms:${AWS::Region}:${AWS::AccountId}:key/${SecretsKmsKeyIDParameter}"]
- PolicyName: ecr
PolicyDocument:
Statement:
- Effect: Allow
Action:
- ecr:BatchCheckLayerAvailability
- ecr:GetDownloadUrlForLayer
- ecr:BatchGetImage
- ecr:DescribeRepositories
- ecr:DescribeImages
- ecr:GetAuthorizationToken
Resource:
- !Sub arn:aws:ecr:${AWS::Region}:${EcrAccountNumberParameter}:repository/*
- PolicyName: rds_data
PolicyDocument:
Statement:
- Effect: Allow
Action:
- rds-data:*
Resource:
- !If [ExistingDatabase, !Ref DatabaseClusterArnParameter, !GetAtt AuroraDatabaseCluster.DBClusterArn]
- PolicyName: state_machine
PolicyDocument:
Statement:
- Effect: Allow
Action:
- states:SendTaskSuccess
- states:SendTaskFailure
# An explicit reference to the CD2 State Machine creates a CloudFormation circular dependency
# This isn't a great work-around.
Resource:
- '*'
- PolicyName: kms_for_data
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- kms:*
Resource:
- !If [CreateDatabase, !GetAtt DataKmsKey.Arn, !Sub "arn:aws:kms:${AWS::Region}:${AWS::AccountId}:key/${DataKmsKeyIDParameter}"]
- PolicyName: logging
PolicyDocument:
Version: '2012-10-17'
Statement:
- Effect: Allow
Action:
- logs:CreateLogGroup
Resource: !Sub arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:*
- Effect: Allow
Action:
- logs:CreateLogStream
- logs:PutLogEvents
Resource: !Sub arn:${AWS::Partition}:logs:${AWS::Region}:${AWS::AccountId}:log-group:/${AWS::StackName}/fargate/*
ManagedPolicyArns:
- arn:aws:iam::aws:policy/service-role/AmazonECSTaskExecutionRolePolicy
InitTableTaskDefinition:
Type: AWS::ECS::TaskDefinition
Properties:
Family: !Sub ${AWS::StackName}-InitTable
Cpu: !Ref TaskCpuParameter
Memory: !Ref TaskMemoryParameter
EphemeralStorage:
SizeInGiB: !Ref TaskStorageParameter
NetworkMode: awsvpc
RequiresCompatibilities:
- FARGATE
ExecutionRoleArn: !Sub ${FargateExecutionRole.Arn}
TaskRoleArn: !Sub ${TaskRole.Arn}
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
ContainerDefinitions:
- Name: !Sub ${AWS::StackName}-InitTable
Cpu: !Ref TaskCpuParameter
Memory: !Ref TaskMemoryParameter
Image:
Fn::If:
- CreateDatabase
- Fn::Sub: ${EcrAccountNumberParameter}.dkr.ecr.${AWS::Region}.amazonaws.com/${AWS::StackName}/init-table:${EnvironmentParameter}
- Fn::Sub: ${EcrAccountNumberParameter}.dkr.ecr.${AWS::Region}.amazonaws.com/${MainCD2StackNameParameter}/init-table:${EnvironmentParameter}
Essential: true
LogConfiguration:
LogDriver: awslogs
Options:
awslogs-group: !Ref InitTableLogGroup
awslogs-region: !Ref AWS::Region
awslogs-stream-prefix: InitTable
# Additional configuration for Falcon container sensor
EntryPoint:
!If
- ConfigureFalconSensor
-
- /tmp/CrowdStrike/rootfs/lib64/ld-linux-x86-64.so.2
- --library-path
- /tmp/CrowdStrike/rootfs/lib64
- /tmp/CrowdStrike/rootfs/bin/bash
- /tmp/CrowdStrike/rootfs/entrypoint-ecs.sh
- python
- app.py
- !Ref "AWS::NoValue"
Secrets:
!If
- ConfigureFalconSensor
-
- Name: FALCONCTL_OPTS
ValueFrom: !Sub arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter${FalconSensorOptionsParameter}
- !Ref "AWS::NoValue"
LinuxParameters:
!If
- ConfigureFalconSensor
- Capabilities:
Add:
- SYS_PTRACE
- !Ref "AWS::NoValue"
MountPoints:
!If
- ConfigureFalconSensor
-
- ContainerPath: /tmp/CrowdStrike
SourceVolume: crowdstrike-falcon-volume
ReadOnly: true
- !Ref "AWS::NoValue"
DependsOn:
!If
- ConfigureFalconSensor
-
- Condition: COMPLETE
ContainerName: crowdstrike-falcon-init-container
- !Ref "AWS::NoValue"
# Conditional container definition for the falcon-init-container
- !If
- ConfigureFalconSensor
-
Name: crowdstrike-falcon-init-container
Image: !Sub ${FalconSensorRepoParameter}
Essential: false
EntryPoint:
- /bin/bash
- -c
- chmod u+rwx /tmp/CrowdStrike && mkdir /tmp/CrowdStrike/rootfs && cp -r /bin /etc /lib64 /usr /entrypoint-ecs.sh /tmp/CrowdStrike/rootfs && chmod -R a=rX /tmp/CrowdStrike
MountPoints:
- ContainerPath: /tmp/CrowdStrike
SourceVolume: crowdstrike-falcon-volume
ReadOnly: false
ReadonlyRootFilesystem: true
User: '0:0'
- !Ref "AWS::NoValue"
Volumes:
!If
- ConfigureFalconSensor
-
- Name: crowdstrike-falcon-volume
- !Ref "AWS::NoValue"
InitTableLogGroup:
Type: AWS::Logs::LogGroup
Properties:
LogGroupName: !Sub ${AWS::StackName}/fargate/InitTable
RetentionInDays: !Ref LogRetentionParameter
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
SyncTableTaskDefinition:
Type: AWS::ECS::TaskDefinition
Properties:
Family: !Sub ${AWS::StackName}-SyncTable
Cpu: !Ref TaskCpuParameter
Memory: !Ref TaskMemoryParameter
EphemeralStorage:
SizeInGiB: !Ref TaskStorageParameter
NetworkMode: awsvpc
RequiresCompatibilities:
- FARGATE
ExecutionRoleArn: !Sub ${FargateExecutionRole.Arn}
TaskRoleArn: !Sub ${TaskRole.Arn}
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}
ContainerDefinitions:
- Name: !Sub ${AWS::StackName}-SyncTable
Cpu: !Ref TaskCpuParameter
Memory: !Ref TaskMemoryParameter
Image:
Fn::If:
- CreateDatabase
- Fn::Sub: ${EcrAccountNumberParameter}.dkr.ecr.${AWS::Region}.amazonaws.com/${AWS::StackName}/sync-table:${EnvironmentParameter}
- Fn::Sub: ${EcrAccountNumberParameter}.dkr.ecr.${AWS::Region}.amazonaws.com/${MainCD2StackNameParameter}/sync-table:${EnvironmentParameter}
Essential: true
LogConfiguration:
LogDriver: awslogs
Options:
awslogs-group: !Ref SyncTableLogGroup
awslogs-region: !Ref AWS::Region
awslogs-stream-prefix: InitTable
# Additional configuration for Falcon container sensor
EntryPoint:
!If
- ConfigureFalconSensor
-
- /tmp/CrowdStrike/rootfs/lib64/ld-linux-x86-64.so.2
- --library-path
- /tmp/CrowdStrike/rootfs/lib64
- /tmp/CrowdStrike/rootfs/bin/bash
- /tmp/CrowdStrike/rootfs/entrypoint-ecs.sh
- python
- app.py
- !Ref "AWS::NoValue"
Secrets:
!If
- ConfigureFalconSensor
-
- Name: FALCONCTL_OPTS
ValueFrom: !Sub arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:parameter${FalconSensorOptionsParameter}
- !Ref "AWS::NoValue"
LinuxParameters:
!If
- ConfigureFalconSensor
- Capabilities:
Add:
- SYS_PTRACE
- !Ref "AWS::NoValue"
MountPoints:
!If
- ConfigureFalconSensor
-
- ContainerPath: /tmp/CrowdStrike
SourceVolume: crowdstrike-falcon-volume
ReadOnly: true
- !Ref "AWS::NoValue"
DependsOn:
!If
- ConfigureFalconSensor
-
- Condition: COMPLETE
ContainerName: crowdstrike-falcon-init-container
- !Ref "AWS::NoValue"
# Conditional container definition for the falcon-init-container
- !If
- ConfigureFalconSensor
-
Name: crowdstrike-falcon-init-container
Image: !Sub ${FalconSensorRepoParameter}
Essential: false
EntryPoint:
- /bin/bash
- -c
- chmod u+rwx /tmp/CrowdStrike && mkdir /tmp/CrowdStrike/rootfs && cp -r /bin /etc /lib64 /usr /entrypoint-ecs.sh /tmp/CrowdStrike/rootfs && chmod -R a=rX /tmp/CrowdStrike
MountPoints:
- ContainerPath: /tmp/CrowdStrike
SourceVolume: crowdstrike-falcon-volume
ReadOnly: false
ReadonlyRootFilesystem: true
User: '0:0'
- !Ref "AWS::NoValue"
Volumes:
!If
- ConfigureFalconSensor
-
- Name: crowdstrike-falcon-volume
- !Ref "AWS::NoValue"
SyncTableLogGroup:
Type: AWS::Logs::LogGroup
Properties:
LogGroupName: !Sub ${AWS::StackName}/fargate/SyncTable
RetentionInDays: !Ref LogRetentionParameter
Tags:
- Key: !Sub ${TagNameParameter}
Value: !Sub ${TagValueParameter}