aws-sdk-imagebuilder 1.20.0 → 1.24.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c53f1c873e2288329eb4eeedf5fc485e42898e91114e794a4e08169961b9e1f3
4
- data.tar.gz: 517ef461c3415e786e44a0286da2ee928d067b7ed6d21b0a3db8bdeddbf95b2d
3
+ metadata.gz: 369f134281103a25c59f2dcb1a265f8bb4f2808aa64c3596461728212ef66622
4
+ data.tar.gz: b29a97da2710e35f5849ca281ad297f37877f43dbc51944dd90ebd7e13395837
5
5
  SHA512:
6
- metadata.gz: b15c9968b3174c0acb54eaf3fdf39d2584fc6a866505299701d7cc2bb1118f012d1e689c823227cc7bbad716e3627445e3d183185e03cf14c4c35dd26e966b2a
7
- data.tar.gz: b7aa9d474a083ba986722e9b9f3d5911c0398096b6259b76a64cf915b720ddff45bcc5502d00b5f623703498692b013e955144c8769c520e85a21eec59d954d4
6
+ metadata.gz: fcdbf885f23d57df20e4e36fcc4015db22a4c69d50471ab16b1ee5efd318bdb18073a4bb45271c977ebfe7a17cd8e4102671bffc0d1fe934efaa969d51538cb6
7
+ data.tar.gz: f56bf97767486b1a08bdf5a771bace8855d41e7855567d20828036af604c623b9e4d61dc78d73875ebcb3d63a721cc82887021be710251ecbfdcd86717c09200
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.24.0 (2021-07-19)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for reversal of default value for additional instance configuration SSM switch, plus improved descriptions for semantic versioning.
8
+
9
+ 1.23.0 (2021-07-06)
10
+ ------------------
11
+
12
+ * Feature - Adds support for specifying parameters to customize components for recipes. Expands configuration of the Amazon EC2 instances that are used for building and testing images, including the ability to specify commands to run on launch, and more control over installation and removal of the SSM agent.
13
+
14
+ 1.22.0 (2021-05-14)
15
+ ------------------
16
+
17
+ * Feature - Text-only updates for bundled documentation feedback tickets - spring 2021.
18
+
19
+ 1.21.0 (2021-04-02)
20
+ ------------------
21
+
22
+ * Feature - This release adds support for Block Device Mappings for container image builds, and adds distribution configuration support for EC2 launch templates in AMI builds.
23
+
4
24
  1.20.0 (2021-03-10)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.20.0
1
+ 1.24.0
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-imagebuilder/customizations'
48
48
  # @!group service
49
49
  module Aws::Imagebuilder
50
50
 
51
- GEM_VERSION = '1.20.0'
51
+ GEM_VERSION = '1.24.0'
52
52
 
53
53
  end
@@ -376,8 +376,23 @@ module Aws::Imagebuilder
376
376
  #
377
377
  # @option params [required, String] :semantic_version
378
378
  # The semantic version of the component. This version follows the
379
- # semantic version syntax. For example, major.minor.patch. This could be
380
- # versioned like software (2.0.1) or like a date (2019.12.01).
379
+ # semantic version syntax.
380
+ #
381
+ # <note markdown="1"> The semantic version has four nodes:
382
+ # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
383
+ # assign values for the first three, and can filter on all of them.
384
+ #
385
+ # **Assignment:** For the first three nodes you can assign any positive
386
+ # integer value, including zero, with an upper limit of 2^30-1, or
387
+ # 1073741823 for each node. Image Builder automatically assigns the
388
+ # build number, and that is not open for updates.
389
+ #
390
+ # **Patterns:** You can use any numeric pattern that adheres to the
391
+ # assignment requirements for the nodes that you can assign. For
392
+ # example, you might choose a software version pattern, such as 1.0.0,
393
+ # or a date, such as 2021.01.01.
394
+ #
395
+ # </note>
381
396
  #
382
397
  # @option params [String] :description
383
398
  # The description of the component. Describes the contents of the
