aws-sdk-imagebuilder 1.112.0 → 1.114.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.
@@ -61,8 +61,9 @@ module Aws::Imagebuilder
61
61
  # whether to keep it for the AMI that you create.
62
62
  #
63
63
  # @!attribute [rw] systems_manager_agent
64
- # Contains settings for the Systems Manager agent on your build
65
- # instance.
64
+ # The Systems Manager agent settings for your build instance. This
65
+ # setting applies to Linux and macOS build instances only. Requests
66
+ # that set it for a recipe with a Windows base image are rejected.
66
67
  # @return [Types::SystemsManagerAgent]
67
68
  #
68
69
  # @!attribute [rw] user_data_override
@@ -77,7 +78,7 @@ module Aws::Imagebuilder
77
78
  #
78
79
  # <note markdown="1"> The user data is always base 64 encoded. For example, the following
79
80
  # commands are encoded as
80
- # `IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$`:
81
+ # `IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhcg==`:
81
82
  #
82
83
  # *#!/bin/bash*
83
84
  #
@@ -117,7 +118,8 @@ module Aws::Imagebuilder
117
118
  # @return [String]
118
119
  #
119
120
  # @!attribute [rw] state
120
- # Image status and the reason for that status.
121
+ # The state of the AMI, which includes the status and, if applicable,
122
+ # the reason for that status.
121
123
  # @return [Types::ImageState]
122
124
  #
123
125
  # @!attribute [rw] account_id
@@ -140,16 +142,27 @@ module Aws::Imagebuilder
140
142
  # Define and configure the output AMIs of the pipeline.
141
143
  #
142
144
  # @!attribute [rw] name
143
- # The name of the output AMI.
145
+ # The name of the output AMI. The name must include the `{{
146
+ # imagebuilder:buildDate }}` dynamic tag so that each build produces a
147
+ # uniquely named AMI. If you don't specify a name, Image Builder
148
+ # names the output AMI with the image name followed by the build
149
+ # timestamp, for example `my-image 2022-10-26T22-30-05.912619Z`.
144
150
  # @return [String]
145
151
  #
146
152
  # @!attribute [rw] description
147
- # The description of the AMI distribution configuration. Minimum and
148
- # maximum length are in characters.
153
+ # The description to apply to the distributed AMI. Image Builder sets
154
+ # this as the output AMI's description in each target Region and
155
+ # account. If you don't specify a description, the AMI in the build
156
+ # Region uses the image recipe's description, if the recipe has one.
157
+ # Copies distributed to other Regions and accounts don't receive a
158
+ # default description.
149
159
  # @return [String]
150
160
  #
151
161
  # @!attribute [rw] target_account_ids
152
- # The ID of an account to which you want to distribute an image.
162
+ # The Amazon Web Services account IDs to distribute the AMI to in this
163
+ # Region. Each listed account receives its own copy of the output AMI.
164
+ # If you don't specify accounts, Image Builder distributes the AMI
165
+ # only to your own account.
153
166
  # @return [Array<String>]
154
167
  #
155
168
  # @!attribute [rw] ami_tags
@@ -186,7 +199,9 @@ module Aws::Imagebuilder
186
199
  end
187
200
 
188
201
  # Defines the rules by which an image pipeline is automatically disabled
189
- # when it fails.
202
+ # when it fails. By default, if the schedule doesn't include an
203
+ # auto-disable policy, Image Builder disables the pipeline after 5
204
+ # consecutive failed scheduled builds.
190
205
  #
191
206
  # @!attribute [rw] failure_count
192
207
  # The number of consecutive scheduled image pipeline executions that
@@ -201,8 +216,35 @@ module Aws::Imagebuilder
201
216
  include Aws::Structure
202
217
  end
203
218
 
204
- # You have exceeded the permitted request rate for the specific
205
- # operation.
219
+ # Identifies the Amazon EC2 Auto Scaling group that Image Builder takes
220
+ # the build instance from, and how long Image Builder waits when the
221
+ # group has no instance available.
222
+ #
223
+ # @!attribute [rw] name
224
+ # The name of the Auto Scaling group, in the same account and Amazon
225
+ # Web Services Region as the infrastructure configuration. To specify
226
+ # a group, you must have permissions to describe it.
227
+ # @return [String]
228
+ #
229
+ # @!attribute [rw] capacity_wait_timeout_seconds
230
+ # The number of seconds that Image Builder waits for an instance to
231
+ # become available in the group before the build fails. If you set
232
+ # this value to 0 or omit it, the build fails as soon as the group has
233
+ # no instance available.
234
+ # @return [Integer]
235
+ #
236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/AutoScalingGroupConfiguration AWS API Documentation
237
+ #
238
+ class AutoScalingGroupConfiguration < Struct.new(
239
+ :name,
240
+ :capacity_wait_timeout_seconds)
241
+ SENSITIVE = []
242
+ include Aws::Structure
243
+ end
244
+
245
+ # You have exceeded the permitted request rate for the Amazon EC2 APIs
246
+ # that Image Builder calls on your behalf. Retry with an increasing or
247
+ # variable delay between requests.
206
248
  #
207
249
  # @!attribute [rw] message
208
250
  # @return [String]
@@ -222,10 +264,10 @@ module Aws::Imagebuilder
222
264
  #
223
265
  # @!attribute [rw] client_token
224
266
  # A unique, case-sensitive identifier you provide to ensure that the
225
- # operation completes no more than one time. If this token matches a
226
- # previous request, the service ignores the request, but does not
227
- # return an error. For more information, see [Ensuring idempotency][1]
228
- # in the *Amazon EC2 API Reference*.
267
+ # operation runs no more than one time. If you retry a request with
268
+ # the same client token, Image Builder returns the original response
269
+ # without running the operation again. For more information, see
270
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
229
271
  #
230
272
  # **A suitable default value is auto-generated.** You should normally
231
273
  # not need to pass this option.
@@ -274,10 +316,10 @@ module Aws::Imagebuilder
274
316
  #
275
317
  # @!attribute [rw] client_token
276
318
  # A unique, case-sensitive identifier you provide to ensure that the
277
- # operation completes no more than one time. If this token matches a
278
- # previous request, the service ignores the request, but does not
279
- # return an error. For more information, see [Ensuring idempotency][1]
280
- # in the *Amazon EC2 API Reference*.
319
+ # operation runs no more than one time. If you retry a request with
320
+ # the same client token, Image Builder returns the original response
321
+ # without running the operation again. For more information, see
322
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
281
323
  #
282
324
  # **A suitable default value is auto-generated.** You should normally
283
325
  # not need to pass this option.
@@ -297,8 +339,9 @@ module Aws::Imagebuilder
297
339
  end
298
340
 
299
341
  # @!attribute [rw] lifecycle_execution_id
300
- # The unique identifier for the image lifecycle runtime instance that
301
- # was canceled.
342
+ # The unique identifier of the lifecycle execution that the
343
+ # cancellation request applies to. The cancellation completes
344
+ # asynchronously.
302
345
  # @return [String]
303
346
  #
304
347
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CancelLifecycleExecutionResponse AWS API Documentation
@@ -309,10 +352,9 @@ module Aws::Imagebuilder
309
352
  include Aws::Structure
310
353
  end
311
354
 
312
- # These errors are usually caused by a client action, such as using an
313
- # action or resource on behalf of a user that doesn't have permissions
314
- # to use the action or resource, or specifying an invalid resource
315
- # identifier.
355
+ # A generic client error. This error usually indicates that the request
356
+ # failed a validation check, such as when a downstream service rejects a
357
+ # configured value.
316
358
  #
317
359
  # @!attribute [rw] message
318
360
  # @return [String]
@@ -374,7 +416,9 @@ module Aws::Imagebuilder
374
416
  # @return [Array<Types::ComponentParameterDetail>]
375
417
  #
376
418
  # @!attribute [rw] owner
377
- # The owner of the component.
419
+ # The owner of the component. The value is your account ID for
420
+ # components that you own, the sharing account's ID for shared
421
+ # components, or `Amazon`, `ThirdParty`, or `AWSMarketplace`.
378
422
  # @return [String]
379
423
  #
380
424
  # @!attribute [rw] data
@@ -393,7 +437,9 @@ module Aws::Imagebuilder
393
437
  # @return [String]
394
438
  #
395
439
  # @!attribute [rw] encrypted
396
- # The encryption status of the component.
440
+ # Indicates whether the component data is encrypted at rest. Image
441
+ # Builder encrypts all component data at rest, so this value is always
442
+ # `true`. This field is retained for backward compatibility.
397
443
  # @return [Boolean]
398
444
  #
399
445
  # @!attribute [rw] date_created
@@ -446,15 +492,21 @@ module Aws::Imagebuilder
446
492
  include Aws::Structure
447
493
  end
448
494
 
449
- # Configuration details of the component.
495
+ # Configuration details of the component. You can specify each component
496
+ # only once in a recipe, regardless of version. Components with a status
497
+ # of `DEPRECATED` or `DISABLED` can't be added to new recipes.
450
498
  #
451
499
  # @!attribute [rw] component_arn
452
- # The Amazon Resource Name (ARN) of the component.
500
+ # The Amazon Resource Name (ARN) of the component. You can specify a
501
+ # build version ARN, or a component version ARN whose version segments
502
+ # can use `x` wildcards, for example `1.x.x`.
453
503
  # @return [String]
454
504
  #
455
505
  # @!attribute [rw] parameters
456
506
  # A group of parameter settings that Image Builder uses to configure
457
- # the component for a specific recipe.
507
+ # the component for a specific recipe. You must supply a value for
508
+ # every component parameter that has no default value, and you can
509
+ # only supply parameters that the component defines.
458
510
  # @return [Array<Types::ComponentParameter>]
459
511
  #
460
512
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ComponentConfiguration AWS API Documentation
@@ -559,7 +611,8 @@ module Aws::Imagebuilder
559
611
  # A group of fields that describe the current status of components.
560
612
  #
561
613
  # @!attribute [rw] status
562
- # The current state of the component.
614
+ # The current state of the component. Components with a status of
615
+ # `DEPRECATED` or `DISABLED` can't be added to new recipes.
563
616
  # @return [String]
564
617
  #
565
618
  # @!attribute [rw] reason
@@ -610,7 +663,9 @@ module Aws::Imagebuilder
610
663
  # @return [String]
611
664
  #
612
665
  # @!attribute [rw] owner
613
- # The owner of the component.
666
+ # The owner of the component. The value is your account ID for
667
+ # components that you own, the sharing account's ID for shared
668
+ # components, or `Amazon`, `ThirdParty`, or `AWSMarketplace`.
614
669
  # @return [String]
615
670
  #
616
671
  # @!attribute [rw] description
@@ -618,11 +673,11 @@ module Aws::Imagebuilder
618
673
  # @return [String]
619
674
  #
620
675
  # @!attribute [rw] change_description
621
- # The change description for the current version of the component.
676
+ # The change description for this version of the component.
622
677
  # @return [String]
623
678
  #
624
679
  # @!attribute [rw] date_created
625
- # The original creation date of the component.
680
+ # The date that Image Builder created this version of the component.
626
681
  # @return [String]
627
682
  #
628
683
  # @!attribute [rw] tags
@@ -661,8 +716,7 @@ module Aws::Imagebuilder
661
716
  include Aws::Structure
662
717
  end
663
718
 
664
- # The defining characteristics of a specific version of an Amazon Web
665
- # Services TOE component.
719
+ # The defining characteristics of a specific version of a component.
666
720
  #
667
721
  # @!attribute [rw] arn
668
722
  # The Amazon Resource Name (ARN) of the component.
@@ -732,7 +786,9 @@ module Aws::Imagebuilder
732
786
  # @return [String]
733
787
  #
734
788
  # @!attribute [rw] owner
735
- # The owner of the component.
789
+ # The owner of the component. The value is your account ID for
790
+ # components that you own, the sharing account's ID for shared
791
+ # components, or `Amazon`, `ThirdParty`, or `AWSMarketplace`.
736
792
  # @return [String]
737
793
  #
738
794
  # @!attribute [rw] date_created
@@ -766,7 +822,9 @@ module Aws::Imagebuilder
766
822
  include Aws::Structure
767
823
  end
768
824
 
769
- # A container encapsulates the runtime environment for an application.
825
+ # Details of the container images that are output resources of an image
826
+ # build in a given Amazon Web Services Region: the Region, and the URIs
827
+ # of the container images.
770
828
  #
771
829
  # @!attribute [rw] region
772
830
  # Containers and container images are Region-specific. This is the
@@ -786,15 +844,18 @@ module Aws::Imagebuilder
786
844
  include Aws::Structure
787
845
  end
788
846
 
789
- # Container distribution settings for encryption, licensing, and sharing
790
- # in a specific Region.
847
+ # Defines how the output container image is distributed in a specific
848
+ # Amazon Web Services Region: the target repository, the image tags to
849
+ # apply to the distributed image, and an optional description.
791
850
  #
792
851
  # @!attribute [rw] description
793
852
  # The description of the container distribution configuration.
794
853
  # @return [String]
795
854
  #
796
855
  # @!attribute [rw] container_tags
797
- # Tags that are attached to the container distribution configuration.
856
+ # Tags that Image Builder applies to the distributed container image
857
+ # in the target repository. These are repository image tags, not
858
+ # resource tags.
798
859
  # @return [Array<String>]
799
860
  #
800
861
  # @!attribute [rw] target_repository
@@ -812,7 +873,10 @@ module Aws::Imagebuilder
812
873
  include Aws::Structure
813
874
  end
814
875
 
815
- # A container recipe.
876
+ # Defines how Image Builder builds and tests a container image: the base
877
+ # image, components to apply, the Dockerfile template, the build and
878
+ # test instance configuration, and the target repository for the output
879
+ # image.
816
880
  #
817
881
  # @!attribute [rw] arn
818
882
  # The Amazon Resource Name (ARN) of the container recipe.
@@ -846,7 +910,8 @@ module Aws::Imagebuilder
846
910
  # @return [String]
847
911
  #
848
912
  # @!attribute [rw] platform
849
- # The system platform for the container, such as Windows or Linux.
913
+ # The system platform for the container. Container recipes support
914
+ # only the Linux and Windows platforms.
850
915
  # @return [String]
851
916
  #
852
917
  # @!attribute [rw] owner
@@ -880,8 +945,14 @@ module Aws::Imagebuilder
880
945
  #
881
946
  # @!attribute [rw] components
882
947
  # Build and test components that are included in the container recipe.
883
- # Recipes require a minimum of one build component, and can have a
884
- # maximum of 20 build and test components in any combination.
948
+ # A recipe can contain a maximum of 20 build and test components in
949
+ # any combination, by default. This maximum is an adjustable quota.
950
+ # For more information, see [EC2 Image Builder endpoints and
951
+ # quotas][1] in the *Amazon Web Services General Reference*.
952
+ #
953
+ #
954
+ #
955
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html
885
956
  # @return [Array<Types::ComponentConfiguration>]
886
957
  #
887
958
  # @!attribute [rw] instance_configuration
@@ -890,19 +961,26 @@ module Aws::Imagebuilder
890
961
  # @return [Types::InstanceConfiguration]
891
962
  #
892
963
  # @!attribute [rw] dockerfile_template_data
893
- # Dockerfiles are text documents that are used to build Docker
894
- # containers, and ensure that they contain all of the elements
895
- # required by the application running inside. The template data
896
- # consists of contextual variables where Image Builder places build
897
- # information or scripts, based on your container image recipe.
964
+ # The Dockerfile template that Image Builder uses to build the
965
+ # container image. The template can include contextual variables that
966
+ # Image Builder replaces with build information at build time. For the
967
+ # contextual variables that the template can include, see [Create a
968
+ # new version of a container recipe][1] in the *EC2 Image Builder User
969
+ # Guide*.
970
+ #
971
+ #
972
+ #
973
+ # [1]: https://docs.aws.amazon.com/imagebuilder/latest/userguide/create-container-recipes.html
898
974
  # @return [String]
899
975
  #
900
976
  # @!attribute [rw] kms_key_id
901
- # The Amazon Resource Name (ARN) that uniquely identifies which KMS
902
- # key is used to encrypt the container image for distribution to the
903
- # target Region. This can be either the Key ARN or the Alias ARN. For
904
- # more information, see [Key identifiers (KeyId)][1] in the *Key
905
- # Management Service Developer Guide*.
977
+ # The KMS key that Image Builder uses to encrypt the recipe's
978
+ # Dockerfile template data at rest. This can be either the Key ARN or
979
+ # the Alias ARN. For more information, see [Key identifiers
980
+ # (KeyId)][1] in the *Key Management Service Developer Guide*. If you
981
+ # don't specify a key, Image Builder encrypts the template data with
982
+ # a KMS key that Image Builder owns. This key isn't used to encrypt
983
+ # the output container image.
906
984
  #
907
985
  #
908
986
  #
@@ -910,7 +988,11 @@ module Aws::Imagebuilder
910
988
  # @return [String]
911
989
  #
912
990
  # @!attribute [rw] encrypted
913
- # A flag that indicates if the target container is encrypted.
991
+ # Specifies whether the recipe's Dockerfile template data is
992
+ # encrypted at rest. Image Builder encrypts all Dockerfile template
993
+ # data at rest, so this value is always `true`. This field is retained
994
+ # for backward compatibility, and doesn't describe encryption of the
995
+ # output container image.
914
996
  # @return [Boolean]
915
997
  #
916
998
  # @!attribute [rw] parent_image
@@ -959,7 +1041,7 @@ module Aws::Imagebuilder
959
1041
  include Aws::Structure
960
1042
  end
961
1043
 
962
- # A summary of a container recipe
1044
+ # A summary of a container recipe.
963
1045
  #
964
1046
  # @!attribute [rw] arn
965
1047
  # The Amazon Resource Name (ARN) of the container recipe.
@@ -974,7 +1056,8 @@ module Aws::Imagebuilder
974
1056
  # @return [String]
975
1057
  #
976
1058
  # @!attribute [rw] platform
977
- # The system platform for the container, such as Windows or Linux.
1059
+ # The system platform for the container. Container recipes support
1060
+ # only the Linux and Windows platforms.
978
1061
  # @return [String]
979
1062
  #
980
1063
  # @!attribute [rw] owner
@@ -1020,7 +1103,14 @@ module Aws::Imagebuilder
1020
1103
  end
1021
1104
 
1022
1105
  # @!attribute [rw] name
1023
- # The name of the component.
1106
+ # The name of the component. Image Builder generates the component ARN
1107
+ # from a normalized form of the name, so names that differ only in
1108
+ # case, spaces, or underscores count as the same name. If a component
1109
+ # with the same name and semantic version already exists in your
1110
+ # account in the same Amazon Web Services Region, the request creates
1111
+ # a new build version for it. If the content is also identical to the
1112
+ # latest build version, the request fails because the component
1113
+ # already exists.
1024
1114
  # @return [String]
1025
1115
  #
1026
1116
  # @!attribute [rw] semantic_version
@@ -1075,7 +1165,8 @@ module Aws::Imagebuilder
1075
1165
  # The `uri` of a YAML component document file. This must be an S3 URL
1076
1166
  # (`s3://bucket/key`), and you must have permission to access the S3
1077
1167
  # bucket it points to. If you use Amazon S3, you can specify component
1078
- # content up to your service quota.
1168
+ # content up to your service quota for component size, which is 64 KB
1169
+ # by default.
1079
1170
  #
1080
1171
  # Alternatively, you can specify the YAML document inline, using the
1081
1172
  # component `data` property. You cannot specify both properties.
@@ -1085,7 +1176,9 @@ module Aws::Imagebuilder
1085
1176
  # The Amazon Resource Name (ARN) that uniquely identifies the KMS key
1086
1177
  # used to encrypt this component. This can be either the Key ARN or
1087
1178
  # the Alias ARN. For more information, see [Key identifiers
1088
- # (KeyId)][1] in the *Key Management Service Developer Guide*.
1179
+ # (KeyId)][1] in the *Key Management Service Developer Guide*. If you
1180
+ # don't specify a key, Image Builder encrypts the component data with
1181
+ # a KMS key that Image Builder owns.
1089
1182
  #
1090
1183
  #
1091
1184
  #
@@ -1098,10 +1191,10 @@ module Aws::Imagebuilder
1098
1191
  #
1099
1192
  # @!attribute [rw] client_token
1100
1193
  # A unique, case-sensitive identifier you provide to ensure that the
1101
- # operation completes no more than one time. If this token matches a
1102
- # previous request, the service ignores the request, but does not
1103
- # return an error. For more information, see [Ensuring idempotency][1]
1104
- # in the *Amazon EC2 API Reference*.
1194
+ # operation runs no more than one time. If you retry a request with
1195
+ # the same client token, Image Builder returns the original response
1196
+ # without running the operation again. For more information, see
1197
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1105
1198
  #
1106
1199
  # **A suitable default value is auto-generated.** You should normally
1107
1200
  # not need to pass this option.
@@ -1113,8 +1206,8 @@ module Aws::Imagebuilder
1113
1206
  #
1114
1207
  # @!attribute [rw] dry_run
1115
1208
  # Validates the required permissions and request parameters without
1116
- # making the request. If validation succeeds, the operation returns a
1117
- # `DryRunOperationException` error response.
1209
+ # performing the operation. If validation succeeds, the operation
1210
+ # returns a `DryRunOperationException` error response.
1118
1211
  # @return [Boolean]
1119
1212
  #
1120
1213
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateComponentRequest AWS API Documentation
@@ -1150,8 +1243,10 @@ module Aws::Imagebuilder
1150
1243
  # @return [String]
1151
1244
  #
1152
1245
  # @!attribute [rw] latest_version_references
1153
- # The resource ARNs with different wildcard variations of semantic
1154
- # versioning.
1246
+ # A set of wildcard version ARNs that always reference the latest
1247
+ # version of the resource. ARNs are included for the latest version
1248
+ # overall, and for the latest versions within the same major, minor,
1249
+ # and patch levels.
1155
1250
  # @return [Types::LatestVersionReferences]
1156
1251
  #
1157
1252
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateComponentResponse AWS API Documentation
@@ -1170,7 +1265,11 @@ module Aws::Imagebuilder
1170
1265
  # @return [String]
1171
1266
  #
1172
1267
  # @!attribute [rw] name
1173
- # The name of the container recipe.
1268
+ # The name of the container recipe. The recipe name, combined with the
1269
+ # semantic version, must be unique to your account in each Amazon Web
1270
+ # Services Region. Image Builder generates the container recipe ARN
1271
+ # from a normalized form of the name, so names that differ only in
1272
+ # case, spaces, or underscores count as the same name.
1174
1273
  # @return [String]
1175
1274
  #
1176
1275
  # @!attribute [rw] description
@@ -1199,7 +1298,8 @@ module Aws::Imagebuilder
1199
1298
  # @return [String]
1200
1299
  #
1201
1300
  # @!attribute [rw] components
1202
- # The components included in the container recipe.
1301
+ # The components included in the container recipe. You can specify
1302
+ # each component only one time in a recipe.
1203
1303
  # @return [Array<Types::ComponentConfiguration>]
1204
1304
  #
1205
1305
  # @!attribute [rw] instance_configuration
@@ -1208,26 +1308,43 @@ module Aws::Imagebuilder
1208
1308
  # @return [Types::InstanceConfiguration]
1209
1309
  #
1210
1310
  # @!attribute [rw] dockerfile_template_data
1211
- # The Dockerfile template used to build your image as an inline data
1212
- # blob.
1311
+ # The Dockerfile template used to build your image, as an inline data
1312
+ # blob. You must specify exactly one of the `dockerfileTemplateData`
1313
+ # or `dockerfileTemplateUri` properties. For the contextual variables
1314
+ # that the template can include, see [Create a new version of a
1315
+ # container recipe][1] in the *EC2 Image Builder User Guide*.
1316
+ #
1317
+ #
1318
+ #
1319
+ # [1]: https://docs.aws.amazon.com/imagebuilder/latest/userguide/create-container-recipes.html
1213
1320
  # @return [String]
1214
1321
  #
1215
1322
  # @!attribute [rw] dockerfile_template_uri
1216
- # The Amazon S3 URI for the Dockerfile that is used to build your
1217
- # container image.
1323
+ # The Amazon S3 URI for the Dockerfile template that is used to build
1324
+ # your container image. You must have permission to read the object.
1325
+ # Image Builder reads the object once, when it creates the recipe, and
1326
+ # stores its content in the recipe. Later changes to the S3 object
1327
+ # don't affect the recipe. You must specify exactly one of the
1328
+ # `dockerfileTemplateData` or `dockerfileTemplateUri` properties.
1218
1329
  # @return [String]
1219
1330
  #
1220
1331
  # @!attribute [rw] platform_override
1221
1332
  # Specifies the operating system platform when you use a custom base
1222
- # image.
1333
+ # image. Container recipes support only the Linux and Windows
1334
+ # platforms.
1223
1335
  # @return [String]
1224
1336
  #
1225
1337
  # @!attribute [rw] image_os_version_override
1226
- # Specifies the operating system version for the base image.
1338
+ # Specifies the operating system version for the base image. Use this
1339
+ # property only when the base image is a container image from a
1340
+ # registry. When the base image is an Image Builder image, the
1341
+ # operating system version comes from the parent image.
1227
1342
  # @return [String]
