aws-sdk-imagebuilder 1.26.0 → 1.30.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -12,9 +12,10 @@ module Aws::Imagebuilder
12
12
 
13
13
  # In addition to your infrastruction configuration, these settings
14
14
  # provide an extra layer of control over your build instances. For
15
- # instances where Image Builder installs the SSM agent, you can choose
16
- # whether to keep it for the AMI that you create. You can also specify
17
- # commands to run on launch for all of your build instances.
15
+ # instances where Image Builder installs the Systems Manager agent, you
16
+ # can choose whether to keep it for the AMI that you create. You can
17
+ # also specify commands to run on launch for all of your build
18
+ # instances.
18
19
  #
19
20
  # @note When making an API call, you may pass AdditionalInstanceConfiguration
20
21
  # data as a hash:
@@ -27,7 +28,8 @@ module Aws::Imagebuilder
27
28
  # }
28
29
  #
29
30
  # @!attribute [rw] systems_manager_agent
30
- # Contains settings for the SSM agent on your build instance.
31
+ # Contains settings for the Systems Manager agent on your build
32
+ # instance.
31
33
  # @return [Types::SystemsManagerAgent]
32
34
  #
33
35
  # @!attribute [rw] user_data_override
@@ -35,10 +37,10 @@ module Aws::Imagebuilder
35
37
  # when you launch your build instance.
36
38
  #
37
39
  # <note markdown="1"> The userDataOverride property replaces any commands that Image
38
- # Builder might have added to ensure that SSM is installed on your
39
- # Linux build instance. If you override the user data, make sure that
40
- # you add commands to install SSM, if it is not pre-installed on your
41
- # source image.
40
+ # Builder might have added to ensure that Systems Manager is installed
41
+ # on your Linux build instance. If you override the user data, make
42
+ # sure that you add commands to install Systems Manager, if it is not
43
+ # pre-installed on your source image.
42
44
  #
43
45
  # </note>
44
46
  # @return [String]
@@ -55,7 +57,7 @@ module Aws::Imagebuilder
55
57
  # Details of an Amazon EC2 AMI.
56
58
  #
57
59
  # @!attribute [rw] region
58
- # The Region of the Amazon EC2 AMI.
60
+ # The Amazon Web Services Region of the Amazon EC2 AMI.
59
61
  # @return [String]
60
62
  #
61
63
  # @!attribute [rw] image
@@ -133,8 +135,8 @@ module Aws::Imagebuilder
133
135
  # @return [String]
134
136
  #
135
137
  # @!attribute [rw] launch_permission
136
- # Launch permissions can be used to configure which accounts can use
137
- # the AMI to launch instances.
138
+ # Launch permissions can be used to configure which Amazon Web
139
+ # Services accounts can use the AMI to launch instances.
138
140
  # @return [Types::LaunchPermissionConfiguration]
139
141
  #
140
142
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/AmiDistributionConfiguration AWS API Documentation
@@ -269,6 +271,11 @@ module Aws::Imagebuilder
269
271
  # parent image OS version during image recipe creation.
270
272
  # @return [Array<String>]
271
273
  #
274
+ # @!attribute [rw] state
275
+ # Describes the current status of the component. This is used for
276
+ # components that are no longer active.
277
+ # @return [Types::ComponentState]
278
+ #
272
279
  # @!attribute [rw] parameters
273
280
  # Contains parameter details for each of the parameters that are
274
281
  # defined for the component.
@@ -309,6 +316,7 @@ module Aws::Imagebuilder
309
316
  :type,
310
317
  :platform,
311
318
  :supported_os_versions,
319
+ :state,
312
320
  :parameters,
313
321
  :owner,
314
322
  :data,
@@ -411,6 +419,26 @@ module Aws::Imagebuilder
411
419
  include Aws::Structure
412
420
  end
413
421
 
422
+ # A group of fields that describe the current status of components that
423
+ # are no longer active.
424
+ #
425
+ # @!attribute [rw] status
426
+ # The current state of the component.
427
+ # @return [String]
428
+ #
429
+ # @!attribute [rw] reason
430
+ # Describes how or why the component changed state.
431
+ # @return [String]
432
+ #
433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ComponentState AWS API Documentation
434
+ #
435
+ class ComponentState < Struct.new(
436
+ :status,
437
+ :reason)
438
+ SENSITIVE = []
439
+ include Aws::Structure
440
+ end
441
+
414
442
  # A high-level summary of a component.
415
443
  #
416
444
  # @!attribute [rw] arn