@@ -401,10 +416,10 @@ module Aws::Imagebuilder
401
416
  # `data` or `uri` can be used to specify the data within the component.
402
417
  #
403
418
  # @option params [String] :uri
404
- # The uri of the component. Must be an S3 URL and the requester must
405
- # have permission to access the S3 bucket. If you use S3, you can
406
- # specify component content up to your service quota. Either `data` or
407
- # `uri` can be used to specify the data within the component.
419
+ # The uri of the component. Must be an Amazon S3 URL and the requester
420
+ # must have permission to access the Amazon S3 bucket. If you use Amazon
421
+ # S3, you can specify component content up to your service quota. Either
422
+ # `data` or `uri` can be used to specify the data within the component.
408
423
  #
409
424
  # @option params [String] :kms_key_id
410
425
  # The ID of the KMS key that should be used to encrypt this component.
@@ -470,19 +485,39 @@ module Aws::Imagebuilder
470
485
  # The description of the container recipe.
471
486
  #
472
487
  # @option params [required, String] :semantic_version
473
- # The semantic version of the container recipe
474
- # (&lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;).
488
+ # The semantic version of the container recipe. This version follows the
489
+ # semantic version syntax.
490
+ #
491
+ # <note markdown="1"> The semantic version has four nodes:
492
+ # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
493
+ # assign values for the first three, and can filter on all of them.
494
+ #
495
+ # **Assignment:** For the first three nodes you can assign any positive
496
+ # integer value, including zero, with an upper limit of 2^30-1, or
497
+ # 1073741823 for each node. Image Builder automatically assigns the
498
+ # build number, and that is not open for updates.
499
+ #
500
+ # **Patterns:** You can use any numeric pattern that adheres to the
501
+ # assignment requirements for the nodes that you can assign. For
502
+ # example, you might choose a software version pattern, such as 1.0.0,
503
+ # or a date, such as 2021.01.01.
504
+ #
505
+ # </note>
475
506
  #
476
507
  # @option params [required, Array<Types::ComponentConfiguration>] :components
477
508
  # Components for build and test that are included in the container
478
509
  # recipe.
479
510
  #
480
- # @option params [required, String] :dockerfile_template_data
511
+ # @option params [Types::InstanceConfiguration] :instance_configuration
512
+ # A group of options that can be used to configure an instance for
513
+ # building and testing container images.
514
+ #
515
+ # @option params [String] :dockerfile_template_data
481
516
  # The Dockerfile template used to build your image as an inline data
482
517
  # blob.
483
518
  #
484
519
  # @option params [String] :dockerfile_template_uri
485
- # The S3 URI for the Dockerfile that will be used to build your
520
+ # The Amazon S3 URI for the Dockerfile that will be used to build your
486
521
  # container image.
487
522
  #
488
523
  # @option params [String] :platform_override
@@ -529,9 +564,34 @@ module Aws::Imagebuilder
529
564
  # components: [ # required
530
565
  # {
531
566
  # component_arn: "ComponentVersionArnOrBuildVersionArn", # required
567
+ # parameters: [
568
+ # {
569
+ # name: "ComponentParameterName", # required
570
+ # value: ["ComponentParameterValue"], # required
571
+ # },
572
+ # ],
532
573
  # },
533
574
  # ],
534
- # dockerfile_template_data: "InlineDockerFileTemplate", # required
575
+ # instance_configuration: {
576
+ # image: "NonEmptyString",
577
+ # block_device_mappings: [
578
+ # {
579
+ # device_name: "NonEmptyString",
580
+ # ebs: {
581
+ # encrypted: false,
582
+ # delete_on_termination: false,
583
+ # iops: 1,
584
+ # kms_key_id: "NonEmptyString",
585
+ # snapshot_id: "NonEmptyString",
586
+ # volume_size: 1,
587
+ # volume_type: "standard", # accepts standard, io1, io2, gp2, gp3, sc1, st1
588
+ # },
589
+ # virtual_name: "NonEmptyString",
590
+ # no_device: "EmptyString",
591
+ # },
592
+ # ],
593
+ # },
594
+ # dockerfile_template_data: "InlineDockerFileTemplate",
535
595
  # dockerfile_template_uri: "Uri",