1228
1343
  #
1229
1344
  # @!attribute [rw] parent_image
1230
- # The base image for the container recipe.
1345
+ # The base image for the container recipe. This can be an Image
1346
+ # Builder image resource ARN or a container image URI from a registry,
1347
+ # for example `amazonlinux:latest`.
1231
1348
  # @return [String]
1232
1349
  #
1233
1350
  # @!attribute [rw] tags
@@ -1239,7 +1356,9 @@ module Aws::Imagebuilder
1239
1356
  # @return [String]
1240
1357
  #
1241
1358
  # @!attribute [rw] target_repository
1242
- # The destination repository for the container image.
1359
+ # The destination repository for the container image. The Amazon ECR
1360
+ # repository must already exist in the Amazon Web Services Region
1361
+ # where the build runs.
1243
1362
  # @return [Types::TargetContainerRepository]
1244
1363
  #
1245
1364
  # @!attribute [rw] kms_key_id
@@ -1256,10 +1375,10 @@ module Aws::Imagebuilder
1256
1375
  #
1257
1376
  # @!attribute [rw] client_token
1258
1377
  # A unique, case-sensitive identifier you provide to ensure that the
1259
- # operation completes no more than one time. If this token matches a
1260
- # previous request, the service ignores the request, but does not
1261
- # return an error. For more information, see [Ensuring idempotency][1]
1262
- # in the *Amazon EC2 API Reference*.
1378
+ # operation runs no more than one time. If you retry a request with
1379
+ # the same client token, Image Builder returns the original response
1380
+ # without running the operation again. For more information, see
1381
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1263
1382
  #
1264
1383
  # **A suitable default value is auto-generated.** You should normally
1265
1384
  # not need to pass this option.
@@ -1271,8 +1390,8 @@ module Aws::Imagebuilder
1271
1390
  #
1272
1391
  # @!attribute [rw] dry_run
1273
1392
  # Validates the required permissions and request parameters without
1274
- # making the request. If validation succeeds, the operation returns a
1275
- # `DryRunOperationException` error response.
1393
+ # performing the operation. If validation succeeds, the operation
1394
+ # returns a `DryRunOperationException` error response.
1276
1395
  # @return [Boolean]
1277
1396
  #
1278
1397
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateContainerRecipeRequest AWS API Documentation
@@ -1313,8 +1432,10 @@ module Aws::Imagebuilder
1313
1432
  # @return [String]
1314
1433
  #
1315
1434
  # @!attribute [rw] latest_version_references
1316
- # The resource ARNs with different wildcard variations of semantic
1317
- # versioning.
1435
+ # A set of wildcard version ARNs that always reference the latest
1436
+ # version of the resource. ARNs are included for the latest version
1437
+ # overall, and for the latest versions within the same major, minor,
1438
+ # and patch levels.
1318
1439
  # @return [Types::LatestVersionReferences]
1319
1440
  #
1320
1441
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateContainerRecipeResponse AWS API Documentation
@@ -1329,7 +1450,11 @@ module Aws::Imagebuilder
1329
1450
  end
1330
1451
 
1331
1452
  # @!attribute [rw] name
1332
- # The name of the distribution configuration.
1453
+ # The name of the distribution configuration. Distribution
1454
+ # configuration names must be unique to your account in each Amazon
1455
+ # Web Services Region. Image Builder generates the distribution
1456
+ # configuration ARN from a normalized form of the name, so names that
1457
+ # differ only in case, spaces, or underscores count as the same name.
1333
1458
  # @return [String]
1334
1459
  #
1335
1460
  # @!attribute [rw] description
@@ -1337,7 +1462,9 @@ module Aws::Imagebuilder
1337
1462
  # @return [String]
1338
1463
  #
1339
1464
  # @!attribute [rw] distributions
1340
- # The distributions of the distribution configuration.
1465
+ # The distribution settings for the configuration. Each entry defines
1466
+ # how output images are distributed in one target Amazon Web Services
1467
+ # Region. A Region can appear at most once in the list.
1341
1468
  # @return [Array<Types::Distribution>]
1342
1469
  #
1343
1470
  # @!attribute [rw] tags
@@ -1346,10 +1473,10 @@ module Aws::Imagebuilder
1346
1473
  #
1347
1474
  # @!attribute [rw] client_token
1348
1475
  # A unique, case-sensitive identifier you provide to ensure that the
1349
- # operation completes no more than one time. If this token matches a
1350
- # previous request, the service ignores the request, but does not
1351
- # return an error. For more information, see [Ensuring idempotency][1]
1352
- # in the *Amazon EC2 API Reference*.
1476
+ # operation runs no more than one time. If you retry a request with
1477
+ # the same client token, Image Builder returns the original response
1478
+ # without running the operation again. For more information, see
1479
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1353
1480
  #
1354
1481
  # **A suitable default value is auto-generated.** You should normally
1355
1482
  # not need to pass this option.
@@ -1361,8 +1488,8 @@ module Aws::Imagebuilder
1361
1488
  #
1362
1489
  # @!attribute [rw] dry_run
1363
1490
  # Validates the required permissions and request parameters without
1364
- # making the request. If validation succeeds, the operation returns a
1365
- # `DryRunOperationException` error response.
1491
+ # performing the operation. If validation succeeds, the operation
1492
+ # returns a `DryRunOperationException` error response.
1366
1493
  # @return [Boolean]
1367
1494
  #
1368
1495
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateDistributionConfigurationRequest AWS API Documentation
@@ -1402,7 +1529,11 @@ module Aws::Imagebuilder
1402
1529
  end
1403
1530
 
1404
1531
  # @!attribute [rw] name
1405
- # The name of the image pipeline.
1532
+ # The name of the image pipeline. Pipeline names must be unique to
1533
+ # your account in each Amazon Web Services Region. Image Builder
1534
+ # generates the pipeline ARN from a normalized form of the name, so
1535
+ # names that differ only in case, spaces, or underscores count as the
1536
+ # same name.
1406
1537
  # @return [String]
1407
1538
  #
1408
1539
  # @!attribute [rw] description
@@ -1411,12 +1542,14 @@ module Aws::Imagebuilder
1411
1542
  #
1412
1543
  # @!attribute [rw] image_recipe_arn
1413
1544
  # The Amazon Resource Name (ARN) of the image recipe that configures
1414
- # images created by this image pipeline.
1545
+ # images created by this image pipeline. You must specify either this
1546
+ # property or `containerRecipeArn`, but not both.
1415
1547
  # @return [String]
1416
1548
  #
1417
1549
  # @!attribute [rw] container_recipe_arn
1418
1550
  # The Amazon Resource Name (ARN) of the container recipe that is used
1419
- # to configure images created by this container pipeline.
1551
+ # to configure images created by this container pipeline. You must
1552
+ # specify either this property or `imageRecipeArn`, but not both.
1420
1553
  # @return [String]
1421
1554
  #
1422
1555
  # @!attribute [rw] infrastructure_configuration_arn
@@ -1431,7 +1564,10 @@ module Aws::Imagebuilder
1431
1564
  # @return [String]
1432
1565
  #
1433
1566
  # @!attribute [rw] image_tests_configuration
1434
- # The image test configuration of the image pipeline.
1567
+ # Specifies the test settings that Image Builder applies to images
1568
+ # that this pipeline creates. If you don't provide test settings,
1569
+ # Image Builder stores a default configuration with image tests
1570
+ # enabled.
1435
1571
  # @return [Types::ImageTestsConfiguration]
1436
1572
  #
1437
1573
  # @!attribute [rw] enhanced_image_metadata_enabled
@@ -1441,11 +1577,15 @@ module Aws::Imagebuilder
1441
1577
  # @return [Boolean]
1442
1578
  #
1443
1579
  # @!attribute [rw] schedule
1444
- # The schedule of the image pipeline.
1580
+ # The schedule of the image pipeline. If you don't provide a
1581
+ # schedule, the pipeline runs only when you call
1582
+ # StartImagePipelineExecution.
1445
1583
  # @return [Types::Schedule]
1446
1584
  #
1447
1585
  # @!attribute [rw] status
1448
- # The status of the image pipeline.
1586
+ # The status of the image pipeline. If you don't specify a status, it
1587
+ # defaults to `ENABLED`. A disabled pipeline doesn't run on its
1588
+ # schedule, but you can still start builds manually.
1449
1589
  # @return [String]
1450
1590
  #
1451
1591
  # @!attribute [rw] tags
@@ -1453,15 +1593,18 @@ module Aws::Imagebuilder
1453
1593
  # @return [Hash<String,String>]
1454
1594
  #
1455
1595
  # @!attribute [rw] image_tags
1456
- # The tags to be applied to the images produced by this pipeline.
1596
+ # The tags that Image Builder applies to the Image Builder image
1597
+ # resource that this pipeline's scheduled executions create. These
1598
+ # tags don't apply to the output AMI. To tag output AMIs, use
1599
+ # `amiTags` in the pipeline's distribution configuration.
1457
1600
  # @return [Hash<String,String>]
1458
1601
  #
1459
1602
  # @!attribute [rw] client_token
1460
1603
  # A unique, case-sensitive identifier you provide to ensure that the
1461
- # operation completes no more than one time. If this token matches a
1462
- # previous request, the service ignores the request, but does not
1463
- # return an error. For more information, see [Ensuring idempotency][1]
1464
- # in the *Amazon EC2 API Reference*.
1604
+ # operation runs no more than one time. If you retry a request with
1605
+ # the same client token, Image Builder returns the original response
1606
+ # without running the operation again. For more information, see
1607
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1465
1608
  #
1466
1609
  # **A suitable default value is auto-generated.** You should normally
1467
1610
  # not need to pass this option.
@@ -1472,11 +1615,14 @@ module Aws::Imagebuilder
1472
1615
  # @return [String]
1473
1616
  #
1474
1617
  # @!attribute [rw] image_scanning_configuration
1475
- # Contains settings for vulnerability scans.
1618
+ # Contains settings for vulnerability scans that Amazon Inspector runs
1619
+ # against the test instance during image creation.
1476
1620
  # @return [Types::ImageScanningConfiguration]
1477
1621
  #
1478
1622
  # @!attribute [rw] workflows
1479
- # Contains an array of workflow configuration objects.
1623
+ # The array of workflow configuration objects for builds that this
1624
+ # pipeline starts. You must also specify `executionRole` when you
1625
+ # provide workflows.
1480
1626
  # @return [Array<Types::WorkflowConfiguration>]
1481
1627
  #
1482
1628
  # @!attribute [rw] execution_role
@@ -1495,8 +1641,8 @@ module Aws::Imagebuilder
1495
1641
  #
1496
1642
  # @!attribute [rw] dry_run
1497
1643
  # Validates the required permissions and request parameters without
1498
- # making the request. If validation succeeds, the operation returns a
1499
- # `DryRunOperationException` error response.
1644
+ # performing the operation. If validation succeeds, the operation
1645
+ # returns a `DryRunOperationException` error response.
1500
1646
  # @return [Boolean]
1501
1647
  #
1502
1648
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImagePipelineRequest AWS API Documentation
@@ -1548,7 +1694,11 @@ module Aws::Imagebuilder
1548
1694
  end
1549
1695
 
1550
1696
  # @!attribute [rw] name
1551
- # The name of the image recipe.
1697
+ # The name of the image recipe. The recipe name, combined with the
1698
+ # semantic version, must be unique to your account in each Amazon Web
1699
+ # Services Region. Image Builder generates the image recipe ARN from a
1700
+ # normalized form of the name, so names that differ only in case,
1701
+ # spaces, or underscores count as the same name.
1552
1702
  # @return [String]
1553
1703
  #
1554
1704
  # @!attribute [rw] description
@@ -1577,7 +1727,11 @@ module Aws::Imagebuilder
1577
1727
  # @return [String]
1578
1728
  #
1579
1729
  # @!attribute [rw] components
1580
- # The components included in the image recipe.
1730
+ # The components included in the image recipe. Components are
1731
+ # optional. A recipe with no components bakes the base image without
1732
+ # additional customization. You can specify each component only one
1733
+ # time in a recipe. Components with a status of `DEPRECATED` or
1734
+ # `DISABLED` can't be added to new recipes.
1581
1735
  # @return [Array<Types::ComponentConfiguration>]
1582
1736
  #
1583
1737
  # @!attribute [rw] parent_image
@@ -1595,12 +1749,14 @@ module Aws::Imagebuilder
1595
1749
  # * Amazon Web Services Marketplace product ID
1596
1750
  #
1597
1751
  # If you enter an AMI ID or an SSM parameter that contains the AMI ID,
1598
- # you must have access to the AMI, and the AMI must be in the source
1599
- # Region.
1752
+ # you must have access to the AMI. The AMI must also be in the Region
1753
+ # where you're creating the recipe.
1600
1754
  # @return [String]
1601
1755
  #
1602
1756
  # @!attribute [rw] block_device_mappings
1603
- # The block device mappings of the image recipe.
1757
+ # The block device mappings that Image Builder applies to the build
1758
+ # instance and the output AMI. For example, you can override the size
1759
+ # of the base image's root volume or attach additional EBS volumes.
1604
1760
  # @return [Array<Types::InstanceBlockDeviceMapping>]
1605
1761
  #
1606
1762
  # @!attribute [rw] tags
@@ -1608,7 +1764,10 @@ module Aws::Imagebuilder
1608
1764
  # @return [Hash<String,String>]
1609
1765
  #
1610
1766
  # @!attribute [rw] working_directory
1611
- # The working directory used during build and test workflows.
1767
+ # The working directory used during build and test workflows. If you
1768
+ # don't specify a working directory, Image Builder uses `/tmp` for
1769
+ # Linux and macOS build instances, and `C:/` for Windows build
1770
+ # instances.
1612
1771
  # @return [String]
1613
1772
  #
1614
1773
  # @!attribute [rw] additional_instance_configuration
@@ -1634,10 +1793,10 @@ module Aws::Imagebuilder
1634
1793
  #
1635
1794
  # @!attribute [rw] client_token
1636
1795
  # A unique, case-sensitive identifier you provide to ensure that the
1637
- # operation completes no more than one time. If this token matches a
1638
- # previous request, the service ignores the request, but does not
1639
- # return an error. For more information, see [Ensuring idempotency][1]
1640
- # in the *Amazon EC2 API Reference*.
1796
+ # operation runs no more than one time. If you retry a request with
1797
+ # the same client token, Image Builder returns the original response
1798
+ # without running the operation again. For more information, see
1799
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1641
1800
  #
1642
1801
  # **A suitable default value is auto-generated.** You should normally
1643
1802
  # not need to pass this option.
@@ -1649,8 +1808,8 @@ module Aws::Imagebuilder
1649
1808
  #
1650
1809
  # @!attribute [rw] dry_run
1651
1810
  # Validates the required permissions and request parameters without
1652
- # making the request. If validation succeeds, the operation returns a
1653
- # `DryRunOperationException` error response.
1811
+ # performing the operation. If validation succeeds, the operation
1812
+ # returns a `DryRunOperationException` error response.
1654
1813
  # @return [Boolean]
1655
1814
  #
1656
1815
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRecipeRequest AWS API Documentation
@@ -1687,8 +1846,10 @@ module Aws::Imagebuilder
1687
1846
  # @return [String]
1688
1847
  #
1689
1848
  # @!attribute [rw] latest_version_references
1690
- # The resource ARNs with different wildcard variations of semantic
1691
- # versioning.
1849
+ # A set of wildcard version ARNs that always reference the latest
1850
+ # version of the resource. ARNs are included for the latest version
1851
+ # overall, and for the latest versions within the same major, minor,
1852
+ # and patch levels.
1692
1853
  # @return [Types::LatestVersionReferences]
1693
1854
  #
1694
1855
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRecipeResponse AWS API Documentation
@@ -1704,17 +1865,22 @@ module Aws::Imagebuilder
1704
1865
 
1705
1866
  # @!attribute [rw] image_recipe_arn
1706
1867
  # The Amazon Resource Name (ARN) of the image recipe that defines how
1707
- # images are configured, tested, and assessed.
1868
+ # images are configured, tested, and assessed. You must specify either
1869
+ # this property or `containerRecipeArn`, but not both.
1708
1870
  # @return [String]
1709
1871
  #
1710
1872
  # @!attribute [rw] container_recipe_arn
1711
1873
  # The Amazon Resource Name (ARN) of the container recipe that defines
1712
- # how images are configured and tested.
1874
+ # how images are configured and tested. You must specify either this
1875
+ # property or `imageRecipeArn`, but not both.
1713
1876
  # @return [String]
1714
1877
  #
1715
1878
  # @!attribute [rw] distribution_configuration_arn
1716
1879
  # The Amazon Resource Name (ARN) of the distribution configuration
1717
- # that defines and configures the outputs of your pipeline.
1880
+ # that defines and configures the outputs of the image build. If you
1881
+ # don't specify a distribution configuration, Image Builder creates
1882
+ # the output image only in the account and Amazon Web Services Region
1883
+ # where the build runs.
1718
1884
  # @return [String]
1719
1885
  #
1720
1886
  # @!attribute [rw] infrastructure_configuration_arn
@@ -1724,7 +1890,8 @@ module Aws::Imagebuilder
1724
1890
  # @return [String]
1725
1891
  #
1726
1892
  # @!attribute [rw] image_tests_configuration
1727
- # The image tests configuration of the image.
1893
+ # Settings that determine whether Image Builder runs tests on the
1894
+ # image after building it. Image tests are enabled by default.
1728
1895
  # @return [Types::ImageTestsConfiguration]
1729
1896
  #
1730
1897
  # @!attribute [rw] enhanced_image_metadata_enabled
@@ -1739,10 +1906,10 @@ module Aws::Imagebuilder
1739
1906
  #
1740
1907
  # @!attribute [rw] client_token
1741
1908
  # A unique, case-sensitive identifier you provide to ensure that the
1742
- # operation completes no more than one time. If this token matches a
1743
- # previous request, the service ignores the request, but does not
1744
- # return an error. For more information, see [Ensuring idempotency][1]
1745
- # in the *Amazon EC2 API Reference*.
1909
+ # operation runs no more than one time. If you retry a request with
1910
+ # the same client token, Image Builder returns the original response
1911
+ # without running the operation again. For more information, see
1912
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1746
1913
  #
1747
1914
  # **A suitable default value is auto-generated.** You should normally
1748
1915
  # not need to pass this option.
@@ -1753,20 +1920,33 @@ module Aws::Imagebuilder
1753
1920
  # @return [String]
1754
1921
  #
1755
1922
  # @!attribute [rw] image_scanning_configuration
1756
- # Contains settings for vulnerability scans.
1923
+ # Settings for vulnerability scans that Amazon Inspector runs during
1924
+ # image creation. For AMI output, Amazon Inspector scans the test
1925
+ # instance. For container output, Amazon Inspector scans the container
1926
+ # image that Image Builder pushes to the Amazon ECR repository
1927
+ # specified in `ecrConfiguration`.
1757
1928
  # @return [Types::ImageScanningConfiguration]
1758
1929
  #
1759
1930
  # @!attribute [rw] workflows
1760
- # Contains an array of workflow configuration objects.
1931
+ # The array of workflow configuration objects for the build. If you
1932
+ # specify workflows, they replace the default workflows that Image
1933
+ # Builder otherwise runs for the build, and you must also provide an
1934
+ # `executionRole`.
1761
1935
  # @return [Array<Types::WorkflowConfiguration>]
1762
1936
  #
1763
1937
  # @!attribute [rw] execution_role
1764
1938
  # The name or Amazon Resource Name (ARN) for the IAM role you create
1765
- # that grants Image Builder access to perform workflow actions.
1939
+ # that grants Image Builder access to perform workflow actions. This
1940
+ # property is required if you specify `workflows`. If you don't
1941
+ # provide a role, Image Builder uses the Image Builder service-linked
1942
+ # role in your account, and creates it if it doesn't exist.
1766
1943
  # @return [String]
1767
1944
  #
1768
1945
  # @!attribute [rw] logging_configuration
1769
- # The logging configuration for the image build process.
1946
+ # The CloudWatch Logs log group where Image Builder sends the image
1947
+ # build logs. If you specify a log group name outside of the
1948
+ # `/aws/imagebuilder/` namespace, you must also provide an
1949
+ # `executionRole` that has permission to write to that log group.
1770
1950
  # @return [Types::ImageLoggingConfiguration]
1771
1951
  #
1772
1952
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRequest AWS API Documentation
@@ -1802,8 +1982,10 @@ module Aws::Imagebuilder
1802
1982
  # @return [String]
1803
1983
  #
1804
1984
  # @!attribute [rw] latest_version_references
1805
- # The resource ARNs with different wildcard variations of semantic
1806
- # versioning.
1985
+ # A set of wildcard version ARNs that always reference the latest
1986
+ # version of the resource. ARNs are included for the latest version
1987
+ # overall, and for the latest versions within the same major, minor,
1988
+ # and patch levels.
1807
1989
  # @return [Types::LatestVersionReferences]
1808
1990
  #
1809
1991
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageResponse AWS API Documentation
@@ -1818,7 +2000,11 @@ module Aws::Imagebuilder
1818
2000
  end
1819
2001
 
1820
2002
  # @!attribute [rw] name
1821
- # The name of the infrastructure configuration.
2003
+ # The name of the infrastructure configuration. Infrastructure
2004
+ # configuration names must be unique to your account in each Amazon
2005
+ # Web Services Region. Image Builder generates the infrastructure
2006
+ # configuration ARN from a normalized form of the name, so names that
2007
+ # differ only in case, spaces, or underscores count as the same name.
1822
2008
  # @return [String]
1823
2009
  #
1824
2010
  # @!attribute [rw] description
@@ -1828,12 +2014,16 @@ module Aws::Imagebuilder
1828
2014
  # @!attribute [rw] instance_types
1829
2015
  # The instance types of the infrastructure configuration. You can
1830
2016
  # specify one or more instance types to use for this build. Image
1831
- # Builder picks one of these instance types based on availability.
2017
+ # Builder picks one of these instance types based on availability. If
2018
+ # you don't specify instance types, Image Builder selects compatible
2019
+ # instance types automatically. If you specify a Dedicated Host, Image
2020
+ # Builder uses only instance types that the host supports.
1832
2021
  # @return [Array<String>]
1833
2022
  #
1834
2023
  # @!attribute [rw] instance_profile_name
1835
2024
  # The instance profile to associate with the instance used to
1836
- # customize your Amazon EC2 AMI.
2025
+ # customize your Amazon EC2 AMI. The instance profile must exist in
2026
+ # your account.
1837
2027
  # @return [String]
1838
2028
  #
1839
2029
  # @!attribute [rw] security_group_ids
@@ -1843,11 +2033,15 @@ module Aws::Imagebuilder
1843
2033
  #
1844
2034
  # @!attribute [rw] subnet_id
1845
2035
  # The subnet ID in which to place the instance used to customize your
1846
- # Amazon EC2 AMI.
2036
+ # Amazon EC2 AMI. If you specify `subnetId`, you must also specify one
2037
+ # or more security group IDs in `securityGroupIds`. Otherwise, the
2038
+ # request fails.
1847
2039
  # @return [String]
1848
2040
  #
1849
2041
  # @!attribute [rw] logging
1850
- # The logging configuration of the infrastructure configuration.
2042
+ # The logging configuration of the infrastructure configuration. When
2043
+ # you configure S3 logs, Image Builder writes logs from the build and
2044
+ # test process to the specified bucket under the key prefix.
1851
2045
  # @return [Types::Logging]
1852
2046
  #
1853
2047
  # @!attribute [rw] key_pair
@@ -1862,14 +2056,23 @@ module Aws::Imagebuilder
1862
2056
  # to `true`.
1863
2057
  # @return [Boolean]
1864
2058
  #
2059
+ # @!attribute [rw] terminate_instance_on_completion
2060
+ # Specifies whether Image Builder terminates build and test instances
2061
+ # when image creation ends without a failure (success, cancellation,
2062
+ # or expiration). Defaults to `true`.
2063
+ # @return [Boolean]
2064
+ #
1865
2065
  # @!attribute [rw] sns_topic_arn
1866
2066
  # The Amazon Resource Name (ARN) of the SNS topic to which Image
1867
- # Builder sends image build event notifications.
2067
+ # Builder sends image build event notifications. Specify a standard
2068
+ # topic. Image Builder doesn't support FIFO topics. Image Builder
2069
+ # validates the topic when you create or update the configuration. You
2070
+ # must have permission to publish to the topic.
1868
2071
  #
1869
- # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
1870
- # are encrypted using keys from other accounts. The key that is used
1871
- # to encrypt the SNS topic must reside in the account that the Image
1872
- # Builder service runs under.
2072
+ # <note markdown="1"> EC2 Image Builder can't send notifications to SNS topics that are
2073
+ # encrypted using keys from other accounts. If your SNS topic is
2074
+ # encrypted, the key must be owned by the same account that owns your
2075
+ # Image Builder resources.
1873
2076
  #
1874
2077
  # </note>
1875
2078
  # @return [String]
@@ -1877,12 +2080,28 @@ module Aws::Imagebuilder
1877
2080
  # @!attribute [rw] resource_tags
1878
2081
  # The metadata tags to assign to the Amazon EC2 instance that Image
