-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Expand file tree
/
Copy pathparameter.test.ts
More file actions
1244 lines (1080 loc) · 45.5 KB
/
Copy pathparameter.test.ts
File metadata and controls
1244 lines (1080 loc) · 45.5 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
import { testDeprecated } from '@aws-cdk/cdk-build-tools';
import { Template, Annotations } from '../../assertions';
import * as iam from '../../aws-iam';
import * as kms from '../../aws-kms';
import * as cdk from '../../core';
import * as cxapi from '../../cx-api';
import * as ssm from '../lib';
import { ParameterType, ParameterValueType } from '../lib';
test('creating a String SSM Parameter', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
new ssm.StringParameter(stack, 'Parameter', {
allowedPattern: '.*',
description: 'The value Foo',
parameterName: 'FooParameter',
stringValue: 'Foo',
});
// THEN
Template.fromStack(stack).hasResourceProperties('AWS::SSM::Parameter', {
AllowedPattern: '.*',
Description: 'The value Foo',
Name: 'FooParameter',
Type: 'String',
Value: 'Foo',
});
});
testDeprecated('type cannot be specified as AWS_EC2_IMAGE_ID', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => new ssm.StringParameter(stack, 'myParam', {
stringValue: 'myValue',
type: ssm.ParameterType.AWS_EC2_IMAGE_ID,
})).toThrow('The type must either be ParameterType.STRING or ParameterType.STRING_LIST. Did you mean to set dataType: ParameterDataType.AWS_EC2_IMAGE instead?');
});
test('dataType can be specified', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
new ssm.StringParameter(stack, 'myParam', {
stringValue: 'myValue',
dataType: ssm.ParameterDataType.AWS_EC2_IMAGE,
});
// THEN
Template.fromStack(stack).hasResourceProperties('AWS::SSM::Parameter', {
Value: 'myValue',
DataType: 'aws:ec2:image',
});
});
test('expect String SSM Parameter to have tier properly set', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
new ssm.StringParameter(stack, 'Parameter', {
allowedPattern: '.*',
description: 'The value Foo',
parameterName: 'FooParameter',
stringValue: 'Foo',
tier: ssm.ParameterTier.ADVANCED,
});
// THEN
Template.fromStack(stack).hasResourceProperties('AWS::SSM::Parameter', {
Tier: 'Advanced',
});
});
test('String SSM Parameter rejects invalid values', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => new ssm.StringParameter(stack, 'Parameter', { allowedPattern: '^Bar$', stringValue: 'FooBar' })).toThrow(
/does not match the specified allowedPattern/);
});
test('String SSM Parameter allows unresolved tokens', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
new ssm.StringParameter(stack, 'Parameter', {
allowedPattern: '^Bar$',
stringValue: cdk.Lazy.string({ produce: () => 'Foo!' }),
});
}).not.toThrow();
});
test('creating a StringList SSM Parameter', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
new ssm.StringListParameter(stack, 'Parameter', {
allowedPattern: '(Foo|Bar)',
description: 'The values Foo and Bar',
parameterName: 'FooParameter',
stringListValue: ['Foo', 'Bar'],
});
// THEN
Template.fromStack(stack).hasResourceProperties('AWS::SSM::Parameter', {
AllowedPattern: '(Foo|Bar)',
Description: 'The values Foo and Bar',
Name: 'FooParameter',
Type: 'StringList',
Value: 'Foo,Bar',
});
});
test('String SSM Parameter throws on long descriptions', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
new ssm.StringParameter(stack, 'Parameter', {
stringValue: 'Foo',
description: '1024+ character long description: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \
Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, \
nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat \
massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, \
imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. \
Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, \
eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus \
varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. \
Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing \
sem neque sed ipsum.',
});
}).toThrow(/Description cannot be longer than 1024 characters./);
});
test('String SSM Parameter throws on long names', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
new ssm.StringParameter(stack, 'Parameter', {
stringValue: 'Foo',
parameterName: '2048+ character long name: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \
Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, \
nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat \
massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, \
imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. \
Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, \
eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus \
varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. \
Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing \
sem neque sed ipsum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \
Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, \
nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat \
massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, \
imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. \
Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, \
eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus \
varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. \
Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing \
sem neque sed ipsum.',
});
}).toThrow(/name cannot be longer than 2048 characters./);
});
test.each([
'/parameter/with spaces',
'charactersOtherThan^allowed',
'trying;this',
])('String SSM Parameter throws on invalid name %s', (parameterName) => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
new ssm.StringParameter(stack, 'Parameter', { stringValue: 'Foo', parameterName });
}).toThrow(/name must only contain letters, numbers, and the following 4 symbols.*/);
});
test('StringList SSM Parameter throws on long descriptions', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
new ssm.StringListParameter(stack, 'Parameter', {
stringListValue: ['Foo', 'Bar'],
description: '1024+ character long description: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \
Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, \
nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat \
massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, \
imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. \
Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, \
eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus \
varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. \
Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing \
sem neque sed ipsum.',
});
}).toThrow(/Description cannot be longer than 1024 characters./);
});
test('StringList SSM Parameter throws on long names', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
new ssm.StringListParameter(stack, 'Parameter', {
stringListValue: ['Foo', 'Bar'],
parameterName: '2048+ character long name: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \
Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, \
nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat \
massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, \
imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. \
Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, \
eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus \
varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. \
Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing \
sem neque sed ipsum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. \
Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, \
nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat \
massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, \
imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. \
Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, \
eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus \
varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. \
Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing \
sem neque sed ipsum.',
});
}).toThrow(/name cannot be longer than 2048 characters./);
});
test.each([
'/parameter/with spaces',
'charactersOtherThan^allowed',
'trying;this',
])('StringList SSM Parameter throws on invalid name %s', (parameterName) => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
new ssm.StringListParameter(stack, 'Parameter', { stringListValue: ['Foo'], parameterName });
}).toThrow(/name must only contain letters, numbers, and the following 4 symbols.*/);
});
test('StringList SSM Parameter values cannot contain commas', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => new ssm.StringListParameter(stack, 'Parameter', { stringListValue: ['Foo,Bar'] })).toThrow(
/cannot contain the ',' character/);
});
test('StringList SSM Parameter rejects invalid values', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => new ssm.StringListParameter(stack, 'Parameter', { allowedPattern: '^(Foo|Bar)$', stringListValue: ['Foo', 'FooBar'] })).toThrow(
/does not match the specified allowedPattern/);
});
test('StringList SSM Parameter allows unresolved tokens', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => new ssm.StringListParameter(stack, 'Parameter', {
allowedPattern: '^(Foo|Bar)$',
stringListValue: ['Foo', cdk.Lazy.string({ produce: () => 'Baz!' })],
})).not.toThrow();
});
test('parameterArn is crafted correctly', () => {
// GIVEN
const stack = new cdk.Stack();
const param = new ssm.StringParameter(stack, 'Parameter', { stringValue: 'Foo' });
// THEN
expect(stack.resolve(param.parameterArn)).toEqual({
'Fn::Join': ['', [
'arn:',
{ Ref: 'AWS::Partition' },
':ssm:',
{ Ref: 'AWS::Region' },
':',
{ Ref: 'AWS::AccountId' },
':parameter/',
{ Ref: 'Parameter9E1B4FBA' },
]],
});
});
test('parameterName that includes a "/" must be fully qualified (i.e. begin with "/") as well', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => new ssm.StringParameter(stack, 'myParam', {
stringValue: 'myValue',
parameterName: 'path/to/parameter',
})).toThrow(/Parameter names must be fully qualified/);
expect(() => new ssm.StringListParameter(stack, 'myParam2', {
stringListValue: ['foo', 'bar'],
parameterName: 'path/to/parameter2',
})).toThrow(/Parameter names must be fully qualified \(if they include \"\/\" they must also begin with a \"\/\"\)\: path\/to\/parameter2/);
});
test('StringParameter.fromStringParameterName', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringParameter.fromStringParameterName(stack, 'MyParamName', 'MyParamName');
// THEN
expect(stack.resolve(param.parameterArn)).toEqual({
'Fn::Join': ['', [
'arn:',
{ Ref: 'AWS::Partition' },
':ssm:',
{ Ref: 'AWS::Region' },
':',
{ Ref: 'AWS::AccountId' },
':parameter/MyParamName',
]],
});
expect(stack.resolve(param.parameterName)).toEqual('MyParamName');
expect(stack.resolve(param.parameterType)).toEqual('String');
expect(stack.resolve(param.stringValue)).toEqual({ Ref: 'MyParamNameParameter' });
Template.fromStack(stack).templateMatches({
Parameters: {
MyParamNameParameter: {
Type: 'AWS::SSM::Parameter::Value<String>',
Default: 'MyParamName',
},
},
});
});
test('StringParameter.fromStringParameterName still synthesizes correctly when stringValue is first read inside a Lazy callback', () => {
// GIVEN
const stack = new cdk.Stack();
const param = ssm.StringParameter.fromStringParameterName(stack, 'MyParamName', 'MyParamName');
// WHEN
// First read of stringValue happens inside a Lazy producer instead of application code.
new cdk.CfnOutput(stack, 'Out', {
value: cdk.Lazy.string({ produce: () => param.stringValue }),
});
// THEN
const template = Template.fromStack(stack);
template.hasParameter('MyParamNameParameter', {
Type: 'AWS::SSM::Parameter::Value<String>',
Default: 'MyParamName',
});
template.hasOutput('Out', {
Value: { Ref: 'MyParamNameParameter' },
});
});
test('StringParameter.fromStringParameterName does not create a Parameter when only the ARN is used', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
// Only parameterArn is used, `stringValue` is never accessed (e.g. ecs.Secret.fromSsmParameter)
const param = ssm.StringParameter.fromStringParameterName(stack, 'MyParamName', 'MyParamName');
expect(stack.resolve(param.parameterArn)).toBeDefined();
// THEN
Template.fromStack(stack).templateMatches({});
});
test('StringParameter.fromStringParameterArn does not create a Parameter when only the ARN is used', () => {
// GIVEN
const stack = new cdk.Stack();
const sharingParameterArn = 'arn:aws:ssm:us-east-1:123456789012:parameter/dummyName';
// WHEN
const param = ssm.StringParameter.fromStringParameterArn(stack, 'MyParamName', sharingParameterArn);
expect(stack.resolve(param.parameterArn)).toEqual(sharingParameterArn);
// THEN
Template.fromStack(stack).templateMatches({});
});
test('fromStringParameterArn StringParameter.fromStringParameterArn', () => {
// GIVEN
const stack = new cdk.Stack();
const sharingParameterArn = 'arn:aws:ssm:us-east-1:123456789012:parameter/dummyName';
// WHEN
const param = ssm.StringParameter.fromStringParameterArn(stack, 'MyParamName', sharingParameterArn);
// THEN
expect(stack.resolve(param.parameterArn)).toEqual(sharingParameterArn);
expect(stack.resolve(param.parameterName)).toEqual('dummyName');
expect(stack.resolve(param.parameterType)).toEqual('String');
expect(stack.resolve(param.stringValue)).toEqual({ Ref: 'MyParamNameParameter' });
Template.fromStack(stack).templateMatches({
Parameters: {
MyParamNameParameter: {
Type: 'AWS::SSM::Parameter::Value<String>',
Default: sharingParameterArn,
},
},
});
});
test('fromStringParameterArn throws when StringParameter.fromStringParameterArn is called with a token ARN', () => {
// GIVEN
const stack = new cdk.Stack();
const tokenizedParam = new cdk.CfnParameter(stack, 'TokenParam', {
type: 'String',
}).valueAsString;
// THEN
expect(() => {
ssm.StringParameter.fromStringParameterArn(stack, 'MyParamName', tokenizedParam);
}).toThrow(/stringParameterArn cannot be an unresolved token/);
});
test('fromStringParameterArn throws error when StringParameterArn has unexpected format', () => {
// GIVEN
const stack = new cdk.Stack();
const invalidArn = 'invalid:arn:format';
// THEN
expect(() => {
ssm.StringParameter.fromStringParameterArn(stack, 'MyParamName', invalidArn);
}).toThrow('unexpected StringParameterArn format');
});
test('fromStringParameterArn throws error when StringParameterArn is in a different region than the stack', () => {
// GIVEN
const stack = new cdk.Stack(undefined, 'TestStack', { env: { region: 'us-west-2' } });
const differentRegionArn = 'arn:aws:ssm:us-east-1:123456789012:parameter/dummyName';
// THEN
expect(() => {
ssm.StringParameter.fromStringParameterArn(stack, 'MyParamName', differentRegionArn);
}).toThrow('stringParameterArn must be in the same region as the stack');
});
test('fromStringParameterArn does not throw error when StringParameterArn is in the same region as the stack', () => {
// GIVEN
const stack = new cdk.Stack(undefined, 'TestStack', { env: { region: 'us-east-1' } });
const sameRegionArn = 'arn:aws:ssm:us-east-1:123456789012:parameter/dummyName';
// THEN
expect(() => {
ssm.StringParameter.fromStringParameterArn(stack, 'MyParamName', sameRegionArn);
}).not.toThrow();
});
test('fromStringParameterArn emits an annotation when stack region is unresolved', () => {
// GIVEN
const stack = new cdk.Stack(undefined, 'Stack');
const sameRegionArn = 'arn:aws:ssm:us-east-1:123456789012:parameter/dummyName';
// WHEN
ssm.StringParameter.fromStringParameterArn(stack, 'MyParamName', sameRegionArn);
// THEN
Annotations.fromStack(stack).hasWarning('/Stack', 'Cross-account references will only work within the same region [ack: aws-cdk-lib/aws-ssm:crossAccountReferenceSameRegion]');
});
test('StringParameter.fromStringParameterAttributes', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringParameter.fromStringParameterAttributes(stack, 'MyParamName', {
parameterName: 'MyParamName',
version: 2,
});
// THEN
expect(stack.resolve(param.parameterArn)).toEqual({
'Fn::Join': ['', [
'arn:',
{ Ref: 'AWS::Partition' },
':ssm:',
{ Ref: 'AWS::Region' },
':',
{ Ref: 'AWS::AccountId' },
':parameter/MyParamName',
]],
});
expect(stack.resolve(param.parameterName)).toEqual('MyParamName');
expect(stack.resolve(param.parameterType)).toEqual('String');
expect(stack.resolve(param.stringValue)).toEqual('{{resolve:ssm:MyParamName:2}}');
});
test('StringParameter.fromStringParameterAttributes with version from token', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringParameter.fromStringParameterAttributes(stack, 'MyParamName', {
parameterName: 'MyParamName',
version: cdk.Token.asNumber({ Ref: 'version' }),
});
// THEN
expect(stack.resolve(param.parameterArn)).toEqual({
'Fn::Join': ['', [
'arn:',
{ Ref: 'AWS::Partition' },
':ssm:',
{ Ref: 'AWS::Region' },
':',
{ Ref: 'AWS::AccountId' },
':parameter/MyParamName',
]],
});
expect(stack.resolve(param.parameterName)).toEqual('MyParamName');
expect(stack.resolve(param.parameterType)).toEqual('String');
expect(stack.resolve(param.stringValue)).toEqual({
'Fn::Join': ['', [
'{{resolve:ssm:MyParamName:',
{ Ref: 'version' },
'}}',
]],
});
});
test('StringParameter.fromSecureStringParameterAttributes', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringParameter.fromSecureStringParameterAttributes(stack, 'MyParamName', {
parameterName: 'MyParamName',
version: 2,
});
// THEN
expect(stack.resolve(param.parameterArn)).toEqual({
'Fn::Join': ['', [
'arn:',
{ Ref: 'AWS::Partition' },
':ssm:',
{ Ref: 'AWS::Region' },
':',
{ Ref: 'AWS::AccountId' },
':parameter/MyParamName',
]],
});
expect(stack.resolve(param.parameterName)).toEqual('MyParamName');
expect(stack.resolve(param.parameterType)).toEqual('SecureString');
expect(stack.resolve(param.stringValue)).toEqual('{{resolve:ssm-secure:MyParamName:2}}');
});
test('StringParameter.fromSecureStringParameterAttributes with version from token', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringParameter.fromSecureStringParameterAttributes(stack, 'MyParamName', {
parameterName: 'MyParamName',
version: cdk.Token.asNumber({ Ref: 'version' }),
});
// THEN
expect(stack.resolve(param.parameterArn)).toEqual({
'Fn::Join': ['', [
'arn:',
{ Ref: 'AWS::Partition' },
':ssm:',
{ Ref: 'AWS::Region' },
':',
{ Ref: 'AWS::AccountId' },
':parameter/MyParamName',
]],
});
expect(stack.resolve(param.parameterName)).toEqual('MyParamName');
expect(stack.resolve(param.parameterType)).toEqual('SecureString');
expect(stack.resolve(param.stringValue)).toEqual({
'Fn::Join': ['', [
'{{resolve:ssm-secure:MyParamName:',
{ Ref: 'version' },
'}}',
]],
});
});
test('StringParameter.fromSecureStringParameterAttributes with encryption key creates the correct policy for grantRead', () => {
// GIVEN
const stack = new cdk.Stack();
const key = kms.Key.fromKeyArn(stack, 'CustomKey', 'arn:aws:kms:us-east-1:123456789012:key/xyz');
const role = new iam.Role(stack, 'Role', {
assumedBy: new iam.AccountRootPrincipal(),
});
// WHEN
const param = ssm.StringParameter.fromSecureStringParameterAttributes(stack, 'MyParamName', {
parameterName: 'MyParamName',
version: 2,
encryptionKey: key,
});
param.grantRead(role);
// THEN
Template.fromStack(stack).hasResourceProperties('AWS::IAM::Policy', {
PolicyDocument: {
Statement: [
{
Action: 'kms:Decrypt',
Effect: 'Allow',
Resource: 'arn:aws:kms:us-east-1:123456789012:key/xyz',
},
{
Action: [
'ssm:DescribeParameters',
'ssm:GetParameters',
'ssm:GetParameter',
'ssm:GetParameterHistory',
],
Effect: 'Allow',
Resource: {
'Fn::Join': [
'',
[
'arn:',
{
Ref: 'AWS::Partition',
},
':ssm:',
{
Ref: 'AWS::Region',
},
':',
{
Ref: 'AWS::AccountId',
},
':parameter/MyParamName',
],
],
},
},
],
Version: '2012-10-17',
},
});
});
test('StringParameter.fromSecureStringParameterAttributes with encryption key creates the correct policy for grantWrite', () => {
// GIVEN
const stack = new cdk.Stack();
const key = kms.Key.fromKeyArn(stack, 'CustomKey', 'arn:aws:kms:us-east-1:123456789012:key/xyz');
const role = new iam.Role(stack, 'Role', {
assumedBy: new iam.AccountRootPrincipal(),
});
// WHEN
const param = ssm.StringParameter.fromSecureStringParameterAttributes(stack, 'MyParamName', {
parameterName: 'MyParamName',
version: 2,
encryptionKey: key,
});
param.grantWrite(role);
// THEN
Template.fromStack(stack).hasResourceProperties('AWS::IAM::Policy', {
PolicyDocument: {
Statement: [
{
Action: [
'kms:Encrypt',
'kms:ReEncrypt*',
'kms:GenerateDataKey*',
],
Effect: 'Allow',
Resource: 'arn:aws:kms:us-east-1:123456789012:key/xyz',
},
{
Action: 'ssm:PutParameter',
Effect: 'Allow',
Resource: {
'Fn::Join': [
'',
[
'arn:',
{
Ref: 'AWS::Partition',
},
':ssm:',
{
Ref: 'AWS::Region',
},
':',
{
Ref: 'AWS::AccountId',
},
':parameter/MyParamName',
],
],
},
},
],
Version: '2012-10-17',
},
});
});
test('StringParameter.fromSecureStringParameterAttributes without version', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringParameter.fromSecureStringParameterAttributes(stack, 'MyParamName', {
parameterName: 'MyParamName',
});
// THEN
expect(stack.resolve(param.stringValue)).toEqual('{{resolve:ssm-secure:MyParamName}}');
});
test('StringListParameter.fromName', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringListParameter.fromStringListParameterName(stack, 'MyParamName', 'MyParamName');
// THEN
expect(stack.resolve(param.parameterArn)).toEqual({
'Fn::Join': ['', [
'arn:',
{ Ref: 'AWS::Partition' },
':ssm:',
{ Ref: 'AWS::Region' },
':',
{ Ref: 'AWS::AccountId' },
':parameter/MyParamName',
]],
});
expect(stack.resolve(param.parameterName)).toEqual('MyParamName');
expect(stack.resolve(param.parameterType)).toEqual('StringList');
expect(stack.resolve(param.stringListValue)).toEqual({ 'Fn::Split': [',', '{{resolve:ssm:MyParamName}}'] });
});
test('fromLookup will use the SSM context provider to read value during synthesis', () => {
// GIVEN
const app = new cdk.App({ context: { [cxapi.NEW_STYLE_STACK_SYNTHESIS_CONTEXT]: false } });
const stack = new cdk.Stack(app, 'my-staq', { env: { region: 'us-east-1', account: '12344' } });
// WHEN
const value = ssm.StringParameter.valueFromLookup(stack, 'my-param-name');
// THEN
expect(value).toEqual('dummy-value-for-my-param-name');
expect(app.synth().manifest.missing).toEqual([
{
key: 'ssm:account=12344:parameterName=my-param-name:region=us-east-1',
props: {
account: '12344',
ignoreErrorOnMissingContext: false,
dummyValue: 'dummy-value-for-my-param-name',
region: 'us-east-1',
parameterName: 'my-param-name',
},
provider: 'ssm',
},
]);
});
test('fromLookup will return defaultValue when it is provided', () => {
// GIVEN
const app = new cdk.App({ context: { [cxapi.NEW_STYLE_STACK_SYNTHESIS_CONTEXT]: false } });
const stack = new cdk.Stack(app, 'my-staq', { env: { region: 'us-east-1', account: '12344' } });
// WHEN
const value = ssm.StringParameter.valueFromLookup(stack, 'my-param-name', 'some-default-value');
// THEN
expect(value).toEqual('some-default-value');
expect(app.synth().manifest.missing).toEqual([
{
key: 'ssm:account=12344:parameterName=my-param-name:region=us-east-1',
props: {
account: '12344',
ignoreErrorOnMissingContext: true,
dummyValue: 'some-default-value',
region: 'us-east-1',
parameterName: 'my-param-name',
},
provider: 'ssm',
},
]);
});
test('fromLookup will use the SSM context provider to read value during synthesis when linked to scope', () => {
// GIVEN
const app = new cdk.App({ context: { [cxapi.NEW_STYLE_STACK_SYNTHESIS_CONTEXT]: false } });
const stack = new cdk.Stack(app, 'my-staq', { env: { region: 'us-east-1', account: '12344' } });
// WHEN
const value = ssm.StringParameter.valueFromLookup(stack, 'my-param-name', undefined, { additionalCacheKey: 'extraKey' });
// THEN
expect(value).toEqual('dummy-value-for-my-param-name');
expect(app.synth().manifest.missing).toEqual([
{
key: 'ssm:account=12344:additionalCacheKey=extraKey:parameterName=my-param-name:region=us-east-1',
props: {
account: '12344',
region: 'us-east-1',
parameterName: 'my-param-name',
dummyValue: 'dummy-value-for-my-param-name',
ignoreErrorOnMissingContext: false,
additionalCacheKey: 'extraKey',
},
provider: 'ssm',
},
]);
});
describe('from string list parameter', () => {
testDeprecated('valueForTypedStringParameter list type throws error', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
ssm.StringParameter.valueForTypedStringParameter(stack, 'my-param-name', ParameterType.STRING_LIST);
}).toThrow(/use valueForTypedListParameter instead/);
});
testDeprecated('fromStringParameterAttributes list type throws error', () => {
// GIVEN
const stack = new cdk.Stack();
// THEN
expect(() => {
ssm.StringParameter.fromStringParameterAttributes(stack, 'my-param-name', {
parameterName: 'my-param-name',
type: ParameterType.STRING_LIST,
});
}).toThrow(/fromStringParameterAttributes does not support StringList/);
});
testDeprecated('fromStringParameterAttributes returns correct value', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringParameter.fromStringParameterAttributes(stack, 'my-param-name', {
parameterName: 'my-param-name',
type: ParameterType.STRING,
});
param.stringValue;
// THEN
Template.fromStack(stack).templateMatches({
Parameters: {
myparamnameParameter: {
Type: 'AWS::SSM::Parameter::Value<String>',
Default: 'my-param-name',
},
},
});
});
test('fromStringParameterAttributes returns correct value with valueType', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringParameter.fromStringParameterAttributes(stack, 'my-param-name', {
parameterName: 'my-param-name',
valueType: ParameterValueType.STRING,
});
param.stringValue;
// THEN
Template.fromStack(stack).templateMatches({
Parameters: {
myparamnameParameter: {
Type: 'AWS::SSM::Parameter::Value<String>',
Default: 'my-param-name',
},
},
});
});
test('fromStringParameterAttributes does not create a Parameter when stringValue is never accessed', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
ssm.StringParameter.fromStringParameterAttributes(stack, 'my-param-name', {
parameterName: 'my-param-name',
});
// THEN
Template.fromStack(stack).templateMatches({});
});
test('valueForTypedListParameter returns correct value', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
ssm.StringListParameter.valueForTypedListParameter(stack, 'my-param-name');
// THEN
Template.fromStack(stack).templateMatches({
Parameters: {
SsmParameterValuemyparamnameC96584B6F00A464EAD1953AFF4B05118Parameter: {
Type: 'AWS::SSM::Parameter::Value<List<String>>',
Default: 'my-param-name',
},
},
});
});
test('valueForTypedListParameter returns correct value with type', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
ssm.StringListParameter.valueForTypedListParameter(stack, 'my-param-name', ParameterValueType.AWS_EC2_INSTANCE_ID);
// THEN
Template.fromStack(stack).templateMatches({
Parameters: {
SsmParameterValuemyparamnameC96584B6F00A464EAD1953AFF4B05118Parameter: {
Type: 'AWS::SSM::Parameter::Value<List<AWS::EC2::Instance::Id>>',
Default: 'my-param-name',
},
},
});
});
test('fromStringListParameterAttributes returns correct value', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
const param = ssm.StringListParameter.fromListParameterAttributes(stack, 'my-param-name', {
parameterName: 'my-param-name',
});
param.stringListValue;
// THEN
Template.fromStack(stack).templateMatches({
Parameters: {
myparamnameParameter: {
Type: 'AWS::SSM::Parameter::Value<List<String>>',
Default: 'my-param-name',
},
},
});
});
test('fromListParameterAttributes does not create a Parameter when stringListValue is never accessed', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
ssm.StringListParameter.fromListParameterAttributes(stack, 'my-param-name', {
parameterName: 'my-param-name',
});
// THEN
Template.fromStack(stack).templateMatches({});
});
testDeprecated('string type returns correct value', () => {
// GIVEN
const stack = new cdk.Stack();
// WHEN
ssm.StringParameter.valueForTypedStringParameter(stack, 'my-param-name', ParameterType.STRING);
// THEN
Template.fromStack(stack).templateMatches({
Parameters: {
SsmParameterValuemyparamnameC96584B6F00A464EAD1953AFF4B05118Parameter: {
Type: 'AWS::SSM::Parameter::Value<String>',
Default: 'my-param-name',
},