536
596
  # platform_override: "Windows", # accepts Windows, Linux
537
597
  # image_os_version_override: "NonEmptyString",
@@ -620,6 +680,13 @@ module Aws::Imagebuilder
620
680
  # },
621
681
  # },
622
682
  # license_configuration_arns: ["LicenseConfigurationArn"],
683
+ # launch_template_configurations: [
684
+ # {
685
+ # launch_template_id: "LaunchTemplateId", # required
686
+ # account_id: "AccountId",
687
+ # set_default_version: false,
688
+ # },
689
+ # ],
623
690
  # },
624
691
  # ],
625
692
  # tags: {
@@ -645,7 +712,8 @@ module Aws::Imagebuilder
645
712
 
646
713
  # Creates a new image. This request will create a new image along with
647
714
  # all of the configured output resources defined in the distribution
648
- # configuration.
715
+ # configuration. You must specify exactly one recipe for your image,
716
+ # using either a ContainerRecipeArn or an ImageRecipeArn.
649
717
  #
650
718
  # @option params [String] :image_recipe_arn
651
719
  # The Amazon Resource Name (ARN) of the image recipe that defines how
@@ -828,7 +896,24 @@ module Aws::Imagebuilder
828
896
  # The description of the image recipe.
829
897
  #
830
898
  # @option params [required, String] :semantic_version
831
- # The semantic version of the image recipe.
899
+ # The semantic version of the image recipe. This version follows the
900
+ # semantic version syntax.
901
+ #
902
+ # <note markdown="1"> The semantic version has four nodes:
903
+ # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
904
+ # assign values for the first three, and can filter on all of them.
905
+ #
906
+ # **Assignment:** For the first three nodes you can assign any positive
907
+ # integer value, including zero, with an upper limit of 2^30-1, or
908
+ # 1073741823 for each node. Image Builder automatically assigns the
909
+ # build number, and that is not open for updates.
910
+ #
911
+ # **Patterns:** You can use any numeric pattern that adheres to the
912
+ # assignment requirements for the nodes that you can assign. For
913
+ # example, you might choose a software version pattern, such as 1.0.0,
914
+ # or a date, such as 2021.01.01.
915
+ #
916
+ # </note>
832
917
  #
833
918
  # @option params [required, Array<Types::ComponentConfiguration>] :components
834
919
  # The components of the image recipe.
@@ -837,7 +922,7 @@ module Aws::Imagebuilder
837
922
  # The parent image of the image recipe. The value of the string can be
838
923
  # the ARN of the parent image or an AMI ID. The format for the ARN
839
924
  # follows this example:
840
- # `arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/xxxx.x.x`.
925
+ # `arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x`.
841
926
  # You can provide the specific version that you want to use, or you can
842
927
  # use a wildcard in all of the fields. If you enter an AMI ID for the
843
928
  # string value, you must have access to the AMI, and the AMI must be in
@@ -850,7 +935,11 @@ module Aws::Imagebuilder
850
935
  # The tags of the image recipe.
851
936
  #
852
937
  # @option params [String] :working_directory
853
- # The working directory to be used during build and test workflows.
938
+ # The working directory used during build and test workflows.
939
+ #
940
+ # @option params [Types::AdditionalInstanceConfiguration] :additional_instance_configuration
941
+ # Specify additional settings and launch scripts for your build
942
+ # instances.
854
943
  #
855
944
  # @option params [required, String] :client_token
856
945
  # The idempotency token used to make this request idempotent.
@@ -873,6 +962,12 @@ module Aws::Imagebuilder
873
962
  # components: [ # required
874
963
  # {
875
964
  # component_arn: "ComponentVersionArnOrBuildVersionArn", # required
965
+ # parameters: [
966
+ # {
967
+ # name: "ComponentParameterName", # required
968
+ # value: ["ComponentParameterValue"], # required
969
+ # },
970
+ # ],
876
971
  # },
877
972
  # ],