@@ -435,6 +463,10 @@ module Aws::Imagebuilder
435
463
  # parent image OS version during image recipe creation.
436
464
  # @return [Array<String>]
437
465
  #
466
+ # @!attribute [rw] state
467
+ # Describes the current status of the component.
468
+ # @return [Types::ComponentState]
469
+ #
438
470
  # @!attribute [rw] type
439
471
  # The type of the component denotes whether the component is used to
440
472
  # build the image or only to test it.
@@ -468,6 +500,7 @@ module Aws::Imagebuilder
468
500
  :version,
469
501
  :platform,
470
502
  :supported_os_versions,
503
+ :state,
471
504
  :type,
472
505
  :owner,
473
506
  :description,
@@ -478,8 +511,8 @@ module Aws::Imagebuilder
478
511
  include Aws::Structure
479
512
  end
480
513
 
481
- # The defining characteristics of a specific version of an TOE
482
- # component.
514
+ # The defining characteristics of a specific version of an Amazon Web
515
+ # Services TOE component.
483
516
  #
484
517
  # @!attribute [rw] arn
485
518
  # The Amazon Resource Name (ARN) of the component.
@@ -514,21 +547,18 @@ module Aws::Imagebuilder
514
547
  # **Assignment:** For the first three nodes you can assign any
515
548
  # positive integer value, including zero, with an upper limit of
516
549
  # 2^30-1, or 1073741823 for each node. Image Builder automatically
517
- # assigns the build number, and that is not open for updates.
550
+ # assigns the build number to the fourth node.
518
551
  #
519
552
  # **Patterns:** You can use any numeric pattern that adheres to the
520
553
  # assignment requirements for the nodes that you can assign. For
521
554
  # example, you might choose a software version pattern, such as 1.0.0,
522
555
  # or a date, such as 2021.01.01.
523
556
  #
524
- # **Filtering:** When you retrieve or reference a resource with a
525
- # semantic version, you can use wildcards (x) to filter your results.
526
- # When you use a wildcard in any node, all nodes to the right of the
527
- # first wildcard must also be wildcards. For example, specifying
528
- # "1.2.x", or "1.x.x" works to filter list results, but neither
529
- # "1.x.2", nor "x.2.x" will work. You do not have to specify the
530
- # build - Image Builder automatically uses a wildcard for that, if
531
- # applicable.
557
+ # **Filtering:** With semantic versioning, you have the flexibility to
558
+ # use wildcards (x) to specify the most recent versions or nodes when
559
+ # selecting the source image or components for your recipe. When you
560
+ # use a wildcard in any node, all nodes to the right of the first
561
+ # wildcard must also be wildcards.
532
562
  #
533
563
  # </note>
534
564
  # @return [String]
@@ -685,21 +715,18 @@ module Aws::Imagebuilder
685
715
  # **Assignment:** For the first three nodes you can assign any
686
716
  # positive integer value, including zero, with an upper limit of
687
717
  # 2^30-1, or 1073741823 for each node. Image Builder automatically
688
- # assigns the build number, and that is not open for updates.
718
+ # assigns the build number to the fourth node.
689
719
  #
690
720
  # **Patterns:** You can use any numeric pattern that adheres to the
691
721
  # assignment requirements for the nodes that you can assign. For
692
722
  # example, you might choose a software version pattern, such as 1.0.0,
693
723
  # or a date, such as 2021.01.01.
694
724
  #
695
- # **Filtering:** When you retrieve or reference a resource with a
696
- # semantic version, you can use wildcards (x) to filter your results.
697
- # When you use a wildcard in any node, all nodes to the right of the
698
- # first wildcard must also be wildcards. For example, specifying
699
- # "1.2.x", or "1.x.x" works to filter list results, but neither
700
- # "1.x.2", nor "x.2.x" will work. You do not have to specify the
701
- # build - Image Builder automatically uses a wildcard for that, if
702
- # applicable.
725
+ # **Filtering:** With semantic versioning, you have the flexibility to
726
+ # use wildcards (x) to specify the most recent versions or nodes when
727
+ # selecting the source image or components for your recipe. When you
728
+ # use a wildcard in any node, all nodes to the right of the first
729
+ # wildcard must also be wildcards.
703
730
  #
704
731
  # </note>
705
732
  # @return [String]
@@ -858,7 +885,7 @@ module Aws::Imagebuilder
858
885
  # **Assignment:** For the first three nodes you can assign any
859
886
  # positive integer value, including zero, with an upper limit of
