@aws-sdk/client-imagebuilder 3.245.0 → 3.254.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +12 -4
- package/dist-cjs/protocols/Aws_restJson1.js +7 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +8 -0
- package/dist-es/protocols/Aws_restJson1.js +7 -0
- package/dist-types/Imagebuilder.d.ts +29 -26
- package/dist-types/ImagebuilderClient.d.ts +3 -3
- package/dist-types/commands/CreateComponentCommand.d.ts +5 -5
- package/dist-types/commands/DeleteImageCommand.d.ts +7 -7
- package/dist-types/commands/ImportVmImageCommand.d.ts +2 -2
- package/dist-types/commands/ListComponentBuildVersionsCommand.d.ts +4 -4
- package/dist-types/commands/ListComponentsCommand.d.ts +7 -5
- package/dist-types/commands/ListImagePipelineImagesCommand.d.ts +1 -1
- package/dist-types/commands/ListImagesCommand.d.ts +2 -1
- package/dist-types/commands/UpdateImagePipelineCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +273 -222
- package/dist-types/ts3.4/ImagebuilderClient.d.ts +2 -1
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +14 -0
- package/package.json +32 -32
|
@@ -13,10 +13,14 @@ export interface SystemsManagerAgent {
|
|
|
13
13
|
uninstallAfterBuild?: boolean;
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* <p>In addition to your
|
|
17
|
-
* control over your build instances.
|
|
18
|
-
*
|
|
19
|
-
*
|
|
16
|
+
* <p>In addition to your infrastructure configuration, these settings provide an extra layer of
|
|
17
|
+
* control over your build instances. You can also specify commands to run on launch for all of
|
|
18
|
+
* your build instances.</p>
|
|
19
|
+
* <p>Image Builder does not automatically install the Systems Manager agent on Windows instances. If your
|
|
20
|
+
* base image includes the Systems Manager agent, then the AMI that you create will also include the
|
|
21
|
+
* agent. For Linux instances, if the base image does not already include the Systems Manager agent, Image Builder
|
|
22
|
+
* installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can choose
|
|
23
|
+
* whether to keep it for the AMI that you create.</p>
|
|
20
24
|
*/
|
|
21
25
|
export interface AdditionalInstanceConfiguration {
|
|
22
26
|
/**
|
|
@@ -26,20 +30,19 @@ export interface AdditionalInstanceConfiguration {
|
|
|
26
30
|
/**
|
|
27
31
|
* <p>Use this property to provide commands or a command script to run when you launch
|
|
28
32
|
* your build instance.</p>
|
|
29
|
-
*
|
|
33
|
+
* <p>The userDataOverride property replaces any commands that Image Builder might have added to ensure
|
|
30
34
|
* that Systems Manager is installed on your Linux build instance. If you override the user data,
|
|
31
35
|
* make sure that you add commands to install Systems Manager, if it is not pre-installed on your
|
|
32
36
|
* base image.</p>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
37
|
+
* <note>
|
|
38
|
+
* <p>The user data is always base 64 encoded. For example, the
|
|
35
39
|
* following commands are encoded as <code>IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$</code>:</p>
|
|
36
|
-
*
|
|
37
|
-
* <p>
|
|
40
|
+
* <p>
|
|
38
41
|
* <i>#!/bin/bash</i>
|
|
39
42
|
* </p>
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
+
* <p>mkdir -p /var/bb/</p>
|
|
44
|
+
* <p>touch /var</p>
|
|
45
|
+
* </note>
|
|
43
46
|
*/
|
|
44
47
|
userDataOverride?: string;
|
|
45
48
|
}
|
|
@@ -349,17 +352,17 @@ export interface Component {
|
|
|
349
352
|
*/
|
|
350
353
|
changeDescription?: string;
|
|
351
354
|
/**
|
|
352
|
-
* <p>The type
|
|
355
|
+
* <p>The component type specifies whether Image Builder uses the component to build the image or only
|
|
353
356
|
* to test it.</p>
|
|
354
357
|
*/
|
|
355
358
|
type?: ComponentType | string;
|
|
356
359
|
/**
|
|
357
|
-
* <p>The platform of the component.</p>
|
|
360
|
+
* <p>The operating system platform of the component.</p>
|
|
358
361
|
*/
|
|
359
362
|
platform?: Platform | string;
|
|
360
363
|
/**
|
|
361
364
|
* <p>The operating system (OS) version supported by the component. If the OS information is
|
|
362
|
-
* available, a prefix match
|
|
365
|
+
* available, Image Builder performs a prefix match against the base image OS version during image recipe
|
|
363
366
|
* creation.</p>
|
|
364
367
|
*/
|
|
365
368
|
supportedOsVersions?: string[];
|
|
@@ -369,7 +372,8 @@ export interface Component {
|
|
|
369
372
|
*/
|
|
370
373
|
state?: ComponentState;
|
|
371
374
|
/**
|
|
372
|
-
* <p>Contains parameter details for each of the parameters that
|
|
375
|
+
* <p>Contains parameter details for each of the parameters that the component document
|
|
376
|
+
* defined for the component.</p>
|
|
373
377
|
*/
|
|
374
378
|
parameters?: ComponentParameterDetail[];
|
|
375
379
|
/**
|
|
@@ -389,13 +393,23 @@ export interface Component {
|
|
|
389
393
|
*/
|
|
390
394
|
encrypted?: boolean;
|
|
391
395
|
/**
|
|
392
|
-
* <p>The date that the component
|
|
396
|
+
* <p>The date that Image Builder created the component.</p>
|
|
393
397
|
*/
|
|
394
398
|
dateCreated?: string;
|
|
395
399
|
/**
|
|
396
|
-
* <p>The tags
|
|
400
|
+
* <p>The tags that apply to the component.</p>
|
|
397
401
|
*/
|
|
398
402
|
tags?: Record<string, string>;
|
|
403
|
+
/**
|
|
404
|
+
* <p>Contains the name of the publisher if this is a third-party component. Otherwise,
|
|
405
|
+
* this property is empty.</p>
|
|
406
|
+
*/
|
|
407
|
+
publisher?: string;
|
|
408
|
+
/**
|
|
409
|
+
* <p>Indicates whether component source is hidden from view in the console,
|
|
410
|
+
* and from component detail results for API, CLI, or SDK operations.</p>
|
|
411
|
+
*/
|
|
412
|
+
obfuscate?: boolean;
|
|
399
413
|
}
|
|
400
414
|
/**
|
|
401
415
|
* <p>Contains a key/value pair that sets the named component parameter.</p>
|
|
@@ -419,7 +433,7 @@ export interface ComponentConfiguration {
|
|
|
419
433
|
*/
|
|
420
434
|
componentArn: string | undefined;
|
|
421
435
|
/**
|
|
422
|
-
* <p>A group of parameter settings that
|
|
436
|
+
* <p>A group of parameter settings that Image Builder uses to configure the component for a specific recipe.</p>
|
|
423
437
|
*/
|
|
424
438
|
parameters?: ComponentParameter[];
|
|
425
439
|
}
|
|
@@ -443,12 +457,12 @@ export interface ComponentSummary {
|
|
|
443
457
|
*/
|
|
444
458
|
version?: string;
|
|
445
459
|
/**
|
|
446
|
-
* <p>The platform of the component.</p>
|
|
460
|
+
* <p>The operating system platform of the component.</p>
|
|
447
461
|
*/
|
|
448
462
|
platform?: Platform | string;
|
|
449
463
|
/**
|
|
450
|
-
* <p>The operating system (OS) version
|
|
451
|
-
* available, a prefix match
|
|
464
|
+
* <p>The operating system (OS) version that the component supports. If the OS information is
|
|
465
|
+
* available, Image Builder performs a prefix match against the base image OS version during image recipe
|
|
452
466
|
* creation.</p>
|
|
453
467
|
*/
|
|
454
468
|
supportedOsVersions?: string[];
|
|
@@ -457,7 +471,7 @@ export interface ComponentSummary {
|
|
|
457
471
|
*/
|
|
458
472
|
state?: ComponentState;
|
|
459
473
|
/**
|
|
460
|
-
* <p>The type
|
|
474
|
+
* <p>The component type specifies whether Image Builder uses the component to build the image or only
|
|
461
475
|
* to test it.</p>
|
|
462
476
|
*/
|
|
463
477
|
type?: ComponentType | string;
|
|
@@ -470,17 +484,27 @@ export interface ComponentSummary {
|
|
|
470
484
|
*/
|
|
471
485
|
description?: string;
|
|
472
486
|
/**
|
|
473
|
-
* <p>The change description of the component.</p>
|
|
487
|
+
* <p>The change description for the current version of the component.</p>
|
|
474
488
|
*/
|
|
475
489
|
changeDescription?: string;
|
|
476
490
|
/**
|
|
477
|
-
* <p>The date
|
|
491
|
+
* <p>The original creation date of the component.</p>
|
|
478
492
|
*/
|
|
479
493
|
dateCreated?: string;
|
|
480
494
|
/**
|
|
481
|
-
* <p>The tags
|
|
495
|
+
* <p>The tags that apply to the component.</p>
|
|
482
496
|
*/
|
|
483
497
|
tags?: Record<string, string>;
|
|
498
|
+
/**
|
|
499
|
+
* <p>Contains the name of the publisher if this is a third-party component. Otherwise,
|
|
500
|
+
* this property is empty.</p>
|
|
501
|
+
*/
|
|
502
|
+
publisher?: string;
|
|
503
|
+
/**
|
|
504
|
+
* <p>Indicates whether component source is hidden from view in the console,
|
|
505
|
+
* and from component detail results for API, CLI, or SDK operations.</p>
|
|
506
|
+
*/
|
|
507
|
+
obfuscate?: boolean;
|
|
484
508
|
}
|
|
485
509
|
/**
|
|
486
510
|
* <p>The defining characteristics of a specific version of an Amazon Web Services TOE component.</p>
|
|
@@ -488,22 +512,22 @@ export interface ComponentSummary {
|
|
|
488
512
|
export interface ComponentVersion {
|
|
489
513
|
/**
|
|
490
514
|
* <p>The Amazon Resource Name (ARN) of the component.</p>
|
|
491
|
-
*
|
|
492
|
-
*
|
|
515
|
+
* <note>
|
|
516
|
+
* <p>Semantic versioning is included in each object's Amazon Resource Name (ARN),
|
|
493
517
|
* at the level that applies to that object as follows:</p>
|
|
494
|
-
*
|
|
518
|
+
* <ol>
|
|
495
519
|
* <li>
|
|
496
|
-
*
|
|
520
|
+
* <p>Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are
|
|
497
521
|
* either left off entirely, or they are specified as wildcards, for example: x.x.x.</p>
|
|
498
|
-
*
|
|
522
|
+
* </li>
|
|
499
523
|
* <li>
|
|
500
|
-
*
|
|
501
|
-
*
|
|
524
|
+
* <p>Version ARNs have only the first three nodes: <major>.<minor>.<patch></p>
|
|
525
|
+
* </li>
|
|
502
526
|
* <li>
|
|
503
|
-
*
|
|
504
|
-
*
|
|
527
|
+
* <p>Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.</p>
|
|
528
|
+
* </li>
|
|
505
529
|
* </ol>
|
|
506
|
-
*
|
|
530
|
+
* </note>
|
|
507
531
|
*/
|
|
508
532
|
arn?: string;
|
|
509
533
|
/**
|
|
@@ -512,23 +536,23 @@ export interface ComponentVersion {
|
|
|
512
536
|
name?: string;
|
|
513
537
|
/**
|
|
514
538
|
* <p>The semantic version of the component.</p>
|
|
515
|
-
*
|
|
516
|
-
*
|
|
539
|
+
* <note>
|
|
540
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
517
541
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
518
|
-
*
|
|
542
|
+
* <p>
|
|
519
543
|
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
520
544
|
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
521
545
|
* build number to the fourth node.</p>
|
|
522
|
-
*
|
|
546
|
+
* <p>
|
|
523
547
|
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
524
548
|
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
525
549
|
* a date, such as 2021.01.01.</p>
|
|
526
|
-
*
|
|
550
|
+
* <p>
|
|
527
551
|
* <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
|
|
528
552
|
* to specify the most recent versions or nodes when selecting the base image or components for your
|
|
529
553
|
* recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
|
|
530
554
|
* wildcards.</p>
|
|
531
|
-
*
|
|
555
|
+
* </note>
|
|
532
556
|
*/
|
|
533
557
|
version?: string;
|
|
534
558
|
/**
|
|
@@ -698,22 +722,22 @@ export interface InstanceConfiguration {
|
|
|
698
722
|
export interface ContainerRecipe {
|
|
699
723
|
/**
|
|
700
724
|
* <p>The Amazon Resource Name (ARN) of the container recipe.</p>
|
|
701
|
-
*
|
|
702
|
-
*
|
|
725
|
+
* <note>
|
|
726
|
+
* <p>Semantic versioning is included in each object's Amazon Resource Name (ARN),
|
|
703
727
|
* at the level that applies to that object as follows:</p>
|
|
704
|
-
*
|
|
728
|
+
* <ol>
|
|
705
729
|
* <li>
|
|
706
|
-
*
|
|
730
|
+
* <p>Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are
|
|
707
731
|
* either left off entirely, or they are specified as wildcards, for example: x.x.x.</p>
|
|
708
|
-
*
|
|
732
|
+
* </li>
|
|
709
733
|
* <li>
|
|
710
|
-
*
|
|
711
|
-
*
|
|
734
|
+
* <p>Version ARNs have only the first three nodes: <major>.<minor>.<patch></p>
|
|
735
|
+
* </li>
|
|
712
736
|
* <li>
|
|
713
|
-
*
|
|
714
|
-
*
|
|
737
|
+
* <p>Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.</p>
|
|
738
|
+
* </li>
|
|
715
739
|
* </ol>
|
|
716
|
-
*
|
|
740
|
+
* </note>
|
|
717
741
|
*/
|
|
718
742
|
arn?: string;
|
|
719
743
|
/**
|
|
@@ -738,27 +762,28 @@ export interface ContainerRecipe {
|
|
|
738
762
|
owner?: string;
|
|
739
763
|
/**
|
|
740
764
|
* <p>The semantic version of the container recipe.</p>
|
|
741
|
-
*
|
|
742
|
-
*
|
|
765
|
+
* <note>
|
|
766
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
743
767
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
744
|
-
*
|
|
768
|
+
* <p>
|
|
745
769
|
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
746
770
|
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
747
771
|
* build number to the fourth node.</p>
|
|
748
|
-
*
|
|
772
|
+
* <p>
|
|
749
773
|
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
750
774
|
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
751
775
|
* a date, such as 2021.01.01.</p>
|
|
752
|
-
*
|
|
776
|
+
* <p>
|
|
753
777
|
* <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
|
|
754
778
|
* to specify the most recent versions or nodes when selecting the base image or components for your
|
|
755
779
|
* recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
|
|
756
780
|
* wildcards.</p>
|
|
757
|
-
*
|
|
781
|
+
* </note>
|
|
758
782
|
*/
|
|
759
783
|
version?: string;
|
|
760
784
|
/**
|
|
761
|
-
* <p>
|
|
785
|
+
* <p>Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can
|
|
786
|
+
* have a maximum of 20 build and test components in any combination.</p>
|
|
762
787
|
*/
|
|
763
788
|
components?: ComponentConfiguration[];
|
|
764
789
|
/**
|
|
@@ -842,22 +867,22 @@ export interface CreateComponentRequest {
|
|
|
842
867
|
name: string | undefined;
|
|
843
868
|
/**
|
|
844
869
|
* <p>The semantic version of the component. This version follows the semantic version syntax.</p>
|
|
845
|
-
*
|
|
846
|
-
*
|
|
870
|
+
* <note>
|
|
871
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
847
872
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
848
|
-
*
|
|
873
|
+
* <p>
|
|
849
874
|
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
850
875
|
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
851
876
|
* build number to the fourth node.</p>
|
|
852
|
-
*
|
|
877
|
+
* <p>
|
|
853
878
|
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
854
879
|
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
855
880
|
* a date, such as 2021.01.01.</p>
|
|
856
|
-
*
|
|
881
|
+
* </note>
|
|
857
882
|
*/
|
|
858
883
|
semanticVersion: string | undefined;
|
|
859
884
|
/**
|
|
860
|
-
* <p>
|
|
885
|
+
* <p>Describes the contents of the component.</p>
|
|
861
886
|
*/
|
|
862
887
|
description?: string;
|
|
863
888
|
/**
|
|
@@ -866,7 +891,7 @@ export interface CreateComponentRequest {
|
|
|
866
891
|
*/
|
|
867
892
|
changeDescription?: string;
|
|
868
893
|
/**
|
|
869
|
-
* <p>The platform of the component.</p>
|
|
894
|
+
* <p>The operating system platform of the component.</p>
|
|
870
895
|
*/
|
|
871
896
|
platform: Platform | string | undefined;
|
|
872
897
|
/**
|
|
@@ -886,16 +911,16 @@ export interface CreateComponentRequest {
|
|
|
886
911
|
* (<code>s3://bucket/key</code>), and the requester must have permission to access
|
|
887
912
|
* the S3 bucket it points to. If you use Amazon S3, you can specify component content
|
|
888
913
|
* up to your service quota.</p>
|
|
889
|
-
*
|
|
914
|
+
* <p>Alternatively, you can specify the YAML document inline, using the component
|
|
890
915
|
* <code>data</code> property. You cannot specify both properties.</p>
|
|
891
916
|
*/
|
|
892
917
|
uri?: string;
|
|
893
918
|
/**
|
|
894
|
-
* <p>The ID of the KMS key that
|
|
919
|
+
* <p>The ID of the KMS key that is used to encrypt this component.</p>
|
|
895
920
|
*/
|
|
896
921
|
kmsKeyId?: string;
|
|
897
922
|
/**
|
|
898
|
-
* <p>The tags
|
|
923
|
+
* <p>The tags that apply to the component.</p>
|
|
899
924
|
*/
|
|
900
925
|
tags?: Record<string, string>;
|
|
901
926
|
/**
|
|
@@ -966,22 +991,23 @@ export interface CreateContainerRecipeRequest {
|
|
|
966
991
|
description?: string;
|
|
967
992
|
/**
|
|
968
993
|
* <p>The semantic version of the container recipe. This version follows the semantic version syntax.</p>
|
|
969
|
-
*
|
|
970
|
-
*
|
|
994
|
+
* <note>
|
|
995
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
971
996
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
972
|
-
*
|
|
997
|
+
* <p>
|
|
973
998
|
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
974
999
|
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
975
1000
|
* build number to the fourth node.</p>
|
|
976
|
-
*
|
|
1001
|
+
* <p>
|
|
977
1002
|
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
978
1003
|
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
979
1004
|
* a date, such as 2021.01.01.</p>
|
|
980
|
-
*
|
|
1005
|
+
* </note>
|
|
981
1006
|
*/
|
|
982
1007
|
semanticVersion: string | undefined;
|
|
983
1008
|
/**
|
|
984
|
-
* <p>Components for build and test that are included in the container recipe
|
|
1009
|
+
* <p>Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can
|
|
1010
|
+
* have a maximum of 20 build and test components in any combination.</p>
|
|
985
1011
|
*/
|
|
986
1012
|
components: ComponentConfiguration[] | undefined;
|
|
987
1013
|
/**
|
|
@@ -1057,10 +1083,10 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
1057
1083
|
/**
|
|
1058
1084
|
* <p>Identifies the launch template that the associated Windows AMI uses for
|
|
1059
1085
|
* launching an instance when faster launching is enabled.</p>
|
|
1060
|
-
*
|
|
1061
|
-
*
|
|
1086
|
+
* <note>
|
|
1087
|
+
* <p>You can specify either the <code>launchTemplateName</code> or the
|
|
1062
1088
|
* <code>launchTemplateId</code>, but not both.</p>
|
|
1063
|
-
*
|
|
1089
|
+
* </note>
|
|
1064
1090
|
*/
|
|
1065
1091
|
export interface FastLaunchLaunchTemplateSpecification {
|
|
1066
1092
|
/**
|
|
@@ -1153,22 +1179,22 @@ export interface S3ExportConfiguration {
|
|
|
1153
1179
|
/**
|
|
1154
1180
|
* <p>Export the updated image to one of the following supported disk
|
|
1155
1181
|
* image formats:</p>
|
|
1156
|
-
*
|
|
1182
|
+
* <ul>
|
|
1157
1183
|
* <li>
|
|
1158
|
-
*
|
|
1184
|
+
* <p>
|
|
1159
1185
|
* <b>Virtual Hard Disk (VHD)</b> –
|
|
1160
1186
|
* Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.</p>
|
|
1161
|
-
*
|
|
1187
|
+
* </li>
|
|
1162
1188
|
* <li>
|
|
1163
|
-
*
|
|
1189
|
+
* <p>
|
|
1164
1190
|
* <b>Stream-optimized ESX Virtual Machine Disk
|
|
1165
1191
|
* (VMDK)</b> – Compatible with VMware ESX and
|
|
1166
1192
|
* VMware vSphere versions 4, 5, and 6.</p>
|
|
1167
|
-
*
|
|
1193
|
+
* </li>
|
|
1168
1194
|
* <li>
|
|
1169
|
-
*
|
|
1195
|
+
* <p>
|
|
1170
1196
|
* <b>Raw</b> – Raw format.</p>
|
|
1171
|
-
*
|
|
1197
|
+
* </li>
|
|
1172
1198
|
* </ul>
|
|
1173
1199
|
*/
|
|
1174
1200
|
diskImageFormat: DiskImageFormat | string | undefined;
|
|
@@ -1268,6 +1294,9 @@ export interface ImageTestsConfiguration {
|
|
|
1268
1294
|
imageTestsEnabled?: boolean;
|
|
1269
1295
|
/**
|
|
1270
1296
|
* <p>The maximum time in minutes that tests are permitted to run.</p>
|
|
1297
|
+
* <note>
|
|
1298
|
+
* <p>The timeoutMinutes attribute is not currently active. This value is ignored.</p>
|
|
1299
|
+
* </note>
|
|
1271
1300
|
*/
|
|
1272
1301
|
timeoutMinutes?: number;
|
|
1273
1302
|
}
|
|
@@ -1335,7 +1364,7 @@ export interface Schedule {
|
|
|
1335
1364
|
/**
|
|
1336
1365
|
* <p>The cron expression determines how often EC2 Image Builder evaluates your
|
|
1337
1366
|
* <code>pipelineExecutionStartCondition</code>.</p>
|
|
1338
|
-
*
|
|
1367
|
+
* <p>For information on how to format a cron expression in Image Builder, see <a href="https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html">Use cron
|
|
1339
1368
|
* expressions in EC2 Image Builder</a>.</p>
|
|
1340
1369
|
*/
|
|
1341
1370
|
scheduleExpression?: string;
|
|
@@ -1442,22 +1471,22 @@ export interface CreateImageRecipeRequest {
|
|
|
1442
1471
|
description?: string;
|
|
1443
1472
|
/**
|
|
1444
1473
|
* <p>The semantic version of the image recipe. This version follows the semantic version syntax.</p>
|
|
1445
|
-
*
|
|
1446
|
-
*
|
|
1474
|
+
* <note>
|
|
1475
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
1447
1476
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
1448
|
-
*
|
|
1477
|
+
* <p>
|
|
1449
1478
|
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
1450
1479
|
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
1451
1480
|
* build number to the fourth node.</p>
|
|
1452
|
-
*
|
|
1481
|
+
* <p>
|
|
1453
1482
|
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
1454
1483
|
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
1455
1484
|
* a date, such as 2021.01.01.</p>
|
|
1456
|
-
*
|
|
1485
|
+
* </note>
|
|
1457
1486
|
*/
|
|
1458
1487
|
semanticVersion: string | undefined;
|
|
1459
1488
|
/**
|
|
1460
|
-
* <p>The components
|
|
1489
|
+
* <p>The components included in the image recipe.</p>
|
|
1461
1490
|
*/
|
|
1462
1491
|
components: ComponentConfiguration[] | undefined;
|
|
1463
1492
|
/**
|
|
@@ -1521,26 +1550,27 @@ export interface InstanceMetadataOptions {
|
|
|
1521
1550
|
/**
|
|
1522
1551
|
* <p>Indicates whether a signed token header is required for instance metadata retrieval requests.
|
|
1523
1552
|
* The values affect the response as follows:</p>
|
|
1524
|
-
*
|
|
1553
|
+
* <ul>
|
|
1525
1554
|
* <li>
|
|
1526
|
-
*
|
|
1555
|
+
* <p>
|
|
1527
1556
|
* <b>required</b> – When you retrieve the
|
|
1528
1557
|
* IAM role credentials, version 2.0 credentials are returned in all cases.</p>
|
|
1529
|
-
*
|
|
1558
|
+
* </li>
|
|
1530
1559
|
* <li>
|
|
1531
|
-
*
|
|
1560
|
+
* <p>
|
|
1532
1561
|
* <b>optional</b> – You can include a signed token header
|
|
1533
1562
|
* in your request to retrieve instance metadata, or you can leave it out. If you
|
|
1534
1563
|
* include it, version 2.0 credentials are returned for the IAM role. Otherwise,
|
|
1535
1564
|
* version 1.0 credentials are returned.</p>
|
|
1536
|
-
*
|
|
1565
|
+
* </li>
|
|
1537
1566
|
* </ul>
|
|
1538
|
-
*
|
|
1567
|
+
* <p>The default setting is <b>optional</b>.</p>
|
|
1539
1568
|
*/
|
|
1540
1569
|
httpTokens?: string;
|
|
1541
1570
|
/**
|
|
1542
1571
|
* <p>Limit the number of hops that an instance metadata request can traverse to reach its
|
|
1543
|
-
* destination
|
|
1572
|
+
* destination. The default is one hop. However, if HTTP tokens are required, container
|
|
1573
|
+
* image builds need a minimum of two hops.</p>
|
|
1544
1574
|
*/
|
|
1545
1575
|
httpPutResponseHopLimit?: number;
|
|
1546
1576
|
}
|
|
@@ -1610,11 +1640,11 @@ export interface CreateInfrastructureConfigurationRequest {
|
|
|
1610
1640
|
terminateInstanceOnFailure?: boolean;
|
|
1611
1641
|
/**
|
|
1612
1642
|
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</p>
|
|
1613
|
-
*
|
|
1614
|
-
*
|
|
1643
|
+
* <note>
|
|
1644
|
+
* <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys
|
|
1615
1645
|
* from other accounts. The key that is used to encrypt the SNS topic must reside in the
|
|
1616
1646
|
* account that the Image Builder service runs under.</p>
|
|
1617
|
-
*
|
|
1647
|
+
* </note>
|
|
1618
1648
|
*/
|
|
1619
1649
|
snsTopicArn?: string;
|
|
1620
1650
|
/**
|
|
@@ -1997,7 +2027,8 @@ export interface ImageRecipe {
|
|
|
1997
2027
|
*/
|
|
1998
2028
|
version?: string;
|
|
1999
2029
|
/**
|
|
2000
|
-
* <p>The components
|
|
2030
|
+
* <p>The components that are included in the image recipe. Recipes require a minimum of one build component, and can
|
|
2031
|
+
* have a maximum of 20 build and test components in any combination.</p>
|
|
2001
2032
|
*/
|
|
2002
2033
|
components?: ComponentConfiguration[];
|
|
2003
2034
|
/**
|
|
@@ -2028,6 +2059,12 @@ export interface ImageRecipe {
|
|
|
2028
2059
|
*/
|
|
2029
2060
|
additionalInstanceConfiguration?: AdditionalInstanceConfiguration;
|
|
2030
2061
|
}
|
|
2062
|
+
export declare enum ImageSource {
|
|
2063
|
+
AMAZON_MANAGED = "AMAZON_MANAGED",
|
|
2064
|
+
AWS_MARKETPLACE = "AWS_MARKETPLACE",
|
|
2065
|
+
CUSTOM = "CUSTOM",
|
|
2066
|
+
IMPORTED = "IMPORTED"
|
|
2067
|
+
}
|
|
2031
2068
|
/**
|
|
2032
2069
|
* <p>Details of the infrastructure configuration.</p>
|
|
2033
2070
|
*/
|
|
@@ -2075,11 +2112,11 @@ export interface InfrastructureConfiguration {
|
|
|
2075
2112
|
terminateInstanceOnFailure?: boolean;
|
|
2076
2113
|
/**
|
|
2077
2114
|
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</p>
|
|
2078
|
-
*
|
|
2079
|
-
*
|
|
2115
|
+
* <note>
|
|
2116
|
+
* <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys
|
|
2080
2117
|
* from other accounts. The key that is used to encrypt the SNS topic must reside in the
|
|
2081
2118
|
* account that the Image Builder service runs under.</p>
|
|
2082
|
-
*
|
|
2119
|
+
* </note>
|
|
2083
2120
|
*/
|
|
2084
2121
|
snsTopicArn?: string;
|
|
2085
2122
|
/**
|
|
@@ -2124,26 +2161,26 @@ export interface OutputResources {
|
|
|
2124
2161
|
export interface Image {
|
|
2125
2162
|
/**
|
|
2126
2163
|
* <p>The Amazon Resource Name (ARN) of the image.</p>
|
|
2127
|
-
*
|
|
2128
|
-
*
|
|
2164
|
+
* <note>
|
|
2165
|
+
* <p>Semantic versioning is included in each object's Amazon Resource Name (ARN),
|
|
2129
2166
|
* at the level that applies to that object as follows:</p>
|
|
2130
|
-
*
|
|
2167
|
+
* <ol>
|
|
2131
2168
|
* <li>
|
|
2132
|
-
*
|
|
2169
|
+
* <p>Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are
|
|
2133
2170
|
* either left off entirely, or they are specified as wildcards, for example: x.x.x.</p>
|
|
2134
|
-
*
|
|
2171
|
+
* </li>
|
|
2135
2172
|
* <li>
|
|
2136
|
-
*
|
|
2137
|
-
*
|
|
2173
|
+
* <p>Version ARNs have only the first three nodes: <major>.<minor>.<patch></p>
|
|
2174
|
+
* </li>
|
|
2138
2175
|
* <li>
|
|
2139
|
-
*
|
|
2140
|
-
*
|
|
2176
|
+
* <p>Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.</p>
|
|
2177
|
+
* </li>
|
|
2141
2178
|
* </ol>
|
|
2142
|
-
*
|
|
2179
|
+
* </note>
|
|
2143
2180
|
*/
|
|
2144
2181
|
arn?: string;
|
|
2145
2182
|
/**
|
|
2146
|
-
* <p>Specifies whether this
|
|
2183
|
+
* <p>Specifies whether this image produces an AMI or a container image.</p>
|
|
2147
2184
|
*/
|
|
2148
2185
|
type?: ImageType | string;
|
|
2149
2186
|
/**
|
|
@@ -2152,38 +2189,37 @@ export interface Image {
|
|
|
2152
2189
|
name?: string;
|
|
2153
2190
|
/**
|
|
2154
2191
|
* <p>The semantic version of the image.</p>
|
|
2155
|
-
*
|
|
2156
|
-
*
|
|
2192
|
+
* <note>
|
|
2193
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
2157
2194
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
2158
|
-
*
|
|
2195
|
+
* <p>
|
|
2159
2196
|
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
2160
2197
|
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
2161
2198
|
* build number to the fourth node.</p>
|
|
2162
|
-
*
|
|
2199
|
+
* <p>
|
|
2163
2200
|
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
2164
2201
|
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
2165
2202
|
* a date, such as 2021.01.01.</p>
|
|
2166
|
-
*
|
|
2203
|
+
* <p>
|
|
2167
2204
|
* <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
|
|
2168
2205
|
* to specify the most recent versions or nodes when selecting the base image or components for your
|
|
2169
2206
|
* recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
|
|
2170
2207
|
* wildcards.</p>
|
|
2171
|
-
*
|
|
2208
|
+
* </note>
|
|
2172
2209
|
*/
|
|
2173
2210
|
version?: string;
|
|
2174
2211
|
/**
|
|
2175
|
-
* <p>The platform
|
|
2212
|
+
* <p>The image operating system platform, such as Linux or Windows.</p>
|
|
2176
2213
|
*/
|
|
2177
2214
|
platform?: Platform | string;
|
|
2178
2215
|
/**
|
|
2179
|
-
* <p>
|
|
2180
|
-
* system (OS) version and package list
|
|
2181
|
-
* experience of using EC2 Image Builder. Enabled by default.</p>
|
|
2216
|
+
* <p>Indicates whether Image Builder collects additional information about the image, such as the
|
|
2217
|
+
* operating system (OS) version and package list.</p>
|
|
2182
2218
|
*/
|
|
2183
2219
|
enhancedImageMetadataEnabled?: boolean;
|
|
2184
2220
|
/**
|
|
2185
|
-
* <p>The operating system version
|
|
2186
|
-
* Microsoft Windows Server 2019.</p>
|
|
2221
|
+
* <p>The operating system version for instances that launch from this image. For example,
|
|
2222
|
+
* Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.</p>
|
|
2187
2223
|
*/
|
|
2188
2224
|
osVersion?: string;
|
|
2189
2225
|
/**
|
|
@@ -2191,11 +2227,13 @@ export interface Image {
|
|
|
2191
2227
|
*/
|
|
2192
2228
|
state?: ImageState;
|
|
2193
2229
|
/**
|
|
2194
|
-
* <p>
|
|
2230
|
+
* <p>For images that distribute an AMI, this is the image recipe that Image Builder used to
|
|
2231
|
+
* create the image. For container images, this is empty.</p>
|
|
2195
2232
|
*/
|
|
2196
2233
|
imageRecipe?: ImageRecipe;
|
|
2197
2234
|
/**
|
|
2198
|
-
* <p>
|
|
2235
|
+
* <p>For container images, this is the container recipe that Image Builder used to create the
|
|
2236
|
+
* image. For images that distribute an AMI, this is empty.</p>
|
|
2199
2237
|
*/
|
|
2200
2238
|
containerRecipe?: ContainerRecipe;
|
|
2201
2239
|
/**
|
|
@@ -2207,51 +2245,55 @@ export interface Image {
|
|
|
2207
2245
|
*/
|
|
2208
2246
|
sourcePipelineArn?: string;
|
|
2209
2247
|
/**
|
|
2210
|
-
* <p>The infrastructure used
|
|
2248
|
+
* <p>The infrastructure that Image Builder used to create this image.</p>
|
|
2211
2249
|
*/
|
|
2212
2250
|
infrastructureConfiguration?: InfrastructureConfiguration;
|
|
2213
2251
|
/**
|
|
2214
|
-
* <p>The distribution configuration used
|
|
2252
|
+
* <p>The distribution configuration that Image Builder used to create this image.</p>
|
|
2215
2253
|
*/
|
|
2216
2254
|
distributionConfiguration?: DistributionConfiguration;
|
|
2217
2255
|
/**
|
|
2218
|
-
* <p>The image tests
|
|
2256
|
+
* <p>The image tests that ran when that Image Builder created this image.</p>
|
|
2219
2257
|
*/
|
|
2220
2258
|
imageTestsConfiguration?: ImageTestsConfiguration;
|
|
2221
2259
|
/**
|
|
2222
|
-
* <p>The date on which this image
|
|
2260
|
+
* <p>The date on which Image Builder created this image.</p>
|
|
2223
2261
|
*/
|
|
2224
2262
|
dateCreated?: string;
|
|
2225
2263
|
/**
|
|
2226
|
-
* <p>The output resources
|
|
2264
|
+
* <p>The output resources that Image Builder produces for this image.</p>
|
|
2227
2265
|
*/
|
|
2228
2266
|
outputResources?: OutputResources;
|
|
2229
2267
|
/**
|
|
2230
|
-
* <p>The tags
|
|
2268
|
+
* <p>The tags that apply to this image.</p>
|
|
2231
2269
|
*/
|
|
2232
2270
|
tags?: Record<string, string>;
|
|
2233
2271
|
/**
|
|
2234
2272
|
* <p>Indicates the type of build that created this image. The build can be initiated
|
|
2235
2273
|
* in the following ways:</p>
|
|
2236
|
-
*
|
|
2274
|
+
* <ul>
|
|
2237
2275
|
* <li>
|
|
2238
|
-
*
|
|
2276
|
+
* <p>
|
|
2239
2277
|
* <b>USER_INITIATED</b> – A manual
|
|
2240
2278
|
* pipeline build request.</p>
|
|
2241
|
-
*
|
|
2279
|
+
* </li>
|
|
2242
2280
|
* <li>
|
|
2243
|
-
*
|
|
2281
|
+
* <p>
|
|
2244
2282
|
* <b>SCHEDULED</b> – A pipeline build
|
|
2245
2283
|
* initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p>
|
|
2246
|
-
*
|
|
2284
|
+
* </li>
|
|
2247
2285
|
* <li>
|
|
2248
|
-
*
|
|
2286
|
+
* <p>
|
|
2249
2287
|
* <b>IMPORT</b> – A VM import created
|
|
2250
2288
|
* the image to use as the base image for the recipe.</p>
|
|
2251
|
-
*
|
|
2289
|
+
* </li>
|
|
2252
2290
|
* </ul>
|
|
2253
2291
|
*/
|
|
2254
2292
|
buildType?: BuildType | string;
|
|
2293
|
+
/**
|
|
2294
|
+
* <p>The origin of the base image that Image Builder used to build this image.</p>
|
|
2295
|
+
*/
|
|
2296
|
+
imageSource?: ImageSource | string;
|
|
2255
2297
|
}
|
|
2256
2298
|
export interface GetImageResponse {
|
|
2257
2299
|
/**
|
|
@@ -2335,11 +2377,11 @@ export interface ImagePipeline {
|
|
|
2335
2377
|
*/
|
|
2336
2378
|
dateUpdated?: string;
|
|
2337
2379
|
/**
|
|
2338
|
-
* <p>
|
|
2380
|
+
* <p>This is no longer supported, and does not return a value.</p>
|
|
2339
2381
|
*/
|
|
2340
2382
|
dateLastRun?: string;
|
|
2341
2383
|
/**
|
|
2342
|
-
* <p>
|
|
2384
|
+
* <p>This is no longer supported, and does not return a value.</p>
|
|
2343
2385
|
*/
|
|
2344
2386
|
dateNextRun?: string;
|
|
2345
2387
|
/**
|
|
@@ -2435,15 +2477,15 @@ export interface ImportComponentRequest {
|
|
|
2435
2477
|
name: string | undefined;
|
|
2436
2478
|
/**
|
|
2437
2479
|
* <p>The semantic version of the component. This version follows the semantic version syntax.</p>
|
|
2438
|
-
*
|
|
2439
|
-
*
|
|
2480
|
+
* <note>
|
|
2481
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
2440
2482
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
2441
|
-
*
|
|
2483
|
+
* <p>
|
|
2442
2484
|
* <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
|
|
2443
2485
|
* to specify the most recent versions or nodes when selecting the base image or components for your
|
|
2444
2486
|
* recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
|
|
2445
2487
|
* wildcards.</p>
|
|
2446
|
-
*
|
|
2488
|
+
* </note>
|
|
2447
2489
|
*/
|
|
2448
2490
|
semanticVersion: string | undefined;
|
|
2449
2491
|
/**
|
|
@@ -2515,18 +2557,18 @@ export interface ImportVmImageRequest {
|
|
|
2515
2557
|
/**
|
|
2516
2558
|
* <p>The semantic version to attach to the base image that was created during the
|
|
2517
2559
|
* import process. This version follows the semantic version syntax.</p>
|
|
2518
|
-
*
|
|
2519
|
-
*
|
|
2560
|
+
* <note>
|
|
2561
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
2520
2562
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
2521
|
-
*
|
|
2563
|
+
* <p>
|
|
2522
2564
|
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
2523
2565
|
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
2524
2566
|
* build number to the fourth node.</p>
|
|
2525
|
-
*
|
|
2567
|
+
* <p>
|
|
2526
2568
|
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
2527
2569
|
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
2528
2570
|
* a date, such as 2021.01.01.</p>
|
|
2529
|
-
*
|
|
2571
|
+
* </note>
|
|
2530
2572
|
*/
|
|
2531
2573
|
semanticVersion: string | undefined;
|
|
2532
2574
|
/**
|
|
@@ -2619,19 +2661,20 @@ export interface ListComponentBuildVersionsResponse {
|
|
|
2619
2661
|
export declare enum Ownership {
|
|
2620
2662
|
AMAZON = "Amazon",
|
|
2621
2663
|
SELF = "Self",
|
|
2622
|
-
SHARED = "Shared"
|
|
2664
|
+
SHARED = "Shared",
|
|
2665
|
+
THIRDPARTY = "ThirdParty"
|
|
2623
2666
|
}
|
|
2624
2667
|
export interface ListComponentsRequest {
|
|
2625
2668
|
/**
|
|
2626
|
-
* <p>
|
|
2627
|
-
*
|
|
2628
|
-
* components
|
|
2629
|
-
* other
|
|
2669
|
+
* <p>Filters results based on the type of owner for the component. By default, this request
|
|
2670
|
+
* returns a list of components that your account owns. To see results for other types of owners,
|
|
2671
|
+
* you can specify components that Amazon manages, third party components, or components that
|
|
2672
|
+
* other accounts have shared with you.</p>
|
|
2630
2673
|
*/
|
|
2631
2674
|
owner?: Ownership | string;
|
|
2632
2675
|
/**
|
|
2633
2676
|
* <p>Use the following filters to streamline results:</p>
|
|
2634
|
-
*
|
|
2677
|
+
* <ul>
|
|
2635
2678
|
* <li>
|
|
2636
2679
|
* <p>
|
|
2637
2680
|
* <code>description</code>
|
|
@@ -2666,7 +2709,7 @@ export interface ListComponentsRequest {
|
|
|
2666
2709
|
*/
|
|
2667
2710
|
filters?: Filter[];
|
|
2668
2711
|
/**
|
|
2669
|
-
* <p>Returns the list of
|
|
2712
|
+
* <p>Returns the list of components for the specified name.</p>
|
|
2670
2713
|
*/
|
|
2671
2714
|
byName?: boolean;
|
|
2672
2715
|
/**
|
|
@@ -2686,10 +2729,10 @@ export interface ListComponentsResponse {
|
|
|
2686
2729
|
requestId?: string;
|
|
2687
2730
|
/**
|
|
2688
2731
|
* <p>The list of component semantic versions.</p>
|
|
2689
|
-
*
|
|
2690
|
-
*
|
|
2732
|
+
* <note>
|
|
2733
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
2691
2734
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
2692
|
-
*
|
|
2735
|
+
* </note>
|
|
2693
2736
|
*/
|
|
2694
2737
|
componentVersionList?: ComponentVersion[];
|
|
2695
2738
|
/**
|
|
@@ -2706,7 +2749,7 @@ export interface ListContainerRecipesRequest {
|
|
|
2706
2749
|
owner?: Ownership | string;
|
|
2707
2750
|
/**
|
|
2708
2751
|
* <p>Use the following filters to streamline results:</p>
|
|
2709
|
-
*
|
|
2752
|
+
* <ul>
|
|
2710
2753
|
* <li>
|
|
2711
2754
|
* <p>
|
|
2712
2755
|
* <code>containerType</code>
|
|
@@ -2791,7 +2834,7 @@ export interface ListImageBuildVersionsRequest {
|
|
|
2791
2834
|
imageVersionArn: string | undefined;
|
|
2792
2835
|
/**
|
|
2793
2836
|
* <p>Use the following filters to streamline results:</p>
|
|
2794
|
-
*
|
|
2837
|
+
* <ul>
|
|
2795
2838
|
* <li>
|
|
2796
2839
|
* <p>
|
|
2797
2840
|
* <code>name</code>
|
|
@@ -2843,7 +2886,7 @@ export interface ImageSummary {
|
|
|
2843
2886
|
*/
|
|
2844
2887
|
name?: string;
|
|
2845
2888
|
/**
|
|
2846
|
-
* <p>Specifies whether this
|
|
2889
|
+
* <p>Specifies whether this image produces an AMI or a container image.</p>
|
|
2847
2890
|
*/
|
|
2848
2891
|
type?: ImageType | string;
|
|
2849
2892
|
/**
|
|
@@ -2851,12 +2894,12 @@ export interface ImageSummary {
|
|
|
2851
2894
|
*/
|
|
2852
2895
|
version?: string;
|
|
2853
2896
|
/**
|
|
2854
|
-
* <p>The platform
|
|
2897
|
+
* <p>The image operating system platform, such as Linux or Windows.</p>
|
|
2855
2898
|
*/
|
|
2856
2899
|
platform?: Platform | string;
|
|
2857
2900
|
/**
|
|
2858
|
-
* <p>The operating system version of the
|
|
2859
|
-
* Microsoft Windows Server 2019.</p>
|
|
2901
|
+
* <p>The operating system version of the instances that launch from this image. For
|
|
2902
|
+
* example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.</p>
|
|
2860
2903
|
*/
|
|
2861
2904
|
osVersion?: string;
|
|
2862
2905
|
/**
|
|
@@ -2868,39 +2911,43 @@ export interface ImageSummary {
|
|
|
2868
2911
|
*/
|
|
2869
2912
|
owner?: string;
|
|
2870
2913
|
/**
|
|
2871
|
-
* <p>The date on which this image
|
|
2914
|
+
* <p>The date on which Image Builder created this image.</p>
|
|
2872
2915
|
*/
|
|
2873
2916
|
dateCreated?: string;
|
|
2874
2917
|
/**
|
|
2875
|
-
* <p>The output resources produced when
|
|
2918
|
+
* <p>The output resources that Image Builder produced when it created this image.</p>
|
|
2876
2919
|
*/
|
|
2877
2920
|
outputResources?: OutputResources;
|
|
2878
2921
|
/**
|
|
2879
|
-
* <p>The tags
|
|
2922
|
+
* <p>The tags that apply to this image.</p>
|
|
2880
2923
|
*/
|
|
2881
2924
|
tags?: Record<string, string>;
|
|
2882
2925
|
/**
|
|
2883
2926
|
* <p>Indicates the type of build that created this image. The build can be initiated
|
|
2884
2927
|
* in the following ways:</p>
|
|
2885
|
-
*
|
|
2928
|
+
* <ul>
|
|
2886
2929
|
* <li>
|
|
2887
|
-
*
|
|
2930
|
+
* <p>
|
|
2888
2931
|
* <b>USER_INITIATED</b> – A manual
|
|
2889
2932
|
* pipeline build request.</p>
|
|
2890
|
-
*
|
|
2933
|
+
* </li>
|
|
2891
2934
|
* <li>
|
|
2892
|
-
*
|
|
2935
|
+
* <p>
|
|
2893
2936
|
* <b>SCHEDULED</b> – A pipeline build
|
|
2894
2937
|
* initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p>
|
|
2895
|
-
*
|
|
2938
|
+
* </li>
|
|
2896
2939
|
* <li>
|
|
2897
|
-
*
|
|
2940
|
+
* <p>
|
|
2898
2941
|
* <b>IMPORT</b> – A VM import created
|
|
2899
2942
|
* the image to use as the base image for the recipe.</p>
|
|
2900
|
-
*
|
|
2943
|
+
* </li>
|
|
2901
2944
|
* </ul>
|
|
2902
2945
|
*/
|
|
2903
2946
|
buildType?: BuildType | string;
|
|
2947
|
+
/**
|
|
2948
|
+
* <p>The origin of the base image that Image Builder used to build this image.</p>
|
|
2949
|
+
*/
|
|
2950
|
+
imageSource?: ImageSource | string;
|
|
2904
2951
|
}
|
|
2905
2952
|
export interface ListImageBuildVersionsResponse {
|
|
2906
2953
|
/**
|
|
@@ -2966,7 +3013,7 @@ export interface ListImagePipelineImagesRequest {
|
|
|
2966
3013
|
imagePipelineArn: string | undefined;
|
|
2967
3014
|
/**
|
|
2968
3015
|
* <p>Use the following filters to streamline results:</p>
|
|
2969
|
-
*
|
|
3016
|
+
* <ul>
|
|
2970
3017
|
* <li>
|
|
2971
3018
|
* <p>
|
|
2972
3019
|
* <code>name</code>
|
|
@@ -3009,7 +3056,7 @@ export interface ListImagePipelineImagesResponse {
|
|
|
3009
3056
|
export interface ListImagePipelinesRequest {
|
|
3010
3057
|
/**
|
|
3011
3058
|
* <p>Use the following filters to streamline results:</p>
|
|
3012
|
-
*
|
|
3059
|
+
* <ul>
|
|
3013
3060
|
* <li>
|
|
3014
3061
|
* <p>
|
|
3015
3062
|
* <code>description</code>
|
|
@@ -3079,7 +3126,7 @@ export interface ListImageRecipesRequest {
|
|
|
3079
3126
|
owner?: Ownership | string;
|
|
3080
3127
|
/**
|
|
3081
3128
|
* <p>Use the following filters to streamline results:</p>
|
|
3082
|
-
*
|
|
3129
|
+
* <ul>
|
|
3083
3130
|
* <li>
|
|
3084
3131
|
* <p>
|
|
3085
3132
|
* <code>name</code>
|
|
@@ -3167,7 +3214,7 @@ export interface ListImagesRequest {
|
|
|
3167
3214
|
owner?: Ownership | string;
|
|
3168
3215
|
/**
|
|
3169
3216
|
* <p>Use the following filters to streamline results:</p>
|
|
3170
|
-
*
|
|
3217
|
+
* <ul>
|
|
3171
3218
|
* <li>
|
|
3172
3219
|
* <p>
|
|
3173
3220
|
* <code>name</code>
|
|
@@ -3220,22 +3267,22 @@ export interface ListImagesRequest {
|
|
|
3220
3267
|
export interface ImageVersion {
|
|
3221
3268
|
/**
|
|
3222
3269
|
* <p>The Amazon Resource Name (ARN) of a specific version of an Image Builder image.</p>
|
|
3223
|
-
*
|
|
3224
|
-
*
|
|
3270
|
+
* <note>
|
|
3271
|
+
* <p>Semantic versioning is included in each object's Amazon Resource Name (ARN),
|
|
3225
3272
|
* at the level that applies to that object as follows:</p>
|
|
3226
|
-
*
|
|
3273
|
+
* <ol>
|
|
3227
3274
|
* <li>
|
|
3228
|
-
*
|
|
3275
|
+
* <p>Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are
|
|
3229
3276
|
* either left off entirely, or they are specified as wildcards, for example: x.x.x.</p>
|
|
3230
|
-
*
|
|
3277
|
+
* </li>
|
|
3231
3278
|
* <li>
|
|
3232
|
-
*
|
|
3233
|
-
*
|
|
3279
|
+
* <p>Version ARNs have only the first three nodes: <major>.<minor>.<patch></p>
|
|
3280
|
+
* </li>
|
|
3234
3281
|
* <li>
|
|
3235
|
-
*
|
|
3236
|
-
*
|
|
3282
|
+
* <p>Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.</p>
|
|
3283
|
+
* </li>
|
|
3237
3284
|
* </ol>
|
|
3238
|
-
*
|
|
3285
|
+
* </note>
|
|
3239
3286
|
*/
|
|
3240
3287
|
arn?: string;
|
|
3241
3288
|
/**
|
|
@@ -3243,32 +3290,32 @@ export interface ImageVersion {
|
|
|
3243
3290
|
*/
|
|
3244
3291
|
name?: string;
|
|
3245
3292
|
/**
|
|
3246
|
-
* <p>Specifies whether this image
|
|
3293
|
+
* <p>Specifies whether this image produces an AMI or a container image.</p>
|
|
3247
3294
|
*/
|
|
3248
3295
|
type?: ImageType | string;
|
|
3249
3296
|
/**
|
|
3250
3297
|
* <p>Details for a specific version of an Image Builder image. This version follows the semantic version syntax.</p>
|
|
3251
|
-
*
|
|
3252
|
-
*
|
|
3298
|
+
* <note>
|
|
3299
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
3253
3300
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
3254
|
-
*
|
|
3301
|
+
* <p>
|
|
3255
3302
|
* <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including
|
|
3256
3303
|
* zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the
|
|
3257
3304
|
* build number to the fourth node.</p>
|
|
3258
|
-
*
|
|
3305
|
+
* <p>
|
|
3259
3306
|
* <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for
|
|
3260
3307
|
* the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or
|
|
3261
3308
|
* a date, such as 2021.01.01.</p>
|
|
3262
|
-
*
|
|
3309
|
+
* <p>
|
|
3263
3310
|
* <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
|
|
3264
3311
|
* to specify the most recent versions or nodes when selecting the base image or components for your
|
|
3265
3312
|
* recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
|
|
3266
3313
|
* wildcards.</p>
|
|
3267
|
-
*
|
|
3314
|
+
* </note>
|
|
3268
3315
|
*/
|
|
3269
3316
|
version?: string;
|
|
3270
3317
|
/**
|
|
3271
|
-
* <p>The platform of the image version, for example "Windows" or "Linux".</p>
|
|
3318
|
+
* <p>The operating system platform of the image version, for example "Windows" or "Linux".</p>
|
|
3272
3319
|
*/
|
|
3273
3320
|
platform?: Platform | string;
|
|
3274
3321
|
/**
|
|
@@ -3287,25 +3334,29 @@ export interface ImageVersion {
|
|
|
3287
3334
|
/**
|
|
3288
3335
|
* <p>Indicates the type of build that created this image. The build can be initiated
|
|
3289
3336
|
* in the following ways:</p>
|
|
3290
|
-
*
|
|
3337
|
+
* <ul>
|
|
3291
3338
|
* <li>
|
|
3292
|
-
*
|
|
3339
|
+
* <p>
|
|
3293
3340
|
* <b>USER_INITIATED</b> – A manual
|
|
3294
3341
|
* pipeline build request.</p>
|
|
3295
|
-
*
|
|
3342
|
+
* </li>
|
|
3296
3343
|
* <li>
|
|
3297
|
-
*
|
|
3344
|
+
* <p>
|
|
3298
3345
|
* <b>SCHEDULED</b> – A pipeline build
|
|
3299
3346
|
* initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p>
|
|
3300
|
-
*
|
|
3347
|
+
* </li>
|
|
3301
3348
|
* <li>
|
|
3302
|
-
*
|
|
3349
|
+
* <p>
|
|
3303
3350
|
* <b>IMPORT</b> – A VM import created
|
|
3304
3351
|
* the image to use as the base image for the recipe.</p>
|
|
3305
|
-
*
|
|
3352
|
+
* </li>
|
|
3306
3353
|
* </ul>
|
|
3307
3354
|
*/
|
|
3308
3355
|
buildType?: BuildType | string;
|
|
3356
|
+
/**
|
|
3357
|
+
* <p>The origin of the base image that Image Builder used to build this image.</p>
|
|
3358
|
+
*/
|
|
3359
|
+
imageSource?: ImageSource | string;
|
|
3309
3360
|
}
|
|
3310
3361
|
export interface ListImagesResponse {
|
|
3311
3362
|
/**
|
|
@@ -3314,15 +3365,15 @@ export interface ListImagesResponse {
|
|
|
3314
3365
|
requestId?: string;
|
|
3315
3366
|
/**
|
|
3316
3367
|
* <p>The list of image semantic versions.</p>
|
|
3317
|
-
*
|
|
3318
|
-
*
|
|
3368
|
+
* <note>
|
|
3369
|
+
* <p>The semantic version has four nodes: <major>.<minor>.<patch>/<build>.
|
|
3319
3370
|
* You can assign values for the first three, and can filter on all of them.</p>
|
|
3320
|
-
*
|
|
3371
|
+
* <p>
|
|
3321
3372
|
* <b>Filtering:</b> With semantic versioning, you have the flexibility to use wildcards (x)
|
|
3322
3373
|
* to specify the most recent versions or nodes when selecting the base image or components for your
|
|
3323
3374
|
* recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be
|
|
3324
3375
|
* wildcards.</p>
|
|
3325
|
-
*
|
|
3376
|
+
* </note>
|
|
3326
3377
|
*/
|
|
3327
3378
|
imageVersionList?: ImageVersion[];
|
|
3328
3379
|
/**
|
|
@@ -3710,11 +3761,11 @@ export interface UpdateInfrastructureConfigurationRequest {
|
|
|
3710
3761
|
terminateInstanceOnFailure?: boolean;
|
|
3711
3762
|
/**
|
|
3712
3763
|
* <p>The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.</p>
|
|
3713
|
-
*
|
|
3714
|
-
*
|
|
3764
|
+
* <note>
|
|
3765
|
+
* <p>EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys
|
|
3715
3766
|
* from other accounts. The key that is used to encrypt the SNS topic must reside in the
|
|
3716
3767
|
* account that the Image Builder service runs under.</p>
|
|
3717
|
-
*
|
|
3768
|
+
* </note>
|
|
3718
3769
|
*/
|
|
3719
3770
|
snsTopicArn?: string;
|
|
3720
3771
|
/**
|
|
@@ -3729,23 +3780,23 @@ export interface UpdateInfrastructureConfigurationRequest {
|
|
|
3729
3780
|
* <p>The instance metadata options that you can set for the HTTP requests that pipeline builds
|
|
3730
3781
|
* use to launch EC2 build and test instances. For more information about instance metadata
|
|
3731
3782
|
* options, see one of the following links:</p>
|
|
3732
|
-
*
|
|
3783
|
+
* <ul>
|
|
3733
3784
|
* <li>
|
|
3734
|
-
*
|
|
3785
|
+
* <p>
|
|
3735
3786
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html">Configure
|
|
3736
3787
|
* the instance metadata options</a> in the <i>
|
|
3737
3788
|
* <i>Amazon EC2 User Guide</i>
|
|
3738
3789
|
* </i>
|
|
3739
3790
|
* for Linux instances.</p>
|
|
3740
|
-
*
|
|
3791
|
+
* </li>
|
|
3741
3792
|
* <li>
|
|
3742
|
-
*
|
|
3793
|
+
* <p>
|
|
3743
3794
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html">Configure
|
|
3744
3795
|
* the instance metadata options</a> in the <i>
|
|
3745
3796
|
* <i>Amazon EC2 Windows Guide</i>
|
|
3746
3797
|
* </i>
|
|
3747
3798
|
* for Windows instances.</p>
|
|
3748
|
-
*
|
|
3799
|
+
* </li>
|
|
3749
3800
|
* </ul>
|
|
3750
3801
|
*/
|
|
3751
3802
|
instanceMetadataOptions?: InstanceMetadataOptions;
|