878
973
  # parent_image: "NonEmptyString", # required
@@ -896,6 +991,12 @@ module Aws::Imagebuilder
896
991
  # "TagKey" => "TagValue",
897
992
  # },
898
993
  # working_directory: "NonEmptyString",
994
+ # additional_instance_configuration: {
995
+ # systems_manager_agent: {
996
+ # uninstall_after_build: false,
997
+ # },
998
+ # user_data_override: "UserDataOverride",
999
+ # },
899
1000
  # client_token: "ClientToken", # required
900
1001
  # })
901
1002
  #
@@ -931,15 +1032,15 @@ module Aws::Imagebuilder
931
1032
  #
932
1033
  # @option params [required, String] :instance_profile_name
933
1034
  # The instance profile to associate with the instance used to customize
934
- # your EC2 AMI.
1035
+ # your Amazon EC2 AMI.
935
1036
  #
936
1037
  # @option params [Array<String>] :security_group_ids
937
1038
  # The security group IDs to associate with the instance used to
938
- # customize your EC2 AMI.
1039
+ # customize your Amazon EC2 AMI.
939
1040
  #
940
1041
  # @option params [String] :subnet_id
941
1042
  # The subnet ID in which to place the instance used to customize your
942
- # EC2 AMI.
1043
+ # Amazon EC2 AMI.
943
1044
  #
944
1045
  # @option params [Types::Logging] :logging
945
1046
  # The logging configuration of the infrastructure configuration.
@@ -981,7 +1082,7 @@ module Aws::Imagebuilder
981
1082
  # name: "ResourceName", # required
982
1083
  # description: "NonEmptyString",
983
1084
  # instance_types: ["InstanceType"],
984
- # instance_profile_name: "NonEmptyString", # required
1085
+ # instance_profile_name: "InstanceProfileNameType", # required
985
1086
  # security_group_ids: ["NonEmptyString"],
986
1087
  # subnet_id: "NonEmptyString",
987
1088
  # logging: {
@@ -1259,6 +1360,12 @@ module Aws::Imagebuilder
1259
1360
  # resp.component.platform #=> String, one of "Windows", "Linux"
1260
1361
  # resp.component.supported_os_versions #=> Array
1261
1362
  # resp.component.supported_os_versions[0] #=> String
1363
+ # resp.component.parameters #=> Array
1364
+ # resp.component.parameters[0].name #=> String
1365
+ # resp.component.parameters[0].type #=> String
1366
+ # resp.component.parameters[0].default_value #=> Array
1367
+ # resp.component.parameters[0].default_value[0] #=> String
1368
+ # resp.component.parameters[0].description #=> String
1262
1369
  # resp.component.owner #=> String
1263
1370
  # resp.component.data #=> String
1264
1371
  # resp.component.kms_key_id #=> String
@@ -1335,6 +1442,22 @@ module Aws::Imagebuilder
1335
1442
  # resp.container_recipe.version #=> String
1336
1443
  # resp.container_recipe.components #=> Array
1337
1444
  # resp.container_recipe.components[0].component_arn #=> String
1445
+ # resp.container_recipe.components[0].parameters #=> Array
1446
+ # resp.container_recipe.components[0].parameters[0].name #=> String
1447
+ # resp.container_recipe.components[0].parameters[0].value #=> Array
1448
+ # resp.container_recipe.components[0].parameters[0].value[0] #=> String
1449
+ # resp.container_recipe.instance_configuration.image #=> String
1450
+ # resp.container_recipe.instance_configuration.block_device_mappings #=> Array
1451
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].device_name #=> String
1452
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].ebs.encrypted #=> Boolean
1453
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
1454
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].ebs.iops #=> Integer
1455
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].ebs.kms_key_id #=> String
1456
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].ebs.snapshot_id #=> String
1457
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].ebs.volume_size #=> Integer
1458
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "gp3", "sc1", "st1"
1459
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].virtual_name #=> String
1460
+ # resp.container_recipe.instance_configuration.block_device_mappings[0].no_device #=> String
1338
1461
  # resp.container_recipe.dockerfile_template_data #=> String