1879
2082
  # Builder launches during the build process. Tags are formatted as key
1880
- # value pairs.
2083
+ # value pairs. Tag keys can't begin with `aws:` or match one of the
2084
+ # following reserved keys: `CreatedBy`, `Ec2ImageBuilderArn`, `Name`,
2085
+ # or `Tags`.
1881
2086
  # @return [Hash<String,String>]
1882
2087
  #
1883
2088
  # @!attribute [rw] instance_metadata_options
1884
- # The instance metadata options that you can set for the HTTP requests
1885
- # that pipeline builds use to launch EC2 build and test instances.
2089
+ # The instance metadata service (IMDS) settings that Image Builder
2090
+ # applies to the EC2 build and test instances it launches during image
2091
+ # creation. If you don't set these options, the EC2 launch defaults
2092
+ # for the instance apply. For more information about instance metadata
2093
+ # options, see one of the following links:
2094
+ #
2095
+ # * [Configure the instance metadata options][1] in the <i> <i>Amazon
2096
+ # EC2 User Guide</i> </i> for Linux instances.
2097
+ #
2098
+ # * [Configure the instance metadata options][2] in the <i> <i>Amazon
2099
+ # EC2 Windows Guide</i> </i> for Windows instances.
2100
+ #
2101
+ #
2102
+ #
2103
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
2104
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
1886
2105
  # @return [Types::InstanceMetadataOptions]
1887
2106
  #
1888
2107
  # @!attribute [rw] tags
@@ -1892,16 +2111,34 @@ module Aws::Imagebuilder
1892
2111
  # @return [Hash<String,String>]
1893
2112
  #
1894
2113
  # @!attribute [rw] placement
1895
- # The instance placement settings that define where the instances that
1896
- # are launched from your image run.
2114
+ # The instance placement settings that define where the build and test
2115
+ # instances that Image Builder launches during image creation run.
2116
+ # These settings don't affect instances that you launch from the
2117
+ # output image.
1897
2118
  # @return [Types::Placement]
1898
2119
  #
2120
+ # @!attribute [rw] parent_instance
2121
+ # The Amazon EC2 Auto Scaling group that Image Builder takes the build
2122
+ # instance from, instead of launching a new instance. This applies
2123
+ # only to the build phase.
2124
+ #
2125
+ # To use this feature, the execution role for the build must have
2126
+ # permissions to describe the Auto Scaling group, tag the instance
2127
+ # while it's still in the group, and detach it from the group. For
2128
+ # more information, see [Build on an instance from an Auto Scaling
2129
+ # group][1] in the *EC2 Image Builder User Guide*.
2130
+ #
2131
+ #
2132
+ #
2133
+ # [1]: https://docs.aws.amazon.com/imagebuilder/latest/userguide/infra-config-parent-instance.html
2134
+ # @return [Types::ParentInstanceConfiguration]
2135
+ #
1899
2136
  # @!attribute [rw] client_token
1900
2137
  # A unique, case-sensitive identifier you provide to ensure that the
1901
- # operation completes no more than one time. If this token matches a
1902
- # previous request, the service ignores the request, but does not
1903
- # return an error. For more information, see [Ensuring idempotency][1]
1904
- # in the *Amazon EC2 API Reference*.
2138
+ # operation runs no more than one time. If you retry a request with
2139
+ # the same client token, Image Builder returns the original response
2140
+ # without running the operation again. For more information, see
2141
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
1905
2142
  #
1906
2143
  # **A suitable default value is auto-generated.** You should normally
1907
2144
  # not need to pass this option.
@@ -1913,8 +2150,8 @@ module Aws::Imagebuilder
1913
2150
  #
1914
2151
  # @!attribute [rw] dry_run
1915
2152
  # Validates the required permissions and request parameters without
1916
- # making the request. If validation succeeds, the operation returns a
1917
- # `DryRunOperationException` error response.
2153
+ # performing the operation. If validation succeeds, the operation
2154
+ # returns a `DryRunOperationException` error response.
1918
2155
  # @return [Boolean]
1919
2156
  #
1920
2157
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateInfrastructureConfigurationRequest AWS API Documentation
@@ -1929,11 +2166,13 @@ module Aws::Imagebuilder
1929
2166
  :logging,
1930
2167
  :key_pair,
1931
2168
  :terminate_instance_on_failure,
2169
+ :terminate_instance_on_completion,
1932
2170
  :sns_topic_arn,
1933
2171
  :resource_tags,
1934
2172
  :instance_metadata_options,
1935
2173
  :tags,
1936
2174
  :placement,
2175
+ :parent_instance,
1937
2176
  :client_token,
1938
2177
  :dry_run)
1939
2178
  SENSITIVE = []
@@ -1964,7 +2203,11 @@ module Aws::Imagebuilder
1964
2203
  end
1965
2204
 
1966
2205
  # @!attribute [rw] name
1967
- # The name of the lifecycle policy to create.
2206
+ # The name of the lifecycle policy to create. Policy names must be
2207
+ # unique to your account in each Amazon Web Services Region. Image
2208
+ # Builder generates the policy ARN from a normalized form of the name,
2209
+ # so names that differ only in case, spaces, or underscores count as
2210
+ # the same name. You can't change the name after creation.
1968
2211
  # @return [String]
1969
2212
  #
1970
2213
  # @!attribute [rw] description
@@ -1972,26 +2215,37 @@ module Aws::Imagebuilder
1972
2215
  # @return [String]
1973
2216
  #
1974
2217
  # @!attribute [rw] status
1975
- # Indicates whether the lifecycle policy resource is enabled.
2218
+ # Indicates whether the lifecycle policy resource is enabled. If you
2219
+ # don't specify a status, it defaults to `ENABLED`. Only enabled
2220
+ # policies run on their schedule.
1976
2221
  # @return [String]
1977
2222
  #
1978
2223
  # @!attribute [rw] execution_role
1979
2224
  # The name or Amazon Resource Name (ARN) for the IAM role you create
1980
- # that grants Image Builder access to run lifecycle actions.
2225
+ # that grants Image Builder access to run lifecycle actions. You must
2226
+ # have permission to pass the role, and the role's trust policy must
2227
+ # allow the Image Builder service principal to assume it.
1981
2228
  # @return [String]
1982
2229
  #
1983
2230
  # @!attribute [rw] resource_type
1984
2231
  # The type of Image Builder resource that the lifecycle policy applies
1985
- # to.
2232
+ # to. The resource type determines the allowed rule actions: policies
2233
+ # for AMI-based Image Builder images support `DELETE`, `DEPRECATE`,
2234
+ # and `DISABLE`, and policies for container-based Image Builder images
2235
+ # support only `DELETE`. You can't change the resource type after
2236
+ # creation.
1986
2237
  # @return [String]
1987
2238
  #
1988
2239
  # @!attribute [rw] policy_details
1989
- # Configuration details for the lifecycle policy rules.
2240
+ # Configuration details for the lifecycle policy rules. A policy can
2241
+ # contain at most one rule per action type: one `DELETE`, one
2242
+ # `DEPRECATE`, and one `DISABLE`.
1990
2243
  # @return [Array<Types::LifecyclePolicyDetail>]
1991
2244
  #
1992
2245
  # @!attribute [rw] resource_selection
1993
2246
  # Selection criteria for the resources that the lifecycle policy
1994
- # applies to.
2247
+ # applies to. You must specify exactly one selection criteria: either
2248
+ # recipes or a tag map, not both.
1995
2249
  # @return [Types::LifecyclePolicyResourceSelection]
1996
2250
  #
1997
2251
  # @!attribute [rw] tags
@@ -2000,10 +2254,10 @@ module Aws::Imagebuilder
2000
2254
  #
2001
2255
  # @!attribute [rw] client_token
2002
2256
  # A unique, case-sensitive identifier you provide to ensure that the
2003
- # operation completes no more than one time. If this token matches a
2004
- # previous request, the service ignores the request, but does not
2005
- # return an error. For more information, see [Ensuring idempotency][1]
2006
- # in the *Amazon EC2 API Reference*.
2257
+ # operation runs no more than one time. If you retry a request with
2258
+ # the same client token, Image Builder returns the original response
2259
+ # without running the operation again. For more information, see
2260
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
2007
2261
  #
2008
2262
  # **A suitable default value is auto-generated.** You should normally
2009
2263
  # not need to pass this option.
@@ -2015,8 +2269,8 @@ module Aws::Imagebuilder
2015
2269
  #
2016
2270
  # @!attribute [rw] dry_run
2017
2271
  # Validates the required permissions and request parameters without
2018
- # making the request. If validation succeeds, the operation returns a
2019
- # `DryRunOperationException` error response.
2272
+ # performing the operation. If validation succeeds, the operation
2273
+ # returns a `DryRunOperationException` error response.
2020
2274
  # @return [Boolean]
2021
2275
  #
2022
2276
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateLifecyclePolicyRequest AWS API Documentation
@@ -2055,7 +2309,14 @@ module Aws::Imagebuilder
2055
2309
  end
2056
2310
 
2057
2311
  # @!attribute [rw] name
2058
- # The name of the workflow to create.
2312
+ # The name of the workflow to create. Image Builder generates the
2313
+ # workflow ARN from a normalized form of the name, so names that
2314
+ # differ only in case, spaces, or underscores count as the same name.
2315
+ # If a workflow with the same name and semantic version already exists
2316
+ # in your account in the same Amazon Web Services Region, the request
2317
+ # creates a new build version for it. If the content is also identical
2318
+ # to the latest build version, the request fails because the workflow
2319
+ # already exists.
2059
2320
  # @return [String]
2060
2321
  #
2061
2322
  # @!attribute [rw] semantic_version
@@ -2090,26 +2351,31 @@ module Aws::Imagebuilder
2090
2351
  # @return [String]
2091
2352
  #
2092
2353
  # @!attribute [rw] data
2093
- # Contains the UTF-8 encoded YAML document content for the workflow.
2094
- # Alternatively, you can specify the `uri` of a YAML document file
2095
- # stored in Amazon S3. However, you cannot specify both properties.
2354
+ # The UTF-8 encoded YAML document content for the workflow, up to
2355
+ # 16,000 characters. For larger documents, store the document in
2356
+ # Amazon S3 and specify the `uri` property instead. You must specify
2357
+ # exactly one of the `data` or `uri` properties.
2096
2358
  # @return [String]
2097
2359
  #
2098
2360
  # @!attribute [rw] uri
2099
- # The `uri` of a YAML component document file. This must be an S3 URL
2100
- # (`s3://bucket/key`), and you must have permission to access the S3
2101
- # bucket it points to. If you use Amazon S3, you can specify component
2102
- # content up to your service quota.
2361
+ # The `uri` of a YAML workflow document file stored in Amazon S3. This
2362
+ # must be an S3 URL (`s3://bucket/key`), and you must have permission
2363
+ # to access the S3 bucket it points to. A workflow document that you
2364
+ # provide from Amazon S3 can be up to your service quota for workflow
2365
+ # size.
2103
2366
  #
2104
2367
  # Alternatively, you can specify the YAML document inline, using the
2105
- # component `data` property. You cannot specify both properties.
2368
+ # workflow `data` property. You must specify exactly one of the `data`
2369
+ # or `uri` properties.
2106
2370
  # @return [String]
2107
2371
  #
2108
2372
  # @!attribute [rw] kms_key_id
2109
2373
  # The Amazon Resource Name (ARN) that uniquely identifies the KMS key
2110
2374
  # used to encrypt this workflow resource. This can be either the Key
2111
2375
  # ARN or the Alias ARN. For more information, see [Key identifiers
2112
- # (KeyId)][1] in the *Key Management Service Developer Guide*.
2376
+ # (KeyId)][1] in the *Key Management Service Developer Guide*. If you
2377
+ # don't specify a key, Image Builder encrypts the workflow document
2378
+ # with a KMS key that Image Builder owns.
2113
2379
  #
2114
2380
  #
2115
2381
  #
@@ -2122,10 +2388,10 @@ module Aws::Imagebuilder
2122
2388
  #
2123
2389
  # @!attribute [rw] client_token
2124
2390
  # A unique, case-sensitive identifier you provide to ensure that the
2125
- # operation completes no more than one time. If this token matches a
2126
- # previous request, the service ignores the request, but does not
2127
- # return an error. For more information, see [Ensuring idempotency][1]
2128
- # in the *Amazon EC2 API Reference*.
2391
+ # operation runs no more than one time. If you retry a request with
2392
+ # the same client token, Image Builder returns the original response
2393
+ # without running the operation again. For more information, see
2394
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
2129
2395
  #
2130
2396
  # **A suitable default value is auto-generated.** You should normally
2131
2397
  # not need to pass this option.
@@ -2136,14 +2402,15 @@ module Aws::Imagebuilder
2136
2402
  # @return [String]
2137
2403
  #
2138
2404
  # @!attribute [rw] type
2139
- # The phase in the image build process for which the workflow resource
2140
- # is responsible.
2405
+ # The image creation stage that this workflow applies to. Image
2406
+ # Builder validates the workflow document steps against the stage you
2407
+ # specify.
2141
2408
  # @return [String]
2142
2409
  #
2143
2410
  # @!attribute [rw] dry_run
2144
2411
  # Validates the required permissions and request parameters without
2145
- # making the request. If validation succeeds, the operation returns a
2146
- # `DryRunOperationException` error response.
2412
+ # performing the operation. If validation succeeds, the operation
2413
+ # returns a `DryRunOperationException` error response.
2147
2414
  # @return [Boolean]
2148
2415
  #
2149
2416
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateWorkflowRequest AWS API Documentation
@@ -2174,8 +2441,10 @@ module Aws::Imagebuilder
2174
2441
  # @return [String]
2175
2442
  #
2176
2443
  # @!attribute [rw] latest_version_references
2177
- # The resource ARNs with different wildcard variations of semantic
2178
- # versioning.
2444
+ # A set of wildcard version ARNs that always reference the latest
2445
+ # version of the resource. ARNs are included for the latest version
2446
+ # overall, and for the latest versions within the same major, minor,
2447
+ # and patch levels.
2179
2448
  # @return [Types::LatestVersionReferences]
2180
2449
  #
2181
2450
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateWorkflowResponse AWS API Documentation
@@ -2188,18 +2457,10 @@ module Aws::Imagebuilder
2188
2457
  include Aws::Structure
2189
2458
  end
2190
2459
 
2191
- # Amazon Inspector generates a risk score for each finding. This score
2192
- # helps you to prioritize findings, to focus on the most critical
2193
- # findings and the most vulnerable resources. The score uses the Common
2194
- # Vulnerability Scoring System (CVSS) format. This format is a
2195
- # modification of the base CVSS score that the National Vulnerability
2196
- # Database (NVD) provides. For more information about severity levels,
2197
- # see [Severity levels for Amazon Inspector findings][1] in the *Amazon
2198
- # Inspector User Guide*.
2199
- #
2200
- #
2201
- #
2202
- # [1]: https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html
2460
+ # A CVSS score for the vulnerability, as published by the vulnerability
2461
+ # source. Sources include the National Vulnerability Database (NVD) and
2462
+ # the operating system vendor's security feed. A finding can include
2463
+ # CVSS scores from multiple sources and CVSS versions.
2203
2464
  #
2204
2465
  # @!attribute [rw] base_score
2205
2466
  # The CVSS base score.
@@ -2256,7 +2517,8 @@ module Aws::Imagebuilder
2256
2517
  # @return [String]
2257
2518
  #
2258
2519
  # @!attribute [rw] cvss_source
2259
- # The source of the finding.
2520
+ # The source of the CVSS data that the Amazon Inspector score for the
2521
+ # finding is based on, for example NVD or a vendor security feed.
2260
2522
  # @return [String]
2261
2523
  #
2262
2524
  # @!attribute [rw] version
@@ -2272,8 +2534,9 @@ module Aws::Imagebuilder
2272
2534
  # @return [String]
2273
2535
  #
2274
2536
  # @!attribute [rw] adjustments
2275
- # An object that contains details about an adjustment that Amazon
2276
- # Inspector made to the CVSS score for the finding.
2537
+ # The adjustments that Amazon Inspector applied to the base CVSS score
2538
+ # to produce its own score for the finding. The list is empty when
2539
+ # Amazon Inspector made no adjustments.
2277
2540
  # @return [Array<Types::CvssScoreAdjustment>]
2278
2541
  #
2279
2542
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CvssScoreDetails AWS API Documentation
@@ -2554,10 +2817,19 @@ module Aws::Imagebuilder
2554
2817
  end
2555
2818
 
2556
2819
  # @!attribute [rw] source_image
2557
- # The source image to distribute. Specify an AMI identifier, SSM
2558
- # parameter path, or Image Builder image Amazon Resource Name (ARN).
2559
- # When you specify an Image Builder image Amazon Resource Name (ARN),
2560
- # the image must be in the `AVAILABLE` state.
2820
+ # The source image to distribute. You can specify the source in any of
2821
+ # the following formats:
2822
+ #
2823
+ # * An AMI ID.
2824
+ #
2825
+ # * An Amazon Web Services Systems Manager Parameter Store reference,
2826
+ # prefixed by `ssm:`, followed by the parameter name or ARN.
2827
+ #
2828
+ # * An Image Builder image Amazon Resource Name (ARN). An image
2829
+ # version ARN resolves to the latest available build version.
2830
+ #
2831
+ # Whichever format you use, the source must resolve to an AMI in the
2832
+ # current Amazon Web Services Region.
2561
2833
  # @return [String]
2562
2834
  #
2563
2835
  # @!attribute [rw] distribution_configuration_arn
@@ -2573,15 +2845,17 @@ module Aws::Imagebuilder
2573
2845
  # @return [String]
2574
2846
  #
2575
2847
  # @!attribute [rw] tags
2576
- # The tags to apply to the distributed image.
2848
+ # The tags to apply to the new Image Builder image resource that this
2849
+ # operation creates. To tag the output AMIs, use `amiTags` in the
2850
+ # distribution configuration.
2577
2851
  # @return [Hash<String,String>]
2578
2852
  #
2579
2853
  # @!attribute [rw] client_token
2580
2854
  # A unique, case-sensitive identifier you provide to ensure that the
2581
- # operation completes no more than one time. If this token matches a
2582
- # previous request, the service ignores the request, but does not
2583
- # return an error. For more information, see [Ensuring idempotency][1]
2584
- # in the *Amazon EC2 API Reference*.
2855
+ # operation runs no more than one time. If you retry a request with
2856
+ # the same client token, Image Builder returns the original response
2857
+ # without running the operation again. For more information, see
2858
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
2585
2859
  #
2586
2860
  # **A suitable default value is auto-generated.** You should normally
2587
2861
  # not need to pass this option.
@@ -2613,7 +2887,9 @@ module Aws::Imagebuilder
2613
2887
  # @return [String]
2614
2888
  #
2615
2889
  # @!attribute [rw] image_build_version_arn
2616
- # The Amazon Resource Name (ARN) of the image to be distributed.
2890
+ # The Amazon Resource Name (ARN) of the new Image Builder image
2891
+ # resource that this operation creates to track the distribution. Use
2892
+ # this ARN with GetImage to monitor distribution progress.
2617
2893
  # @return [String]
2618
2894
  #
2619
2895
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DistributeImageResponse AWS API Documentation
@@ -2683,7 +2959,14 @@ module Aws::Imagebuilder
2683
2959
  include Aws::Structure
2684
2960
  end
2685
2961
 
2686
- # A distribution configuration.
2962
+ # Defines how Image Builder distributes the output of an image build.
2963
+ # You can configure:
2964
+ #
2965
+ # * The Regions to distribute the image to.
2966
+ #
2967
+ # * The Region-specific settings to apply, such as output AMI names,
2968
+ # launch permissions for other Amazon Web Services accounts, and
2969
+ # target container repositories.
2687
2970
  #
2688
2971
  # @!attribute [rw] arn
2689
2972
  # The Amazon Resource Name (ARN) of the distribution configuration.
@@ -2703,7 +2986,9 @@ module Aws::Imagebuilder
2703
2986
  # @return [Array<Types::Distribution>]
2704
2987
  #
2705
2988
  # @!attribute [rw] timeout_minutes
2706
- # The maximum duration in minutes for this distribution configuration.
2989
+ # A property that Image Builder doesn't use. You can't set this
2990
+ # property when you create or update a distribution configuration, and
2991
+ # it has no effect on distribution behavior.
2707
2992
  # @return [Integer]
2708
2993
  #
2709
2994
  # @!attribute [rw] date_created
@@ -2760,7 +3045,8 @@ module Aws::Imagebuilder
2760
3045
  # @return [Hash<String,String>]
2761
3046
  #
2762
3047
  # @!attribute [rw] regions
2763
- # A list of Regions where the container image is distributed to.
3048
+ # A list of the Regions that the distribution configuration
3049
+ # distributes images to.
2764
3050
  # @return [Array<String>]
2765
3051
  #
2766
3052
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DistributionConfigurationSummary AWS API Documentation
@@ -2876,12 +3162,13 @@ module Aws::Imagebuilder
2876
3162
  # the output container images that Amazon Inspector scans.
2877
3163
  #
2878
3164
  # @!attribute [rw] repository_name
2879
- # The name of the container repository that Amazon Inspector scans to
2880
- # identify findings for your container images. The name includes the
2881
- # path for the repository location. If you don’t provide this
2882
- # information, Image Builder creates a repository in your account
2883
- # named `image-builder-image-scanning-repository` for vulnerability
2884
- # scans of your output container images.
3165
+ # The name of the container repository where Image Builder pushes the
3166
+ # container image for the vulnerability scan. Provide the repository
3167
+ # name only (a namespace path is allowed, but not the registry
3168
+ # hostname); the repository must already exist in your account. If you
3169
+ # don't specify a repository name, Image Builder creates the default
3170
+ # repository `image-builder-image-scanning-repository` in your
3171
+ # account.
2885
3172
  # @return [String]
2886
3173
  #
2887
3174
  # @!attribute [rw] container_tags
@@ -2899,18 +3186,18 @@ module Aws::Imagebuilder
2899
3186
  include Aws::Structure
2900
3187
  end
2901
3188
 
2902
- # Define and configure faster launching for output Windows AMIs.
3189
+ # Defines and configures EC2 Fast Launch for output Windows AMIs.
2903
3190
  #
2904
3191
  # @!attribute [rw] enabled
2905
- # A Boolean that represents the current state of faster launching for
2906
- # the Windows AMI. Set to `true` to start using Windows faster
2907
- # launching, or `false` to stop using it.
3192
+ # Specifies whether to enable Windows fast launch on the output AMI
3193
+ # during distribution. A value of `false` means Image Builder takes no
3194
+ # fast-launch action for this configuration.
2908
3195
  # @return [Boolean]
2909
3196
  #
2910
3197
  # @!attribute [rw] snapshot_configuration
2911
3198
  # Configuration settings for managing the number of snapshots that are
2912
3199
  # created from pre-provisioned instances for the Windows AMI when
2913
- # faster launching is enabled.
3200
+ # Windows fast launch is enabled.
2914
3201
  # @return [Types::FastLaunchSnapshotConfiguration]
2915
3202
  #
2916
3203
  # @!attribute [rw] max_parallel_launches
@@ -2941,7 +3228,7 @@ module Aws::Imagebuilder
2941
3228
  end
2942
3229
 
2943
3230
  # Identifies the launch template that the associated Windows AMI uses
2944
- # for launching an instance when faster launching is enabled.
3231
+ # for launching an instance when Windows fast launch is enabled.
2945
3232
  #
2946
3233
  # <note markdown="1"> You can specify either the `launchTemplateName` or the
2947
3234
  # `launchTemplateId`, but not both.
@@ -2949,18 +3236,18 @@ module Aws::Imagebuilder
2949
3236
  # </note>
2950
3237
  #
2951
3238
  # @!attribute [rw] launch_template_id
2952
- # The ID of the launch template to use for faster launching for a
3239
+ # The ID of the launch template to use for Windows fast launch for a
2953
3240
  # Windows AMI.
2954
3241
  # @return [String]
2955
3242
  #
2956
3243
  # @!attribute [rw] launch_template_name
2957
- # The name of the launch template to use for faster launching for a
3244
+ # The name of the launch template to use for Windows fast launch for a
2958
3245
  # Windows AMI.
2959
3246
  # @return [String]
2960
3247
  #
2961
3248
  # @!attribute [rw] launch_template_version
2962
- # The version of the launch template to use for faster launching for a
2963
- # Windows AMI.
3249
+ # The version of the launch template to use for Windows fast launch
3250
+ # for a Windows AMI.
2964
3251
  # @return [String]
2965
3252
  #
2966
3253
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/FastLaunchLaunchTemplateSpecification AWS API Documentation
@@ -3056,7 +3343,10 @@ module Aws::Imagebuilder
3056
3343
 
3057
3344
  # @!attribute [rw] component_build_version_arn
3058
3345
  # The Amazon Resource Name (ARN) of the component that you want to
3059
- # get. Regex requires the suffix `/\d+$`.
3346
+ # get. You can specify a build version ARN, or a component version
3347
+ # ARN. The version can use the `x` wildcard in trailing positions, for
3348
+ # example `1.0.x` or `1.x.x`. Version ARNs resolve to the latest
3349
+ # available matching component build version.
3060
3350
  # @return [String]
3061
3351
  #