860
887
  # 2^30-1, or 1073741823 for each node. Image Builder automatically
861
- # assigns the build number, and that is not open for updates.
888
+ # assigns the build number to the fourth node.
862
889
  #
863
890
  # **Patterns:** You can use any numeric pattern that adheres to the
864
891
  # assignment requirements for the nodes that you can assign. For
@@ -991,6 +1018,7 @@ module Aws::Imagebuilder
991
1018
  # snapshot_id: "NonEmptyString",
992
1019
  # volume_size: 1,
993
1020
  # volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
1021
+ # throughput: 1,
994
1022
  # },
995
1023
  # virtual_name: "NonEmptyString",
996
1024
  # no_device: "EmptyString",
@@ -1037,7 +1065,7 @@ module Aws::Imagebuilder
1037
1065
  # **Assignment:** For the first three nodes you can assign any
1038
1066
  # positive integer value, including zero, with an upper limit of
1039
1067
  # 2^30-1, or 1073741823 for each node. Image Builder automatically
1040
- # assigns the build number, and that is not open for updates.
1068
+ # assigns the build number to the fourth node.
1041
1069
  #
1042
1070
  # **Patterns:** You can use any numeric pattern that adheres to the
1043
1071
  # assignment requirements for the nodes that you can assign. For
@@ -1411,6 +1439,7 @@ module Aws::Imagebuilder
1411
1439
  # snapshot_id: "NonEmptyString",
1412
1440
  # volume_size: 1,
1413
1441
  # volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
1442
+ # throughput: 1,
1414
1443
  # },
1415
1444
  # virtual_name: "NonEmptyString",
1416
1445
  # no_device: "EmptyString",
@@ -1448,7 +1477,7 @@ module Aws::Imagebuilder
1448
1477
  # **Assignment:** For the first three nodes you can assign any
1449
1478
  # positive integer value, including zero, with an upper limit of
1450
1479
  # 2^30-1, or 1073741823 for each node. Image Builder automatically
1451
- # assigns the build number, and that is not open for updates.
1480
+ # assigns the build number to the fourth node.
1452
1481
  #
1453
1482
  # **Patterns:** You can use any numeric pattern that adheres to the
1454
1483
  # assignment requirements for the nodes that you can assign. For
@@ -1659,6 +1688,10 @@ module Aws::Imagebuilder
1659
1688
  # resource_tags: {
1660
1689
  # "TagKey" => "TagValue",
1661
1690
  # },
1691
+ # instance_metadata_options: {
1692
+ # http_tokens: "HttpTokens",
1693
+ # http_put_response_hop_limit: 1,
1694
+ # },
1662
1695
  # tags: {
1663
1696
  # "TagKey" => "TagValue",
1664
1697
  # },
@@ -1674,9 +1707,21 @@ module Aws::Imagebuilder
1674
1707
  # @return [String]
1675
1708
  #
1676
1709
  # @!attribute [rw] instance_types
1677
- # The instance types of the infrastructure configuration. You can
1678
- # specify one or more instance types to use for this build. The
1679
- # service will pick one of these instance types based on availability.
1710
+ # The instance metadata options that you can set for the HTTP requests
1711
+ # that pipeline builds use to launch EC2 build and test instances. For
1712
+ # more information about instance metadata options, see one of the
1713
+ # following links:
1714
+ #
1715
+ # * [Configure the instance metadata options][1] in the <i> <i>Amazon
1716
+ # EC2 User Guide</i> </i> for Linux instances.
1717
+ #
1718
+ # * [Configure the instance metadata options][2] in the <i> <i>Amazon
1719
+ # EC2 Windows Guide</i> </i> for Windows instances.
1720
+ #
1721
+ #
1722
+ #
1723
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
1724
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
1680
1725
  # @return [Array<String>]
1681
1726
  #
1682
1727
  # @!attribute [rw] instance_profile_name
@@ -1699,7 +1744,7 @@ module Aws::Imagebuilder
1699
1744
  # @return [Types::Logging]
1700
1745
  #
1701
1746
  # @!attribute [rw] key_pair
1702
- # The key pair of the infrastructure configuration. This can be used
1747
+ # The key pair of the infrastructure configuration. You can use this
1703
1748
  # to log on to and debug the instance used to create your image.
1704
1749
  # @return [String]
1705
1750
  #
@@ -1718,6 +1763,11 @@ module Aws::Imagebuilder
1718
1763
  # The tags attached to the resource created by Image Builder.
1719
1764
  # @return [Hash<String,String>]
1720
1765
  #
1766
+ # @!attribute [rw] instance_metadata_options
1767
+ # The instance metadata options that you can set for the HTTP requests
1768
+ # that pipeline builds use to launch EC2 build and test instances.
1769
+ # @return [Types::InstanceMetadataOptions]
1770
+ #
1721
1771
  # @!attribute [rw] tags
1722
1772
  # The tags of the infrastructure configuration.
1723
1773
  # @return [Hash<String,String>]
@@ -1743,6 +1793,7 @@ module Aws::Imagebuilder
1743
1793
  :terminate_instance_on_failure,
1744
1794
  :sns_topic_arn,
1745
1795
  :resource_tags,
1796
+ :instance_metadata_options,
1746
1797
  :tags,
1747
1798
  :client_token)
1748
1799
  SENSITIVE = []
@@ -1966,7 +2017,8 @@ module Aws::Imagebuilder
1966
2017
  # }
1967
2018
  #
1968
2019
  # @!attribute [rw] image_build_version_arn
1969
- # The Amazon Resource Name (ARN) of the image to delete.
2020
+ # The Amazon Resource Name (ARN) of the Image Builder image resource
2021
+ # to delete.
1970
2022
  # @return [String]
1971
2023
  #
1972
2024
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImageRequest AWS API Documentation
@@ -1982,7 +2034,8 @@ module Aws::Imagebuilder
1982
2034
  # @return [String]
1983
2035
  #
1984
2036
  # @!attribute [rw] image_build_version_arn
1985
- # The Amazon Resource Name (ARN) of the image that was deleted.
2037
+ # The Amazon Resource Name (ARN) of the Image Builder image resource
2038
+ # that was deleted.
1986
2039
  # @return [String]
1987
2040
  #
1988
2041
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImageResponse AWS API Documentation
@@ -2213,6 +2266,7 @@ module Aws::Imagebuilder
2213
2266
  # snapshot_id: "NonEmptyString",
2214
2267
  # volume_size: 1,
2215
2268
  # volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
2269
+ # throughput: 1,
2216
2270
  # }
2217
2271
  #
2218
2272
  # @!attribute [rw] encrypted
@@ -2243,6 +2297,11 @@ module Aws::Imagebuilder
2243
2297
  # Use to override the device's volume type.
2244
2298
  # @return [String]
2245
2299
  #
2300
+ # @!attribute [rw] throughput
2301
+ # **For GP3 volumes only** – The throughput in MiB/s that the volume
2302
+ # supports.
2303
+ # @return [Integer]
2304
+ #
2246
2305
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/EbsInstanceBlockDeviceSpecification AWS API Documentation
2247
2306
  #
2248
2307
  class EbsInstanceBlockDeviceSpecification < Struct.new(
@@ -2252,7 +2311,8 @@ module Aws::Imagebuilder
2252
2311
  :kms_key_id,
2253
2312
  :snapshot_id,
2254
2313
  :volume_size,
2255
- :volume_type)
2314
+ :volume_type,
2315
+ :throughput)
2256
2316
  SENSITIVE = []
2257
2317
  include Aws::Structure
2258
2318
  end
@@ -2767,21 +2827,18 @@ module Aws::Imagebuilder
2767
2827
  # **Assignment:** For the first three nodes you can assign any
2768
2828
  # positive integer value, including zero, with an upper limit of
2769
2829
  # 2^30-1, or 1073741823 for each node. Image Builder automatically
2770
- # assigns the build number, and that is not open for updates.
2830
+ # assigns the build number to the fourth node.
2771
2831
  #
2772
2832
  # **Patterns:** You can use any numeric pattern that adheres to the
2773
2833
  # assignment requirements for the nodes that you can assign. For
2774
2834
  # example, you might choose a software version pattern, such as 1.0.0,
2775
2835
  # or a date, such as 2021.01.01.
2776
2836
  #
2777
- # **Filtering:** When you retrieve or reference a resource with a
2778
- # semantic version, you can use wildcards (x) to filter your results.
2779
- # When you use a wildcard in any node, all nodes to the right of the
2780
- # first wildcard must also be wildcards. For example, specifying
2781
- # "1.2.x", or "1.x.x" works to filter list results, but neither
2782
- # "1.x.2", nor "x.2.x" will work. You do not have to specify the
2783
- # build - Image Builder automatically uses a wildcard for that, if
2784
- # applicable.
2837
+ # **Filtering:** With semantic versioning, you have the flexibility to
2838
+ # use wildcards (x) to specify the most recent versions or nodes when
2839
+ # selecting the source image or components for your recipe. When you
2840
+ # use a wildcard in any node, all nodes to the right of the first
2841
+ # wildcard must also be wildcards.
2785
2842
  #
2786
2843
  # </note>
2787
2844
  # @return [String]
@@ -3276,21 +3333,18 @@ module Aws::Imagebuilder
3276
3333
  # **Assignment:** For the first three nodes you can assign any
3277
3334
  # positive integer value, including zero, with an upper limit of
3278
3335
  # 2^30-1, or 1073741823 for each node. Image Builder automatically
3279
- # assigns the build number, and that is not open for updates.
3336
+ # assigns the build number to the fourth node.
3280
3337
  #
3281
3338
  # **Patterns:** You can use any numeric pattern that adheres to the
3282
3339
  # assignment requirements for the nodes that you can assign. For
3283
3340
  # example, you might choose a software version pattern, such as 1.0.0,
3284
3341
  # or a date, such as 2021.01.01.
3285
3342
  #
3286
- # **Filtering:** When you retrieve or reference a resource with a
3287
- # semantic version, you can use wildcards (x) to filter your results.
3288
- # When you use a wildcard in any node, all nodes to the right of the
3289
- # first wildcard must also be wildcards. For example, specifying
3290
- # "1.2.x", or "1.x.x" works to filter list results, but neither
3291
- # "1.x.2", nor "x.2.x" will work. You do not have to specify the
3292
- # build - Image Builder automatically uses a wildcard for that, if
3293
- # applicable.
3343
+ # **Filtering:** With semantic versioning, you have the flexibility to
3344
+ # use wildcards (x) to specify the most recent versions or nodes when
3345
+ # selecting the source image or components for your recipe. When you
3346
+ # use a wildcard in any node, all nodes to the right of the first
3347
+ # wildcard must also be wildcards.
3294
3348
  #
3295
3349
  # </note>
3296
3350
  # @return [String]
@@ -3362,14 +3416,11 @@ module Aws::Imagebuilder
3362
3416
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
3363
3417
  # assign values for the first three, and can filter on all of them.
3364
3418
  #
3365
- # **Filtering:** When you retrieve or reference a resource with a
3366
- # semantic version, you can use wildcards (x) to filter your results.
3367
- # When you use a wildcard in any node, all nodes to the right of the
3368
- # first wildcard must also be wildcards. For example, specifying
3369
- # "1.2.x", or "1.x.x" works to filter list results, but neither
3370
- # "1.x.2", nor "x.2.x" will work. You do not have to specify the
3371
- # build - Image Builder automatically uses a wildcard for that, if
3372
- # applicable.
3419
+ # **Filtering:** With semantic versioning, you have the flexibility to
3420
+ # use wildcards (x) to specify the most recent versions or nodes when
3421
+ # selecting the source image or components for your recipe. When you
3422
+ # use a wildcard in any node, all nodes to the right of the first
3423
+ # wildcard must also be wildcards.
3373
3424
  #
3374
3425
  # </note>
3375
3426
  # @return [String]
@@ -3528,6 +3579,11 @@ module Aws::Imagebuilder
3528
3579
  # The tags attached to the resource created by Image Builder.
3529
3580
  # @return [Hash<String,String>]
3530
3581
  #
3582
+ # @!attribute [rw] instance_metadata_options
3583
+ # The instance metadata option settings for the infrastructure
3584
+ # configuration.
3585
+ # @return [Types::InstanceMetadataOptions]
3586
+ #
3531
3587
  # @!attribute [rw] tags
3532
3588
  # The tags of the infrastructure configuration.
3533
3589
  # @return [Hash<String,String>]
@@ -3549,6 +3605,7 @@ module Aws::Imagebuilder
3549
3605
  :date_created,
3550
3606
  :date_updated,
3551
3607
  :resource_tags,
3608
+ :instance_metadata_options,
3552
3609
  :tags)
3553
3610
  SENSITIVE = []
3554
3611
  include Aws::Structure
@@ -3624,6 +3681,7 @@ module Aws::Imagebuilder
3624
3681
  # snapshot_id: "NonEmptyString",
3625
3682
  # volume_size: 1,
3626
3683
  # volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
3684
+ # throughput: 1,
3627
3685
  # },
3628
3686
  # virtual_name: "NonEmptyString",
3629
3687
  # no_device: "EmptyString",
@@ -3675,6 +3733,7 @@ module Aws::Imagebuilder
3675
3733
  # snapshot_id: "NonEmptyString",
3676
3734
  # volume_size: 1,
3677
3735
  # volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
3736
+ # throughput: 1,
3678
3737
  # },
3679
3738
  # virtual_name: "NonEmptyString",
3680
3739
  # no_device: "EmptyString",
@@ -3702,6 +3761,57 @@ module Aws::Imagebuilder
3702
3761
  include Aws::Structure
3703
3762
  end
3704
3763
 
3764
+ # The instance metadata options that apply to the HTTP requests that
3765
+ # pipeline builds use to launch EC2 build and test instances. For more
3766
+ # information about instance metadata options, see [Configure the
3767
+ # instance metadata options][1] in the <i> <i>Amazon EC2 User Guide</i>
3768
+ # </i> for Linux instances, or [Configure the instance metadata
3769
+ # options][2] in the <i> <i>Amazon EC2 Windows Guide</i> </i> for
3770
+ # Windows instances.
3771
+ #
3772
+ #
3773
+ #
3774
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
3775
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
3776
+ #
3777
+ # @note When making an API call, you may pass InstanceMetadataOptions
3778
+ # data as a hash:
3779
+ #
3780
+ # {
3781
+ # http_tokens: "HttpTokens",
3782
+ # http_put_response_hop_limit: 1,
3783
+ # }
3784
+ #
3785
+ # @!attribute [rw] http_tokens
3786
+ # Indicates whether a signed token header is required for instance
3787
+ # metadata retrieval requests. The values affect the response as
3788
+ # follows:
3789
+ #
3790
+ # * **required** – When you retrieve the IAM role credentials, version
3791
+ # 2.0 credentials are returned in all cases.
3792
+ #
3793
+ # * **optional** – You can include a signed token header in your
3794
+ # request to retrieve instance metadata, or you can leave it out. If
3795
+ # you include it, version 2.0 credentials are returned for the IAM
3796
+ # role. Otherwise, version 1.0 credentials are returned.
3797
+ #
3798
+ # The default setting is **optional**.
3799
+ # @return [String]
3800
+ #
3801
+ # @!attribute [rw] http_put_response_hop_limit
3802
+ # Limit the number of hops that an instance metadata request can
3803
+ # traverse to reach its destination.
3804
+ # @return [Integer]
3805
+ #
3806
+ # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceMetadataOptions AWS API Documentation
3807
+ #
3808
+ class InstanceMetadataOptions < Struct.new(
3809
+ :http_tokens,
3810
+ :http_put_response_hop_limit)
3811
+ SENSITIVE = []
3812
+ include Aws::Structure
3813
+ end
3814
+
3705
3815
  # You have provided an invalid pagination token in your request.
3706
3816
  #
3707
3817
  # @!attribute [rw] message
@@ -3804,7 +3914,7 @@ module Aws::Imagebuilder
3804
3914
  # }
3805
3915
  #
3806
3916
  # @!attribute [rw] user_ids
3807
- # The account ID.
3917
+ # The Amazon Web Services account ID.
3808
3918
  # @return [Array<String>]
3809
3919
  #
3810
3920
  # @!attribute [rw] user_groups
@@ -3938,7 +4048,19 @@ module Aws::Imagebuilder
3938
4048
  # @return [String]
3939
4049
  #
3940
4050
  # @!attribute [rw] filters
3941
- # The filters.
4051
+ # Use the following filters to streamline results:
4052
+ #
4053
+ # * `description`
4054
+ #
4055
+ # * `name`
4056
+ #
4057
+ # * `platform`
4058
+ #
4059
+ # * `supportedOsVersion`
4060
+ #
4061
+ # * `type`
4062
+ #
4063
+ # * `version`
3942
4064
  # @return [Array<Types::Filter>]
3943
4065
  #
3944
4066
  # @!attribute [rw] by_name
@@ -4019,8 +4141,15 @@ module Aws::Imagebuilder
4019
4141
  # @return [String]
4020
4142
  #
4021
4143
  # @!attribute [rw] filters
4022
- # Request filters that are used to narrow the list of container images
4023
- # that are returned.
4144
+ # Use the following filters to streamline results:
4145
+ #
4146
+ # * `containerType`
4147
+ #
4148
+ # * `name`
4149
+ #
4150
+ # * `parentImage`
4151
+ #
4152
+ # * `platform`
4024
4153
  # @return [Array<Types::Filter>]
4025
4154
  #
4026
4155
  # @!attribute [rw] max_results
@@ -4084,11 +4213,7 @@ module Aws::Imagebuilder
4084
4213
  # }
4085
4214
  #
4086
4215
  # @!attribute [rw] filters
4087
- # The filters.
4088
- #
4089
- # * `name` - The name of this distribution configuration.
4090
- #
4091
- # ^
4216
+ # You can filter on `name` to streamline results.
4092
4217
  # @return [Array<Types::Filter>]
4093
4218
  #
4094
4219
  # @!attribute [rw] max_results
@@ -4156,7 +4281,17 @@ module Aws::Imagebuilder
4156
4281
  # @return [String]
4157
4282
  #
4158
4283
  # @!attribute [rw] filters
4159
- # The filters.
4284
+ # Use the following filters to streamline results:
4285
+ #
4286
+ # * `name`
4287
+ #
4288
+ # * `osVersion`
4289
+ #
4290
+ # * `platform`
4291
+ #
4292
+ # * `type`
4293
+ #
4294
+ # * `version`
4160
4295
  # @return [Array<Types::Filter>]
4161
4296
  #
4162
4297
  # @!attribute [rw] max_results
@@ -4282,7 +4417,11 @@ module Aws::Imagebuilder
4282
4417
  # @return [String]
4283
4418
  #
4284
4419
  # @!attribute [rw] filters
4285
- # The filters.
4420
+ # Use the following filters to streamline results:
4421
+ #
4422
+ # * `name`
4423
+ #
4424
+ # * `version`
4286
4425
  # @return [Array<Types::Filter>]
4287
4426
  #
4288
4427
  # @!attribute [rw] max_results
@@ -4345,7 +4484,19 @@ module Aws::Imagebuilder
4345
4484
  # }
4346
4485
  #
4347
4486
  # @!attribute [rw] filters
4348
- # The filters.
4487
+ # Use the following filters to streamline results:
4488
+ #
4489
+ # * `description`
4490
+ #
4491
+ # * `distributionConfigurationArn`
4492
+ #
4493
+ # * `imageRecipeArn`
4494
+ #
4495
+ # * `infrastructureConfigurationArn`
4496
+ #
4497
+ # * `name`
4498
+ #
4499
+ # * `status`
4349
4500
  # @return [Array<Types::Filter>]
4350
4501
  #
4351
4502
  # @!attribute [rw] max_results
@@ -4416,7 +4567,13 @@ module Aws::Imagebuilder
4416
4567
  # @return [String]
4417
4568
  #
4418
4569
  # @!attribute [rw] filters
4419
- # The filters.
4570
+ # Use the following filters to streamline results:
4571
+ #
4572
+ # * `name`
4573
+ #
4574
+ # * `parentImage`
4575
+ #
4576
+ # * `platform`
4420
4577
  # @return [Array<Types::Filter>]
4421
4578
  #
4422
4579
  # @!attribute [rw] max_results
@@ -4490,7 +4647,17 @@ module Aws::Imagebuilder
4490
4647
  # @return [String]
4491
4648
  #
4492
4649
  # @!attribute [rw] filters
4493
- # The filters.
4650
+ # Use the following filters to streamline results:
4651
+ #
4652
+ # * `name`
4653
+ #
4654
+ # * `osVersion`
4655
+ #
4656
+ # * `platform`
4657
+ #
4658
+ # * `type`
4659
+ #
4660
+ # * `version`
4494
4661
  # @return [Array<Types::Filter>]
4495
4662
  #
4496
4663
  # @!attribute [rw] by_name
@@ -4534,14 +4701,11 @@ module Aws::Imagebuilder
4534
4701
  # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
4535
4702
  # assign values for the first three, and can filter on all of them.
4536
4703
  #
4537
- # **Filtering:** When you retrieve or reference a resource with a
4538
- # semantic version, you can use wildcards (x) to filter your results.
4539
- # When you use a wildcard in any node, all nodes to the right of the
4540
- # first wildcard must also be wildcards. For example, specifying
4541
- # "1.2.x", or "1.x.x" works to filter list results, but neither
4542
- # "1.x.2", nor "x.2.x" will work. You do not have to specify the
4543
- # build - Image Builder automatically uses a wildcard for that, if
4544
- # applicable.
4704
+ # **Filtering:** With semantic versioning, you have the flexibility to
4705
+ # use wildcards (x) to specify the most recent versions or nodes when
4706
+ # selecting the source image or components for your recipe. When you
4707
+ # use a wildcard in any node, all nodes to the right of the first
4708
+ # wildcard must also be wildcards.
4545
4709
  #
4546
4710
  # </note>
4547
4711
  # @return [Array<Types::ImageVersion>]
@@ -4578,7 +4742,7 @@ module Aws::Imagebuilder
4578
4742
  # }
4579
4743
  #
4580
4744
  # @!attribute [rw] filters
4581
- # The filters.
4745
+ # You can filter on `name` to streamline results.
4582
4746
  # @return [Array<Types::Filter>]
4583
4747
  #
4584
4748
  # @!attribute [rw] max_results
@@ -5119,7 +5283,8 @@ module Aws::Imagebuilder
5119
5283
  include Aws::Structure
5120
5284
  end
5121
5285
 
5122
- # Contains settings for the SSM agent on your build instance.
5286
+ # Contains settings for the Systems Manager agent on your build
5287
+ # instance.
5123
5288
  #
5124
5289
  # @note When making an API call, you may pass SystemsManagerAgent
5125
5290
  # data as a hash:
@@ -5129,11 +5294,11 @@ module Aws::Imagebuilder
5129
5294
  # }
5130
5295
  #
5131
5296
  # @!attribute [rw] uninstall_after_build
5132
- # Controls whether the SSM agent is removed from your final build
5133
- # image, prior to creating the new AMI. If this is set to true, then
5134
- # the agent is removed from the final image. If it's set to false,
5135
- # then the agent is left in, so that it is included in the new AMI.
5136
- # The default value is false.
5297
+ # Controls whether the Systems Manager agent is removed from your
5298
+ # final build image, prior to creating the new AMI. If this is set to
5299
+ # true, then the agent is removed from the final image. If it's set
5300
+ # to false, then the agent is left in, so that it is included in the
5301
+ # new AMI. The default value is false.
5137
5302
  # @return [Boolean]
5138
5303
  #
5139
5304
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SystemsManagerAgent AWS API Documentation
@@ -5473,6 +5638,10 @@ module Aws::Imagebuilder
5473
5638
  # resource_tags: {
5474
5639
  # "TagKey" => "TagValue",
5475
5640
  # },
5641
+ # instance_metadata_options: {
5642
+ # http_tokens: "HttpTokens",
5643
+ # http_put_response_hop_limit: 1,
5644
+ # },
5476
5645
  # }
5477
5646
  #
5478
5647
  # @!attribute [rw] infrastructure_configuration_arn
@@ -5510,7 +5679,7 @@ module Aws::Imagebuilder
5510
5679
  # @return [Types::Logging]
5511
5680
  #
5512
5681
  # @!attribute [rw] key_pair
5513
- # The key pair of the infrastructure configuration. This can be used
5682
+ # The key pair of the infrastructure configuration. You can use this
5514
5683
  # to log on to and debug the instance used to create your image.
5515
5684
  # @return [String]
5516
5685
  #
@@ -5536,6 +5705,24 @@ module Aws::Imagebuilder
5536
5705
  # The tags attached to the resource created by Image Builder.
5537
5706
  # @return [Hash<String,String>]
5538
5707
  #
5708
+ # @!attribute [rw] instance_metadata_options
5709
+ # The instance metadata options that you can set for the HTTP requests
5710
+ # that pipeline builds use to launch EC2 build and test instances. For
5711
+ # more information about instance metadata options, see one of the
5712
+ # following links:
5713
+ #
5714
+ # * [Configure the instance metadata options][1] in the <i> <i>Amazon
5715
+ # EC2 User Guide</i> </i> for Linux instances.
5716
+ #
5717
+ # * [Configure the instance metadata options][2] in the <i> <i>Amazon
5718
+ # EC2 Windows Guide</i> </i> for Windows instances.
5719
+ #
5720
+ #
5721
+ #
5722
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
5723
+ # [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
5724
+ # @return [Types::InstanceMetadataOptions]
5725
+ #
5539
5726
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateInfrastructureConfigurationRequest AWS API Documentation
5540
5727
  #
5541
5728
  class UpdateInfrastructureConfigurationRequest < Struct.new(
@@ -5550,7 +5737,8 @@ module Aws::Imagebuilder
5550
5737
  :terminate_instance_on_failure,
5551
5738
  :sns_topic_arn,
5552
5739
  :client_token,
5553
- :resource_tags)
5740
+ :resource_tags,
5741
+ :instance_metadata_options)
5554
5742
  SENSITIVE = []
5555
5743
  include Aws::Structure
5556
5744
  end