1339
1462
  # resp.container_recipe.kms_key_id #=> String
1340
1463
  # resp.container_recipe.encrypted #=> Boolean
@@ -1429,6 +1552,10 @@ module Aws::Imagebuilder
1429
1552
  # resp.distribution_configuration.distributions[0].container_distribution_configuration.target_repository.repository_name #=> String
1430
1553
  # resp.distribution_configuration.distributions[0].license_configuration_arns #=> Array
1431
1554
  # resp.distribution_configuration.distributions[0].license_configuration_arns[0] #=> String
1555
+ # resp.distribution_configuration.distributions[0].launch_template_configurations #=> Array
1556
+ # resp.distribution_configuration.distributions[0].launch_template_configurations[0].launch_template_id #=> String
1557
+ # resp.distribution_configuration.distributions[0].launch_template_configurations[0].account_id #=> String
1558
+ # resp.distribution_configuration.distributions[0].launch_template_configurations[0].set_default_version #=> Boolean
1432
1559
  # resp.distribution_configuration.timeout_minutes #=> Integer
1433
1560
  # resp.distribution_configuration.date_created #=> String
1434
1561
  # resp.distribution_configuration.date_updated #=> String
@@ -1481,6 +1608,10 @@ module Aws::Imagebuilder
1481
1608
  # resp.image.image_recipe.version #=> String
1482
1609
  # resp.image.image_recipe.components #=> Array
1483
1610
  # resp.image.image_recipe.components[0].component_arn #=> String
1611
+ # resp.image.image_recipe.components[0].parameters #=> Array
1612
+ # resp.image.image_recipe.components[0].parameters[0].name #=> String
1613
+ # resp.image.image_recipe.components[0].parameters[0].value #=> Array
1614
+ # resp.image.image_recipe.components[0].parameters[0].value[0] #=> String
1484
1615
  # resp.image.image_recipe.parent_image #=> String
1485
1616
  # resp.image.image_recipe.block_device_mappings #=> Array
1486
1617
  # resp.image.image_recipe.block_device_mappings[0].device_name #=> String
@@ -1497,6 +1628,8 @@ module Aws::Imagebuilder
1497
1628
  # resp.image.image_recipe.tags #=> Hash
1498
1629
  # resp.image.image_recipe.tags["TagKey"] #=> String
1499
1630
  # resp.image.image_recipe.working_directory #=> String
1631
+ # resp.image.image_recipe.additional_instance_configuration.systems_manager_agent.uninstall_after_build #=> Boolean
1632
+ # resp.image.image_recipe.additional_instance_configuration.user_data_override #=> String
1500
1633
  # resp.image.container_recipe.arn #=> String
1501
1634
  # resp.image.container_recipe.container_type #=> String, one of "DOCKER"
1502
1635
  # resp.image.container_recipe.name #=> String
@@ -1506,6 +1639,22 @@ module Aws::Imagebuilder
1506
1639
  # resp.image.container_recipe.version #=> String
1507
1640
  # resp.image.container_recipe.components #=> Array
1508
1641
  # resp.image.container_recipe.components[0].component_arn #=> String
1642
+ # resp.image.container_recipe.components[0].parameters #=> Array
1643
+ # resp.image.container_recipe.components[0].parameters[0].name #=> String
1644
+ # resp.image.container_recipe.components[0].parameters[0].value #=> Array
1645
+ # resp.image.container_recipe.components[0].parameters[0].value[0] #=> String
1646
+ # resp.image.container_recipe.instance_configuration.image #=> String
1647
+ # resp.image.container_recipe.instance_configuration.block_device_mappings #=> Array
1648
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].device_name #=> String
1649
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].ebs.encrypted #=> Boolean
1650
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].ebs.delete_on_termination #=> Boolean
1651
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].ebs.iops #=> Integer
1652
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].ebs.kms_key_id #=> String
1653
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].ebs.snapshot_id #=> String
1654
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].ebs.volume_size #=> Integer
1655
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].ebs.volume_type #=> String, one of "standard", "io1", "io2", "gp2", "gp3", "sc1", "st1"
1656
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].virtual_name #=> String
1657
+ # resp.image.container_recipe.instance_configuration.block_device_mappings[0].no_device #=> String
1509
1658
  # resp.image.container_recipe.dockerfile_template_data #=> String