3062
3352
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentRequest AWS API Documentation
@@ -3076,8 +3366,10 @@ module Aws::Imagebuilder
3076
3366
  # @return [Types::Component]
3077
3367
  #
3078
3368
  # @!attribute [rw] latest_version_references
3079
- # The resource ARNs with different wildcard variations of semantic
3080
- # versioning.
3369
+ # A set of wildcard version ARNs that always reference the latest
3370
+ # version of the resource. ARNs are included for the latest version
3371
+ # overall, and for the latest versions within the same major, minor,
3372
+ # and patch levels.
3081
3373
  # @return [Types::LatestVersionReferences]
3082
3374
  #
3083
3375
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentResponse AWS API Documentation
@@ -3108,7 +3400,9 @@ module Aws::Imagebuilder
3108
3400
  # @return [String]
3109
3401
  #
3110
3402
  # @!attribute [rw] policy
3111
- # The container recipe policy object that is returned.
3403
+ # The resource policy for the container recipe, as a JSON policy
3404
+ # document. If no policy has been applied, the response contains an
3405
+ # empty JSON object (`{}`).
3112
3406
  # @return [String]
3113
3407
  #
3114
3408
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetContainerRecipePolicyResponse AWS API Documentation
@@ -3141,8 +3435,10 @@ module Aws::Imagebuilder
3141
3435
  # @return [Types::ContainerRecipe]
3142
3436
  #
3143
3437
  # @!attribute [rw] latest_version_references
3144
- # The resource ARNs with different wildcard variations of semantic
3145
- # versioning.
3438
+ # A set of wildcard version ARNs that always reference the latest
3439
+ # version of the resource. ARNs are included for the latest version
3440
+ # overall, and for the latest versions within the same major, minor,
3441
+ # and patch levels.
3146
3442
  # @return [Types::LatestVersionReferences]
3147
3443
  #
3148
3444
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetContainerRecipeResponse AWS API Documentation
@@ -3233,7 +3529,9 @@ module Aws::Imagebuilder
3233
3529
  # @return [String]
3234
3530
  #
3235
3531
  # @!attribute [rw] policy
3236
- # The image policy object.
3532
+ # The resource policy for the image, as a JSON policy document. If the
3533
+ # image has no policy applied, the response contains an empty JSON
3534
+ # object (`{}`).
3237
3535
  # @return [String]
3238
3536
  #
3239
3537
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImagePolicyResponse AWS API Documentation
@@ -3263,7 +3561,9 @@ module Aws::Imagebuilder
3263
3561
  # @return [String]
3264
3562
  #
3265
3563
  # @!attribute [rw] policy
3266
- # The image recipe policy object.
3564
+ # The resource policy for the image recipe, as a JSON policy document.
3565
+ # If no policy has been applied, the response contains an empty JSON
3566
+ # object (`{}`).
3267
3567
  # @return [String]
3268
3568
  #
3269
3569
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipePolicyResponse AWS API Documentation
@@ -3277,7 +3577,9 @@ module Aws::Imagebuilder
3277
3577
 
3278
3578
  # @!attribute [rw] image_recipe_arn
3279
3579
  # The Amazon Resource Name (ARN) of the image recipe that you want to
3280
- # retrieve.
3580
+ # retrieve. You can use the `x` wildcard in trailing version positions
3581
+ # to retrieve the latest matching version, for example `x.x.x` or
3582
+ # `1.x.x`.
3281
3583
  # @return [String]
3282
3584
  #
3283
3585
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipeRequest AWS API Documentation
@@ -3297,8 +3599,10 @@ module Aws::Imagebuilder
3297
3599
  # @return [Types::ImageRecipe]
3298
3600
  #
3299
3601
  # @!attribute [rw] latest_version_references
3300
- # The resource ARNs with different wildcard variations of semantic
3301
- # versioning.
3602
+ # A set of wildcard version ARNs that always reference the latest
3603
+ # version of the resource. ARNs are included for the latest version
3604
+ # overall, and for the latest versions within the same major, minor,
3605
+ # and patch levels.
3302
3606
  # @return [Types::LatestVersionReferences]
3303
3607
  #
3304
3608
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipeResponse AWS API Documentation
@@ -3313,6 +3617,13 @@ module Aws::Imagebuilder
3313
3617
 
3314
3618
  # @!attribute [rw] image_build_version_arn
3315
3619
  # The Amazon Resource Name (ARN) of the image that you want to get.
3620
+ # You can specify a full build version ARN, or a version ARN with or
3621
+ # without wildcards (`x.x.x`, `1.x.x`, or `1.0.x`). A version or
3622
+ # wildcard ARN resolves to the latest matching build version that has
3623
+ # reached `AVAILABLE` status. Builds that were later deprecated,
3624
+ # disabled, or deleted don't resolve. To get an image in any other
3625
+ # state, such as a failed or in-progress build, specify the full build
3626
+ # version ARN.
3316
3627
  # @return [String]
3317
3628
  #
3318
3629
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRequest AWS API Documentation
@@ -3332,8 +3643,10 @@ module Aws::Imagebuilder
3332
3643
  # @return [Types::Image]
3333
3644
  #
3334
3645
  # @!attribute [rw] latest_version_references
3335
- # The resource ARNs with different wildcard variations of semantic
3336
- # versioning.
3646
+ # A set of wildcard version ARNs that always reference the latest
3647
+ # version of the resource. ARNs are included for the latest version
3648
+ # overall, and for the latest versions within the same major, minor,
3649
+ # and patch levels.
3337
3650
  # @return [Types::LatestVersionReferences]
3338
3651
  #
3339
3652
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageResponse AWS API Documentation
@@ -3420,8 +3733,7 @@ module Aws::Imagebuilder
3420
3733
  end
3421
3734
 
3422
3735
  # @!attribute [rw] lifecycle_policy
3423
- # The Amazon Resource Name (ARN) of the image lifecycle policy
3424
- # resource that was returned.
3736
+ # The details of the lifecycle policy that the request retrieved.
3425
3737
  # @return [Types::LifecyclePolicy]
3426
3738
  #
3427
3739
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetLifecyclePolicyResponse AWS API Documentation
@@ -3443,8 +3755,8 @@ module Aws::Imagebuilder
3443
3755
  # @return [String]
3444
3756
  #
3445
3757
  # @!attribute [rw] resource_location
3446
- # The bucket path that you can specify to download the resource from
3447
- # Amazon S3.
3758
+ # The Amazon S3 location of the component artifact to retrieve, in
3759
+ # `s3://bucket/key` form.
3448
3760
  # @return [String]
3449
3761
  #
3450
3762
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetMarketplaceResourceRequest AWS API Documentation
@@ -3463,7 +3775,8 @@ module Aws::Imagebuilder
3463
3775
  # @return [String]
3464
3776
  #
3465
3777
  # @!attribute [rw] url
3466
- # The obfuscated S3 URL to download the component artifact from.
3778
+ # A time-limited presigned URL for downloading the component artifact
3779
+ # from Amazon S3.
3467
3780
  # @return [String]
3468
3781
  #
3469
3782
  # @!attribute [rw] data
@@ -3510,8 +3823,8 @@ module Aws::Imagebuilder
3510
3823
  # @return [String]
3511
3824
  #
3512
3825
  # @!attribute [rw] image_build_version_arn
3513
- # The Amazon Resource Name (ARN) of the image resource build version
3514
- # that the specified runtime instance of the workflow created.
3826
+ # The Amazon Resource Name (ARN) of the image build version that owns
3827
+ # the specified runtime instance of the workflow.
3515
3828
  # @return [String]
3516
3829
  #
3517
3830
  # @!attribute [rw] type
@@ -3521,7 +3834,8 @@ module Aws::Imagebuilder
3521
3834
  #
3522
3835
  # @!attribute [rw] status
3523
3836
  # The current runtime status for the specified runtime instance of the
3524
- # workflow.
3837
+ # workflow. `COMPLETED`, `FAILED`, `ROLLBACK_COMPLETED`, `CANCELLED`,
3838
+ # and `SKIPPED` are terminal states.
3525
3839
  # @return [String]
3526
3840
  #
3527
3841
  # @!attribute [rw] message
@@ -3530,9 +3844,11 @@ module Aws::Imagebuilder
3530
3844
  # @return [String]
3531
3845
  #
3532
3846
  # @!attribute [rw] total_step_count
3533
- # The total number of steps in the specified runtime instance of the
3534
- # workflow that ran. This number should equal the sum of the step
3535
- # counts for steps that succeeded, were skipped, and failed.
3847
+ # The total number of steps that the workflow document defines for
3848
+ # this runtime instance of the workflow. Image Builder sets this count
3849
+ # before any steps run. The sum of succeeded, skipped, and failed
3850
+ # steps only reaches this total if every step finishes in one of those
3851
+ # states.
3536
3852
  # @return [Integer]
3537
3853
  #
3538
3854
  # @!attribute [rw] total_steps_succeeded
@@ -3561,8 +3877,9 @@ module Aws::Imagebuilder
3561
3877
  # @return [String]
3562
3878
  #
3563
3879
  # @!attribute [rw] parallel_group
3564
- # Test workflows are defined within named runtime groups. The parallel
3565
- # group is a named group that contains one or more test workflows.
3880
+ # The name of the parallel group that this runtime instance of the
3881
+ # workflow ran in, if configured. Parallel groups apply only to test
3882
+ # workflows.
3566
3883
  # @return [String]
3567
3884
  #
3568
3885
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowExecutionResponse AWS API Documentation
@@ -3588,7 +3905,10 @@ module Aws::Imagebuilder
3588
3905
 
3589
3906
  # @!attribute [rw] workflow_build_version_arn
3590
3907
  # The Amazon Resource Name (ARN) of the workflow resource that you
3591
- # want to get.
3908
+ # want to get. You can specify a build version ARN, or a version ARN
3909
+ # with or without wildcards (`x`) in its version segments. Image
3910
+ # Builder resolves version and wildcard ARNs to the most recent
3911
+ # matching build version.
3592
3912
  # @return [String]
3593
3913
  #
3594
3914
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowRequest AWS API Documentation
@@ -3604,8 +3924,10 @@ module Aws::Imagebuilder
3604
3924
  # @return [Types::Workflow]
3605
3925
  #
3606
3926
  # @!attribute [rw] latest_version_references
3607
- # The resource ARNs with different wildcard variations of semantic
3608
- # versioning.
3927
+ # A set of wildcard version ARNs that always reference the latest
3928
+ # version of the resource. ARNs are included for the latest version
3929
+ # overall, and for the latest versions within the same major, minor,
3930
+ # and patch levels.
3609
3931
  # @return [Types::LatestVersionReferences]
3610
3932
  #
3611
3933
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowResponse AWS API Documentation
@@ -3618,8 +3940,9 @@ module Aws::Imagebuilder
3618
3940
  end
3619
3941
 
3620
3942
  # @!attribute [rw] step_execution_id
3621
- # Use the unique identifier for a specific runtime instance of the
3622
- # workflow step to get runtime details for that step.
3943
+ # The unique identifier for the runtime instance of the workflow step
3944
+ # that you want to get runtime details for. To get the identifiers for
3945
+ # the steps that ran in a workflow, call ListWorkflowStepExecutions.
3623
3946
  # @return [String]
3624
3947
  #
3625
3948
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetWorkflowStepExecutionRequest AWS API Documentation
@@ -3635,7 +3958,7 @@ module Aws::Imagebuilder
3635
3958
  # @return [String]
3636
3959
  #
3637
3960
  # @!attribute [rw] step_execution_id
3638
- # The unique identifier for the runtime version of the workflow step
3961
+ # The unique identifier for the runtime instance of the workflow step
3639
3962
  # that you specified in the request.
3640
3963
  # @return [String]
3641
3964
  #
@@ -3650,8 +3973,8 @@ module Aws::Imagebuilder
3650
3973
  # @return [String]
3651
3974
  #
3652
3975
  # @!attribute [rw] image_build_version_arn
3653
- # The Amazon Resource Name (ARN) of the image resource build version
3654
- # that the specified runtime instance of the workflow step creates.
3976
+ # The Amazon Resource Name (ARN) of the image build version that owns
3977
+ # the specified runtime instance of the workflow step.
3655
3978
  # @return [String]
3656
3979
  #
3657
3980
  # @!attribute [rw] name
@@ -3667,13 +3990,14 @@ module Aws::Imagebuilder
3667
3990
  # @return [String]
3668
3991
  #
3669
3992
  # @!attribute [rw] status
3670
- # The current status for the specified runtime version of the workflow
3671
- # step.
3993
+ # The current status for the specified runtime instance of the
3994
+ # workflow step.
3672
3995
  # @return [String]
3673
3996
  #
3674
3997
  # @!attribute [rw] rollback_status
3675
- # Reports on the rollback status of the specified runtime version of
3676
- # the workflow step, if applicable.
3998
+ # Reports on the rollback status of the specified runtime instance of
3999
+ # the workflow step, if applicable. Rollback runs when the workflow
4000
+ # execution fails, and undoes the work that completed steps performed.
3677
4001
  # @return [String]
3678
4002
  #
3679
4003
  # @!attribute [rw] message
@@ -3683,16 +4007,18 @@ module Aws::Imagebuilder
3683
4007
  #
3684
4008
  # @!attribute [rw] inputs
3685
4009
  # Input parameters that Image Builder provided for the specified
3686
- # runtime instance of the workflow step.
4010
+ # runtime instance of the workflow step, as a JSON-encoded string.
3687
4011
  # @return [String]
3688
4012
  #
3689
4013
  # @!attribute [rw] outputs
3690
- # The file names that the specified runtime version of the workflow
3691
- # step created as output.
4014
+ # The output values that the specified runtime instance of the
4015
+ # workflow step produced, as a JSON-encoded string. For example, a
4016
+ # step that launches an instance outputs the instance ID. If the step
4017
+ # failed, this field contains the error message.
3692
4018
  # @return [String]
3693
4019
  #
3694
4020
  # @!attribute [rw] start_time
3695
- # The timestamp when the specified runtime version of the workflow
4021
+ # The timestamp when the specified runtime instance of the workflow
3696
4022
  # step started.
3697
4023
  # @return [String]
3698
4024
  #
@@ -3702,12 +4028,17 @@ module Aws::Imagebuilder
3702
4028
  # @return [String]
3703
4029
  #
3704
4030
  # @!attribute [rw] on_failure
3705
- # The action to perform if the workflow step fails.
4031
+ # The action that the workflow takes if this step fails, as configured
4032
+ # in the workflow document. `Abort` fails the workflow and rolls back
4033
+ # completed steps. `Continue` proceeds to the next step. If the step
4034
+ # doesn't set a value, it defaults to `Abort`.
3706
4035
  # @return [String]
3707
4036
  #
3708
4037
  # @!attribute [rw] timeout_seconds
3709
4038
  # The maximum duration in seconds for this step to complete its
3710
- # action.
4039
+ # action. If the workflow document doesn't set a timeout for the
4040
+ # step, Image Builder applies the default timeout for the step's
4041
+ # action. This field returns that value.
3711
4042
  # @return [Integer]
3712
4043
  #
3713
4044
  # @!attribute [rw] attempt_number
@@ -3766,9 +4097,10 @@ module Aws::Imagebuilder
3766
4097
 
3767
4098
  # An Image Builder image resource that keeps track of all of the
3768
4099
  # settings used to create, configure, and distribute output for that
3769
- # image. You must specify exactly one recipe for the image – either a
3770
- # container recipe (`containerRecipe`), which creates a container image,
3771
- # or an image recipe (`imageRecipe`), which creates an AMI.
4100
+ # image. An image that Image Builder built from a recipe contains
4101
+ # exactly one recipe – either a container recipe (`containerRecipe`),
4102
+ # which creates a container image, or an image recipe (`imageRecipe`),
4103
+ # which creates an AMI. Imported images don't contain a recipe.
3772
4104
  #
3773
4105
  # @!attribute [rw] arn
3774
4106
  # The Amazon Resource Name (ARN) of the image.
@@ -3855,12 +4187,15 @@ module Aws::Imagebuilder
3855
4187
  # @return [Types::ContainerRecipe]
3856
4188
  #
3857
4189
  # @!attribute [rw] source_pipeline_name
3858
- # The name of the image pipeline that created this image.
4190
+ # The name of the image pipeline that created this image. Image
4191
+ # Builder doesn't return this field for new images. Use
4192
+ # `sourcePipelineArn` instead.
3859
4193
  # @return [String]
3860
4194
  #
3861
4195
  # @!attribute [rw] source_pipeline_arn
3862
4196
  # The Amazon Resource Name (ARN) of the image pipeline that created
3863
- # this image.
4197
+ # this image. This field is only present for images that a pipeline
4198
+ # execution created.
3864
4199
  # @return [String]
3865
4200
  #
3866
4201
  # @!attribute [rw] infrastructure_configuration
@@ -3873,7 +4208,8 @@ module Aws::Imagebuilder
3873
4208
  # @return [Types::DistributionConfiguration]
3874
4209
  #
3875
4210
  # @!attribute [rw] image_tests_configuration
3876
- # The image tests that ran when that Image Builder created this image.
4211
+ # The image test settings that Image Builder used when it created this
4212
+ # image.
3877
4213
  # @return [Types::ImageTestsConfiguration]
3878
4214
  #
3879
4215
  # @!attribute [rw] date_created
@@ -3914,7 +4250,10 @@ module Aws::Imagebuilder
3914
4250
  # @return [Types::ImageScanState]
3915
4251
  #
3916
4252
  # @!attribute [rw] image_scanning_configuration
3917
- # Contains settings for vulnerability scans.
4253
+ # Settings for the vulnerability scans that Amazon Inspector runs for
4254
+ # this image. For AMI output, Amazon Inspector scans the test instance
4255
+ # during image creation. For container output, Amazon Inspector scans
4256
+ # the container image in its Amazon ECR repository.
3918
4257
  # @return [Types::ImageScanningConfiguration]
3919
4258
  #
3920
4259
  # @!attribute [rw] deprecation_time
@@ -3933,8 +4272,8 @@ module Aws::Imagebuilder
3933
4272
  # @return [String]
3934
4273
  #
3935
4274
  # @!attribute [rw] workflows
3936
- # Contains the build and test workflows that are associated with the
3937
- # image.
4275
+ # The build, test, and distribution workflow configurations that are
4276
+ # associated with the image.
3938
4277
  # @return [Array<Types::WorkflowConfiguration>]
3939
4278
  #
3940
4279
  # @!attribute [rw] logging_configuration
@@ -4070,8 +4409,9 @@ module Aws::Imagebuilder
4070
4409
  include Aws::Structure
4071
4410
  end
4072
4411
 
4073
- # A software package that's installed on top of the base image to
4074
- # create a customized image.
4412
+ # A software package that's installed on an image, as detected by
4413
+ # Amazon Web Services Systems Manager Inventory at build time. The list
4414
+ # includes packages that shipped with the base image.
4075
4415
  #
4076
4416
  # @!attribute [rw] package_name
4077
4417
  # The name of the package that's reported to the operating system
@@ -4092,7 +4432,11 @@ module Aws::Imagebuilder
4092
4432
  include Aws::Structure
4093
4433
  end
4094
4434
 
4095
- # Details of an image pipeline.
4435
+ # Defines the automation configuration for building, testing, and
4436
+ # distributing images. A pipeline references the resources that its
4437
+ # builds use, such as the recipe and infrastructure configuration. It
4438
+ # also holds the settings that control its builds, such as the schedule
4439
+ # and custom workflows.
4096
4440
  #
4097
4441
  # @!attribute [rw] arn
4098
4442
  # The Amazon Resource Name (ARN) of the image pipeline.
@@ -4107,7 +4451,8 @@ module Aws::Imagebuilder
4107
4451
  # @return [String]
4108
4452
  #
4109
4453
  # @!attribute [rw] platform
4110
- # The platform of the image pipeline.
4454
+ # The platform of the image pipeline, inherited from the recipe that
4455
+ # the pipeline uses.
4111
4456
  # @return [String]
4112
4457
  #
4113
4458
  # @!attribute [rw] enhanced_image_metadata_enabled
@@ -4145,7 +4490,10 @@ module Aws::Imagebuilder
4145
4490
  # @return [Types::Schedule]
4146
4491
  #
4147
4492
  # @!attribute [rw] status
4148
- # The status of the image pipeline.
4493
+ # The status of the image pipeline. A disabled pipeline doesn't run
4494
+ # on its schedule, but you can still start builds manually. Image
4495
+ # Builder can also disable a pipeline automatically when consecutive
4496
+ # scheduled builds fail.
4149
4497
  # @return [String]
4150
4498
  #
4151
4499
  # @!attribute [rw] date_created
@@ -4157,7 +4505,7 @@ module Aws::Imagebuilder
4157
4505
  # @return [String]
4158
4506
  #
4159
4507
  # @!attribute [rw] date_last_run
4160
- # This is no longer supported, and does not return a value.
4508
+ # The date on which this image pipeline was last run.
4161
4509
  # @return [String]
4162
4510
  #
4163
4511
  # @!attribute [rw] last_run_status
@@ -4174,11 +4522,20 @@ module Aws::Imagebuilder
4174
4522
  # @return [Hash<String,String>]
4175
4523
  #
4176
4524
  # @!attribute [rw] image_scanning_configuration
4177
- # Contains settings for vulnerability scans.
4525
+ # Contains settings for vulnerability scans that Amazon Inspector runs
4526
+ # against the test instance during image creation.
4178
4527
  # @return [Types::ImageScanningConfiguration]
4179
4528
  #
4180
4529
  # @!attribute [rw] image_tags
4181
- # The tags to be applied to the images produced by this pipeline.
4530
+ # The tags that Image Builder applies to the Image Builder image
4531
+ # resource that this pipeline's scheduled executions create. These
4532
+ # tags don't apply to the output AMI. Builds that you start manually
4533
+ # use the tags from the [StartImagePipelineExecution][1] request
4534
+ # instead.
4535
+ #
4536
+ #
4537
+ #
4538
+ # [1]: https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_StartImagePipelineExecution.html
4182
4539
  # @return [Hash<String,String>]
4183
4540
  #
4184
4541
  # @!attribute [rw] execution_role
@@ -4191,7 +4548,8 @@ module Aws::Imagebuilder
4191
4548
  # @return [Array<Types::WorkflowConfiguration>]
4192
4549
  #
4193
4550
  # @!attribute [rw] logging_configuration
4194
- # Defines logging configuration for the output image.
4551
+ # The CloudWatch Logs configuration for the pipeline: the log group
4552
+ # for image build logs and the log group for pipeline execution logs.
4195
4553
  # @return [Types::PipelineLoggingConfiguration]
4196
4554
  #
4197
4555
  # @!attribute [rw] consecutive_failures
@@ -4203,9 +4561,9 @@ module Aws::Imagebuilder
4203
4561
  # failures resets to zero.
4204
4562
  #
4205
4563
  # * If the pipeline execution fails, Image Builder increments the
4206
- # number of consecutive failures. If the failure count exceeds the
4207
- # limit defined in the `AutoDisablePolicy`, Image Builder disables
4208
- # the pipeline.
4564
+ # number of consecutive failures. If the failure count reaches the
4565
+ # limit defined in the AutoDisablePolicy, Image Builder disables the
4566
+ # pipeline.
4209
4567
  #
4210
4568
  # The consecutive failure count is also reset to zero under the
4211
4569
  # following conditions:
@@ -4279,8 +4637,9 @@ module Aws::Imagebuilder
4279
4637
  # @return [String]
4280
4638
  #
4281
4639
  # @!attribute [rw] type
4282
- # Specifies which type of image is created by the recipe - an AMI or a
4283
- # container image.
4640
+ # The output image type. For an image recipe, this is always AMI.
4641
+ # Container images are built from container recipes, a separate
4642
+ # resource. This field isn't currently returned in responses.
4284
4643
  # @return [String]
4285
4644
  #
4286
4645
  # @!attribute [rw] name
@@ -4304,9 +4663,15 @@ module Aws::Imagebuilder
4304
4663
  # @return [String]
4305
4664
  #
4306
4665
  # @!attribute [rw] components
4307
- # The components that are included in the image recipe. Recipes
4308
- # require a minimum of one build component, and can have a maximum of
4309
- # 20 build and test components in any combination.
4666
+ # The components that are included in the image recipe. A recipe can
4667
+ # contain a maximum of 20 build and test components in any
4668
+ # combination, by default. This maximum is an adjustable quota. For
4669
+ # more information, see [EC2 Image Builder endpoints and quotas][1] in
4670
+ # the *Amazon Web Services General Reference*.
4671
+ #
4672
+ #
4673
+ #
4674
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/imagebuilder.html
4310
4675
  # @return [Array<Types::ComponentConfiguration>]
4311
4676
  #
4312
4677
  # @!attribute [rw] parent_image
@@ -4338,15 +4703,18 @@ module Aws::Imagebuilder
4338
4703
  # @return [Hash<String,String>]
4339
4704
  #
4340
4705
  # @!attribute [rw] working_directory
4341
- # The working directory to be used during build and test workflows.
4706
+ # The working directory used during build and test workflows. If you
4707
+ # don't specify a working directory, Image Builder uses `/tmp` for
4708
+ # Linux and macOS build instances, and `C:/` for Windows build
4709
+ # instances.
4342
4710
  # @return [String]
