-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathcloudhsm.yml
3349 lines (3100 loc) · 123 KB
/
cloudhsm.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
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
Description: >-
Creates, updates, and deletes an AWS CloudHSM cluster
Metadata:
AWS::CloudFormation::Interface:
ParameterGroups:
- Label:
default: Resource Naming Qualifiers
Parameters:
- pSystem
- pEnvPurpose
- Label:
default: CloudHSM Cluster Configuration
Parameters:
- pSubnets
- pHsmsPerSubnet
- pHsmType
- pUseExternalPkiProcess
- pExternallyProvidedCertsReady
- pBackupRetentionDays
- pBackupId
- Label:
default: EC2 Client Instance Configuration
Parameters:
- pClientPkg
- pClientVpcId
- pClientSubnet
- pClientType
- pClientAmiSsmParameter
- pClientAmiId
ParameterLabels:
pSystem:
default: System identifier used to qualify cloud resource names
pEnvPurpose:
default: Environment identifier used to qualify cloud resource names
pSubnets:
default: Subnets to use for the CloudHSM cluster
pHsmsPerSubnet:
default: Number of HSMs per subnet to create in the CloudHSM cluster
pHsmType:
default: Type of HSM to use in the cluster. Currently the only supported value is "hsm1.medium"
pUseExternalPkiProcess:
default: Use your own PKI process to issue cluster certificate?
pExternallyProvidedCertsReady:
default: Have externally issued cluster and CA certificates been uploaded?
pBackupRetentionDays:
default: Number of days to retain backups (specify 7 to 379)
pBackupId:
default: ID of CloudHSM cluster backup. Specify when creating cluster from a backup.
pClientPkg:
default: CloudHSM client package to install
pClientVpcId:
default: ID of the VPC in which to create the EC2 client instance
pClientSubnet:
default: ID of the subnet in which to create the EC2 client instance
pClientType:
default: EC2 instance type for the client instance
pClientAmiSsmParameter:
default: SSM Parameter Name for EC2 Amazon Machine Image (AMI) for the client instance
pClientAmiId:
default: ID for EC2 Amazon Machine Image (AMI) for the client instance
Parameters:
pSystem:
Description: Used to prefix many of the cloud resource names. You can normally use the default value.
Type: String
Default: cloudhsm
pEnvPurpose:
Description: Used to qualify many of the cloud resource names so that you can more easily manage multiple stacks in the same AWS account
Type: String
Default: '1'
pSubnets:
Description: Subnets to use for the CloudHSM cluster
Type: List<AWS::EC2::Subnet::Id>
pHsmsPerSubnet:
Description: Number of HSMs per subnet to create in the CloudHSM cluster
Type: Number
Default: 1
MinValue: 0
pHsmType:
Description: Type of HSM to use in the cluster. Currently the only supported value is "hsm1.medium"
Type: String
Default: hsm1.medium
pUseExternalPkiProcess:
Description: Use your own PKI process to issue cluster certificate?
Type: String
Default: false
AllowedValues: [true, false]
pExternallyProvidedCertsReady:
Description: Have externally issued cluster and CA certificates been uploaded?
Type: String
Default: false
AllowedValues: [true, false]
pBackupRetentionDays:
Description: Number of days to retain CloudHSM cluster backups (specify 7 to 379)
Type: Number
MinValue: 7
MaxValue: 379
Default: 90
pBackupId:
Description: ID of CloudHSM cluster backup. Specify when creating cluster from a backup.
Type: String
Default: ''
pClientPkg:
Description: CloudHSM client package to install
Type: String
Default: cloudhsm-client
AllowedValues:
- cloudhsm-client
- cloudhsm-cli
pClientVpcId:
Description: ID of the VPC in which to create the EC2 client instance
Type: AWS::EC2::VPC::Id
pClientSubnet:
Description: ID of the subnet in which to create the EC2 client instance
Type: AWS::EC2::Subnet::Id
pClientType:
Description: Enter t3a.small, t3a.medium. The EC2 instance is a critical component for automating the provisioning.
Type: String
Default: t3a.small
pClientAmiSsmParameter:
Type: AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>
Description: SSM parameter name for EC2 Amazon Machine Image (AMI) for the client instance
Default: /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs
pClientAmiId:
Description: ID for EC2 Amazon Machine Image (AMI) for the client instance (Optional. When specified, overrides SSM parameter)
Type: String
Conditions:
cUseAmiId: !Not [!Equals [ !Ref 'pClientAmiId', '' ] ]
cUseInternalPkiProcess: !Equals [ !Ref 'pUseExternalPkiProcess', false ]
Resources:
rCloudHsmCluster:
Type: Custom::CustomClusterLauncher
Properties:
ServiceToken: !GetAtt rCustomResourceCloudHsmCluster.Arn
Subnets: !Ref pSubnets
HsmsPerSubnet: !Ref pHsmsPerSubnet
HsmType: !Ref pHsmType
ClientInstanceId: !Ref rClientInstance
ClientPkg: !Ref pClientPkg
UseExternalPkiProcess: !Ref pUseExternalPkiProcess
ExternallyProvidedCertsReady: !Ref pExternallyProvidedCertsReady
InternalRootCaArn: !If [ cUseInternalPkiProcess, !GetAtt rRootCa.Arn, !Ref 'AWS::NoValue' ]
InternalRootCaCertArn: !If [ cUseInternalPkiProcess, !GetAtt rRootCaCert.Arn, !Ref 'AWS::NoValue' ]
BackupRetentionDays: !Ref pBackupRetentionDays
BackupId: !Ref pBackupId
SystemId: !Ref pSystem
EnvPurpose: !Ref pEnvPurpose
StateMachineCreate: !Ref rStateMachineCreate
StateMachineUpdate: !Ref rStateMachineUpdate
StateMachineDelete: !Ref rStateMachineDelete
rCustomResourceCloudHsmCluster:
Type: AWS::Lambda::Function
Properties:
FunctionName: !Sub '${pSystem}-${pEnvPurpose}-cfn-custom-resource'
Handler: index.lambda_handler
Runtime: python3.10
Timeout: 20
Role: !GetAtt rLambdaCustomResourceExecutionRole.Arn
Code:
ZipFile: |
'''Manages lifecycle CRUD of CloudHSM cluster with step functions '''
import boto3
from botocore.vendored import requests
import cfnresponse
import json
import logging
import os
logger = logging.getLogger()
logger.setLevel(logging.INFO)
sfn = boto3.client('stepfunctions')
def lambda_handler(event, context):
logger.info(json.dumps(event, indent=2, default=str))
logger.info(context)
CreateStateMachineArn = event['ResourceProperties']['StateMachineCreate']
UpdateStateMachineArn = event['ResourceProperties']['StateMachineUpdate']
DeleteStateMachineArn = event['ResourceProperties']['StateMachineDelete']
if event['RequestType'] == 'Create':
logger.info(f'Executing {str(CreateStateMachineArn)} to create cluster')
sfn.start_execution(stateMachineArn=CreateStateMachineArn,input=json.dumps(event))
return
elif event['RequestType'] == 'Update':
event['ClusterId'] = event['PhysicalResourceId']
logger.info(f'Executing {str(UpdateStateMachineArn)} to update cluster')
sfn.start_execution(stateMachineArn=UpdateStateMachineArn,input=json.dumps(event))
return
elif event['RequestType'] == 'Delete':
event['ClusterId'] = event['PhysicalResourceId']
logger.info(f'Executing {str(DeleteStateMachineArn)} to delete cluster')
sfn.start_execution(stateMachineArn=DeleteStateMachineArn,input=json.dumps(event))
return
rLambdaCustomResourceExecutionRole:
Type: AWS::IAM::Role
Properties:
RoleName: !Sub '${pSystem}-${pEnvPurpose}-${AWS::Region}-svc-lambda-custom'
AssumeRolePolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Principal:
Service:
- lambda.amazonaws.com
Action:
- sts:AssumeRole
Path: /
Policies:
- PolicyName: CloudHsmCustomResourceLambda
PolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Action:
- logs:CreateLogGroup
- logs:CreateLogStream
- logs:PutLogEvents
Resource:
- !Sub 'arn:aws:logs:${AWS::Region}:${AWS::AccountId}:log-group:/aws/lambda/${pSystem}-${pEnvPurpose}-cluster-cfn-custom-resource*'
- Effect: Allow
Action:
- states:StartExecution
Resource:
- !Ref rStateMachineCreate
- !Ref rStateMachineUpdate
- !Ref rStateMachineDelete
rStateMachineCreate:
Type: AWS::StepFunctions::StateMachine
Properties:
StateMachineName: !Sub '${pSystem}-${pEnvPurpose}-create'
RoleArn: !GetAtt rStateMachineCreateExecutionRole.Arn
LoggingConfiguration:
Destinations:
- CloudWatchLogsLogGroup:
LogGroupArn: !GetAtt rCloudWatchLogsStateMachineCreate.Arn
IncludeExecutionData: true
Level: ALL
Definition:
Comment: Creates a CloudHSM cluster including an initial HSM
StartAt: CreateCluster
States:
CreateCluster:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaCreateCluster}'
ResultPath: $.ClusterId
Next: WaitForClusterCreate
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
WaitForClusterCreate:
Type: Wait
Seconds: 30
Next: GetClusterState
GetClusterState:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetClusterState}'
ResultPath: $.ClusterState
Next: ClusterReady?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
ClusterReady?:
Type: Choice
Choices:
- Variable: $.ClusterState
StringEquals: 'UNINITIALIZED'
Next: InitializeSecrets
- Variable: $.ClusterState
StringEquals: 'ACTIVE'
Next: CreateFirstHsm
Default: WaitForClusterCreate
InitializeSecrets:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaInitializeSecrets}'
# Note: Since we don't expect a return value from the supporting Lambda function, we'd prefer to use
# "ResultPath: null" so as to not pollute the data with an empty array. However, see this issue
# as to why we can't currently use "null" in the YAML form of state machines:
# https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-stepfunctions/issues/41
# This approach would apply to all tasks where the state machine does not depend on a return value from
# a task.
ResultPath: $.InitializeSecrets
Next: CreateFirstHsm
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
CreateFirstHsm:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaCreateHsm}'
ResultPath: $.HsmId
Next: WaitForFirstHsmActive
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
WaitForFirstHsmActive:
Type: Wait
Seconds: 30
Next: GetFirstHsmState
GetFirstHsmState:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetHsmState}'
ResultPath: $.HsmState
Next: FirstHsmActive?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
FirstHsmActive?:
Type: Choice
Choices:
- Variable: $.HsmState
StringEquals: 'ACTIVE'
Next: UpdateClusterSecGroup
Default: WaitForFirstHsmActive
UpdateClusterSecGroup:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaUpdateClusterSecGroup}'
ResultPath: $.UpdateClusterSecGroup
Next: CreateClusterFromBackup?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
CreateClusterFromBackup?:
Type: Choice
Choices:
- Variable: $.ResourceProperties.BackupId
StringEquals: ''
Next: GetClusterCertCsr
Default: RetrievePriorCaCert
RetrievePriorCaCert:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaRetrievePriorCaCert}'
ResultPath: $.RetrievePriorCaCert
Next: InitActivateCluster
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
GetClusterCertCsr:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetClusterCertCsr}'
ResultPath: $.GetClusterCertCsr
Next: UseExternalPkiProcess?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
UseExternalPkiProcess?:
Type: Choice
Choices:
- Variable: $.ResourceProperties.UseExternalPkiProcess
StringEquals: 'true'
Next: SendCfnSuccess
Default: InternallyIssueClusterCert
InternallyIssueClusterCert:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaInternallyIssueClusterCert}'
ResultPath: $.InternallyIssueClusterCert
Next: InitActivateCluster
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
InitActivateCluster:
Type: Task
Resource: arn:aws:states:::states:startExecution.sync:2
Parameters:
StateMachineArn: !Ref rStateMachineInitActivateCluster
Input.$: $
ResultPath: $.Exec
Next: InitActivateClusterError?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
InitActivateClusterError?:
Type: Choice
Choices:
- Variable: $.Exec.Output.Cause
IsPresent: true
Next: PrepareExecError
Default: CreateRemainingHsms
CreateRemainingHsms:
Type: Task
Resource: arn:aws:states:::states:startExecution.sync:2
Parameters:
StateMachineArn: !Ref rStateMachineAlignHsms
Input.$: $
ResultPath: $.Exec
Next: CreateRemainingHsmsError?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
CreateRemainingHsmsError?:
Type: Choice
Choices:
- Variable: $.Exec.Output.Cause
IsPresent: true
Next: PrepareExecError
Default: InstallClientPkg?
InstallClientPkg?:
Type: Choice
Choices:
- Variable: $.ResourceProperties.ClientPkg
StringEquals: 'cloudhsm-client'
Next: InstallClientPkg
Default: SendCfnSuccess
InstallClientPkg:
Type: Task
Resource: arn:aws:states:::aws-sdk:ssm:startAutomationExecution.waitForTaskToken
ResultPath: $.InstallClientPkg
Next: SendCfnSuccess
Parameters:
DocumentName: !Ref rRunCmdStepFunctionsDocument
Parameters:
InstanceIds.$: States.Array($.ResourceProperties.ClientInstanceId)
taskToken.$: States.Array($$.Task.Token)
Commands.$: States.Array(States.Format('sudo /root/cloudhsm-work/cloudhsm-client-install.sh;sudo /root/cloudhsm-work/cloudhsm-update-config.sh {}',$.ClusterId))
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
SendCfnSuccess:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaSendCfnSuccess}'
End: true
PrepareExecError:
Type: Pass
Parameters:
Cause.$: $.Exec.Output.Cause
ResultPath: $.Error
Next: SendCfnFailed
SendCfnFailed:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaSendCfnFailed}'
End: true
rCloudWatchLogsStateMachineCreate:
Type: AWS::Logs::LogGroup
Properties:
LogGroupName: !Sub '/aws/vendedlogs/states/${pSystem}-${pEnvPurpose}/create'
RetentionInDays: 30
rStateMachineCreateExecutionRole:
Type: AWS::IAM::Role
Properties:
RoleName: !Sub '${pSystem}-${pEnvPurpose}-${AWS::Region}-svc-states-create'
AssumeRolePolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Principal:
Service:
- !Sub 'states.${AWS::Region}.amazonaws.com'
Action: sts:AssumeRole
Path: /
Policies:
- PolicyName: StatesExecutionPolicy
PolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Action:
- lambda:InvokeFunction
Resource:
- !GetAtt rLambdaCreateCluster.Arn
- !GetAtt rLambdaGetClusterState.Arn
- !GetAtt rLambdaInitializeSecrets.Arn
- !GetAtt rLambdaCreateHsm.Arn
- !GetAtt rLambdaGetHsmState.Arn
- !GetAtt rLambdaUpdateClusterSecGroup.Arn
- !GetAtt rLambdaRetrievePriorCaCert.Arn
- !GetAtt rLambdaGetClusterCertCsr.Arn
- !GetAtt rLambdaInternallyIssueClusterCert.Arn
- !GetAtt rLambdaSendCfnSuccess.Arn
- !GetAtt rLambdaSendCfnFailed.Arn
- Effect: Allow
Action:
- states:StartExecution
Resource:
- !Ref rStateMachineInitActivateCluster
- !Ref rStateMachineAlignHsms
- Effect: Allow
Action:
- states:DescribeExecution
- states:StopExecution
Resource:
- !Sub 'arn:aws:states:${AWS::Region}:${AWS::AccountId}:execution:${rStateMachineInitActivateCluster.Name}'
- !Sub 'arn:aws:states:${AWS::Region}:${AWS::AccountId}:execution:${rStateMachineAlignHsms.Name}'
- Effect: Allow
Action:
- events:PutTargets
- events:PutRule
- events:DescribeRule
Resource:
- !Sub 'arn:aws:events:${AWS::Region}:${AWS::AccountId}:rule/StepFunctionsGetEventsForStepFunctionsExecutionRule'
- Effect: Allow
Action:
- ssm:StartAutomationExecution
Resource:
- !Sub 'arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:automation-definition/${rRunCmdStepFunctionsDocument}:$DEFAULT'
- Effect: Allow
Action:
- logs:CreateLogDelivery
- logs:CreateLogStream
- logs:GetLogDelivery
- logs:UpdateLogDelivery
- logs:DeleteLogDelivery
- logs:ListLogDeliveries
- logs:PutLogEvents
- logs:PutResourcePolicy
- logs:DescribeResourcePolicies
- logs:DescribeLogGroups
Resource:
- '*'
Condition:
'ForAllValues:StringEquals':
'aws:PrincipalAccount': !Sub '${AWS::AccountId}'
'aws:RequestedRegion': !Sub '${AWS::Region}'
rStateMachineUpdate:
Type: AWS::StepFunctions::StateMachine
Properties:
StateMachineName: !Sub '${pSystem}-${pEnvPurpose}-update'
RoleArn: !GetAtt rStateMachineUpdateExecutionRole.Arn
LoggingConfiguration:
Destinations:
- CloudWatchLogsLogGroup:
LogGroupArn: !GetAtt rCloudWatchLogsStateMachineUpdate.Arn
IncludeExecutionData: true
Level: ALL
Definition:
Comment: Updates a CloudHSM cluster
StartAt: Ec2ClientChanged?
States:
Ec2ClientChanged?:
Type: Choice
Choices:
- Variable: $.ResourceProperties.ClientInstanceId
StringEqualsPath: $.OldResourceProperties.ClientInstanceId
Next: ExternallyProvidedCertsReady?
Default: UpdateEc2ClientConfig
UpdateEc2ClientConfig:
Type: Task
Resource: arn:aws:states:::aws-sdk:ssm:startAutomationExecution.waitForTaskToken
ResultPath: $.UpdateEc2ClientConfig
Next: ExternallyProvidedCertsReady?
Parameters:
DocumentName: !Ref rRunCmdStepFunctionsDocument
Parameters:
InstanceIds.$: States.Array($.ResourceProperties.ClientInstanceId)
taskToken.$: States.Array($$.Task.Token)
Commands.$: States.Array(States.Format('sudo /root/cloudhsm-work/cloudhsm-update-config.sh {}',$.ClusterId))
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
ExternallyProvidedCertsReady?:
Type: Choice
Choices:
- And:
- Variable: $.ResourceProperties.UseExternalPkiProcess
StringEquals: 'true'
- Variable: $.ResourceProperties.ExternallyProvidedCertsReady
StringEquals: 'true'
Next: GetClusterState
Default: HsmsPerSubnetChanged?
GetClusterState:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetClusterState}'
ResultPath: $.ClusterState
Next: ClusterActivated?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
ClusterActivated?:
Type: Choice
Choices:
- Variable: $.ClusterState
StringEquals: 'ACTIVE'
Next: HsmsPerSubnetChanged?
Default: InitActivateCluster
InitActivateCluster:
Type: Task
Resource: arn:aws:states:::states:startExecution.sync:2
Parameters:
StateMachineArn: !Ref rStateMachineInitActivateCluster
Input.$: $
ResultPath: $.Exec
Next: InitActivateClusterError?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
InitActivateClusterError?:
Type: Choice
Choices:
- Variable: $.Exec.Output.Cause
IsPresent: true
Next: PrepareExecError
Default: AlignHsmCount
HsmsPerSubnetChanged?:
Type: Choice
Choices:
- Variable: $.ResourceProperties.HsmsPerSubnet
StringEqualsPath: $.OldResourceProperties.HsmsPerSubnet
Next: ClientPkgChanged?
Default: GetHsmsState
# When update fails to create some HSMs (for example, due to quotas), creation of some HSMs
# may still be in progress. Wait for HSMs that are still being created to transition to the active
# state prior to attempting to delete the HSMs.
GetHsmsState:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetHsmsState}'
ResultPath: $.HsmsState
Next: HsmsActive?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
HsmsActive?:
Type: Choice
Choices:
- Variable: $.HsmsState
StringEquals: 'ACTIVE'
Next: AlignHsmCount
Default: WaitForHsmsActive
WaitForHsmsActive:
Type: Wait
Seconds: 30
Next: GetHsmsState
AlignHsmCount:
Type: Task
Resource: arn:aws:states:::states:startExecution.sync:2
Parameters:
StateMachineArn: !Ref rStateMachineAlignHsms
Input.$: $
ResultPath: $.Exec
Next: AlignHsmCountError?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
AlignHsmCountError?:
Type: Choice
Choices:
- Variable: $.Exec.Output.Cause
IsPresent: true
Next: PrepareExecError
Default: ClientPkgChanged?
ClientPkgChanged?:
Type: Choice
Choices:
- And:
- Variable: $.ResourceProperties.ClientPkg
StringEqualsPath: $.OldResourceProperties.ClientPkg
- Variable: $.ResourceProperties.ClientInstanceId
StringEqualsPath: $.OldResourceProperties.ClientInstanceId
Next: SendCfnSuccess
Default: InstallClientPkg?
InstallClientPkg?:
Type: Choice
Choices:
- Variable: $.ResourceProperties.ClientPkg
StringEquals: 'cloudhsm-client'
Next: InstallClientPkg
Default: InstallCliPkg
InstallClientPkg:
Type: Task
Resource: arn:aws:states:::aws-sdk:ssm:startAutomationExecution.waitForTaskToken
ResultPath: $.InstallClientPkg
Next: SendCfnSuccess
Parameters:
DocumentName: !Ref rRunCmdStepFunctionsDocument
Parameters:
InstanceIds.$: States.Array($.ResourceProperties.ClientInstanceId)
taskToken.$: States.Array($$.Task.Token)
Commands.$: States.Array(States.Format('sudo /root/cloudhsm-work/cloudhsm-client-install.sh;sudo /root/cloudhsm-work/cloudhsm-update-config.sh {}',$.ClusterId))
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
InstallCliPkg:
Type: Task
Resource: arn:aws:states:::aws-sdk:ssm:startAutomationExecution.waitForTaskToken
ResultPath: $.InstallCliPkg
Next: SendCfnSuccess
Parameters:
DocumentName: !Ref rRunCmdStepFunctionsDocument
Parameters:
InstanceIds.$: States.Array($.ResourceProperties.ClientInstanceId)
taskToken.$: States.Array($$.Task.Token)
Commands.$: States.Array(States.Format('sudo /root/cloudhsm-work/cloudhsm-cli-install.sh; sudo /root/cloudhsm-work/cloudhsm-update-config.sh {}',$.ClusterId))
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
SendCfnSuccess:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaSendCfnSuccess}'
End: true
PrepareExecError:
Type: Pass
Parameters:
Cause.$: $.Exec.Output.Cause
ResultPath: $.Error
Next: SendCfnFailed
SendCfnFailed:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaSendCfnFailed}'
End: true
rCloudWatchLogsStateMachineUpdate:
Type: AWS::Logs::LogGroup
Properties:
LogGroupName: !Sub '/aws/vendedlogs/states/${pSystem}-${pEnvPurpose}/update'
RetentionInDays: 30
rStateMachineUpdateExecutionRole:
Type: AWS::IAM::Role
Properties:
RoleName: !Sub '${pSystem}-${pEnvPurpose}-${AWS::Region}-svc-states-update'
AssumeRolePolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Principal:
Service:
- !Sub 'states.${AWS::Region}.amazonaws.com'
Action: sts:AssumeRole
Path: /
Policies:
- PolicyName: StatesExecutionPolicy
PolicyDocument:
Version: 2012-10-17
Statement:
- Effect: Allow
Action:
- lambda:InvokeFunction
Resource:
- !GetAtt rLambdaGetClusterState.Arn
- !GetAtt rLambdaGetHsmsState.Arn
- !GetAtt rLambdaSendCfnSuccess.Arn
- !GetAtt rLambdaSendCfnFailed.Arn
- Effect: Allow
Action:
- states:StartExecution
Resource:
- !Ref rStateMachineInitActivateCluster
- !Ref rStateMachineAlignHsms
- Effect: Allow
Action:
- states:DescribeExecution
- states:StopExecution
Resource:
- !Sub 'arn:aws:states:${AWS::Region}:${AWS::AccountId}:execution:${rStateMachineInitActivateCluster.Name}'
- !Sub 'arn:aws:states:${AWS::Region}:${AWS::AccountId}:execution:${rStateMachineAlignHsms.Name}'
- Effect: Allow
Action:
- events:PutTargets
- events:PutRule
- events:DescribeRule
Resource:
- !Sub 'arn:aws:events:${AWS::Region}:${AWS::AccountId}:rule/StepFunctionsGetEventsForStepFunctionsExecutionRule'
- Effect: Allow
Action:
- ssm:StartAutomationExecution
Resource:
- !Sub 'arn:aws:ssm:${AWS::Region}:${AWS::AccountId}:automation-definition/${rRunCmdStepFunctionsDocument}:$DEFAULT'
- Effect: Allow
Action:
- logs:CreateLogDelivery
- logs:CreateLogStream
- logs:GetLogDelivery
- logs:UpdateLogDelivery
- logs:DeleteLogDelivery
- logs:ListLogDeliveries
- logs:PutLogEvents
- logs:PutResourcePolicy
- logs:DescribeResourcePolicies
- logs:DescribeLogGroups
Resource:
- '*'
Condition:
'ForAllValues:StringEquals':
'aws:PrincipalAccount': !Sub '${AWS::AccountId}'
'aws:RequestedRegion': !Sub '${AWS::Region}'
rStateMachineDelete:
Type: AWS::StepFunctions::StateMachine
Properties:
StateMachineName: !Sub '${pSystem}-${pEnvPurpose}-delete'
RoleArn: !GetAtt rStateMachineDeleteExecutionRole.Arn
LoggingConfiguration:
Destinations:
- CloudWatchLogsLogGroup:
LogGroupArn: !GetAtt rCloudWatchLogsStateMachineDelete.Arn
IncludeExecutionData: true
Level: ALL
Definition:
Comment: Deletes HSMs from the CloudHSM cluster and deletes the cluster
StartAt: ClusterExists?
States:
# Guard against situations in which either a cluster hasn't been created or
# an error was uncaught during creation and CloudFormation was not provided
# with a PhysicalResourceId. i.e. rLambdaSendCfnFailed was not executed.
# In that case, CloudFormation will set PhysicalResourceId to a value based
# on the <stack name>-rCloudHsmCluster-...
ClusterExists?:
Type: Choice
Choices:
- Variable: $.ClusterId
StringMatches: cluster-*
Next: GetHsmNum
Default: SendCfnSuccess
GetHsmNum:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetHsmNum}'
ResultPath: $.HsmNum
Next: HsmsExist?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
HsmsExist?:
Type: Choice
Choices:
- Variable: $.HsmNum
NumericEquals: 0
Next: DeleteSecrets
Default: GetHsmsState
# When stack creation fails, creation of HSMs could still be in progress.
# Wait for HSMs that are still being created to transition to the active
# state prior to deleting the HSMs.
GetHsmsState:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetHsmsState}'
ResultPath: $.HsmsState
Next: HsmsActive?
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
HsmsActive?:
Type: Choice
Choices:
- Variable: $.HsmsState
StringEquals: 'ACTIVE'
Next: DeleteHsms
Default: WaitForHsmsActive
WaitForHsmsActive:
Type: Wait
Seconds: 30
Next: GetHsmsState
DeleteHsms:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaDeleteHsms}'
Next: WaitForHsmsDelete
ResultPath: $.HsmIds
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
WaitForHsmsDelete:
Type: Wait
Seconds: 30
Next: GetHsmsState2
GetHsmsState2:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetHsmState}'
Next: HsmsDeleted?
ResultPath: $.HsmsState
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
HsmsDeleted?:
Type: Choice
Choices:
- Variable: $.HsmsState
StringEquals: 'DELETED'
Next: DeleteSecrets
Default: WaitForHsmsDelete
DeleteSecrets:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaDeleteSecrets}'
Next: DeleteCluster
ResultPath: $.DeleteSecrets
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
DeleteCluster:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaDeleteCluster}'
Next: WaitForClusterDelete
ResultPath: $.DeleteCluster
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
WaitForClusterDelete:
Type: Wait
Seconds: 30
Next: GetClusterState
GetClusterState:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaGetClusterState}'
Next: ClusterDeleted?
ResultPath: $.ClusterState
Catch:
- ErrorEquals:
- States.ALL
ResultPath: $.Error
Next: SendCfnFailed
ClusterDeleted?:
Type: Choice
Choices:
- Variable: $.ClusterState
StringEquals: 'DELETED'
Next: SendCfnSuccess
Default: WaitForClusterDelete
SendCfnSuccess:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaSendCfnSuccess}'
End: true
SendCfnFailed:
Type: Task
Resource: !Sub 'arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${rLambdaSendCfnFailed}'
End: true
rCloudWatchLogsStateMachineDelete:
Type: AWS::Logs::LogGroup
Properties:
LogGroupName: !Sub '/aws/vendedlogs/states/${pSystem}-${pEnvPurpose}/delete'
RetentionInDays: 30
rStateMachineDeleteExecutionRole:
Type: AWS::IAM::Role
Properties:
RoleName: !Sub '${pSystem}-${pEnvPurpose}-${AWS::Region}-svc-states-delete'
AssumeRolePolicyDocument:
Version: 2012-10-17
Statement: