aws-sdk-imagebuilder 1.27.0 → 1.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-imagebuilder/client.rb +165 -54
- data/lib/aws-sdk-imagebuilder/client_api.rb +20 -0
- data/lib/aws-sdk-imagebuilder/types.rb +288 -112
- data/lib/aws-sdk-imagebuilder.rb +1 -1
- metadata +5 -5
@@ -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
|
16
|
-
# whether to keep it for the AMI that you create. You can
|
17
|
-
# commands to run on launch for all of your build
|
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
|
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
|
39
|
-
# Linux build instance. If you override the user data, make
|
40
|
-
# you add commands to install
|
41
|
-
#
|
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 base 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
|
@@ -112,7 +114,7 @@ module Aws::Imagebuilder
|
|
112
114
|
# }
|
113
115
|
#
|
114
116
|
# @!attribute [rw] name
|
115
|
-
# The name of the
|
117
|
+
# The name of the output AMI.
|
116
118
|
# @return [String]
|
117
119
|
#
|
118
120
|
# @!attribute [rw] description
|
@@ -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
|
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
|
@@ -266,9 +268,14 @@ module Aws::Imagebuilder
|
|
266
268
|
# @!attribute [rw] supported_os_versions
|
267
269
|
# The operating system (OS) version supported by the component. If the
|
268
270
|
# OS information is available, a prefix match is performed against the
|
269
|
-
#
|
271
|
+
# base 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
|
@@ -432,9 +460,13 @@ module Aws::Imagebuilder
|
|
432
460
|
# @!attribute [rw] supported_os_versions
|
433
461
|
# The operating system (OS) version supported by the component. If the
|
434
462
|
# OS information is available, a prefix match is performed against the
|
435
|
-
#
|
463
|
+
# base 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
|
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
|
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:**
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
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 base image or components for your recipe. When you use
|
560
|
+
# a wildcard in any node, all nodes to the right of the first wildcard
|
561
|
+
# must also be wildcards.
|
532
562
|
#
|
533
563
|
# </note>
|
534
564
|
# @return [String]
|
@@ -544,7 +574,7 @@ module Aws::Imagebuilder
|
|
544
574
|
# @!attribute [rw] supported_os_versions
|
545
575
|
# he operating system (OS) version supported by the component. If the
|
546
576
|
# OS information is available, a prefix match is performed against the
|
547
|
-
#
|
577
|
+
# base image OS version during image recipe creation.
|
548
578
|
# @return [Array<String>]
|
549
579
|
#
|
550
580
|
# @!attribute [rw] type
|
@@ -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
|
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:**
|
696
|
-
#
|
697
|
-
#
|
698
|
-
#
|
699
|
-
#
|
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 base image or components for your recipe. When you use
|
728
|
+
# a wildcard in any node, all nodes to the right of the first wildcard
|
729
|
+
# must also be wildcards.
|
703
730
|
#
|
704
731
|
# </note>
|
705
732
|
# @return [String]
|
@@ -732,7 +759,7 @@ module Aws::Imagebuilder
|
|
732
759
|
# @return [Boolean]
|
733
760
|
#
|
734
761
|
# @!attribute [rw] parent_image
|
735
|
-
# The
|
762
|
+
# The base image for the container recipe.
|
736
763
|
# @return [String]
|
737
764
|
#
|
738
765
|
# @!attribute [rw] date_created
|
@@ -798,7 +825,7 @@ module Aws::Imagebuilder
|
|
798
825
|
# @return [String]
|
799
826
|
#
|
800
827
|
# @!attribute [rw] parent_image
|
801
|
-
# The
|
828
|
+
# The base image for the container recipe.
|
802
829
|
# @return [String]
|
803
830
|
#
|
804
831
|
# @!attribute [rw] date_created
|
@@ -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
|
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
|
@@ -886,7 +913,7 @@ module Aws::Imagebuilder
|
|
886
913
|
# @!attribute [rw] supported_os_versions
|
887
914
|
# The operating system (OS) version supported by the component. If the
|
888
915
|
# OS information is available, a prefix match is performed against the
|
889
|
-
#
|
916
|
+
# base image OS version during image recipe creation.
|
890
917
|
# @return [Array<String>]
|
891
918
|
#
|
892
919
|
# @!attribute [rw] data
|
@@ -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
|
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
|
@@ -1068,16 +1096,16 @@ module Aws::Imagebuilder
|
|
1068
1096
|
# @return [String]
|
1069
1097
|
#
|
1070
1098
|
# @!attribute [rw] platform_override
|
1071
|
-
# Specifies the operating system platform when you use a custom
|
1099
|
+
# Specifies the operating system platform when you use a custom base
|
1072
1100
|
# image.
|
1073
1101
|
# @return [String]
|
1074
1102
|
#
|
1075
1103
|
# @!attribute [rw] image_os_version_override
|
1076
|
-
# Specifies the operating system version for the
|
1104
|
+
# Specifies the operating system version for the base image.
|
1077
1105
|
# @return [String]
|
1078
1106
|
#
|
1079
1107
|
# @!attribute [rw] parent_image
|
1080
|
-
# The
|
1108
|
+
# The base image for the container recipe.
|
1081
1109
|
# @return [String]
|
1082
1110
|
#
|
1083
1111
|
# @!attribute [rw] tags
|
@@ -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
|
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
|
@@ -1463,8 +1492,8 @@ module Aws::Imagebuilder
|
|
1463
1492
|
# @return [Array<Types::ComponentConfiguration>]
|
1464
1493
|
#
|
1465
1494
|
# @!attribute [rw] parent_image
|
1466
|
-
# The
|
1467
|
-
# the ARN of the
|
1495
|
+
# The base image of the image recipe. The value of the string can be
|
1496
|
+
# the ARN of the base image or an AMI ID. The format for the ARN
|
1468
1497
|
# follows this example:
|
1469
1498
|
# `arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x`.
|
1470
1499
|
# You can provide the specific version that you want to use, or you
|
@@ -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
|
# },
|
@@ -1699,7 +1732,7 @@ module Aws::Imagebuilder
|
|
1699
1732
|
# @return [Types::Logging]
|
1700
1733
|
#
|
1701
1734
|
# @!attribute [rw] key_pair
|
1702
|
-
# The key pair of the infrastructure configuration.
|
1735
|
+
# The key pair of the infrastructure configuration. You can use this
|
1703
1736
|
# to log on to and debug the instance used to create your image.
|
1704
1737
|
# @return [String]
|
1705
1738
|
#
|
@@ -1718,6 +1751,11 @@ module Aws::Imagebuilder
|
|
1718
1751
|
# The tags attached to the resource created by Image Builder.
|
1719
1752
|
# @return [Hash<String,String>]
|
1720
1753
|
#
|
1754
|
+
# @!attribute [rw] instance_metadata_options
|
1755
|
+
# The instance metadata options that you can set for the HTTP requests
|
1756
|
+
# that pipeline builds use to launch EC2 build and test instances.
|
1757
|
+
# @return [Types::InstanceMetadataOptions]
|
1758
|
+
#
|
1721
1759
|
# @!attribute [rw] tags
|
1722
1760
|
# The tags of the infrastructure configuration.
|
1723
1761
|
# @return [Hash<String,String>]
|
@@ -1743,6 +1781,7 @@ module Aws::Imagebuilder
|
|
1743
1781
|
:terminate_instance_on_failure,
|
1744
1782
|
:sns_topic_arn,
|
1745
1783
|
:resource_tags,
|
1784
|
+
:instance_metadata_options,
|
1746
1785
|
:tags,
|
1747
1786
|
:client_token)
|
1748
1787
|
SENSITIVE = []
|
@@ -1966,7 +2005,8 @@ module Aws::Imagebuilder
|
|
1966
2005
|
# }
|
1967
2006
|
#
|
1968
2007
|
# @!attribute [rw] image_build_version_arn
|
1969
|
-
# The Amazon Resource Name (ARN) of the image
|
2008
|
+
# The Amazon Resource Name (ARN) of the Image Builder image resource
|
2009
|
+
# to delete.
|
1970
2010
|
# @return [String]
|
1971
2011
|
#
|
1972
2012
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImageRequest AWS API Documentation
|
@@ -1982,7 +2022,8 @@ module Aws::Imagebuilder
|
|
1982
2022
|
# @return [String]
|
1983
2023
|
#
|
1984
2024
|
# @!attribute [rw] image_build_version_arn
|
1985
|
-
# The Amazon Resource Name (ARN) of the
|
2025
|
+
# The Amazon Resource Name (ARN) of the Image Builder image resource
|
2026
|
+
# that was deleted.
|
1986
2027
|
# @return [String]
|
1987
2028
|
#
|
1988
2029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImageResponse AWS API Documentation
|
@@ -2213,6 +2254,7 @@ module Aws::Imagebuilder
|
|
2213
2254
|
# snapshot_id: "NonEmptyString",
|
2214
2255
|
# volume_size: 1,
|
2215
2256
|
# volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
|
2257
|
+
# throughput: 1,
|
2216
2258
|
# }
|
2217
2259
|
#
|
2218
2260
|
# @!attribute [rw] encrypted
|
@@ -2243,6 +2285,11 @@ module Aws::Imagebuilder
|
|
2243
2285
|
# Use to override the device's volume type.
|
2244
2286
|
# @return [String]
|
2245
2287
|
#
|
2288
|
+
# @!attribute [rw] throughput
|
2289
|
+
# **For GP3 volumes only** – The throughput in MiB/s that the volume
|
2290
|
+
# supports.
|
2291
|
+
# @return [Integer]
|
2292
|
+
#
|
2246
2293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/EbsInstanceBlockDeviceSpecification AWS API Documentation
|
2247
2294
|
#
|
2248
2295
|
class EbsInstanceBlockDeviceSpecification < Struct.new(
|
@@ -2252,7 +2299,8 @@ module Aws::Imagebuilder
|
|
2252
2299
|
:kms_key_id,
|
2253
2300
|
:snapshot_id,
|
2254
2301
|
:volume_size,
|
2255
|
-
:volume_type
|
2302
|
+
:volume_type,
|
2303
|
+
:throughput)
|
2256
2304
|
SENSITIVE = []
|
2257
2305
|
include Aws::Structure
|
2258
2306
|
end
|
@@ -2767,21 +2815,18 @@ module Aws::Imagebuilder
|
|
2767
2815
|
# **Assignment:** For the first three nodes you can assign any
|
2768
2816
|
# positive integer value, including zero, with an upper limit of
|
2769
2817
|
# 2^30-1, or 1073741823 for each node. Image Builder automatically
|
2770
|
-
# assigns the build number
|
2818
|
+
# assigns the build number to the fourth node.
|
2771
2819
|
#
|
2772
2820
|
# **Patterns:** You can use any numeric pattern that adheres to the
|
2773
2821
|
# assignment requirements for the nodes that you can assign. For
|
2774
2822
|
# example, you might choose a software version pattern, such as 1.0.0,
|
2775
2823
|
# or a date, such as 2021.01.01.
|
2776
2824
|
#
|
2777
|
-
# **Filtering:**
|
2778
|
-
#
|
2779
|
-
#
|
2780
|
-
#
|
2781
|
-
#
|
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.
|
2825
|
+
# **Filtering:** With semantic versioning, you have the flexibility to
|
2826
|
+
# use wildcards (x) to specify the most recent versions or nodes when
|
2827
|
+
# selecting the base image or components for your recipe. When you use
|
2828
|
+
# a wildcard in any node, all nodes to the right of the first wildcard
|
2829
|
+
# must also be wildcards.
|
2785
2830
|
#
|
2786
2831
|
# </note>
|
2787
2832
|
# @return [String]
|
@@ -3030,7 +3075,7 @@ module Aws::Imagebuilder
|
|
3030
3075
|
# @return [Array<Types::ComponentConfiguration>]
|
3031
3076
|
#
|
3032
3077
|
# @!attribute [rw] parent_image
|
3033
|
-
# The
|
3078
|
+
# The base image of the image recipe.
|
3034
3079
|
# @return [String]
|
3035
3080
|
#
|
3036
3081
|
# @!attribute [rw] block_device_mappings
|
@@ -3098,7 +3143,7 @@ module Aws::Imagebuilder
|
|
3098
3143
|
# @return [String]
|
3099
3144
|
#
|
3100
3145
|
# @!attribute [rw] parent_image
|
3101
|
-
# The
|
3146
|
+
# The base image of the image recipe.
|
3102
3147
|
# @return [String]
|
3103
3148
|
#
|
3104
3149
|
# @!attribute [rw] date_created
|
@@ -3276,21 +3321,18 @@ module Aws::Imagebuilder
|
|
3276
3321
|
# **Assignment:** For the first three nodes you can assign any
|
3277
3322
|
# positive integer value, including zero, with an upper limit of
|
3278
3323
|
# 2^30-1, or 1073741823 for each node. Image Builder automatically
|
3279
|
-
# assigns the build number
|
3324
|
+
# assigns the build number to the fourth node.
|
3280
3325
|
#
|
3281
3326
|
# **Patterns:** You can use any numeric pattern that adheres to the
|
3282
3327
|
# assignment requirements for the nodes that you can assign. For
|
3283
3328
|
# example, you might choose a software version pattern, such as 1.0.0,
|
3284
3329
|
# or a date, such as 2021.01.01.
|
3285
3330
|
#
|
3286
|
-
# **Filtering:**
|
3287
|
-
#
|
3288
|
-
#
|
3289
|
-
#
|
3290
|
-
#
|
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.
|
3331
|
+
# **Filtering:** With semantic versioning, you have the flexibility to
|
3332
|
+
# use wildcards (x) to specify the most recent versions or nodes when
|
3333
|
+
# selecting the base image or components for your recipe. When you use
|
3334
|
+
# a wildcard in any node, all nodes to the right of the first wildcard
|
3335
|
+
# must also be wildcards.
|
3294
3336
|
#
|
3295
3337
|
# </note>
|
3296
3338
|
# @return [String]
|
@@ -3362,14 +3404,11 @@ module Aws::Imagebuilder
|
|
3362
3404
|
# <major>.<minor>.<patch>/<build>. You can
|
3363
3405
|
# assign values for the first three, and can filter on all of them.
|
3364
3406
|
#
|
3365
|
-
# **Filtering:**
|
3366
|
-
#
|
3367
|
-
#
|
3368
|
-
#
|
3369
|
-
#
|
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.
|
3407
|
+
# **Filtering:** With semantic versioning, you have the flexibility to
|
3408
|
+
# use wildcards (x) to specify the most recent versions or nodes when
|
3409
|
+
# selecting the base image or components for your recipe. When you use
|
3410
|
+
# a wildcard in any node, all nodes to the right of the first wildcard
|
3411
|
+
# must also be wildcards.
|
3373
3412
|
#
|
3374
3413
|
# </note>
|
3375
3414
|
# @return [String]
|
@@ -3528,6 +3567,11 @@ module Aws::Imagebuilder
|
|
3528
3567
|
# The tags attached to the resource created by Image Builder.
|
3529
3568
|
# @return [Hash<String,String>]
|
3530
3569
|
#
|
3570
|
+
# @!attribute [rw] instance_metadata_options
|
3571
|
+
# The instance metadata option settings for the infrastructure
|
3572
|
+
# configuration.
|
3573
|
+
# @return [Types::InstanceMetadataOptions]
|
3574
|
+
#
|
3531
3575
|
# @!attribute [rw] tags
|
3532
3576
|
# The tags of the infrastructure configuration.
|
3533
3577
|
# @return [Hash<String,String>]
|
@@ -3549,6 +3593,7 @@ module Aws::Imagebuilder
|
|
3549
3593
|
:date_created,
|
3550
3594
|
:date_updated,
|
3551
3595
|
:resource_tags,
|
3596
|
+
:instance_metadata_options,
|
3552
3597
|
:tags)
|
3553
3598
|
SENSITIVE = []
|
3554
3599
|
include Aws::Structure
|
@@ -3624,6 +3669,7 @@ module Aws::Imagebuilder
|
|
3624
3669
|
# snapshot_id: "NonEmptyString",
|
3625
3670
|
# volume_size: 1,
|
3626
3671
|
# volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
|
3672
|
+
# throughput: 1,
|
3627
3673
|
# },
|
3628
3674
|
# virtual_name: "NonEmptyString",
|
3629
3675
|
# no_device: "EmptyString",
|
@@ -3642,7 +3688,7 @@ module Aws::Imagebuilder
|
|
3642
3688
|
# @return [String]
|
3643
3689
|
#
|
3644
3690
|
# @!attribute [rw] no_device
|
3645
|
-
# Use to remove a mapping from the
|
3691
|
+
# Use to remove a mapping from the base image.
|
3646
3692
|
# @return [String]
|
3647
3693
|
#
|
3648
3694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceBlockDeviceMapping AWS API Documentation
|
@@ -3656,7 +3702,7 @@ module Aws::Imagebuilder
|
|
3656
3702
|
include Aws::Structure
|
3657
3703
|
end
|
3658
3704
|
|
3659
|
-
# Defines a custom
|
3705
|
+
# Defines a custom base AMI and block device mapping configurations of
|
3660
3706
|
# an instance used for building and testing container images.
|
3661
3707
|
#
|
3662
3708
|
# @note When making an API call, you may pass InstanceConfiguration
|
@@ -3675,6 +3721,7 @@ module Aws::Imagebuilder
|
|
3675
3721
|
# snapshot_id: "NonEmptyString",
|
3676
3722
|
# volume_size: 1,
|
3677
3723
|
# volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
|
3724
|
+
# throughput: 1,
|
3678
3725
|
# },
|
3679
3726
|
# virtual_name: "NonEmptyString",
|
3680
3727
|
# no_device: "EmptyString",
|
@@ -3702,6 +3749,57 @@ module Aws::Imagebuilder
|
|
3702
3749
|
include Aws::Structure
|
3703
3750
|
end
|
3704
3751
|
|
3752
|
+
# The instance metadata options that apply to the HTTP requests that
|
3753
|
+
# pipeline builds use to launch EC2 build and test instances. For more
|
3754
|
+
# information about instance metadata options, see [Configure the
|
3755
|
+
# instance metadata options][1] in the <i> <i>Amazon EC2 User Guide</i>
|
3756
|
+
# </i> for Linux instances, or [Configure the instance metadata
|
3757
|
+
# options][2] in the <i> <i>Amazon EC2 Windows Guide</i> </i> for
|
3758
|
+
# Windows instances.
|
3759
|
+
#
|
3760
|
+
#
|
3761
|
+
#
|
3762
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
|
3763
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
|
3764
|
+
#
|
3765
|
+
# @note When making an API call, you may pass InstanceMetadataOptions
|
3766
|
+
# data as a hash:
|
3767
|
+
#
|
3768
|
+
# {
|
3769
|
+
# http_tokens: "HttpTokens",
|
3770
|
+
# http_put_response_hop_limit: 1,
|
3771
|
+
# }
|
3772
|
+
#
|
3773
|
+
# @!attribute [rw] http_tokens
|
3774
|
+
# Indicates whether a signed token header is required for instance
|
3775
|
+
# metadata retrieval requests. The values affect the response as
|
3776
|
+
# follows:
|
3777
|
+
#
|
3778
|
+
# * **required** – When you retrieve the IAM role credentials, version
|
3779
|
+
# 2.0 credentials are returned in all cases.
|
3780
|
+
#
|
3781
|
+
# * **optional** – You can include a signed token header in your
|
3782
|
+
# request to retrieve instance metadata, or you can leave it out. If
|
3783
|
+
# you include it, version 2.0 credentials are returned for the IAM
|
3784
|
+
# role. Otherwise, version 1.0 credentials are returned.
|
3785
|
+
#
|
3786
|
+
# The default setting is **optional**.
|
3787
|
+
# @return [String]
|
3788
|
+
#
|
3789
|
+
# @!attribute [rw] http_put_response_hop_limit
|
3790
|
+
# Limit the number of hops that an instance metadata request can
|
3791
|
+
# traverse to reach its destination.
|
3792
|
+
# @return [Integer]
|
3793
|
+
#
|
3794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceMetadataOptions AWS API Documentation
|
3795
|
+
#
|
3796
|
+
class InstanceMetadataOptions < Struct.new(
|
3797
|
+
:http_tokens,
|
3798
|
+
:http_put_response_hop_limit)
|
3799
|
+
SENSITIVE = []
|
3800
|
+
include Aws::Structure
|
3801
|
+
end
|
3802
|
+
|
3705
3803
|
# You have provided an invalid pagination token in your request.
|
3706
3804
|
#
|
3707
3805
|
# @!attribute [rw] message
|
@@ -3804,7 +3902,7 @@ module Aws::Imagebuilder
|
|
3804
3902
|
# }
|
3805
3903
|
#
|
3806
3904
|
# @!attribute [rw] user_ids
|
3807
|
-
# The account ID.
|
3905
|
+
# The Amazon Web Services account ID.
|
3808
3906
|
# @return [Array<String>]
|
3809
3907
|
#
|
3810
3908
|
# @!attribute [rw] user_groups
|
@@ -3938,7 +4036,19 @@ module Aws::Imagebuilder
|
|
3938
4036
|
# @return [String]
|
3939
4037
|
#
|
3940
4038
|
# @!attribute [rw] filters
|
3941
|
-
#
|
4039
|
+
# Use the following filters to streamline results:
|
4040
|
+
#
|
4041
|
+
# * `description`
|
4042
|
+
#
|
4043
|
+
# * `name`
|
4044
|
+
#
|
4045
|
+
# * `platform`
|
4046
|
+
#
|
4047
|
+
# * `supportedOsVersion`
|
4048
|
+
#
|
4049
|
+
# * `type`
|
4050
|
+
#
|
4051
|
+
# * `version`
|
3942
4052
|
# @return [Array<Types::Filter>]
|
3943
4053
|
#
|
3944
4054
|
# @!attribute [rw] by_name
|
@@ -4019,8 +4129,15 @@ module Aws::Imagebuilder
|
|
4019
4129
|
# @return [String]
|
4020
4130
|
#
|
4021
4131
|
# @!attribute [rw] filters
|
4022
|
-
#
|
4023
|
-
#
|
4132
|
+
# Use the following filters to streamline results:
|
4133
|
+
#
|
4134
|
+
# * `containerType`
|
4135
|
+
#
|
4136
|
+
# * `name`
|
4137
|
+
#
|
4138
|
+
# * `parentImage`
|
4139
|
+
#
|
4140
|
+
# * `platform`
|
4024
4141
|
# @return [Array<Types::Filter>]
|
4025
4142
|
#
|
4026
4143
|
# @!attribute [rw] max_results
|
@@ -4084,11 +4201,7 @@ module Aws::Imagebuilder
|
|
4084
4201
|
# }
|
4085
4202
|
#
|
4086
4203
|
# @!attribute [rw] filters
|
4087
|
-
#
|
4088
|
-
#
|
4089
|
-
# * `name` - The name of this distribution configuration.
|
4090
|
-
#
|
4091
|
-
# ^
|
4204
|
+
# You can filter on `name` to streamline results.
|
4092
4205
|
# @return [Array<Types::Filter>]
|
4093
4206
|
#
|
4094
4207
|
# @!attribute [rw] max_results
|
@@ -4156,7 +4269,17 @@ module Aws::Imagebuilder
|
|
4156
4269
|
# @return [String]
|
4157
4270
|
#
|
4158
4271
|
# @!attribute [rw] filters
|
4159
|
-
#
|
4272
|
+
# Use the following filters to streamline results:
|
4273
|
+
#
|
4274
|
+
# * `name`
|
4275
|
+
#
|
4276
|
+
# * `osVersion`
|
4277
|
+
#
|
4278
|
+
# * `platform`
|
4279
|
+
#
|
4280
|
+
# * `type`
|
4281
|
+
#
|
4282
|
+
# * `version`
|
4160
4283
|
# @return [Array<Types::Filter>]
|
4161
4284
|
#
|
4162
4285
|
# @!attribute [rw] max_results
|
@@ -4282,7 +4405,11 @@ module Aws::Imagebuilder
|
|
4282
4405
|
# @return [String]
|
4283
4406
|
#
|
4284
4407
|
# @!attribute [rw] filters
|
4285
|
-
#
|
4408
|
+
# Use the following filters to streamline results:
|
4409
|
+
#
|
4410
|
+
# * `name`
|
4411
|
+
#
|
4412
|
+
# * `version`
|
4286
4413
|
# @return [Array<Types::Filter>]
|
4287
4414
|
#
|
4288
4415
|
# @!attribute [rw] max_results
|
@@ -4345,7 +4472,19 @@ module Aws::Imagebuilder
|
|
4345
4472
|
# }
|
4346
4473
|
#
|
4347
4474
|
# @!attribute [rw] filters
|
4348
|
-
#
|
4475
|
+
# Use the following filters to streamline results:
|
4476
|
+
#
|
4477
|
+
# * `description`
|
4478
|
+
#
|
4479
|
+
# * `distributionConfigurationArn`
|
4480
|
+
#
|
4481
|
+
# * `imageRecipeArn`
|
4482
|
+
#
|
4483
|
+
# * `infrastructureConfigurationArn`
|
4484
|
+
#
|
4485
|
+
# * `name`
|
4486
|
+
#
|
4487
|
+
# * `status`
|
4349
4488
|
# @return [Array<Types::Filter>]
|
4350
4489
|
#
|
4351
4490
|
# @!attribute [rw] max_results
|
@@ -4416,7 +4555,13 @@ module Aws::Imagebuilder
|
|
4416
4555
|
# @return [String]
|
4417
4556
|
#
|
4418
4557
|
# @!attribute [rw] filters
|
4419
|
-
#
|
4558
|
+
# Use the following filters to streamline results:
|
4559
|
+
#
|
4560
|
+
# * `name`
|
4561
|
+
#
|
4562
|
+
# * `parentImage`
|
4563
|
+
#
|
4564
|
+
# * `platform`
|
4420
4565
|
# @return [Array<Types::Filter>]
|
4421
4566
|
#
|
4422
4567
|
# @!attribute [rw] max_results
|
@@ -4490,7 +4635,17 @@ module Aws::Imagebuilder
|
|
4490
4635
|
# @return [String]
|
4491
4636
|
#
|
4492
4637
|
# @!attribute [rw] filters
|
4493
|
-
#
|
4638
|
+
# Use the following filters to streamline results:
|
4639
|
+
#
|
4640
|
+
# * `name`
|
4641
|
+
#
|
4642
|
+
# * `osVersion`
|
4643
|
+
#
|
4644
|
+
# * `platform`
|
4645
|
+
#
|
4646
|
+
# * `type`
|
4647
|
+
#
|
4648
|
+
# * `version`
|
4494
4649
|
# @return [Array<Types::Filter>]
|
4495
4650
|
#
|
4496
4651
|
# @!attribute [rw] by_name
|
@@ -4534,14 +4689,11 @@ module Aws::Imagebuilder
|
|
4534
4689
|
# <major>.<minor>.<patch>/<build>. You can
|
4535
4690
|
# assign values for the first three, and can filter on all of them.
|
4536
4691
|
#
|
4537
|
-
# **Filtering:**
|
4538
|
-
#
|
4539
|
-
#
|
4540
|
-
#
|
4541
|
-
#
|
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.
|
4692
|
+
# **Filtering:** With semantic versioning, you have the flexibility to
|
4693
|
+
# use wildcards (x) to specify the most recent versions or nodes when
|
4694
|
+
# selecting the base image or components for your recipe. When you use
|
4695
|
+
# a wildcard in any node, all nodes to the right of the first wildcard
|
4696
|
+
# must also be wildcards.
|
4545
4697
|
#
|
4546
4698
|
# </note>
|
4547
4699
|
# @return [Array<Types::ImageVersion>]
|
@@ -4578,7 +4730,7 @@ module Aws::Imagebuilder
|
|
4578
4730
|
# }
|
4579
4731
|
#
|
4580
4732
|
# @!attribute [rw] filters
|
4581
|
-
#
|
4733
|
+
# You can filter on `name` to streamline results.
|
4582
4734
|
# @return [Array<Types::Filter>]
|
4583
4735
|
#
|
4584
4736
|
# @!attribute [rw] max_results
|
@@ -4997,7 +5149,7 @@ module Aws::Imagebuilder
|
|
4997
5149
|
# The condition configures when the pipeline should trigger a new
|
4998
5150
|
# image build. When the `pipelineExecutionStartCondition` is set to
|
4999
5151
|
# `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`, and you use
|
5000
|
-
# semantic version filters on the
|
5152
|
+
# semantic version filters on the base image or components in your
|
5001
5153
|
# image recipe, EC2 Image Builder will build a new image only when
|
5002
5154
|
# there are new versions of the image or components in your recipe
|
5003
5155
|
# that match the semantic version filter. When it is set to
|
@@ -5119,7 +5271,8 @@ module Aws::Imagebuilder
|
|
5119
5271
|
include Aws::Structure
|
5120
5272
|
end
|
5121
5273
|
|
5122
|
-
# Contains settings for the
|
5274
|
+
# Contains settings for the Systems Manager agent on your build
|
5275
|
+
# instance.
|
5123
5276
|
#
|
5124
5277
|
# @note When making an API call, you may pass SystemsManagerAgent
|
5125
5278
|
# data as a hash:
|
@@ -5129,11 +5282,11 @@ module Aws::Imagebuilder
|
|
5129
5282
|
# }
|
5130
5283
|
#
|
5131
5284
|
# @!attribute [rw] uninstall_after_build
|
5132
|
-
# Controls whether the
|
5133
|
-
# image, prior to creating the new AMI. If this is set to
|
5134
|
-
# the agent is removed from the final image. If it's set
|
5135
|
-
# then the agent is left in, so that it is included in the
|
5136
|
-
# The default value is false.
|
5285
|
+
# Controls whether the Systems Manager agent is removed from your
|
5286
|
+
# final build image, prior to creating the new AMI. If this is set to
|
5287
|
+
# true, then the agent is removed from the final image. If it's set
|
5288
|
+
# to false, then the agent is left in, so that it is included in the
|
5289
|
+
# new AMI. The default value is false.
|
5137
5290
|
# @return [Boolean]
|
5138
5291
|
#
|
5139
5292
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SystemsManagerAgent AWS API Documentation
|
@@ -5473,6 +5626,10 @@ module Aws::Imagebuilder
|
|
5473
5626
|
# resource_tags: {
|
5474
5627
|
# "TagKey" => "TagValue",
|
5475
5628
|
# },
|
5629
|
+
# instance_metadata_options: {
|
5630
|
+
# http_tokens: "HttpTokens",
|
5631
|
+
# http_put_response_hop_limit: 1,
|
5632
|
+
# },
|
5476
5633
|
# }
|
5477
5634
|
#
|
5478
5635
|
# @!attribute [rw] infrastructure_configuration_arn
|
@@ -5510,7 +5667,7 @@ module Aws::Imagebuilder
|
|
5510
5667
|
# @return [Types::Logging]
|
5511
5668
|
#
|
5512
5669
|
# @!attribute [rw] key_pair
|
5513
|
-
# The key pair of the infrastructure configuration.
|
5670
|
+
# The key pair of the infrastructure configuration. You can use this
|
5514
5671
|
# to log on to and debug the instance used to create your image.
|
5515
5672
|
# @return [String]
|
5516
5673
|
#
|
@@ -5536,6 +5693,24 @@ module Aws::Imagebuilder
|
|
5536
5693
|
# The tags attached to the resource created by Image Builder.
|
5537
5694
|
# @return [Hash<String,String>]
|
5538
5695
|
#
|
5696
|
+
# @!attribute [rw] instance_metadata_options
|
5697
|
+
# The instance metadata options that you can set for the HTTP requests
|
5698
|
+
# that pipeline builds use to launch EC2 build and test instances. For
|
5699
|
+
# more information about instance metadata options, see one of the
|
5700
|
+
# following links:
|
5701
|
+
#
|
5702
|
+
# * [Configure the instance metadata options][1] in the <i> <i>Amazon
|
5703
|
+
# EC2 User Guide</i> </i> for Linux instances.
|
5704
|
+
#
|
5705
|
+
# * [Configure the instance metadata options][2] in the <i> <i>Amazon
|
5706
|
+
# EC2 Windows Guide</i> </i> for Windows instances.
|
5707
|
+
#
|
5708
|
+
#
|
5709
|
+
#
|
5710
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html
|
5711
|
+
# [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/configuring-instance-metadata-options.html
|
5712
|
+
# @return [Types::InstanceMetadataOptions]
|
5713
|
+
#
|
5539
5714
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateInfrastructureConfigurationRequest AWS API Documentation
|
5540
5715
|
#
|
5541
5716
|
class UpdateInfrastructureConfigurationRequest < Struct.new(
|
@@ -5550,7 +5725,8 @@ module Aws::Imagebuilder
|
|
5550
5725
|
:terminate_instance_on_failure,
|
5551
5726
|
:sns_topic_arn,
|
5552
5727
|
:client_token,
|
5553
|
-
:resource_tags
|
5728
|
+
:resource_tags,
|
5729
|
+
:instance_metadata_options)
|
5554
5730
|
SENSITIVE = []
|
5555
5731
|
include Aws::Structure
|
5556
5732
|
end
|