4343
4711
  #
4344
4712
  # @!attribute [rw] additional_instance_configuration
4345
4713
  # Before you create a new AMI, Image Builder launches temporary Amazon
4346
4714
  # EC2 instances to build and test your image configuration. Instance
4347
4715
  # configuration adds a layer of control over those instances. You can
4348
- # define settings and add scripts to run when an instance is launched
4349
- # from your AMI.
4716
+ # define settings and add scripts to run when Image Builder launches
4717
+ # your build instance.
4350
4718
  # @return [Types::AdditionalInstanceConfiguration]
4351
4719
  #
4352
4720
  # @!attribute [rw] ami_tags
@@ -4427,7 +4795,8 @@ module Aws::Imagebuilder
4427
4795
  include Aws::Structure
4428
4796
  end
4429
4797
 
4430
- # Contains details about a vulnerability scan finding.
4798
+ # Contains details about a vulnerability scan finding that Amazon
4799
+ # Inspector generated for an image.
4431
4800
  #
4432
4801
  # @!attribute [rw] aws_account_id
4433
4802
  # The Amazon Web Services account ID that's associated with the
@@ -4464,7 +4833,13 @@ module Aws::Imagebuilder
4464
4833
  # @return [Types::Remediation]
4465
4834
  #
4466
4835
  # @!attribute [rw] severity
4467
- # The severity of the finding.
4836
+ # The severity of the finding. For more information, see [Severity
4837
+ # levels for Amazon Inspector findings][1] in the *Amazon Inspector
4838
+ # User Guide*.
4839
+ #
4840
+ #
4841
+ #
4842
+ # [1]: https://docs.aws.amazon.com/inspector/latest/user/findings-understanding-severity.html
4468
4843
  # @return [String]
4469
4844
  #
4470
4845
  # @!attribute [rw] first_observed_at
@@ -4490,7 +4865,16 @@ module Aws::Imagebuilder
4490
4865
  #
4491
4866
  # @!attribute [rw] fix_available
4492
4867
  # Details about whether a fix is available for any of the packages
4493
- # that are identified in the finding through a version update.
4868
+ # that are identified in the finding through a version update. Valid
4869
+ # values include:
4870
+ #
4871
+ # * `YES` – A fix is available for all of the packages identified in
4872
+ # the finding.
4873
+ #
4874
+ # * `NO` – No fix is available.
4875
+ #
4876
+ # * `PARTIAL` – A fix is available for some, but not all, of the
4877
+ # packages identified in the finding.
4494
4878
  # @return [String]
4495
4879
  #
4496
4880
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageScanFinding AWS API Documentation
@@ -4553,7 +4937,18 @@ module Aws::Imagebuilder
4553
4937
  #
4554
4938
  # @!attribute [rw] name
4555
4939
  # The name of the image scan finding filter. Filter names are
4556
- # case-sensitive.
4940
+ # case-sensitive. Valid filter names are:
4941
+ #
4942
+ # * `imageBuildVersionArn` – Filters findings by the image build
4943
+ # version that was scanned.
4944
+ #
4945
+ # * `imagePipelineArn` – Filters findings by the pipeline that created
4946
+ # the scanned image.
4947
+ #
4948
+ # * `vulnerabilityId` – Filters findings by vulnerability ID, for
4949
+ # example a CVE ID.
4950
+ #
4951
+ # * `severity` – Filters findings by severity level.
4557
4952
  # @return [String]
4558
4953
  #
4559
4954
  # @!attribute [rw] values
@@ -4573,7 +4968,11 @@ module Aws::Imagebuilder
4573
4968
  # reason for that status.
4574
4969
  #
4575
4970
  # @!attribute [rw] status
4576
- # The current state of vulnerability scans for the image.
4971
+ # The current state of vulnerability scans for the image. The scan
4972
+ # starts as `PENDING` and moves through `SCANNING` and `COLLECTING` to
4973
+ # `COMPLETED`. Image Builder sets the status to `ABANDONED` if the
4974
+ # image reaches a terminal state before the scan finding collection
4975
+ # completes. A scan can also end as `FAILED` or `TIMED_OUT`.
4577
4976
  # @return [String]
4578
4977
  #
4579
4978
  # @!attribute [rw] reason
@@ -4593,9 +4992,13 @@ module Aws::Imagebuilder
4593
4992
  # scans.
4594
4993
  #
4595
4994
  # @!attribute [rw] image_scanning_enabled
4596
- # A setting that indicates whether Image Builder keeps a snapshot of
4597
- # the vulnerability scans that Amazon Inspector runs against the build
4598
- # instance when you create a new image.
4995
+ # Specifies whether Amazon Inspector scans for vulnerabilities when
4996
+ # you create a new image, and whether Image Builder saves the
4997
+ # findings. Amazon Inspector must be enabled in the account. Image
4998
+ # tests must also be enabled. For AMI output, Amazon Inspector scans
4999
+ # the test instance. For container output, Amazon Inspector scans the
5000
+ # container image that Image Builder pushes to the Amazon ECR
5001
+ # repository from your `ecrConfiguration` settings.
4599
5002
  # @return [Boolean]
4600
5003
  #
4601
5004
  # @!attribute [rw] ecr_configuration
@@ -4614,7 +5017,10 @@ module Aws::Imagebuilder
4614
5017
  # Image status and the reason for that status.
4615
5018
  #
4616
5019
  # @!attribute [rw] status
4617
- # The status of the image.
5020
+ # The status of the image. A new image moves through build, test, and
5021
+ # distribution statuses during creation, and ends in the `AVAILABLE`,
5022
+ # `FAILED`, or `CANCELLED` state. The `DEPRECATED`, `DISABLED`, and
5023
+ # `DELETED` statuses come from later resource management actions.
4618
5024
  # @return [String]
4619
5025
  #
4620
5026
  # @!attribute [rw] reason
@@ -4754,7 +5160,8 @@ module Aws::Imagebuilder
4754
5160
  # @return [Boolean]
4755
5161
  #
4756
5162
  # @!attribute [rw] timeout_minutes
4757
- # The maximum time in minutes that tests are permitted to run.
5163
+ # The maximum time in minutes that tests are permitted to run. If you
5164
+ # don't specify a value, Image Builder stores and returns 720.
4758
5165
  #
4759
5166
  # <note markdown="1"> The timeout property is not currently active. This value is ignored.
4760
5167
  #
@@ -4802,8 +5209,8 @@ module Aws::Imagebuilder
4802
5209
  # @return [String]
4803
5210
  #
4804
5211
  # @!attribute [rw] version
4805
- # Details for a specific version of an Image Builder image. This
4806
- # version follows the semantic version syntax.
5212
+ # The semantic version of the image. This version follows the semantic
5213
+ # version syntax.
4807
5214
  #
4808
5215
  # <note markdown="1"> The semantic version has four nodes:
4809
5216
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
@@ -4833,9 +5240,8 @@ module Aws::Imagebuilder
4833
5240
  # @return [String]
4834
5241
  #
4835
5242
  # @!attribute [rw] os_version
4836
- # The operating system version of the Amazon EC2 build instance. For
4837
- # example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server
4838
- # 2019.
5243
+ # The operating system version of the image. For example, Amazon Linux
5244
+ # 2023 or Microsoft Windows Server 2022.
4839
5245
  # @return [String]
4840
5246
  #
4841
5247
  # @!attribute [rw] owner
@@ -4885,7 +5291,14 @@ module Aws::Imagebuilder
4885
5291
  end
4886
5292
 
4887
5293
  # @!attribute [rw] name
4888
- # The name of the component.
5294
+ # The name of the component. Image Builder generates the component ARN
5295
+ # from a normalized form of the name, so names that differ only in
5296
+ # case, spaces, or underscores count as the same name. If a component
5297
+ # with the same name and semantic version already exists in your
5298
+ # account in the same Amazon Web Services Region, the request creates
5299
+ # a new build version for it. If the content is also identical to the
5300
+ # latest build version, the request fails because the component
5301
+ # already exists.
4889
5302
  # @return [String]
4890
5303
  #
4891
5304
  # @!attribute [rw] semantic_version
@@ -4896,10 +5309,15 @@ module Aws::Imagebuilder
4896
5309
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
4897
5310
  # assign values for the first three, and can filter on all of them.
4898
5311
  #
4899
- # **Filtering:** You can use wildcards (x) to specify the most recent
4900
- # versions or nodes when selecting the base image or components for
4901
- # your recipe. When you use a wildcard in any node, all nodes to the
4902
- # right of the first wildcard must also be wildcards.
5312
+ # **Assignment:** For the first three nodes, you can assign any
5313
+ # positive integer value, including zero. The upper limit is 2^30-1,
5314
+ # or 1073741823, for each node. Image Builder automatically assigns
5315
+ # the build number to the fourth node.
5316
+ #
5317
+ # **Patterns:** You can use any numeric pattern that adheres to the
5318
+ # assignment requirements for the nodes that you can assign. For
5319
+ # example, you might choose a software version pattern, such as 1.0.0,
5320
+ # or a date, such as 2021.01.01.
4903
5321
  #
4904
5322
  # </note>
4905
5323
  # @return [String]
@@ -4929,9 +5347,10 @@ module Aws::Imagebuilder
4929
5347
  # @return [String]
4930
5348
  #
4931
5349
  # @!attribute [rw] data
4932
- # The data of the component. Used to specify the data inline. Either
4933
- # `data` or `uri` can be used to specify the data within the
4934
- # component.
5350
+ # The data of the component. For the `SHELL` format, this is the plain
5351
+ # script content. You must specify exactly one of the `data` or `uri`
5352
+ # properties. For scripts that exceed the inline length constraint,
5353
+ # use the `uri` property.
4935
5354
  # @return [String]
4936
5355
  #
4937
5356
  # @!attribute [rw] uri
@@ -4943,10 +5362,12 @@ module Aws::Imagebuilder
4943
5362
  # @return [String]
4944
5363
  #
4945
5364
  # @!attribute [rw] kms_key_id
4946
- # The Amazon Resource Name (ARN) that uniquely identifies the KMS key
4947
- # used to encrypt this component. This can be either the Key ARN or
4948
- # the Alias ARN. For more information, see [Key identifiers
4949
- # (KeyId)][1] in the *Key Management Service Developer Guide*.
5365
+ # The Amazon Resource Name (ARN) of the KMS key that is used to
5366
+ # encrypt this component. This can be either the Key ARN or the Alias
5367
+ # ARN. For more information, see [Key identifiers (KeyId)][1] in the
5368
+ # *Key Management Service Developer Guide*. If you don't specify a
5369
+ # key, Image Builder encrypts the component data with a KMS key that
5370
+ # Image Builder owns.
4950
5371
  #
4951
5372
  #
4952
5373
  #
@@ -4959,10 +5380,10 @@ module Aws::Imagebuilder
4959
5380
  #
4960
5381
  # @!attribute [rw] client_token
4961
5382
  # A unique, case-sensitive identifier you provide to ensure that the
4962
- # operation completes no more than one time. If this token matches a
4963
- # previous request, the service ignores the request, but does not
4964
- # return an error. For more information, see [Ensuring idempotency][1]
4965
- # in the *Amazon EC2 API Reference*.
5383
+ # operation runs no more than one time. If you retry a request with
5384
+ # the same client token, Image Builder returns the original response
5385
+ # without running the operation again. For more information, see
5386
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
4966
5387
  #
4967
5388
  # **A suitable default value is auto-generated.** You should normally
4968
5389
  # not need to pass this option.
@@ -5015,6 +5436,11 @@ module Aws::Imagebuilder
5015
5436
 
5016
5437
  # @!attribute [rw] name
5017
5438
  # The name of the image resource that's created from the import.
5439
+ # Image Builder generates the image ARN from a normalized form of the
5440
+ # name, so names that differ only in case, spaces, or underscores
5441
+ # count as the same name. If an image with the same name and semantic
5442
+ # version already exists in your account in the same Amazon Web
5443
+ # Services Region, the import creates a new build version for it.
5018
5444
  # @return [String]
5019
5445
  #
5020
5446
  # @!attribute [rw] semantic_version
@@ -5033,14 +5459,16 @@ module Aws::Imagebuilder
5033
5459
  # @return [String]
5034
5460
  #
5035
5461
  # @!attribute [rw] os_version
5036
- # The operating system version for the imported image. Allowed values
5037
- # include the following: `Microsoft Windows 11`.
5462
+ # The operating system version for the imported image. The only
5463
+ # supported value is `Microsoft Windows 11`.
5038
5464
  # @return [String]
5039
5465
  #
5040
5466
  # @!attribute [rw] execution_role
5041
5467
  # The name or Amazon Resource Name (ARN) for the IAM role you create
5042
5468
  # that grants Image Builder access to perform workflow actions to
5043
- # import an image from a Microsoft ISO file.
5469
+ # import an image from a Microsoft ISO file. If you don't provide a
5470
+ # role, Image Builder uses the Image Builder service-linked role in
5471
+ # your account, and creates it if it doesn't exist.
5044
5472
  # @return [String]
5045
5473
  #
5046
5474
  # @!attribute [rw] infrastructure_configuration_arn
@@ -5050,11 +5478,17 @@ module Aws::Imagebuilder
5050
5478
  # @return [String]
5051
5479
  #
5052
5480
  # @!attribute [rw] uri
5053
- # The `uri` of the ISO disk file that's stored in Amazon S3.
5481
+ # The `uri` of the ISO disk file that's stored in Amazon S3, in
5482
+ # `s3://bucket/key` format. The key must end with the `.iso`, `.ISO`,
5483
+ # or `.Iso` extension, and the bucket must be owned by the account
5484
+ # that makes the request.
5054
5485
  # @return [String]
5055
5486
  #
5056
5487
  # @!attribute [rw] logging_configuration
5057
- # The logging configuration for the image build process.
5488
+ # The CloudWatch Logs log group where Image Builder sends the import
5489
+ # logs. If you specify a log group name outside of the
5490
+ # `/aws/imagebuilder/` namespace, you must also provide an
5491
+ # `executionRole` that has permission to write to that log group.
5058
5492
  # @return [Types::ImageLoggingConfiguration]
5059
5493
  #
5060
5494
  # @!attribute [rw] tags
@@ -5071,10 +5505,10 @@ module Aws::Imagebuilder
5071
5505
  #
5072
5506
  # @!attribute [rw] client_token
5073
5507
  # A unique, case-sensitive identifier you provide to ensure that the
5074
- # operation completes no more than one time. If this token matches a
5075
- # previous request, the service ignores the request, but does not
5076
- # return an error. For more information, see [Ensuring idempotency][1]
5077
- # in the *Amazon EC2 API Reference*.
5508
+ # operation runs no more than one time. If you retry a request with
5509
+ # the same client token, Image Builder returns the original response
5510
+ # without running the operation again. For more information, see
5511
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
5078
5512
  #
5079
5513
  # **A suitable default value is auto-generated.** You should normally
5080
5514
  # not need to pass this option.
@@ -5109,8 +5543,10 @@ module Aws::Imagebuilder
5109
5543
  # @return [String]
5110
5544
  #
5111
5545
  # @!attribute [rw] image_build_version_arn
5112
- # The Amazon Resource Name (ARN) of the output AMI that was created
5113
- # from the ISO disk file.
5546
+ # The Amazon Resource Name (ARN) of the Image Builder image resource
5547
+ # that this request created. The AMI doesn't exist yet when the
5548
+ # response returns. The import runs asynchronously, and the output AMI
5549
+ # appears in the image's output resources when the import completes.
5114
5550
  # @return [String]
5115
5551
  #
5116
5552
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImportDiskImageResponse AWS API Documentation
@@ -5124,6 +5560,11 @@ module Aws::Imagebuilder
5124
5560
 
5125
5561
  # @!attribute [rw] name
5126
5562
  # The name of the base image that is created by the import process.
5563
+ # Image Builder generates the image ARN from a normalized form of the
5564
+ # name, so names that differ only in case, spaces, or underscores
5565
+ # count as the same name. If an image with the same name and semantic
5566
+ # version already exists in your account in the same Amazon Web
5567
+ # Services Region, the import creates a new build version for it.
5127
5568
  # @return [String]
5128
5569
  #
5129
5570
  # @!attribute [rw] semantic_version
@@ -5163,13 +5604,15 @@ module Aws::Imagebuilder
5163
5604
  #
5164
5605
  # @!attribute [rw] vm_import_task_id
5165
5606
  # The `importTaskId` (API) or `ImportTaskId` (CLI) from the Amazon EC2
5166
- # VM import process. Image Builder retrieves information from the
5167
- # import process to pull in the AMI that is created from the VM source
5168
- # as the base image for your recipe.
5607
+ # VM import process. The import task doesn't need to be complete when
5608
+ # you call ImportVmImage - Image Builder monitors the task and
5609
+ # finishes creating the image when the task completes.
5169
5610
  # @return [String]
5170
5611
  #
5171
5612
  # @!attribute [rw] logging_configuration
5172
- # The logging configuration for the image build process.
5613
+ # The CloudWatch Logs log group where Image Builder sends the import
5614
+ # logs. For ImportVmImage, the log group name must be within the
5615
+ # `/aws/imagebuilder/` namespace.
5173
5616
  # @return [Types::ImageLoggingConfiguration]
5174
5617
  #
5175
5618
  # @!attribute [rw] tags
@@ -5178,10 +5621,10 @@ module Aws::Imagebuilder
5178
5621
  #
5179
5622
  # @!attribute [rw] client_token
5180
5623
  # A unique, case-sensitive identifier you provide to ensure that the
5181
- # operation completes no more than one time. If this token matches a
5182
- # previous request, the service ignores the request, but does not
5183
- # return an error. For more information, see [Ensuring idempotency][1]
5184
- # in the *Amazon EC2 API Reference*.
5624
+ # operation runs no more than one time. If you retry a request with
5625
+ # the same client token, Image Builder returns the original response
5626
+ # without running the operation again. For more information, see
5627
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
5185
5628
  #
5186
5629
  # **A suitable default value is auto-generated.** You should normally
5187
5630
  # not need to pass this option.
@@ -5212,9 +5655,10 @@ module Aws::Imagebuilder
5212
5655
  # @return [String]
5213
5656
  #
5214
5657
  # @!attribute [rw] image_arn
5215
- # The Amazon Resource Name (ARN) of the AMI that was created during
5216
- # the VM import process. This AMI is used as the base image for the
5217
- # recipe that imported the VM.
5658
+ # The Amazon Resource Name (ARN) of the Image Builder image resource
5659
+ # that this request created. Image Builder records the AMI from the VM
5660
+ # import task in the image's output resources after the task
5661
+ # completes.
5218
5662
  # @return [String]
5219
5663
  #
5220
5664
  # @!attribute [rw] client_token
@@ -5262,7 +5706,9 @@ module Aws::Imagebuilder
5262
5706
  # @return [String]
5263
5707
  #
5264
5708
  # @!attribute [rw] logging
5265
- # The logging configuration of the infrastructure configuration.
5709
+ # The logging configuration of the infrastructure configuration. When
5710
+ # you configure S3 logs, Image Builder writes logs from the build and
5711
+ # test process to the specified bucket under the key prefix.
5266
5712
  # @return [Types::Logging]
5267
5713
  #
5268
5714
  # @!attribute [rw] key_pair
@@ -5270,18 +5716,20 @@ module Aws::Imagebuilder
5270
5716
  # @return [String]
5271
5717
  #
5272
5718
  # @!attribute [rw] terminate_instance_on_failure
5273
- # The terminate instance on failure configuration of the
5274
- # infrastructure configuration.
5719
+ # Indicates whether Image Builder terminates the build and test
5720
+ # instances when the image build fails. When `false`, Image Builder
5721
+ # retains the instance so that you can debug it.
5275
5722
  # @return [Boolean]
5276
5723
  #
5277
5724
  # @!attribute [rw] sns_topic_arn
5278
5725
  # The Amazon Resource Name (ARN) of the SNS topic to which Image
5279
- # Builder sends image build event notifications.
5726
+ # Builder sends image build event notifications. Specify a standard
5727
+ # topic. Image Builder doesn't support FIFO topics.
5280
5728
  #
5281
- # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
5282
- # are encrypted using keys from other accounts. The key that is used
5283
- # to encrypt the SNS topic must reside in the account that the Image
5284
- # Builder service runs under.
5729
+ # <note markdown="1"> EC2 Image Builder can't send notifications to SNS topics that are
5730
+ # encrypted using keys from other accounts. If your SNS topic is
5731
+ # encrypted, the key must be owned by the same account that owns your
5732
+ # Image Builder resources.
5285
5733
  #
5286
5734
  # </note>
5287
5735
  # @return [String]
@@ -5295,7 +5743,8 @@ module Aws::Imagebuilder
5295
5743
  # @return [String]
5296
5744
  #
5297
5745
  # @!attribute [rw] resource_tags
5298
- # The tags attached to the resource created by Image Builder.
5746
+ # The metadata tags assigned to the Amazon EC2 build and test
5747
+ # instances that Image Builder launches during image creation.
5299
5748
  # @return [Hash<String,String>]
5300
5749
  #
5301
5750
  # @!attribute [rw] instance_metadata_options
@@ -5308,10 +5757,23 @@ module Aws::Imagebuilder
5308
5757
  # @return [Hash<String,String>]
5309
5758
  #
5310
5759
  # @!attribute [rw] placement
5311
- # The instance placement settings that define where the instances that
5312
- # are launched from your image run.
5760
+ # The instance placement settings that define where the build and test
5761
+ # instances that Image Builder launches during image creation run.
5762
+ # These settings don't affect instances that you launch from the
5763
+ # output image.
5313
5764
  # @return [Types::Placement]
5314
5765
  #
5766
+ # @!attribute [rw] terminate_instance_on_completion
5767
+ # Specifies whether Image Builder terminates build and test instances
5768
+ # when image creation ends without a failure.
5769
+ # @return [Boolean]
5770
+ #
5771
+ # @!attribute [rw] parent_instance
5772
+ # The Amazon EC2 Auto Scaling group that Image Builder takes the build
5773
+ # instance from, instead of launching a new instance. This applies
5774
+ # only to the build phase.
5775
+ # @return [Types::ParentInstanceConfiguration]
5776
+ #
5315
5777
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InfrastructureConfiguration AWS API Documentation
5316
5778
  #
5317
5779
  class InfrastructureConfiguration < Struct.new(
@@ -5331,12 +5793,16 @@ module Aws::Imagebuilder
5331
5793
  :resource_tags,
5332
5794
  :instance_metadata_options,
5333
5795
  :tags,
5334
- :placement)
5796
+ :placement,
5797
+ :terminate_instance_on_completion,
5798
+ :parent_instance)
5335
5799
  SENSITIVE = []
5336
5800
  include Aws::Structure
5337
5801
  end
5338
5802
 
5339
- # The infrastructure used when building Amazon EC2 AMIs.
5803
+ # Contains a high-level summary of an infrastructure configuration,
5804
+ # including the environment settings that Image Builder uses to build
5805
+ # and test images.
5340
5806
  #
5341
5807
  # @!attribute [rw] arn
5342
5808
  # The Amazon Resource Name (ARN) of the infrastructure configuration.
@@ -5359,7 +5825,8 @@ module Aws::Imagebuilder
5359
5825
  # @return [String]
5360
5826
  #
5361
5827
  # @!attribute [rw] resource_tags
5362
- # The tags attached to the image created by Image Builder.
5828
+ # The metadata tags assigned to the Amazon EC2 build and test
5829
+ # instances that Image Builder launches during image creation.
5363
5830
  # @return [Hash<String,String>]
5364
5831
  #
5365
5832
  # @!attribute [rw] tags
@@ -5375,8 +5842,10 @@ module Aws::Imagebuilder
5375
5842
  # @return [String]
5376
5843
  #
5377
5844
  # @!attribute [rw] placement
5378
- # The instance placement settings that define where the instances that
5379
- # are launched from your image run.
5845
+ # The instance placement settings that define where the build and test
5846
+ # instances that Image Builder launches during image creation run.
5847
+ # These settings don't affect instances that you launch from the
5848
+ # output image.
5380
5849
  # @return [Types::Placement]
5381
5850
  #
5382
5851
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InfrastructureConfigurationSummary AWS API Documentation
@@ -5400,8 +5869,9 @@ module Aws::Imagebuilder
5400
5869
  # Inspector assigned for a finding.
5401
5870
  #
5402
5871
  # @!attribute [rw] adjusted_cvss
5403
- # An object that contains details about an adjustment that Amazon
5404
- # Inspector made to the CVSS score for the finding.
5872
+ # The CVSS score that Amazon Inspector assigned to the finding after
5873
+ # applying its adjustments. It includes the score source, CVSS
5874
+ # version, scoring vector, and the adjustments applied.
5405
5875
  # @return [Types::CvssScoreDetails]
5406
5876
  #
5407
5877
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InspectorScoreDetails AWS API Documentation
@@ -5456,8 +5926,8 @@ module Aws::Imagebuilder
5456
5926
  # @return [String]
5457
5927
  #
5458
5928
  # @!attribute [rw] block_device_mappings
5459
- # Defines the block devices to attach for building an instance from
5460
- # this Image Builder AMI.
5929
+ # Defines the block device mappings for the EC2 instance that Image
5930
+ # Builder launches to build and test your container image.
5461
5931
  # @return [Array<Types::InstanceBlockDeviceMapping>]