1510
1659
  # resp.image.container_recipe.kms_key_id #=> String
1511
1660
  # resp.image.container_recipe.encrypted #=> Boolean
@@ -1561,6 +1710,10 @@ module Aws::Imagebuilder
1561
1710
  # resp.image.distribution_configuration.distributions[0].container_distribution_configuration.target_repository.repository_name #=> String
1562
1711
  # resp.image.distribution_configuration.distributions[0].license_configuration_arns #=> Array
1563
1712
  # resp.image.distribution_configuration.distributions[0].license_configuration_arns[0] #=> String
1713
+ # resp.image.distribution_configuration.distributions[0].launch_template_configurations #=> Array
1714
+ # resp.image.distribution_configuration.distributions[0].launch_template_configurations[0].launch_template_id #=> String
1715
+ # resp.image.distribution_configuration.distributions[0].launch_template_configurations[0].account_id #=> String
1716
+ # resp.image.distribution_configuration.distributions[0].launch_template_configurations[0].set_default_version #=> Boolean
1564
1717
  # resp.image.distribution_configuration.timeout_minutes #=> Integer
1565
1718
  # resp.image.distribution_configuration.date_created #=> String
1566
1719
  # resp.image.distribution_configuration.date_updated #=> String
@@ -1704,6 +1857,10 @@ module Aws::Imagebuilder
1704
1857
  # resp.image_recipe.version #=> String
1705
1858
  # resp.image_recipe.components #=> Array
1706
1859
  # resp.image_recipe.components[0].component_arn #=> String
1860
+ # resp.image_recipe.components[0].parameters #=> Array
1861
+ # resp.image_recipe.components[0].parameters[0].name #=> String
1862
+ # resp.image_recipe.components[0].parameters[0].value #=> Array
1863
+ # resp.image_recipe.components[0].parameters[0].value[0] #=> String
1707
1864
  # resp.image_recipe.parent_image #=> String
1708
1865
  # resp.image_recipe.block_device_mappings #=> Array
1709
1866
  # resp.image_recipe.block_device_mappings[0].device_name #=> String
@@ -1720,6 +1877,8 @@ module Aws::Imagebuilder
1720
1877
  # resp.image_recipe.tags #=> Hash
1721
1878
  # resp.image_recipe.tags["TagKey"] #=> String
1722
1879
  # resp.image_recipe.working_directory #=> String
1880
+ # resp.image_recipe.additional_instance_configuration.systems_manager_agent.uninstall_after_build #=> Boolean
1881
+ # resp.image_recipe.additional_instance_configuration.user_data_override #=> String
1723
1882
  #
1724
1883
  # @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipe AWS API Documentation
1725
1884
  #
@@ -1818,8 +1977,22 @@ module Aws::Imagebuilder
1818
1977
  #
1819
1978
  # @option params [required, String] :semantic_version
1820
1979
  # The semantic version of the component. This version follows the
1821
- # semantic version syntax. For example, major.minor.patch. This could be
1822
- # versioned like software (2.0.1) or like a date (2019.12.01).
1980
+ # semantic version syntax.
1981
+ #
1982
+ # <note markdown="1"> The semantic version has four nodes:
1983
+ # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
1984
+ # assign values for the first three, and can filter on all of them.
1985
+ #
1986
+ # **Filtering:** When you retrieve or reference a resource with a
1987
+ # semantic version, you can use wildcards (x) to filter your results.
1988
+ # When you use a wildcard in any node, all nodes to the right of the
1989
+ # first wildcard must also be wildcards. For example, specifying
1990
+ # "1.2.x", or "1.x.x" works to filter list results, but neither
1991
+ # "1.x.2", nor "x.2.x" will work. You do not have to specify the
1992
+ # build - Image Builder automatically uses a wildcard for that, if
1993
+ # applicable.
1994
+ #
1995
+ # </note>
1823
1996
  #