5462
5932
  #
5463
5933
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceConfiguration AWS API Documentation
@@ -5469,18 +5939,10 @@ module Aws::Imagebuilder
5469
5939
  include Aws::Structure
5470
5940
  end
5471
5941
 
5472
- # The instance metadata options that apply to the HTTP requests that
5473
- # pipeline builds use to launch EC2 build and test instances. For more
5474
- # information about instance metadata options, see [Configure the
5475
- # instance metadata options][1] in the <i> <i>Amazon EC2 User Guide</i>
5476
- # </i> for Linux instances, or [Configure the instance metadata
5477
- # options][2] in the <i> <i>Amazon EC2 Windows Guide</i> </i> for
5478
- # Windows instances.
5479
- #
5480
- #
5481
- #
5482
- # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
5483
- # [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
5942
+ # The instance metadata service (IMDS) settings that Image Builder
5943
+ # applies to the EC2 build and test instances it launches. These
5944
+ # settings control how software on those instances retrieves instance
5945
+ # metadata and IAM role credentials.
5484
5946
  #
5485
5947
  # @!attribute [rw] http_tokens
5486
5948
  # Indicates whether a signed token header is required for instance
@@ -5495,14 +5957,22 @@ module Aws::Imagebuilder
5495
5957
  # you include it, version 2.0 credentials are returned for the IAM
5496
5958
  # role. Otherwise, version 1.0 credentials are returned.
5497
5959
  #
5498
- # The default setting is **optional**.
5960
+ # If you don't set a value, the EC2 launch default applies to the
5961
+ # build and test instances. That default depends on the base AMI and
5962
+ # any account-level instance metadata defaults. For more information,
5963
+ # see [Configure the instance metadata options][1] in the <i>
5964
+ # <i>Amazon EC2 User Guide</i> </i>.
5965
+ #
5966
+ #
5967
+ #
5968
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
5499
5969
  # @return [String]
5500
5970
  #
5501
5971
  # @!attribute [rw] http_put_response_hop_limit
5502
5972
  # Limit the number of hops that an instance metadata request can
5503
- # traverse to reach its destination. The default is one hop. However,
5504
- # if HTTP tokens are required, container image builds need a minimum
5505
- # of two hops.
5973
+ # traverse to reach its destination. If you don't set a value, the
5974
+ # EC2 launch default for the instance applies. If HTTP tokens are
5975
+ # required, container image builds need a minimum of two hops.
5506
5976
  # @return [Integer]
5507
5977
  #
5508
5978
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceMetadataOptions AWS API Documentation
@@ -5527,8 +5997,9 @@ module Aws::Imagebuilder
5527
5997
  include Aws::Structure
5528
5998
  end
5529
5999
 
5530
- # You have specified two or more mutually exclusive parameters. Review
5531
- # the error message for details.
6000
+ # You have specified a combination of parameters that isn't valid. For
6001
+ # example, two mutually exclusive parameters, or a parameter without its
6002
+ # required companion parameter. Review the error message for details.
5532
6003
  #
5533
6004
  # @!attribute [rw] message
5534
6005
  # @return [String]
@@ -5568,7 +6039,8 @@ module Aws::Imagebuilder
5568
6039
  include Aws::Structure
5569
6040
  end
5570
6041
 
5571
- # You have requested an action that that the service doesn't support.
6042
+ # The request is malformed or otherwise invalid. Verify the request and
6043
+ # try again.
5572
6044
  #
5573
6045
  # @!attribute [rw] message
5574
6046
  # @return [String]
@@ -5595,8 +6067,10 @@ module Aws::Imagebuilder
5595
6067
  include Aws::Structure
5596
6068
  end
5597
6069
 
5598
- # The resource ARNs with different wildcard variations of semantic
5599
- # versioning.
6070
+ # A set of wildcard version ARNs that always reference the latest
6071
+ # version of the resource. ARNs are included for the latest version
6072
+ # overall, and for the latest versions within the same major, minor, and
6073
+ # patch levels.
5600
6074
  #
5601
6075
  # @!attribute [rw] latest_version_arn
5602
6076
  # The latest version Amazon Resource Name (ARN) of the Image Builder
@@ -5633,19 +6107,22 @@ module Aws::Imagebuilder
5633
6107
  # permission modification request is sent to the [Amazon EC2
5634
6108
  # ModifyImageAttribute][1] API on behalf of the user for each Region
5635
6109
  # they have selected to distribute the AMI. To make an AMI public, set
5636
- # the launch permission authorized accounts to `all`. See the examples
5637
- # for making an AMI public at [Amazon EC2 ModifyImageAttribute][1].
6110
+ # `userGroups` to the value `all`. See the examples for making an AMI
6111
+ # public at [Amazon EC2 ModifyImageAttribute][1].
5638
6112
  #
5639
6113
  #
5640
6114
  #
5641
6115
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html
5642
6116
  #
5643
6117
  # @!attribute [rw] user_ids
5644
- # The Amazon Web Services account ID.
6118
+ # The Amazon Web Services account IDs to grant launch permission to.
6119
+ # Each listed account can use the distributed AMI to launch instances.
5645
6120
  # @return [Array<String>]
5646
6121
  #
5647
6122
  # @!attribute [rw] user_groups
5648
- # The name of the group.
6123
+ # The name of the group that you want to grant launch permission to.
6124
+ # The only supported value is `all`, which makes the distributed AMI
6125
+ # public.
5649
6126
  # @return [Array<String>]
5650
6127
  #
5651
6128
  # @!attribute [rw] organization_arns
@@ -5691,8 +6168,9 @@ module Aws::Imagebuilder
5691
6168
  # @return [String]
5692
6169
  #
5693
6170
  # @!attribute [rw] set_default_version
5694
- # Set the specified Amazon EC2 launch template as the default launch
5695
- # template for the specified account.
6171
+ # Specifies whether to make the new launch template version that Image
6172
+ # Builder creates the default version of the launch template. If you
6173
+ # don't set a value, Image Builder treats it as `true`.
5696
6174
  # @return [Boolean]
5697
6175
  #
5698
6176
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LaunchTemplateConfiguration AWS API Documentation
@@ -5716,13 +6194,13 @@ module Aws::Imagebuilder
5716
6194
  # @return [String]
5717
6195
  #
5718
6196
  # @!attribute [rw] resources_impacted_summary
5719
- # Contains information about associated resources that are identified
5720
- # for action by the runtime instance of the lifecycle policy.
6197
+ # A summary flag that indicates whether the lifecycle execution
6198
+ # identified any resources to take lifecycle actions on.
5721
6199
  # @return [Types::LifecycleExecutionResourcesImpactedSummary]
5722
6200
  #
5723
6201
  # @!attribute [rw] state
5724
- # Runtime state that reports if the policy action ran successfully,
5725
- # failed, or was skipped.
6202
+ # Runtime state that reports whether the lifecycle execution is in
6203
+ # progress, succeeded, or failed.
5726
6204
  # @return [Types::LifecycleExecutionState]
5727
6205
  #
5728
6206
  # @!attribute [rw] start_time
@@ -5766,7 +6244,7 @@ module Aws::Imagebuilder
5766
6244
  # @return [String]
5767
6245
  #
5768
6246
  # @!attribute [rw] state
5769
- # The runtime state for the lifecycle execution.
6247
+ # The runtime state of the lifecycle action for this resource.
5770
6248
  # @return [Types::LifecycleExecutionResourceState]
5771
6249
  #
5772
6250
  # @!attribute [rw] action
@@ -5818,8 +6296,8 @@ module Aws::Imagebuilder
5818
6296
  # resource.
5819
6297
  #
5820
6298
  # @!attribute [rw] name
5821
- # The name of the resource that was identified for a lifecycle policy
5822
- # action.
6299
+ # The name of the lifecycle action that was identified for the
6300
+ # resource.
5823
6301
  # @return [String]
5824
6302
  #
5825
6303
  # @!attribute [rw] reason
@@ -5856,12 +6334,12 @@ module Aws::Imagebuilder
5856
6334
  include Aws::Structure
5857
6335
  end
5858
6336
 
5859
- # Contains details for an image resource that was identified for a
5860
- # lifecycle action.
6337
+ # Contains an indicator that shows whether the lifecycle execution
6338
+ # identified any resources to take lifecycle actions on.
5861
6339
  #
5862
6340
  # @!attribute [rw] has_impacted_resources
5863
- # Indicates whether an image resource that was identified for a
5864
- # lifecycle action has associated resources that are also impacted.
6341
+ # Indicates whether the lifecycle execution identified any resources
6342
+ # to take lifecycle actions on.
5865
6343
  # @return [Boolean]
5866
6344
  #
5867
6345
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LifecycleExecutionResourcesImpactedSummary AWS API Documentation
@@ -5911,7 +6389,8 @@ module Aws::Imagebuilder
5911
6389
  include Aws::Structure
5912
6390
  end
5913
6391
 
5914
- # The configuration details for a lifecycle policy resource.
6392
+ # Defines a lifecycle policy resource: its identity, status, execution
6393
+ # role, resource type, rules, resource selection, timestamps, and tags.
5915
6394
  #
5916
6395
  # @!attribute [rw] arn
5917
6396
  # The Amazon Resource Name (ARN) of the lifecycle policy resource.
@@ -5926,7 +6405,10 @@ module Aws::Imagebuilder
5926
6405
  # @return [String]
5927
6406
  #
5928
6407
  # @!attribute [rw] status
5929
- # Indicates whether the lifecycle policy resource is enabled.
6408
+ # Indicates whether the lifecycle policy resource is enabled. Only
6409
+ # enabled policies run on their schedule. Disabling or deleting a
6410
+ # policy removes its schedule and cancels any in-flight lifecycle
6411
+ # execution.
5930
6412
  # @return [String]
5931
6413
  #
5932
6414
  # @!attribute [rw] execution_role
@@ -5940,7 +6422,9 @@ module Aws::Imagebuilder
5940
6422
  # @return [String]
5941
6423
  #
5942
6424
  # @!attribute [rw] policy_details
5943
- # The configuration details for a lifecycle policy resource.
6425
+ # The list of rules for the lifecycle policy. Each rule pairs an
6426
+ # action with a filter and optional exclusion rules. A policy can
6427
+ # contain at most one rule per action type.
5944
6428
  # @return [Array<Types::LifecyclePolicyDetail>]
5945
6429
  #
5946
6430
  # @!attribute [rw] resource_selection
@@ -5987,7 +6471,9 @@ module Aws::Imagebuilder
5987
6471
  include Aws::Structure
5988
6472
  end
5989
6473
 
5990
- # The configuration details for a lifecycle policy resource.
6474
+ # Defines one lifecycle policy rule: the action to take, the filter that
6475
+ # determines which resources the rule applies to, and optional exclusion
6476
+ # rules.
5991
6477
  #
5992
6478
  # @!attribute [rw] action
5993
6479
  # Configuration details for the policy action.
@@ -6012,14 +6498,23 @@ module Aws::Imagebuilder
6012
6498
  include Aws::Structure
6013
6499
  end
6014
6500
 
6015
- # Contains selection criteria for the lifecycle policy.
6501
+ # Contains the action configuration for a lifecycle policy rule: the
6502
+ # action to take, and which underlying resources the action extends to.
6016
6503
  #
6017
6504
  # @!attribute [rw] type
6018
- # Specifies the lifecycle action to take.
6505
+ # Specifies the lifecycle action to take. `DELETE` deletes the image
6506
+ # resource and, with `includeResources`, also removes distributed
6507
+ # AMIs, snapshots, or container images. `DEPRECATE` and `DISABLE` set
6508
+ # the corresponding status on the image resource and, if
6509
+ # `includeResources.amis` is set, on its distributed AMIs.
6019
6510
  # @return [String]
6020
6511
  #
6021
6512
  # @!attribute [rw] include_resources
6022
- # Specifies the resources that the lifecycle policy applies to.
6513
+ # Specifies which underlying resources the action extends to beyond
6514
+ # the Image Builder image resource itself: distributed AMIs, their
6515
+ # snapshots, or distributed container images. `DELETE` rules can
6516
+ # include all three, `DEPRECATE` and `DISABLE` rules can include AMIs
6517
+ # only, and you can only include snapshots together with AMIs.
6023
6518
  # @return [Types::LifecyclePolicyDetailActionIncludeResources]
6024
6519
  #
6025
6520
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LifecyclePolicyDetailAction AWS API Documentation
@@ -6093,18 +6588,19 @@ module Aws::Imagebuilder
6093
6588
  # @return [Array<String>]
6094
6589
  #
6095
6590
  # @!attribute [rw] shared_accounts
6096
- # Specifies Amazon Web Services accounts whose resources are excluded
6097
- # from the lifecycle action.
6591
+ # The lifecycle action doesn't apply to AMIs that are shared with any
6592
+ # of the specified Amazon Web Services accounts.
6098
6593
  # @return [Array<String>]
6099
6594
  #
6100
6595
  # @!attribute [rw] last_launched
6101
- # Specifies configuration details for Image Builder to exclude the
6102
- # most recent resources from lifecycle actions.
6596
+ # Configures Image Builder to exclude AMIs that were launched within
6597
+ # the specified time period from lifecycle actions. AMIs with no
6598
+ # recorded last-launched time aren't excluded by this rule.
6103
6599
  # @return [Types::LifecyclePolicyDetailExclusionRulesAmisLastLaunched]
6104
6600
  #
6105
6601
  # @!attribute [rw] tag_map
6106
- # Lists tags that should be excluded from lifecycle actions for the
6107
- # AMIs that have them.
6602
+ # Lifecycle actions don't apply to AMIs that have any of these tags.
6603
+ # Both the key and the value must match.
6108
6604
  # @return [Hash<String,String>]
6109
6605
  #
6110
6606
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LifecyclePolicyDetailExclusionRulesAmis AWS API Documentation
@@ -6129,8 +6625,7 @@ module Aws::Imagebuilder
6129
6625
  #
6130
6626
  # @!attribute [rw] unit
6131
6627
  # Defines the unit of time that the lifecycle policy uses to calculate
6132
- # elapsed time since the last instance launched from the AMI. For
6133
- # example: days, weeks, months, or years.
6628
+ # elapsed time since the last launch.
6134
6629
  # @return [String]
6135
6630
  #
6136
6631
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LifecyclePolicyDetailExclusionRulesAmisLastLaunched AWS API Documentation
@@ -6146,7 +6641,8 @@ module Aws::Imagebuilder
6146
6641
  # resource.
6147
6642
  #
6148
6643
  # @!attribute [rw] type
6149
- # Filter resources based on either `age` or `count`.
6644
+ # Filter resources based on either `AGE` or `COUNT`. You can only use
6645
+ # the count filter with the `DELETE` action type.
6150
6646
  # @return [String]
6151
6647
  #
6152
6648
  # @!attribute [rw] value
@@ -6184,7 +6680,8 @@ module Aws::Imagebuilder
6184
6680
  include Aws::Structure
6185
6681
  end
6186
6682
 
6187
- # Resource selection criteria for the lifecycle policy.
6683
+ # Resource selection criteria for the lifecycle policy. You must provide
6684
+ # exactly one selection criteria: either recipes or a tag map, not both.
6188
6685
  #
6189
6686
  # @!attribute [rw] recipes
6190
6687
  # A list of recipes that are used as selection criteria for the output
@@ -6230,8 +6727,7 @@ module Aws::Imagebuilder
6230
6727
  # Contains a summary of lifecycle policy resources.
6231
6728
  #
6232
6729
  # @!attribute [rw] arn
6233
- # The Amazon Resource Name (ARN) of the lifecycle policy summary
6234
- # resource.
6730
+ # The Amazon Resource Name (ARN) of the lifecycle policy.
6235
6731
  # @return [String]
6236
6732
  #
6237
6733
  # @!attribute [rw] name
@@ -6294,8 +6790,10 @@ module Aws::Imagebuilder
6294
6790
  end
6295
6791
 
6296
6792
  # @!attribute [rw] component_version_arn
6297
- # The component version Amazon Resource Name (ARN) whose versions you
6298
- # want to list.
6793
+ # The component version ARN whose build versions you want to list. The
6794
+ # ARN must specify an exact version, without a build number suffix. If
6795
+ # you don't specify an ARN, Image Builder returns build versions for
6796
+ # the components that your account owns.
6299
6797
  # @return [String]
6300
6798
  #
6301
6799
  # @!attribute [rw] max_results
@@ -6322,7 +6820,10 @@ module Aws::Imagebuilder
6322
6820
  # @return [String]
6323
6821
  #
6324
6822
  # @!attribute [rw] component_summary_list
6325
- # The list of component summaries for the specified semantic version.
6823
+ # The list of component summaries. Each summary represents one build
6824
+ # version of the specified component version, or of the components
6825
+ # that your account owns if you didn't specify an ARN. Deprecated
6826
+ # build versions aren't included.
6326
6827
  # @return [Array<Types::ComponentSummary>]
6327
6828
  #
6328
6829
  # @!attribute [rw] next_token
@@ -6346,8 +6847,9 @@ module Aws::Imagebuilder
6346
6847
  # Filters results based on the type of owner for the component. By
6347
6848
  # default, this request returns a list of components that your account
6348
6849
  # owns. To see results for other types of owners, you can specify
6349
- # components that Amazon manages, third party components, or
6350
- # components that other accounts have shared with you.
6850
+ # components that Amazon manages, components from the Amazon Web
6851
+ # Services Marketplace, third party components, or components that
6852
+ # other accounts have shared with you.
6351
6853
  # @return [String]
6352
6854
  #
6353
6855
  # @!attribute [rw] filters
@@ -6359,6 +6861,10 @@ module Aws::Imagebuilder
6359
6861
  #
6360
6862
  # * `platform`
6361
6863
  #
6864
+ # * `productCodes`
6865
+ #
6866
+ # * `status`
6867
+ #
6362
6868
  # * `supportedOsVersion`
6363
6869
  #
6364
6870
  # * `type`
@@ -6367,7 +6873,10 @@ module Aws::Imagebuilder
6367
6873
  # @return [Array<Types::Filter>]
6368
6874
  #
6369
6875
  # @!attribute [rw] by_name
6370
- # Returns the list of components for the specified name.
6876
+ # Specifies whether to return one entry per component name, with all
6877
+ # versions of each component aggregated. Defaults to `false`, which
6878
+ # returns one entry per component version. You can't combine this
6879
+ # option with the `version` filter.
6371
6880
  # @return [Boolean]
6372
6881
  #
6373
6882
  # @!attribute [rw] max_results
@@ -6425,7 +6934,8 @@ module Aws::Imagebuilder
6425
6934
  # @!attribute [rw] owner
6426
6935
  # Returns container recipes belonging to the specified owner, that
6427
6936
  # have been shared with you. You can omit this field to return
6428
- # container recipes belonging to your account.
6937
+ # container recipes belonging to your account. For container recipes,
6938
+ # the valid owner values are `Self`, `Shared`, and `Amazon`.
6429
6939
  # @return [String]
6430
6940
  #
6431
6941
  # @!attribute [rw] filters
@@ -6534,8 +7044,11 @@ module Aws::Imagebuilder
6534
7044
  end
6535
7045
 
6536
7046
  # @!attribute [rw] image_version_arn
6537
- # The Amazon Resource Name (ARN) of the image whose build versions you
6538
- # want to retrieve.
7047
+ # The Amazon Resource Name (ARN) of the image version whose build
7048
+ # versions you want to retrieve. The ARN must specify an exact version
7049
+ # (`<major>.<minor>.<patch>`) - wildcards aren't allowed. This
7050
+ # parameter is optional. If you don't specify it, Image Builder
7051
+ # returns build versions for all of the images in your account.
6539
7052
  # @return [String]
6540
7053
  #
6541
7054
  # @!attribute [rw] filters
@@ -6598,8 +7111,9 @@ module Aws::Imagebuilder
6598
7111
  end
6599
7112
 
6600
7113
  # @!attribute [rw] image_build_version_arn
6601
- # Filter results for the ListImagePackages request by the Image Build
6602
- # Version ARN
7114
+ # The Amazon Resource Name (ARN) of the image build version whose
7115
+ # packages you want to list. The value must be a full build version
7116
+ # ARN.
6603
7117
  # @return [String]
6604
7118
  #
6605
7119
  # @!attribute [rw] max_results
@@ -6830,10 +7344,17 @@ module Aws::Imagebuilder
6830
7344
  end
6831
7345
 
6832
7346
  # @!attribute [rw] filter
6833
- # A filter name and value pair that is used to return a more specific
6834
- # list of results from a list operation. Filters can be used to match
6835
- # a set of resources by specific criteria, such as tags, attributes,
6836
- # or IDs.
7347
+ # A filter name and value pair that determines the type of aggregation
7348
+ # that Image Builder returns. Use one of the following filter names:
7349
+ #
7350
+ # * `imageBuildVersionArn`
7351
+ #
7352
+ # * `imagePipelineArn`
7353
+ #
7354
+ # * `vulnerabilityId`
7355
+ #
7356
+ # If you don't specify a filter, Image Builder returns an aggregation
7357
+ # for your account.
6837
7358
  # @return [Types::Filter]
6838
7359
  #
6839
7360
  # @!attribute [rw] next_token
@@ -6902,13 +7423,16 @@ module Aws::Imagebuilder
6902
7423
  # An array of name value pairs that you can use to filter your
6903
7424
  # results. You can use the following filters to streamline results:
6904
7425
  #
6905
- # * `imageBuildVersionArn`
7426
+ # * `imageBuildVersionArn` – Filters findings by the image build
7427
+ # version that was scanned.
6906
7428
  #
6907
- # * `imagePipelineArn`
7429
+ # * `imagePipelineArn` – Filters findings by the pipeline that created
7430
+ # the scanned image.
6908
7431
  #
6909
- # * `vulnerabilityId`
7432
+ # * `vulnerabilityId` – Filters findings by vulnerability ID, for
7433
+ # example a CVE ID.
6910
7434
  #
6911
- # * `severity`
7435
+ # * `severity` – Filters findings by severity level.
6912
7436
  #
6913
7437
  # If you don't request a filter, then all findings in your account
6914
7438
  # are listed.
@@ -6980,7 +7504,10 @@ module Aws::Imagebuilder
6980
7504
  # @return [Array<Types::Filter>]
6981
7505
  #
6982
7506
  # @!attribute [rw] by_name
6983
- # Requests a list of images with a specific recipe name.
7507
+ # Specifies whether to return one entry per image name, with all
7508
+ # versions of each image aggregated. Defaults to `false`, which
7509
+ # returns one entry per image version. You can't combine this option
7510
+ # with the `version` filter.
6984
7511
  # @return [Boolean]
6985
7512
  #
6986
7513
  # @!attribute [rw] max_results
@@ -6993,7 +7520,9 @@ module Aws::Imagebuilder
6993
7520
  # @return [String]
6994
7521
  #
6995
7522
  # @!attribute [rw] include_deprecated
6996
- # Includes deprecated images in the response list.
7523
+ # Specifies whether to include deprecated Amazon-managed images in the
7524
+ # results. Deprecated images that you own are always returned.
7525
+ # Defaults to `false`.
6997
7526
  # @return [Boolean]
6998
7527
  #
6999
7528
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagesRequest AWS API Documentation
@@ -7099,14 +7628,14 @@ module Aws::Imagebuilder
7099
7628
  # @return [String]
7100
7629
  #
7101
7630
  # @!attribute [rw] parent_resource_id
7102
- # You can leave this empty to get a list of Image Builder resources
7103
- # that were identified for lifecycle actions.
7104
- #
7105
- # To get a list of associated resources that are impacted for an
7106
- # individual resource (the parent), specify its Amazon Resource Name
7107
- # (ARN). Associated resources are produced from your image and
7108
- # distributed when you run a build, such as AMIs or container images
7109
- # stored in ECR repositories.
7631
+ # The Amazon Resource Name (ARN) of an image build version to get the
7632
+ # output resources for, such as AMIs or container images in Amazon
7633
+ # ECR. You can get this value from the `resourceId` in the top-level
7634
+ # response. If you leave this property empty, the response lists the
7635
+ # Image Builder resources that the lifecycle execution identified for
7636
+ # lifecycle actions. If the image build version that you specify in
7637
+ # `parentResourceId` wasn't part of this lifecycle execution, the
7638
+ # response contains an empty list.
7110
7639
  # @return [String]
7111
7640
  #
7112
7641
  # @!attribute [rw] max_results
@@ -7130,7 +7659,7 @@ module Aws::Imagebuilder
7130
7659
  end
7131
7660
 
7132
7661
  # @!attribute [rw] lifecycle_execution_id
7133
- # Runtime details for the specified runtime instance of the lifecycle
7662
+ # The unique identifier for the runtime instance of the lifecycle
7134
7663
  # policy.
7135
7664
  # @return [String]
7136
7665
  #
@@ -7170,8 +7699,11 @@ module Aws::Imagebuilder
7170
7699
  # @return [String]
7171
7700
  #
7172
7701
  # @!attribute [rw] resource_arn
7173
- # The Amazon Resource Name (ARN) of the resource for which to get a
7174
- # list of lifecycle runtime instances.
7702
+ # The Amazon Resource Name (ARN) of the resource for which to list
7703
+ # lifecycle executions. Specify a lifecycle policy ARN to list its
7704
+ # executions, or an image build version ARN to list the executions
7705
+ # that StartResourceStateUpdate started for that image. Other ARN
7706
+ # types aren't valid for this request.
7175
7707
  # @return [String]
7176
7708
  #
7177
7709
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListLifecycleExecutionsRequest AWS API Documentation
@@ -7205,8 +7737,9 @@ module Aws::Imagebuilder
7205
7737
  end
7206
7738
 
7207
7739
  # @!attribute [rw] filters
7208
- # Streamline results based on one of the following values: `Name`,
7209
- # `Status`.
7740
+ # Use the following filters to streamline results: `name`,
7741
+ # `resourceType`, and `status`. Filter names are matched exactly as
7742
+ # shown.
7210
7743
  # @return [Array<Types::Filter>]
7211
7744
  #
7212
7745
  # @!attribute [rw] max_results
@@ -7294,7 +7827,9 @@ module Aws::Imagebuilder
7294
7827
 
7295
7828
  # @!attribute [rw] steps
7296
7829
  # An array of the workflow steps that are waiting for action in your
7297
- # Amazon Web Services account.
7830
+ # Amazon Web Services account. Each step is paused at a
7831
+ # `WaitForAction` step, and remains in the list until you respond with
7832
+ # SendWorkflowStepAction or the wait times out.
7298
7833
  # @return [Array<Types::WorkflowStepExecution>]
7299
7834
  #
7300
7835
  # @!attribute [rw] next_token
@@ -7315,7 +7850,10 @@ module Aws::Imagebuilder
7315
7850
 
7316
7851
  # @!attribute [rw] workflow_version_arn
7317
7852
  # The Amazon Resource Name (ARN) of the workflow resource for which to
7318
- # get a list of build versions.
7853
+ # get a list of build versions. The version segments can contain
7854
+ # wildcards (`x`) to match multiple versions of the workflow. If you
7855
+ # don't specify an ARN, the response lists build versions for all of
7856
+ # the workflows in your account.
7319
7857
  # @return [String]
7320
7858
  #
7321
7859
  # @!attribute [rw] max_results
@@ -7338,8 +7876,8 @@ module Aws::Imagebuilder
7338
7876
  end
7339
7877
 
7340
7878
  # @!attribute [rw] workflow_summary_list
7341
- # A list that contains metadata for the workflow builds that have run
7342
- # for the workflow resource specified in the request.
7879
+ # A list that contains metadata for the build versions of the workflow
7880
+ # resource specified in the request.
7343
7881
  # @return [Array<Types::WorkflowSummary>]
7344
7882
  #
7345
7883
  # @!attribute [rw] next_token
@@ -7387,8 +7925,10 @@ module Aws::Imagebuilder
7387
7925
  # @return [String]
7388
7926
  #
7389
7927
  # @!attribute [rw] workflow_executions
7390
- # Contains an array of runtime details that represents each time a
7391
- # workflow ran for the requested image build version.
7928
+ # An array of runtime details that represents each time a workflow ran
7929
+ # for the requested image build version. Image Builder retains
7930
+ # workflow execution records for a limited time, so this array can be
7931
+ # empty for older image build versions.
7392
7932
  # @return [Array<Types::WorkflowExecutionMetadata>]
7393
7933
  #
7394
7934
  # @!attribute [rw] image_build_version_arn
@@ -7397,7 +7937,10 @@ module Aws::Imagebuilder
7397
7937
  # @return [String]
7398
7938
  #
7399
7939
  # @!attribute [rw] message
7400
- # The output message from the list action, if applicable.
7940
+ # The failure reason for the image build version, if it's in a failed
7941
+ # state. This comes from the image itself, not from an individual
7942
+ # workflow, so it's available even when no workflow executions remain
7943
+ # for the image.
7401
7944
  # @return [String]
7402
7945
  #
7403
7946
  # @!attribute [rw] next_token
@@ -7494,16 +8037,23 @@ module Aws::Imagebuilder
7494
8037
  end
7495
8038
 
7496
8039
  # @!attribute [rw] owner
7497
- # Used to get a list of workflow build version filtered by the
7498
- # identity of the creator.
8040
+ # Filters results based on the workflow owner. By default, this
8041
+ # request returns the workflows that your account owns (`Self`).
8042
+ # Specify `Amazon` to list the workflows that Image Builder manages.
8043
+ # Image Builder rejects the `Shared` and `ThirdParty` owner values for
8044
+ # workflows, and `AWSMarketplace` returns no results.
7499
8045
  # @return [String]
7500
8046
  #
7501
8047
  # @!attribute [rw] filters
7502
- # Used to streamline search results.
8048
+ # Filters to narrow the list of workflows. You can filter on `name`,
8049
+ # `version`, `description`, and `type`.
7503
8050
  # @return [Array<Types::Filter>]
7504
8051
  #
7505
8052
  # @!attribute [rw] by_name
7506
- # Specify all or part of the workflow name to streamline results.
8053
+ # Specifies whether to return one entry per workflow name, with all
8054
+ # versions of each workflow aggregated. Defaults to `false`, which
8055
+ # returns one entry per workflow version. You can't combine this
8056
+ # option with the `version` filter.
7507
8057
  # @return [Boolean]
7508
8058
  #
7509
8059
  # @!attribute [rw] max_results
@@ -7528,7 +8078,7 @@ module Aws::Imagebuilder
7528
8078
  end
7529
8079
 
7530
8080
  # @!attribute [rw] workflow_version_list
7531
- # A list of workflow build versions that match the request criteria.
8081
+ # A list of workflow versions that match the request criteria.
7532
8082
  # @return [Array<Types::WorkflowVersion>]
7533
8083
  #
7534
8084
  # @!attribute [rw] next_token
@@ -7564,12 +8114,14 @@ module Aws::Imagebuilder
7564
8114
  # The resources produced by this image.
7565
8115
  #
7566
8116
  # @!attribute [rw] amis
7567
- # The Amazon EC2 AMIs created by this image.
8117
+ # The Amazon EC2 AMIs created by this image. The list contains one
8118
+ # entry per AMI, including copies that distribution created in each
8119
+ # target Amazon Web Services Region and account.
7568
8120
  # @return [Array<Types::Ami>]
7569
8121
  #
7570
8122
  # @!attribute [rw] containers
7571
- # Container images that the pipeline has generated and stored in the
7572
- # output repository.
8123
+ # The container images that Image Builder created when it built this
8124
+ # image, stored in the output Amazon ECR repository.
7573
8125
  # @return [Array<Types::Container>]
7574
8126
  #
7575
8127
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/OutputResources AWS API Documentation
@@ -7596,8 +8148,9 @@ module Aws::Imagebuilder
7596
8148
  # @return [String]
7597
8149
  #
7598
8150
  # @!attribute [rw] cvss
7599
- # CVSS scores for one or more vulnerabilities that Amazon Inspector
7600
- # identified for a package.
8151
+ # The CVSS scores for the vulnerability in this finding, as published
8152
+ # by the vulnerability sources. Sources include NVD and the operating
8153
+ # system vendor, and scores can span CVSS versions.
7601
8154
  # @return [Array<Types::CvssScore>]
7602
8155
  #
7603
8156
  # @!attribute [rw] related_vulnerabilities
@@ -7645,6 +8198,22 @@ module Aws::Imagebuilder
7645
8198
  include Aws::Structure
7646
8199
  end
7647
8200
 
8201
+ # Settings for building on an instance that is already running, instead
8202
+ # of an instance that Image Builder launches for the build.
8203
+ #
8204
+ # @!attribute [rw] auto_scaling_group
8205
+ # The Amazon EC2 Auto Scaling group that Image Builder takes the build
8206
+ # instance from. This is required when you specify `parentInstance`.
8207
+ # @return [Types::AutoScalingGroupConfiguration]
8208
+ #
8209
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ParentInstanceConfiguration AWS API Documentation
8210
+ #
8211
+ class ParentInstanceConfiguration < Struct.new(
8212
+ :auto_scaling_group)
8213
+ SENSITIVE = []
8214
+ include Aws::Structure
8215
+ end
8216
+
7648
8217
  # The logging configuration that's defined for pipeline execution.
7649
8218
  #
7650
8219
  # @!attribute [rw] image_log_group_name
@@ -7702,17 +8271,13 @@ module Aws::Imagebuilder
7702
8271
  #
7703
8272
  # @!attribute [rw] host_id
7704
8273
  # The ID of the Dedicated Host on which build and test instances run.
7705
- # This only applies if `tenancy` is `host`. If you specify the host
7706
- # ID, you must not specify the resource group ARN. If you specify
7707
- # both, Image Builder returns an error.
8274
+ # This only applies if `tenancy` is `host`.
7708
8275
  # @return [String]
7709
8276
  #
7710
8277
  # @!attribute [rw] host_resource_group_arn
7711
8278
  # The Amazon Resource Name (ARN) of the host resource group in which
7712
8279
  # to launch build and test instances. This only applies if `tenancy`
7713
- # is `host`. If you specify the resource group ARN, you must not
7714
- # specify the host ID. If you specify both, Image Builder returns an
7715
- # error.
8280
+ # is `host`.
7716
8281
  # @return [String]
7717
8282
  #
7718
8283
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Placement AWS API Documentation
@@ -7827,7 +8392,10 @@ module Aws::Imagebuilder
7827
8392
  # @return [String]
7828
8393
  #
7829
8394
  # @!attribute [rw] policy
7830
- # The policy to apply.
8395
+ # The resource policy to apply to the image, as a JSON policy
8396
+ # document. Image Builder validates the policy with Amazon Web
8397
+ # Services RAM before applying it, and rejects invalid policies with
8398
+ # `InvalidParameterValueException`.
7831
8399
  # @return [String]
7832
8400
  #
7833
8401
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PutImagePolicyRequest AWS API Documentation
@@ -8064,11 +8632,13 @@ module Aws::Imagebuilder
8064
8632
  include Aws::Structure
8065
8633
  end
8066
8634
 
8067
- # The current state of an impacted resource.
8635
+ # The state to apply to the image resource in a resource state update
8636
+ # request.
8068
8637
  #
8069
8638
  # @!attribute [rw] status
8070
- # Shows the current lifecycle policy action that was applied to an
8071
- # impacted resource.
8639
+ # The status to which you want to move the image resource. Set the
8640
+ # status to `AVAILABLE` to restore an image that's currently
8641
+ # deprecated or disabled.
8072
8642
  # @return [String]
8073
8643
  #
8074
8644
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ResourceState AWS API Documentation
@@ -8083,7 +8653,8 @@ module Aws::Imagebuilder
8083
8653
  # ad-hoc lifecycle actions.
8084
8654
  #
8085
8655
  # @!attribute [rw] amis
8086
- # Defines criteria for AMIs that are excluded from lifecycle actions.
8656
+ # Defines criteria for AMIs that Image Builder should exclude from the
8657
+ # resource state update.
8087
8658
  # @return [Types::LifecyclePolicyDetailExclusionRulesAmis]
8088
8659
  #
8089
8660
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ResourceStateUpdateExclusionRules AWS API Documentation
@@ -8094,12 +8665,14 @@ module Aws::Imagebuilder
8094
8665
  include Aws::Structure
8095
8666
  end
8096
8667
 
8097
- # Specifies if the lifecycle policy should apply actions to selected
8098
- # resources.
8668
+ # Specifies which underlying resources the resource state update applies
8669
+ # to, in addition to the Image Builder image resource itself:
8670
+ # distributed AMIs and their snapshots for AMI images, or distributed
8671
+ # container images for container images.
8099
8672
  #
8100
8673
  # @!attribute [rw] amis
8101
8674
  # Specifies whether the lifecycle action should apply to distributed
8102
- # AMIs
8675
+ # AMIs.
8103
8676
  # @return [Boolean]
8104
8677
  #
8105
8678
  # @!attribute [rw] snapshots
@@ -8123,15 +8696,17 @@ module Aws::Imagebuilder
8123
8696
  end
8124
8697
 
8125
8698
  # @!attribute [rw] image_build_version_arn
8126
- # The source image Amazon Resource Name (ARN) to retry.
8699
+ # The Amazon Resource Name (ARN) of the image build version that you
8700
+ # want to retry. The image must be in the `FAILED` or `CANCELLED`
8701
+ # state.
8127
8702
  # @return [String]
8128
8703
  #
8129
8704
  # @!attribute [rw] client_token
8130
8705
  # A unique, case-sensitive identifier you provide to ensure that the
8131
- # operation completes no more than one time. If this token matches a
8132
- # previous request, the service ignores the request, but does not
8133
- # return an error. For more information, see [Ensuring idempotency][1]
8134
- # in the *Amazon EC2 API Reference*.
8706
+ # operation runs no more than one time. If you retry a request with
8707
+ # the same client token, Image Builder returns the original response
8708
+ # without running the operation again. For more information, see
8709
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8135
8710
  #
8136
8711
  # **A suitable default value is auto-generated.** You should normally
8137
8712
  # not need to pass this option.
@@ -8167,8 +8742,9 @@ module Aws::Imagebuilder
8167
8742
  include Aws::Structure
8168
8743
  end
8169
8744
 
8170
- # Properties that configure export from your build instance to a
8171
- # compatible file format for your VM.
8745
+ # Properties that configure exporting the output image to a disk image
8746
+ # file in an Amazon S3 bucket, in a format that's compatible with your
8747
+ # VMs.
8172
8748
  #
8173
8749
  # @!attribute [rw] role_name
8174
8750
  # The name of the role that grants VM Import/Export permission to
@@ -8211,11 +8787,16 @@ module Aws::Imagebuilder
8211
8787
  # Amazon S3 logging configuration.
8212
8788
  #
8213
8789
  # @!attribute [rw] s3_bucket_name
8214
- # The S3 bucket in which to store the logs.
8790
+ # The name of an existing Amazon S3 bucket where Image Builder saves
8791
+ # build logs. The bucket isn't validated when you create or update
8792
+ # the configuration, and Image Builder doesn't create it. The
8793
+ # instance profile associated with this infrastructure configuration
8794
+ # must have permission to write to the bucket.
8215
8795
  # @return [String]
8216
8796
  #
8217
8797
  # @!attribute [rw] s3_key_prefix
8218
- # The Amazon S3 path to the bucket where the logs are stored.
8798
+ # The Amazon S3 key prefix under which Image Builder writes build and
8799
+ # test logs in the bucket.
8219
8800
  # @return [String]
8220
8801
  #
8221
8802
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/S3Logs AWS API Documentation
@@ -8231,8 +8812,9 @@ module Aws::Imagebuilder
8231
8812
  # create a new image.
8232
8813
  #
8233
8814
  # @!attribute [rw] schedule_expression
8234
- # The cron expression determines how often EC2 Image Builder evaluates
8235
- # your `pipelineExecutionStartCondition`.
8815
+ # The expression determines how often EC2 Image Builder evaluates your
8816
+ # `pipelineExecutionStartCondition`. You can specify a cron
8817
+ # expression, or a rate expression such as `rate(1 day)`.
8236
8818
  #
8237
8819
  # For information on how to format a cron expression in Image Builder,
8238
8820
  # see [Use cron expressions in EC2 Image Builder][1].
@@ -8243,9 +8825,9 @@ module Aws::Imagebuilder
8243
8825
  # @return [String]
8244
8826
  #
8245
8827
  # @!attribute [rw] timezone
8246
- # The timezone that applies to the scheduling expression. For example,
8247
- # "Etc/UTC", "America/Los\_Angeles" in the [IANA timezone
8248
- # format][1]. If not specified this defaults to UTC.
8828
+ # The timezone that applies to the scheduling expression. Specify a
8829
+ # value in [IANA timezone format][1], for example `Etc/UTC` or
8830
+ # `America/Los_Angeles`. If not specified, this defaults to UTC.
8249
8831
  #
8250
8832
  #
8251
8833
  #
@@ -8270,6 +8852,12 @@ module Aws::Imagebuilder
8270
8852
  # * `EXPRESSION_MATCH_ONLY` – This condition builds a new image every
8271
8853
  # time the CRON expression matches the current time.
8272
8854
  #
8855
+ # <note markdown="1"> If the recipe references its base image through an Amazon Web
8856
+ # Services Systems Manager Parameter Store parameter, a change in the
8857
+ # parameter's value also counts as an available dependency update.
8858
+ #
8859
+ # </note>
8860
+ #
8273
8861
  #
8274
8862
  #
8275
8863
  # [1]: https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html
@@ -8292,7 +8880,8 @@ module Aws::Imagebuilder
8292
8880
  end
8293
8881
 
8294
8882
  # @!attribute [rw] step_execution_id
8295
- # Uniquely identifies the workflow step that sent the step action.
8883
+ # Uniquely identifies the waiting workflow step that you send the
8884
+ # action to. To get this identifier, call ListWaitingWorkflowSteps.
8296
8885
  # @return [String]
8297
8886
  #
8298
8887
  # @!attribute [rw] image_build_version_arn
@@ -8304,9 +8893,12 @@ module Aws::Imagebuilder
8304
8893
  # @return [String]
8305
8894
  #
8306
8895
  # @!attribute [rw] action
8307
- # The action to perform on the paused workflow step. The workflow step
8308
- # must be in a waiting state to accept an action. The request fails if
8309
- # the step has already timed out or been actioned.
8896
+ # The action to perform on the paused workflow step. `RESUME`
8897
+ # completes the waiting step, and the workflow continues. `STOP` fails
8898
+ # the step, and the step's `onFailure` setting determines whether the
8899
+ # workflow continues or aborts. The workflow step must be in a waiting
8900
+ # state to accept an action. The request fails if the step has already
8901
+ # timed out or been actioned.
8310
8902
  # @return [String]
8311
8903
  #
8312
8904
  # @!attribute [rw] reason
@@ -8317,10 +8909,10 @@ module Aws::Imagebuilder
8317
8909
  #
8318
8910
  # @!attribute [rw] client_token
8319
8911
  # A unique, case-sensitive identifier you provide to ensure that the
8320
- # operation completes no more than one time. If this token matches a
8321
- # previous request, the service ignores the request, but does not
8322
- # return an error. For more information, see [Ensuring idempotency][1]
8323
- # in the *Amazon EC2 API Reference*.
8912
+ # operation runs no more than one time. If you retry a request with
8913
+ # the same client token, Image Builder returns the original response
8914
+ # without running the operation again. For more information, see
8915
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8324
8916
  #
8325
8917
  # **A suitable default value is auto-generated.** You should normally
8326
8918
  # not need to pass this option.
@@ -8343,7 +8935,8 @@ module Aws::Imagebuilder
8343
8935
  end
8344
8936
 
8345
8937
  # @!attribute [rw] step_execution_id
8346
- # The workflow step that sent the step action.
8938
+ # The unique identifier for the workflow step that received the
8939
+ # action, as specified in the request.
8347
8940
  # @return [String]
8348
8941
  #
8349
8942
  # @!attribute [rw] image_build_version_arn
@@ -8365,8 +8958,8 @@ module Aws::Imagebuilder
8365
8958
  include Aws::Structure
8366
8959
  end
8367
8960
 
8368
- # This exception is thrown when the service encounters an unrecoverable
8369
- # exception.
8961
+ # An internal server error occurred while Image Builder processed the
8962
+ # request. Retrying the request may succeed.
8370
8963
  #
8371
8964
  # @!attribute [rw] message
8372
8965
  # @return [String]
@@ -8480,10 +9073,10 @@ module Aws::Imagebuilder
8480
9073
  #
8481
9074
  # @!attribute [rw] client_token
8482
9075
  # A unique, case-sensitive identifier you provide to ensure that the
8483
- # operation completes no more than one time. If this token matches a
8484
- # previous request, the service ignores the request, but does not
8485
- # return an error. For more information, see [Ensuring idempotency][1]
8486
- # in the *Amazon EC2 API Reference*.
9076
+ # operation runs no more than one time. If you retry a request with
9077
+ # the same client token, Image Builder returns the original response
9078
+ # without running the operation again. For more information, see
9079
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8487
9080
  #
8488
9081
  # **A suitable default value is auto-generated.** You should normally
8489
9082
  # not need to pass this option.
@@ -8546,38 +9139,45 @@ module Aws::Imagebuilder
8546
9139
  # @return [Types::ResourceState]
8547
9140
  #
8548
9141
  # @!attribute [rw] execution_role
8549
- # The name or Amazon Resource Name (ARN) of the IAM role that’s used
8550
- # to update image state.
9142
+ # The name or Amazon Resource Name (ARN) of the IAM role that's used
9143
+ # to update image state. You must provide this property together with
9144
+ # `includeResources`. Neither is valid without the other.
8551
9145
  # @return [String]
8552
9146
  #
8553
9147
  # @!attribute [rw] include_resources
8554
- # Specifies which image resources to include in the state update. When
8555
- # specified, the lifecycle action applies to underlying resources.
8556
- # These resources include AMIs, snapshots, and containers in addition
8557
- # to the Image Builder image resource. Requires `executionRole` to
8558
- # also be specified. To delete an image and its underlying resources,
8559
- # you must specify `includeResources`. To delete only the Image
8560
- # Builder image record without affecting underlying resources, use the
8561
- # `DeleteImage` API instead.
9148
+ # Specifies which underlying resources to update, in addition to the
9149
+ # Image Builder image resource itself. Snapshots and containers are
9150
+ # only valid for the `DELETED` state. To set an image to `DELETED`,
9151
+ # you must include its underlying resources. To delete only the Image
9152
+ # Builder image record, use the DeleteImage operation instead.
8562
9153
  # @return [Types::ResourceStateUpdateIncludeResources]
8563
9154
  #
8564
9155
  # @!attribute [rw] exclusion_rules
8565
- # Skip action on the image resource and associated resources if
8566
- # specified exclusion rules are met.
9156
+ # Rules that Image Builder evaluates against each of the image's
9157
+ # AMIs. Matching AMIs and their snapshots are skipped. Exclusion rules
9158
+ # only take effect when the request includes AMIs. If the target state
9159
+ # is `DELETED` and any resource was skipped, the Image Builder image
9160
+ # resource itself is also retained. For the `DEPRECATED` and
9161
+ # `DISABLED` target states, Image Builder updates the image
9162
+ # resource's state regardless of exclusions.
8567
9163
  # @return [Types::ResourceStateUpdateExclusionRules]
8568
9164
  #
8569
9165
  # @!attribute [rw] update_at
8570
- # Specifies the timestamp when the state transition takes effect. Use
8571
- # this parameter only when the target status is `DEPRECATED`. The
8572
- # value must be a future time.
9166
+ # The timestamp that indicates when resources are updated by a
9167
+ # lifecycle action. This property is valid only when the target status
9168
+ # is `DEPRECATED`, and the value must be a future time. If you don't
9169
+ # specify a value, Image Builder begins the state update right away.
9170
+ # For a scheduled deprecation, included AMIs get their EC2 deprecation
9171
+ # time set immediately, and Image Builder schedules the image resource
9172
+ # to transition to `DEPRECATED` at that time.
8573
9173
  # @return [Time]
8574
9174
  #
8575
9175
  # @!attribute [rw] client_token
8576
9176
  # A unique, case-sensitive identifier you provide to ensure that the
8577
- # operation completes no more than one time. If this token matches a
8578
- # previous request, the service ignores the request, but does not
8579
- # return an error. For more information, see [Ensuring idempotency][1]
8580
- # in the *Amazon EC2 API Reference*.
9177
+ # operation runs no more than one time. If you retry a request with
9178
+ # the same client token, Image Builder returns the original response
9179
+ # without running the operation again. For more information, see
9180
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8581
9181
  #
8582
9182
  # **A suitable default value is auto-generated.** You should normally
8583
9183
  # not need to pass this option.
@@ -8602,8 +9202,10 @@ module Aws::Imagebuilder
8602
9202
  end
8603
9203
 
8604
9204
  # @!attribute [rw] lifecycle_execution_id
8605
- # Identifies the lifecycle runtime instance that started the resource
8606
- # state update.
9205
+ # Identifies the lifecycle execution that performs the resource state
9206
+ # update. Image Builder only returns this field when it started a
9207
+ # lifecycle execution for the update. Use it with
9208
+ # GetLifecycleExecution to track progress.
8607
9209
  # @return [String]
8608
9210
  #
8609
9211
  # @!attribute [rw] resource_arn
@@ -8621,17 +9223,18 @@ module Aws::Imagebuilder
8621
9223
  end
8622
9224
 
8623
9225
  # Contains settings for the Systems Manager agent on your build
8624
- # instance.
9226
+ # instance. This setting applies to Linux and macOS build instances
9227
+ # only. Requests that set it for a recipe with a Windows base image are
9228
+ # rejected.
8625
9229
  #
8626
9230
  # @!attribute [rw] uninstall_after_build
8627
- # Controls whether the Systems Manager agent is removed from your
8628
- # final build image, prior to creating the new AMI. If this is set to
8629
- # true, then the agent is removed from the final image. If it's set
8630
- # to false, then the agent is left in, so that it is included in the
8631
- # new AMI. default value is false.
8632
- #
8633
- # The default behavior of uninstallAfterBuild is to remove the SSM
8634
- # Agent if it was installed by EC2 Image Builder
9231
+ # Specifies whether the Systems Manager agent is removed from your
9232
+ # final build image before Image Builder creates the new AMI. If
9233
+ # `true`, the agent is removed. If `false`, the agent is kept, so that
9234
+ # it's included in the AMI. If you don't set this property, Image
9235
+ # Builder removes the agent only if Image Builder installed the agent
9236
+ # during the build. An agent that was pre-installed on the base image
9237
+ # is kept.
8635
9238
  # @return [Boolean]