1824
1997
  # @option params [String] :description
1825
1998
  # The description of the component. Describes the contents of the
@@ -1832,7 +2005,7 @@ module Aws::Imagebuilder
1832
2005
  #
1833
2006
  # @option params [required, String] :type
1834
2007
  # The type of the component denotes whether the component is used to
1835
- # build the image or only to test it.
2008
+ # build the image, or only to test it.
1836
2009
  #
1837
2010
  # @option params [required, String] :format
1838
2011
  # The format of the resource that you want to import as a component.
@@ -1845,10 +2018,10 @@ module Aws::Imagebuilder
1845
2018
  # `data` or `uri` can be used to specify the data within the component.
1846
2019
  #
1847
2020
  # @option params [String] :uri
1848
- # The uri of the component. Must be an S3 URL and the requester must
1849
- # have permission to access the S3 bucket. If you use S3, you can
1850
- # specify component content up to your service quota. Either `data` or
1851
- # `uri` can be used to specify the data within the component.
2021
+ # The uri of the component. Must be an Amazon S3 URL and the requester
2022
+ # must have permission to access the Amazon S3 bucket. If you use Amazon
2023
+ # S3, you can specify component content up to your service quota. Either
2024
+ # `data` or `uri` can be used to specify the data within the component.
1852
2025
  #
1853
2026
  # @option params [String] :kms_key_id
1854
2027
  # The ID of the KMS key that should be used to encrypt this component.
@@ -1905,6 +2078,21 @@ module Aws::Imagebuilder
1905
2078
  # Returns the list of component build versions for the specified
1906
2079
  # semantic version.
1907
2080
  #
2081
+ # <note markdown="1"> The semantic version has four nodes:
2082
+ # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
2083
+ # assign values for the first three, and can filter on all of them.
2084
+ #
2085
+ # **Filtering:** When you retrieve or reference a resource with a
2086
+ # semantic version, you can use wildcards (x) to filter your results.
2087
+ # When you use a wildcard in any node, all nodes to the right of the
2088
+ # first wildcard must also be wildcards. For example, specifying
2089
+ # "1.2.x", or "1.x.x" works to filter list results, but neither
2090
+ # "1.x.2", nor "x.2.x" will work. You do not have to specify the
2091
+ # build - Image Builder automatically uses a wildcard for that, if
2092
+ # applicable.
2093
+ #
2094
+ # </note>
2095
+ #
1908
2096
  # @option params [required, String] :component_version_arn
1909
2097
  # The component version Amazon Resource Name (ARN) whose versions you
1910
2098
  # want to list.
@@ -1963,6 +2151,21 @@ module Aws::Imagebuilder
1963
2151
  # Returns the list of component build versions for the specified
1964
2152
  # semantic version.
1965
2153
  #
2154
+ # <note markdown="1"> The semantic version has four nodes:
2155
+ # &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can
2156
+ # assign values for the first three, and can filter on all of them.
2157
+ #
2158
+ # **Filtering:** When you retrieve or reference a resource with a
2159
+ # semantic version, you can use wildcards (x) to filter your results.
2160
+ # When you use a wildcard in any node, all nodes to the right of the
2161
+ # first wildcard must also be wildcards. For example, specifying
2162
+ # "1.2.x", or "1.x.x" works to filter list results, but neither
2163
+ # "1.x.2", nor "x.2.x" will work. You do not have to specify the
2164
+ # build - Image Builder automatically uses a wildcard for that, if
2165
+ # applicable.
2166
+ #
2167
+ # </note>
2168
+ #
1966
2169
  # @option params [String] :owner
1967
2170
  # The owner defines which components you want to list. By default, this
1968
2171
  # request will only show components owned by your account. You can use
@@ -1974,8 +2177,7 @@ module Aws::Imagebuilder
1974
2177
  # The filters.
1975
2178
  #
1976
2179
  # @option params [Boolean] :by_name