8636
9239
  #
8637
9240
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SystemsManagerAgent AWS API Documentation
@@ -8671,8 +9274,8 @@ module Aws::Imagebuilder
8671
9274
  #
8672
9275
  # @!attribute [rw] repository_name
8673
9276
  # The name of the container repository where the output container
8674
- # image is stored. This name is prefixed by the repository location.
8675
- # For example, `<repository location url>/repository_name`.
9277
+ # image is stored. Provide the repository name only (a namespace path
9278
+ # such as `team-a/my-repo` is allowed, but not the registry hostname).
8676
9279
  # @return [String]
8677
9280
  #
8678
9281
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/TargetContainerRepository AWS API Documentation
@@ -8729,15 +9332,18 @@ module Aws::Imagebuilder
8729
9332
  # @return [String]
8730
9333
  #
8731
9334
  # @!attribute [rw] distributions
8732
- # The distributions of the distribution configuration.
9335
+ # The distribution settings for the configuration. Each entry defines
9336
+ # how output images are distributed in one target Amazon Web Services
9337
+ # Region. A Region can appear at most once in the list. This list
9338
+ # replaces the configuration's existing distributions entirely.
8733
9339
  # @return [Array<Types::Distribution>]
8734
9340
  #
8735
9341
  # @!attribute [rw] client_token
8736
9342
  # A unique, case-sensitive identifier you provide to ensure that the
8737
- # operation completes no more than one time. If this token matches a
8738
- # previous request, the service ignores the request, but does not
8739
- # return an error. For more information, see [Ensuring idempotency][1]
8740
- # in the *Amazon EC2 API Reference*.
9343
+ # operation runs no more than one time. If you retry a request with
9344
+ # the same client token, Image Builder returns the original response
9345
+ # without running the operation again. For more information, see
9346
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8741
9347
  #
8742
9348
  # **A suitable default value is auto-generated.** You should normally
8743
9349
  # not need to pass this option.
@@ -8792,27 +9398,33 @@ module Aws::Imagebuilder
8792
9398
  #
8793
9399
  # @!attribute [rw] image_recipe_arn
8794
9400
  # The Amazon Resource Name (ARN) of the image recipe that configures
8795
- # images updated by this image pipeline.
9401
+ # images created by this image pipeline. You must specify either this
9402
+ # property or `containerRecipeArn`, but not both.
8796
9403
  # @return [String]
8797
9404
  #
8798
9405
  # @!attribute [rw] container_recipe_arn
8799
- # The Amazon Resource Name (ARN) of the container pipeline to update.
9406
+ # The Amazon Resource Name (ARN) of the container recipe that is used
9407
+ # to configure images created by this container pipeline. You must
9408
+ # specify either this property or `imageRecipeArn`, but not both.
8800
9409
  # @return [String]
8801
9410
  #
8802
9411
  # @!attribute [rw] infrastructure_configuration_arn
8803
9412
  # The Amazon Resource Name (ARN) of the infrastructure configuration
8804
- # that Image Builder uses to build images that this image pipeline has
8805
- # updated.
9413
+ # that Image Builder uses to build images created by this image
9414
+ # pipeline.
8806
9415
  # @return [String]
8807
9416
  #
8808
9417
  # @!attribute [rw] distribution_configuration_arn
8809
9418
  # The Amazon Resource Name (ARN) of the distribution configuration
8810
- # that Image Builder uses to configure and distribute images that this
8811
- # image pipeline has updated.
9419
+ # that Image Builder uses to configure and distribute images created
9420
+ # by this image pipeline.
8812
9421
  # @return [String]
8813
9422
  #
8814
9423
  # @!attribute [rw] image_tests_configuration
8815
- # The image test configuration of the image pipeline.
9424
+ # Specifies the test settings that Image Builder applies to images
9425
+ # that this pipeline creates. If you don't provide test settings,
9426
+ # Image Builder stores a default configuration with image tests
9427
+ # enabled.
8816
9428
  # @return [Types::ImageTestsConfiguration]
8817
9429
  #
8818
9430
  # @!attribute [rw] enhanced_image_metadata_enabled
@@ -8822,19 +9434,24 @@ module Aws::Imagebuilder
8822
9434
  # @return [Boolean]
8823
9435
  #
8824
9436
  # @!attribute [rw] schedule
8825
- # The schedule of the image pipeline.
9437
+ # The schedule of the image pipeline. Because the update replaces the
9438
+ # entire configuration, omitting this property removes any existing
9439
+ # schedule. The pipeline then runs only when you call
9440
+ # StartImagePipelineExecution.
8826
9441
  # @return [Types::Schedule]
8827
9442
  #
8828
9443
  # @!attribute [rw] status
8829
- # The status of the image pipeline.
9444
+ # The status of the image pipeline. Defaults to `ENABLED` when
9445
+ # omitted. To keep a pipeline disabled, include this property set to
9446
+ # `DISABLED` in your update request.
8830
9447
  # @return [String]
8831
9448
  #
8832
9449
  # @!attribute [rw] client_token
8833
9450
  # A unique, case-sensitive identifier you provide to ensure that the
8834
- # operation completes no more than one time. If this token matches a
8835
- # previous request, the service ignores the request, but does not
8836
- # return an error. For more information, see [Ensuring idempotency][1]
8837
- # in the *Amazon EC2 API Reference*.
9451
+ # operation runs no more than one time. If you retry a request with
9452
+ # the same client token, Image Builder returns the original response
9453
+ # without running the operation again. For more information, see
9454
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
8838
9455
  #
8839
9456
  # **A suitable default value is auto-generated.** You should normally
8840
9457
  # not need to pass this option.
@@ -8845,25 +9462,37 @@ module Aws::Imagebuilder
8845
9462
  # @return [String]
8846
9463
  #
8847
9464
  # @!attribute [rw] image_scanning_configuration
8848
- # Contains settings for vulnerability scans.
9465
+ # Contains settings for vulnerability scans that Amazon Inspector runs
9466
+ # against the test instance during image creation.
8849
9467
  # @return [Types::ImageScanningConfiguration]
8850
9468
  #
8851
9469
  # @!attribute [rw] workflows
8852
- # Contains the workflows to run for the pipeline.
9470
+ # The array of workflow configuration objects for builds that this
9471
+ # pipeline starts. You must also specify `executionRole` when you
9472
+ # provide workflows.
8853
9473
  # @return [Array<Types::WorkflowConfiguration>]
8854
9474
  #
8855
9475
  # @!attribute [rw] logging_configuration
8856
- # Update logging configuration for the output image that's created
8857
- # when the pipeline runs.
9476
+ # Specifies the logging configuration for the image pipeline. Use this
9477
+ # to define custom CloudWatch Logs log groups for your pipeline
9478
+ # execution logs and image build logs. The service manages log groups
9479
+ # with names starting with `/aws/imagebuilder/` using the
9480
+ # service-linked role. For custom log group names outside of this
9481
+ # prefix, you must also provide an `executionRole`.
8858
9482
  # @return [Types::PipelineLoggingConfiguration]
8859
9483
  #
8860
9484
  # @!attribute [rw] execution_role
8861
9485
  # The name or Amazon Resource Name (ARN) for the IAM role you create
8862
- # that grants Image Builder access to perform workflow actions.
9486
+ # that grants Image Builder access to perform workflow actions. If you
9487
+ # omit this property, the pipeline reverts to the Image Builder
9488
+ # service-linked role.
8863
9489
  # @return [String]
8864
9490
  #
8865
9491
  # @!attribute [rw] image_tags
8866
- # The tags to be applied to the images produced by this pipeline.
9492
+ # The tags that Image Builder applies to the Image Builder image
9493
+ # resource that this pipeline's scheduled executions create. These
9494
+ # tags don't apply to the output AMI. To tag output AMIs, use
9495
+ # `amiTags` in the pipeline's distribution configuration.
8867
9496
  # @return [Hash<String,String>]
8868
9497
  #
8869
9498
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateImagePipelineRequest AWS API Documentation
@@ -8924,12 +9553,16 @@ module Aws::Imagebuilder
8924
9553
  # @!attribute [rw] instance_types
8925
9554
  # The instance types of the infrastructure configuration. You can
8926
9555
  # specify one or more instance types to use for this build. Image
8927
- # Builder picks one of these instance types based on availability.
9556
+ # Builder picks one of these instance types based on availability. If
9557
+ # you don't specify instance types, Image Builder selects compatible
9558
+ # instance types automatically. If you specify a Dedicated Host, Image
9559
+ # Builder uses only instance types that the host supports.
8928
9560
  # @return [Array<String>]
8929
9561
  #
8930
9562
  # @!attribute [rw] instance_profile_name
8931
9563
  # The instance profile to associate with the instance used to
8932
- # customize your Amazon EC2 AMI.
9564
+ # customize your Amazon EC2 AMI. The instance profile must exist in
9565
+ # your account.
8933
9566
  # @return [String]
8934
9567
  #
8935
9568
  # @!attribute [rw] security_group_ids
@@ -8938,12 +9571,16 @@ module Aws::Imagebuilder
8938
9571
  # @return [Array<String>]
8939
9572
  #
8940
9573
  # @!attribute [rw] subnet_id
8941
- # The subnet ID to place the instance used to customize your Amazon
8942
- # EC2 AMI in.
9574
+ # The subnet ID in which to place the instance used to customize your
9575
+ # Amazon EC2 AMI. If you specify `subnetId`, you must also specify one
9576
+ # or more security group IDs in `securityGroupIds`. Otherwise, the
9577
+ # request fails.
8943
9578
  # @return [String]
8944
9579
  #
8945
9580
  # @!attribute [rw] logging
8946
- # The logging configuration of the infrastructure configuration.
9581
+ # The logging configuration of the infrastructure configuration. When
9582
+ # you configure S3 logs, Image Builder writes logs from the build and
9583
+ # test process to the specified bucket under the key prefix.
8947
9584
  # @return [Types::Logging]
8948
9585
  #
8949
9586
  # @!attribute [rw] key_pair
@@ -8958,27 +9595,41 @@ module Aws::Imagebuilder
8958
9595
  # to `true`.
8959
9596
  # @return [Boolean]
8960
9597
  #
9598
+ # @!attribute [rw] terminate_instance_on_completion
9599
+ # Specifies whether Image Builder terminates build and test instances
9600
+ # when image creation ends without a failure (success, cancellation,
9601
+ # or expiration). Defaults to `true`.
9602
+ # @return [Boolean]
9603
+ #
8961
9604
  # @!attribute [rw] sns_topic_arn
8962
9605
  # The Amazon Resource Name (ARN) of the SNS topic to which Image
8963
- # Builder sends image build event notifications.
9606
+ # Builder sends image build event notifications. Specify a standard
9607
+ # topic. Image Builder doesn't support FIFO topics. Image Builder
9608
+ # validates the topic when you create or update the configuration. You
9609
+ # must have permission to publish to the topic.
8964
9610
  #
8965
- # <note markdown="1"> EC2 Image Builder is unable to send notifications to SNS topics that
8966
- # are encrypted using keys from other accounts. The key that is used
8967
- # to encrypt the SNS topic must reside in the account that the Image
8968
- # Builder service runs under.
9611
+ # <note markdown="1"> EC2 Image Builder can't send notifications to SNS topics that are
9612
+ # encrypted using keys from other accounts. If your SNS topic is
9613
+ # encrypted, the key must be owned by the same account that owns your
9614
+ # Image Builder resources.
8969
9615
  #
8970
9616
  # </note>
8971
9617
  # @return [String]
8972
9618
  #
8973
9619
  # @!attribute [rw] resource_tags
8974
- # The tags attached to the resource created by Image Builder.
9620
+ # The metadata tags to assign to the Amazon EC2 instance that Image
9621
+ # Builder launches during the build process. Tags are formatted as key
9622
+ # value pairs. Tag keys can't begin with `aws:` or match one of the
9623
+ # following reserved keys: `CreatedBy`, `Ec2ImageBuilderArn`, `Name`,
9624
+ # or `Tags`.
8975
9625
  # @return [Hash<String,String>]
8976
9626
  #
8977
9627
  # @!attribute [rw] instance_metadata_options
8978
- # The instance metadata options that you can set for the HTTP requests
8979
- # that pipeline builds use to launch EC2 build and test instances. For
8980
- # more information about instance metadata options, see one of the
8981
- # following links:
9628
+ # The instance metadata service (IMDS) settings that Image Builder
9629
+ # applies to the EC2 build and test instances it launches during image
9630
+ # creation. If you don't set these options, the EC2 launch defaults
9631
+ # for the instance apply. For more information about instance metadata
9632
+ # options, see one of the following links:
8982
9633
  #
8983
9634
  # * [Configure the instance metadata options][1] in the <i> <i>Amazon
8984
9635
  # EC2 User Guide</i> </i> for Linux instances.
@@ -8993,16 +9644,34 @@ module Aws::Imagebuilder
8993
9644
  # @return [Types::InstanceMetadataOptions]
8994
9645
  #
8995
9646
  # @!attribute [rw] placement
8996
- # The instance placement settings that define where the instances that
8997
- # are launched from your image run.
9647
+ # The instance placement settings that define where the build and test
9648
+ # instances that Image Builder launches during image creation run.
9649
+ # These settings don't affect instances that you launch from the
9650
+ # output image.
8998
9651
  # @return [Types::Placement]
8999
9652
  #
9653
+ # @!attribute [rw] parent_instance
9654
+ # The Amazon EC2 Auto Scaling group that Image Builder takes the build
9655
+ # instance from, instead of launching a new instance. This applies
9656
+ # only to the build phase.
9657
+ #
9658
+ # To use this feature, the execution role for the build must have
9659
+ # permissions to describe the Auto Scaling group, tag the instance
9660
+ # while it's still in the group, and detach it from the group. For
9661
+ # more information, see [Build on an instance from an Auto Scaling
9662
+ # group][1] in the *EC2 Image Builder User Guide*.
9663
+ #
9664
+ #
9665
+ #
9666
+ # [1]: https://docs.aws.amazon.com/imagebuilder/latest/userguide/infra-config-parent-instance.html
9667
+ # @return [Types::ParentInstanceConfiguration]
9668
+ #
9000
9669
  # @!attribute [rw] client_token
9001
9670
  # A unique, case-sensitive identifier you provide to ensure that the
9002
- # operation completes no more than one time. If this token matches a
9003
- # previous request, the service ignores the request, but does not
9004
- # return an error. For more information, see [Ensuring idempotency][1]
9005
- # in the *Amazon EC2 API Reference*.
9671
+ # operation runs no more than one time. If you retry a request with
9672
+ # the same client token, Image Builder returns the original response
9673
+ # without running the operation again. For more information, see
9674
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
9006
9675
  #
9007
9676
  # **A suitable default value is auto-generated.** You should normally
9008
9677
  # not need to pass this option.
@@ -9024,10 +9693,12 @@ module Aws::Imagebuilder
9024
9693
  :logging,
9025
9694
  :key_pair,
9026
9695
  :terminate_instance_on_failure,
9696
+ :terminate_instance_on_completion,
9027
9697
  :sns_topic_arn,
9028
9698
  :resource_tags,
9029
9699
  :instance_metadata_options,
9030
9700
  :placement,
9701
+ :parent_instance,
9031
9702
  :client_token)
9032
9703
  SENSITIVE = []
9033
9704
  include Aws::Structure
@@ -9061,20 +9732,26 @@ module Aws::Imagebuilder
9061
9732
  # @return [String]
9062
9733
  #
9063
9734
  # @!attribute [rw] description
9064
- # Optional description for the lifecycle policy.
9735
+ # Optional description for the lifecycle policy. Because the update
9736
+ # replaces the entire configuration, omitting this property removes
9737
+ # any existing description.
9065
9738
  # @return [String]
9066
9739
  #
9067
9740
  # @!attribute [rw] status
9068
- # Indicates whether the lifecycle policy resource is enabled.
9741
+ # Indicates whether the lifecycle policy resource is enabled. Defaults
9742
+ # to `ENABLED` when omitted, so updating a disabled policy without
9743
+ # setting this property re-enables it.
9069
9744
  # @return [String]
9070
9745
  #
9071
9746
  # @!attribute [rw] execution_role
9072
- # The name or Amazon Resource Name (ARN) of the IAM role that Image
9073
- # Builder uses to update the lifecycle policy.
9747
+ # The name or Amazon Resource Name (ARN) for the IAM role you create
9748
+ # that grants Image Builder access to run lifecycle actions.
9074
9749
  # @return [String]
9075
9750
  #
9076
9751
  # @!attribute [rw] resource_type
9077
- # The type of image resource that the lifecycle policy applies to.
9752
+ # The type of image resource that the lifecycle policy applies to. The
9753
+ # value must match the policy's existing resource type. You can't
9754
+ # change the resource type of an existing lifecycle policy.
9078
9755
  # @return [String]
9079
9756
  #
9080
9757
  # @!attribute [rw] policy_details
@@ -9083,15 +9760,16 @@ module Aws::Imagebuilder
9083
9760
  #
9084
9761
  # @!attribute [rw] resource_selection
9085
9762
  # Selection criteria for resources that the lifecycle policy applies
9086
- # to.
9763
+ # to. You must specify exactly one selection criteria: either recipes
9764
+ # or a tag map, not both.
9087
9765
  # @return [Types::LifecyclePolicyResourceSelection]
9088
9766
  #
9089
9767
  # @!attribute [rw] client_token
9090
9768
  # A unique, case-sensitive identifier you provide to ensure that the
9091
- # operation completes no more than one time. If this token matches a
9092
- # previous request, the service ignores the request, but does not
9093
- # return an error. For more information, see [Ensuring idempotency][1]
9094
- # in the *Amazon EC2 API Reference*.
9769
+ # operation runs no more than one time. If you retry a request with
9770
+ # the same client token, Image Builder returns the original response
9771
+ # without running the operation again. For more information, see
9772
+ # [Ensuring idempotency][1] in the *Amazon EC2 API Reference*.
9095
9773
  #
9096
9774
  # **A suitable default value is auto-generated.** You should normally
9097
9775
  # not need to pass this option.
@@ -9230,8 +9908,8 @@ module Aws::Imagebuilder
9230
9908
  include Aws::Structure
9231
9909
  end
9232
9910
 
9233
- # Defines a process that Image Builder uses to build and test images
9234
- # during the image creation process.
9911
+ # Defines a process that Image Builder runs during the build, test, or
9912
+ # distribution stage of the image creation process.
9235
9913
  #
9236
9914
  # @!attribute [rw] arn
9237
9915
  # The Amazon Resource Name (ARN) of the workflow resource.
@@ -9257,8 +9935,7 @@ module Aws::Imagebuilder
9257
9935
  # @return [String]
9258
9936
  #
9259
9937
  # @!attribute [rw] type
9260
- # Specifies the image creation stage that the workflow applies to.
9261
- # Image Builder currently supports build and test workflows.
9938
+ # The image creation stage that the workflow applies to.
9262
9939
  # @return [String]
9263
9940
  #
9264
9941
  # @!attribute [rw] state
@@ -9290,12 +9967,12 @@ module Aws::Imagebuilder
9290
9967
  # @return [String]
9291
9968
  #
9292
9969
  # @!attribute [rw] tags
9293
- # The tags that apply to the workflow resource
9970
+ # The tags that apply to the workflow resource.
9294
9971
  # @return [Hash<String,String>]
9295
9972
  #
9296
9973
  # @!attribute [rw] parameters
9297
- # An array of input parameters that that the image workflow uses to
9298
- # control actions or configure settings.
9974
+ # An array of input parameters that the image workflow uses to control
9975
+ # actions or configure settings.
9299
9976
  # @return [Array<Types::WorkflowParameterDetail>]
9300
9977
  #
9301
9978
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Workflow AWS API Documentation
@@ -9341,7 +10018,10 @@ module Aws::Imagebuilder
9341
10018
  # @return [String]
9342
10019
  #
9343
10020
  # @!attribute [rw] on_failure
9344
- # The action to take if the workflow fails.
10021
+ # The action to take if the workflow fails. With `CONTINUE`, a failed
10022
+ # workflow is logged and image creation proceeds to the next workflow.
10023
+ # If you don't set a value, the image build fails when the workflow
10024
+ # fails. You can only set this property for test workflows.
9345
10025
  # @return [String]
9346
10026
  #
9347
10027
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowConfiguration AWS API Documentation
@@ -9382,9 +10062,11 @@ module Aws::Imagebuilder
9382
10062
  # @return [String]
9383
10063
  #
9384
10064
  # @!attribute [rw] total_step_count
9385
- # The total number of steps in the workflow. This should equal the sum
9386
- # of the step counts for steps that succeeded, were skipped, and
9387
- # failed.
10065
+ # The total number of steps that the workflow document defines for
10066
+ # this runtime instance of the workflow. Image Builder sets this count
10067
+ # before any steps run. The sum of succeeded, skipped, and failed
10068
+ # steps only reaches this total if every step finishes in one of those
10069
+ # states.
9388
10070
  # @return [Integer]
9389
10071
  #
9390
10072
  # @!attribute [rw] total_steps_succeeded
@@ -9415,7 +10097,10 @@ module Aws::Imagebuilder
9415
10097
  # @return [String]
9416
10098
  #
9417
10099
  # @!attribute [rw] retried
9418
- # Indicates retry status for this runtime instance of the workflow.
10100
+ # Indicates whether a retry of the image build superseded this runtime
10101
+ # instance of the workflow. When you retry a failed image build, Image
10102
+ # Builder sets this flag to `true` on the original workflow executions
10103
+ # that the retry re-ran.
9419
10104
  # @return [Boolean]
9420
10105
  #
9421
10106
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/WorkflowExecutionMetadata AWS API Documentation
@@ -9465,8 +10150,8 @@ module Aws::Imagebuilder
9465
10150
  # @return [String]
9466
10151
  #
9467
10152
  # @!attribute [rw] type
9468
- # The type of input this parameter provides. The currently supported
9469
- # value is "string".
10153
+ # The type of input this parameter provides. Supported values are
10154
+ # `string`, `integer`, `boolean`, and `stringList`.
9470
10155
  # @return [String]
9471
10156
  #
9472
10157
  # @!attribute [rw] default_value
@@ -9488,7 +10173,7 @@ module Aws::Imagebuilder
9488
10173
  include Aws::Structure
9489
10174
  end
9490
10175
 
9491
- # A group of fields that describe the current status of workflow.
10176
+ # A group of fields that describe the current status of the workflow.
9492
10177
  #
9493
10178
  # @!attribute [rw] status
9494
10179
  # The current state of the workflow.
@@ -9507,8 +10192,8 @@ module Aws::Imagebuilder
9507
10192
  include Aws::Structure
9508
10193
  end
9509
10194
 
9510
- # Contains runtime details for an instance of a workflow that ran for
9511
- # the associated image build version.
10195
+ # Contains runtime details for a workflow step that has paused at a
10196
+ # `WaitForAction` step, and is waiting for you to send an action.
9512
10197
  #
9513
10198
  # @!attribute [rw] step_execution_id
9514
10199
  # Uniquely identifies the workflow step that ran for the associated
@@ -9587,12 +10272,15 @@ module Aws::Imagebuilder
9587
10272
  # @return [String]
9588
10273
  #
9589
10274
  # @!attribute [rw] inputs
9590
- # Input parameters that Image Builder provides for the workflow step.
10275
+ # Input parameters that Image Builder provides for the workflow step,
10276
+ # as a JSON-encoded string.
9591
10277
  # @return [String]
9592
10278
  #
9593
10279
  # @!attribute [rw] outputs
9594
- # The file names that the workflow step created as output for this
9595
- # runtime instance of the workflow.
10280
+ # The output values that the workflow step produced for this runtime
10281
+ # instance of the workflow, as a JSON-encoded string. For example, a
10282
+ # step that launches an instance outputs the instance ID. If the step
10283
+ # failed, this field contains the error message.
9596
10284
  # @return [String]
9597
10285
  #
9598
10286
  # @!attribute [rw] start_time
@@ -9658,8 +10346,7 @@ module Aws::Imagebuilder
9658
10346
  # @return [String]
9659
10347
  #
9660
10348
  # @!attribute [rw] type
9661
- # The image creation stage that this workflow applies to. Image
9662
- # Builder currently supports build and test stage workflows.
10349
+ # The image creation stage that this workflow applies to.
9663
10350
  # @return [String]
9664
10351
  #
9665
10352
  # @!attribute [rw] owner
@@ -9715,8 +10402,7 @@ module Aws::Imagebuilder
9715
10402
  # @return [String]
9716
10403
  #
9717
10404
  # @!attribute [rw] type
9718
- # The image creation stage that this workflow applies to. Image
9719
- # Builder currently supports build and test stage workflows.
10405
+ # The image creation stage that this workflow applies to.
9720
10406
  # @return [String]
9721
10407
  #
9722
10408
  # @!attribute [rw] owner