1977
- # Returns the list of component build versions for the specified
1978
- # semantic version.
2180
+ # Returns the list of component build versions for the specified name.
1979
2181
  #
1980
2182
  # @option params [Integer] :max_results
1981
2183
  # The maximum items to return in a request.
@@ -2236,7 +2438,7 @@ module Aws::Imagebuilder
2236
2438
  end
2237
2439
 
2238
2440
  # List the Packages that are associated with an Image Build Version, as
2239
- # determined by AWS Systems Manager Inventory at build time.
2441
+ # determined by Amazon EC2 Systems Manager Inventory at build time.
2240
2442
  #
2241
2443
  # @option params [required, String] :image_build_version_arn
2242
2444
  # Filter results for the ListImagePackages request by the Image Build
@@ -2980,6 +3182,13 @@ module Aws::Imagebuilder
2980
3182
  # },
2981
3183
  # },
2982
3184
  # license_configuration_arns: ["LicenseConfigurationArn"],
3185
+ # launch_template_configurations: [
3186
+ # {
3187
+ # launch_template_id: "LaunchTemplateId", # required
3188
+ # account_id: "AccountId",
3189
+ # set_default_version: false,
3190
+ # },
3191
+ # ],
2983
3192
  # },
2984
3193
  # ],
2985
3194
  # client_token: "ClientToken", # required
@@ -3000,8 +3209,14 @@ module Aws::Imagebuilder
3000
3209
  req.send_request(options)
3001
3210
  end
3002
3211
 
3003
- # Updates a new image pipeline. Image pipelines enable you to automate
3004
- # the creation and distribution of images.
3212
+ # Updates an image pipeline. Image pipelines enable you to automate the
3213
+ # creation and distribution of images.
3214
+ #
3215
+ # <note markdown="1"> UpdateImagePipeline does not support selective updates for the
3216
+ # pipeline. You must specify all of the required properties in the
3217
+ # update request, not just the properties that have changed.
3218
+ #
3219
+ # </note>
3005
3220
  #
3006
3221
  # @option params [required, String] :image_pipeline_arn
3007
3222
  # The Amazon Resource Name (ARN) of the image pipeline that you want to
@@ -3109,14 +3324,15 @@ module Aws::Imagebuilder
3109
3324
  #
3110
3325
  # @option params [required, String] :instance_profile_name
3111
3326
  # The instance profile to associate with the instance used to customize
3112
- # your EC2 AMI.
3327
+ # your Amazon EC2 AMI.
3113
3328
  #
3114
3329
  # @option params [Array<String>] :security_group_ids
3115
3330
  # The security group IDs to associate with the instance used to
3116
- # customize your EC2 AMI.
3331
+ # customize your Amazon EC2 AMI.
3117
3332
  #
3118
3333
  # @option params [String] :subnet_id
3119
- # The subnet ID to place the instance used to customize your EC2 AMI in.
3334
+ # The subnet ID to place the instance used to customize your Amazon EC2
3335
+ # AMI in.
3120
3336
  #
3121
3337
  # @option params [Types::Logging] :logging
3122
3338
  # The logging configuration of the infrastructure configuration.
@@ -3155,7 +3371,7 @@ module Aws::Imagebuilder
3155
3371
  # infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
3156
3372
  # description: "NonEmptyString",
3157
3373
  # instance_types: ["InstanceType"],
3158
- # instance_profile_name: "NonEmptyString", # required
3374
+ # instance_profile_name: "InstanceProfileNameType", # required
3159
3375
  # security_group_ids: ["NonEmptyString"],
3160
3376
  # subnet_id: "NonEmptyString",
3161
3377
  # logging: {
@@ -3201,7 +3417,7 @@ module Aws::Imagebuilder
3201
3417
  params: params,
3202
3418
  config: config)
3203
3419
  context[:gem_name] = 'aws-sdk-imagebuilder'
3204
- context[:gem_version] = '1.20.0'
3420
+ context[:gem_version] = '1.24.0'
3205
3421
  Seahorse::Client::Request.new(handlers, context)
3206
3422
  end
3207
3423