aws-sdk-imagebuilder 1.87.0 → 1.89.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-imagebuilder/client.rb +134 -36
- data/lib/aws-sdk-imagebuilder/client_api.rb +34 -3
- data/lib/aws-sdk-imagebuilder/types.rb +286 -50
- data/lib/aws-sdk-imagebuilder.rb +1 -1
- data/sig/client.rbs +36 -11
- data/sig/types.rbs +31 -0
- metadata +1 -1
@@ -144,7 +144,14 @@ module Aws::Imagebuilder
|
|
144
144
|
# @return [Hash<String,String>]
|
145
145
|
#
|
146
146
|
# @!attribute [rw] kms_key_id
|
147
|
-
# The
|
147
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the KMS key
|
148
|
+
# used to encrypt the distributed image. This can be either the Key
|
149
|
+
# ARN or the Alias ARN. For more information, see [Key identifiers
|
150
|
+
# (KeyId)][1] in the *Key Management Service Developer Guide*.
|
151
|
+
#
|
152
|
+
#
|
153
|
+
#
|
154
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
148
155
|
# @return [String]
|
149
156
|
#
|
150
157
|
# @!attribute [rw] launch_permission
|
@@ -165,6 +172,22 @@ module Aws::Imagebuilder
|
|
165
172
|
include Aws::Structure
|
166
173
|
end
|
167
174
|
|
175
|
+
# Defines the rules by which an image pipeline is automatically disabled
|
176
|
+
# when it fails.
|
177
|
+
#
|
178
|
+
# @!attribute [rw] failure_count
|
179
|
+
# The number of consecutive scheduled image pipeline executions that
|
180
|
+
# must fail before Image Builder automatically disables the pipeline.
|
181
|
+
# @return [Integer]
|
182
|
+
#
|
183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/AutoDisablePolicy AWS API Documentation
|
184
|
+
#
|
185
|
+
class AutoDisablePolicy < Struct.new(
|
186
|
+
:failure_count)
|
187
|
+
SENSITIVE = []
|
188
|
+
include Aws::Structure
|
189
|
+
end
|
190
|
+
|
168
191
|
# You have exceeded the permitted request rate for the specific
|
169
192
|
# operation.
|
170
193
|
#
|
@@ -341,7 +364,14 @@ module Aws::Imagebuilder
|
|
341
364
|
# @return [String]
|
342
365
|
#
|
343
366
|
# @!attribute [rw] kms_key_id
|
344
|
-
# The KMS key identifier used to encrypt the component.
|
367
|
+
# The KMS key identifier used to encrypt the component. This can be
|
368
|
+
# either the Key ARN or the Alias ARN. For more information, see [Key
|
369
|
+
# identifiers (KeyId)][1] in the *Key Management Service Developer
|
370
|
+
# Guide*.
|
371
|
+
#
|
372
|
+
#
|
373
|
+
#
|
374
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
345
375
|
# @return [String]
|
346
376
|
#
|
347
377
|
# @!attribute [rw] encrypted
|
@@ -812,8 +842,15 @@ module Aws::Imagebuilder
|
|
812
842
|
# @return [String]
|
813
843
|
#
|
814
844
|
# @!attribute [rw] kms_key_id
|
815
|
-
#
|
816
|
-
#
|
845
|
+
# The Amazon Resource Name (ARN) that uniquely identifies which KMS
|
846
|
+
# key is used to encrypt the container image for distribution to the
|
847
|
+
# target Region. This can be either the Key ARN or the Alias ARN. For
|
848
|
+
# more information, see [Key identifiers (KeyId)][1] in the *Key
|
849
|
+
# Management Service Developer Guide*.
|
850
|
+
#
|
851
|
+
#
|
852
|
+
#
|
853
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
817
854
|
# @return [String]
|
818
855
|
#
|
819
856
|
# @!attribute [rw] encrypted
|
@@ -896,6 +933,16 @@ module Aws::Imagebuilder
|
|
896
933
|
# The date when this container recipe was created.
|
897
934
|
# @return [String]
|
898
935
|
#
|
936
|
+
# @!attribute [rw] instance_image
|
937
|
+
# The base image for a container build and test instance. This can
|
938
|
+
# contain an AMI ID or it can specify an Amazon Web Services Systems
|
939
|
+
# Manager (SSM) Parameter Store Parameter, prefixed by `ssm:`,
|
940
|
+
# followed by the parameter name or ARN.
|
941
|
+
#
|
942
|
+
# If not specified, Image Builder uses the appropriate ECS-optimized
|
943
|
+
# AMI as a base image.
|
944
|
+
# @return [String]
|
945
|
+
#
|
899
946
|
# @!attribute [rw] tags
|
900
947
|
# Tags that are attached to the container recipe.
|
901
948
|
# @return [Hash<String,String>]
|
@@ -910,6 +957,7 @@ module Aws::Imagebuilder
|
|
910
957
|
:owner,
|
911
958
|
:parent_image,
|
912
959
|
:date_created,
|
960
|
+
:instance_image,
|
913
961
|
:tags)
|
914
962
|
SENSITIVE = []
|
915
963
|
include Aws::Structure
|
@@ -978,7 +1026,14 @@ module Aws::Imagebuilder
|
|
978
1026
|
# @return [String]
|
979
1027
|
#
|
980
1028
|
# @!attribute [rw] kms_key_id
|
981
|
-
# The
|
1029
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the KMS key
|
1030
|
+
# used to encrypt this component. This can be either the Key ARN or
|
1031
|
+
# the Alias ARN. For more information, see [Key identifiers
|
1032
|
+
# (KeyId)][1] in the *Key Management Service Developer Guide*.
|
1033
|
+
#
|
1034
|
+
#
|
1035
|
+
#
|
1036
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
982
1037
|
# @return [String]
|
983
1038
|
#
|
984
1039
|
# @!attribute [rw] tags
|
@@ -1119,7 +1174,15 @@ module Aws::Imagebuilder
|
|
1119
1174
|
# @return [Types::TargetContainerRepository]
|
1120
1175
|
#
|
1121
1176
|
# @!attribute [rw] kms_key_id
|
1122
|
-
#
|
1177
|
+
# The Amazon Resource Name (ARN) that uniquely identifies which KMS
|
1178
|
+
# key is used to encrypt the Dockerfile template. This can be either
|
1179
|
+
# the Key ARN or the Alias ARN. For more information, see [Key
|
1180
|
+
# identifiers (KeyId)][1] in the *Key Management Service Developer
|
1181
|
+
# Guide*.
|
1182
|
+
#
|
1183
|
+
#
|
1184
|
+
#
|
1185
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
1123
1186
|
# @return [String]
|
1124
1187
|
#
|
1125
1188
|
# @!attribute [rw] client_token
|
@@ -1323,6 +1386,10 @@ module Aws::Imagebuilder
|
|
1323
1386
|
# that grants Image Builder access to perform workflow actions.
|
1324
1387
|
# @return [String]
|
1325
1388
|
#
|
1389
|
+
# @!attribute [rw] logging_configuration
|
1390
|
+
# Define logging configuration for the image build process.
|
1391
|
+
# @return [Types::PipelineLoggingConfiguration]
|
1392
|
+
#
|
1326
1393
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImagePipelineRequest AWS API Documentation
|
1327
1394
|
#
|
1328
1395
|
class CreateImagePipelineRequest < Struct.new(
|
@@ -1340,7 +1407,8 @@ module Aws::Imagebuilder
|
|
1340
1407
|
:client_token,
|
1341
1408
|
:image_scanning_configuration,
|
1342
1409
|
:workflows,
|
1343
|
-
:execution_role
|
1410
|
+
:execution_role,
|
1411
|
+
:logging_configuration)
|
1344
1412
|
SENSITIVE = []
|
1345
1413
|
include Aws::Structure
|
1346
1414
|
end
|
@@ -1437,6 +1505,11 @@ module Aws::Imagebuilder
|
|
1437
1505
|
# instances.
|
1438
1506
|
# @return [Types::AdditionalInstanceConfiguration]
|
1439
1507
|
#
|
1508
|
+
# @!attribute [rw] ami_tags
|
1509
|
+
# Tags that are applied to the AMI that Image Builder creates during
|
1510
|
+
# the Build phase prior to image distribution.
|
1511
|
+
# @return [Hash<String,String>]
|
1512
|
+
#
|
1440
1513
|
# @!attribute [rw] client_token
|
1441
1514
|
# Unique, case-sensitive identifier you provide to ensure idempotency
|
1442
1515
|
# of the request. For more information, see [Ensuring idempotency][1]
|
@@ -1462,6 +1535,7 @@ module Aws::Imagebuilder
|
|
1462
1535
|
:tags,
|
1463
1536
|
:working_directory,
|
1464
1537
|
:additional_instance_configuration,
|
1538
|
+
:ami_tags,
|
1465
1539
|
:client_token)
|
1466
1540
|
SENSITIVE = []
|
1467
1541
|
include Aws::Structure
|
@@ -1552,6 +1626,10 @@ module Aws::Imagebuilder
|
|
1552
1626
|
# that grants Image Builder access to perform workflow actions.
|
1553
1627
|
# @return [String]
|
1554
1628
|
#
|
1629
|
+
# @!attribute [rw] logging_configuration
|
1630
|
+
# Define logging configuration for the image build process.
|
1631
|
+
# @return [Types::ImageLoggingConfiguration]
|
1632
|
+
#
|
1555
1633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRequest AWS API Documentation
|
1556
1634
|
#
|
1557
1635
|
class CreateImageRequest < Struct.new(
|
@@ -1565,7 +1643,8 @@ module Aws::Imagebuilder
|
|
1565
1643
|
:client_token,
|
1566
1644
|
:image_scanning_configuration,
|
1567
1645
|
:workflows,
|
1568
|
-
:execution_role
|
1646
|
+
:execution_role,
|
1647
|
+
:logging_configuration)
|
1569
1648
|
SENSITIVE = []
|
1570
1649
|
include Aws::Structure
|
1571
1650
|
end
|
@@ -1864,8 +1943,14 @@ module Aws::Imagebuilder
|
|
1864
1943
|
# @return [String]
|
1865
1944
|
#
|
1866
1945
|
# @!attribute [rw] kms_key_id
|
1867
|
-
# The
|
1868
|
-
# resource.
|
1946
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the KMS key
|
1947
|
+
# used to encrypt this workflow resource. This can be either the Key
|
1948
|
+
# ARN or the Alias ARN. For more information, see [Key identifiers
|
1949
|
+
# (KeyId)][1] in the *Key Management Service Developer Guide*.
|
1950
|
+
#
|
1951
|
+
#
|
1952
|
+
#
|
1953
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
1869
1954
|
# @return [String]
|
1870
1955
|
#
|
1871
1956
|
# @!attribute [rw] tags
|
@@ -2454,7 +2539,14 @@ module Aws::Imagebuilder
|
|
2454
2539
|
# @return [Integer]
|
2455
2540
|
#
|
2456
2541
|
# @!attribute [rw] kms_key_id
|
2457
|
-
#
|
2542
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the KMS key
|
2543
|
+
# to use when encrypting the device. This can be either the Key ARN or
|
2544
|
+
# the Alias ARN. For more information, see [Key identifiers
|
2545
|
+
# (KeyId)][1] in the *Key Management Service Developer Guide*.
|
2546
|
+
#
|
2547
|
+
#
|
2548
|
+
#
|
2549
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
2458
2550
|
# @return [String]
|
2459
2551
|
#
|
2460
2552
|
# @!attribute [rw] snapshot_id
|
@@ -3335,10 +3427,11 @@ module Aws::Imagebuilder
|
|
3335
3427
|
include Aws::Structure
|
3336
3428
|
end
|
3337
3429
|
|
3338
|
-
# An Image Builder image
|
3339
|
-
#
|
3340
|
-
#
|
3341
|
-
#
|
3430
|
+
# An Image Builder image resource that keeps track of all of the
|
3431
|
+
# settings used to create, configure, and distribute output for that
|
3432
|
+
# image. You must specify exactly one recipe for the image – either a
|
3433
|
+
# container recipe (`containerRecipe`), which creates a container image,
|
3434
|
+
# or an image recipe (`imageRecipe`), which creates an AMI.
|
3342
3435
|
#
|
3343
3436
|
# @!attribute [rw] arn
|
3344
3437
|
# The Amazon Resource Name (ARN) of the image.
|
@@ -3508,6 +3601,12 @@ module Aws::Imagebuilder
|
|
3508
3601
|
# image.
|
3509
3602
|
# @return [Array<Types::WorkflowConfiguration>]
|
3510
3603
|
#
|
3604
|
+
# @!attribute [rw] logging_configuration
|
3605
|
+
# The logging configuration that's defined for the image. Image
|
3606
|
+
# Builder uses the defined settings to direct execution log output
|
3607
|
+
# during image creation.
|
3608
|
+
# @return [Types::ImageLoggingConfiguration]
|
3609
|
+
#
|
3511
3610
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Image AWS API Documentation
|
3512
3611
|
#
|
3513
3612
|
class Image < Struct.new(
|
@@ -3536,7 +3635,8 @@ module Aws::Imagebuilder
|
|
3536
3635
|
:deprecation_time,
|
3537
3636
|
:lifecycle_execution_id,
|
3538
3637
|
:execution_role,
|
3539
|
-
:workflows
|
3638
|
+
:workflows,
|
3639
|
+
:logging_configuration)
|
3540
3640
|
SENSITIVE = []
|
3541
3641
|
include Aws::Structure
|
3542
3642
|
end
|
@@ -3563,6 +3663,24 @@ module Aws::Imagebuilder
|
|
3563
3663
|
include Aws::Structure
|
3564
3664
|
end
|
3565
3665
|
|
3666
|
+
# The logging configuration that's defined for the image. Image Builder
|
3667
|
+
# uses the defined settings to direct execution log output during image
|
3668
|
+
# creation.
|
3669
|
+
#
|
3670
|
+
# @!attribute [rw] log_group_name
|
3671
|
+
# The log group name that Image Builder uses for image creation. If
|
3672
|
+
# not specified, the log group name defaults to
|
3673
|
+
# `/aws/imagebuilder/image-name`.
|
3674
|
+
# @return [String]
|
3675
|
+
#
|
3676
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageLoggingConfiguration AWS API Documentation
|
3677
|
+
#
|
3678
|
+
class ImageLoggingConfiguration < Struct.new(
|
3679
|
+
:log_group_name)
|
3680
|
+
SENSITIVE = []
|
3681
|
+
include Aws::Structure
|
3682
|
+
end
|
3683
|
+
|
3566
3684
|
# A software package that's installed on top of the base image to
|
3567
3685
|
# create a customized image.
|
3568
3686
|
#
|
@@ -3654,6 +3772,11 @@ module Aws::Imagebuilder
|
|
3654
3772
|
# This is no longer supported, and does not return a value.
|
3655
3773
|
# @return [String]
|
3656
3774
|
#
|
3775
|
+
# @!attribute [rw] last_run_status
|
3776
|
+
# The status of the last image that this pipeline built, such as
|
3777
|
+
# `BUILDING`, `TESTING`, `FAILED`, or `AVAILABLE`.
|
3778
|
+
# @return [String]
|
3779
|
+
#
|
3657
3780
|
# @!attribute [rw] date_next_run
|
3658
3781
|
# The next date when the pipeline is scheduled to run.
|
3659
3782
|
# @return [String]
|
@@ -3675,6 +3798,35 @@ module Aws::Imagebuilder
|
|
3675
3798
|
# Contains the workflows that run for the image pipeline.
|
3676
3799
|
# @return [Array<Types::WorkflowConfiguration>]
|
3677
3800
|
#
|
3801
|
+
# @!attribute [rw] logging_configuration
|
3802
|
+
# Defines logging configuration for the output image.
|
3803
|
+
# @return [Types::PipelineLoggingConfiguration]
|
3804
|
+
#
|
3805
|
+
# @!attribute [rw] consecutive_failures
|
3806
|
+
# Image Builder tracks the number of consecutive failures for
|
3807
|
+
# scheduled pipeline executions and takes one of the following actions
|
3808
|
+
# each time it runs on a schedule:
|
3809
|
+
#
|
3810
|
+
# * If the pipeline execution is successful, the number of consecutive
|
3811
|
+
# failures resets to zero.
|
3812
|
+
#
|
3813
|
+
# * If the pipeline execution fails, Image Builder increments the
|
3814
|
+
# number of consecutive failures. If the failure count exceeds the
|
3815
|
+
# limit defined in the `AutoDisablePolicy`, Image Builder disables
|
3816
|
+
# the pipeline.
|
3817
|
+
#
|
3818
|
+
# The consecutive failure count is also reset to zero under the
|
3819
|
+
# following conditions:
|
3820
|
+
#
|
3821
|
+
# * The pipeline runs manually and succeeds.
|
3822
|
+
#
|
3823
|
+
# * The pipeline configuration is updated.
|
3824
|
+
#
|
3825
|
+
# If the pipeline runs manually and fails, the count remains the same.
|
3826
|
+
# The next scheduled run continues to increment where it left off
|
3827
|
+
# before.
|
3828
|
+
# @return [Integer]
|
3829
|
+
#
|
3678
3830
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImagePipeline AWS API Documentation
|
3679
3831
|
#
|
3680
3832
|
class ImagePipeline < Struct.new(
|
@@ -3693,11 +3845,14 @@ module Aws::Imagebuilder
|
|
3693
3845
|
:date_created,
|
3694
3846
|
:date_updated,
|
3695
3847
|
:date_last_run,
|
3848
|
+
:last_run_status,
|
3696
3849
|
:date_next_run,
|
3697
3850
|
:tags,
|
3698
3851
|
:image_scanning_configuration,
|
3699
3852
|
:execution_role,
|
3700
|
-
:workflows
|
3853
|
+
:workflows,
|
3854
|
+
:logging_configuration,
|
3855
|
+
:consecutive_failures)
|
3701
3856
|
SENSITIVE = []
|
3702
3857
|
include Aws::Structure
|
3703
3858
|
end
|
@@ -3801,6 +3956,11 @@ module Aws::Imagebuilder
|
|
3801
3956
|
# from your AMI.
|
3802
3957
|
# @return [Types::AdditionalInstanceConfiguration]
|
3803
3958
|
#
|
3959
|
+
# @!attribute [rw] ami_tags
|
3960
|
+
# Tags that are applied to the AMI that Image Builder creates during
|
3961
|
+
# the Build phase prior to image distribution.
|
3962
|
+
# @return [Hash<String,String>]
|
3963
|
+
#
|
3804
3964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageRecipe AWS API Documentation
|
3805
3965
|
#
|
3806
3966
|
class ImageRecipe < Struct.new(
|
@@ -3817,7 +3977,8 @@ module Aws::Imagebuilder
|
|
3817
3977
|
:date_created,
|
3818
3978
|
:tags,
|
3819
3979
|
:working_directory,
|
3820
|
-
:additional_instance_configuration
|
3980
|
+
:additional_instance_configuration,
|
3981
|
+
:ami_tags)
|
3821
3982
|
SENSITIVE = []
|
3822
3983
|
include Aws::Structure
|
3823
3984
|
end
|
@@ -4148,6 +4309,10 @@ module Aws::Imagebuilder
|
|
4148
4309
|
# action on the image.
|
4149
4310
|
# @return [String]
|
4150
4311
|
#
|
4312
|
+
# @!attribute [rw] logging_configuration
|
4313
|
+
# The logging configuration that's defined for the image.
|
4314
|
+
# @return [Types::ImageLoggingConfiguration]
|
4315
|
+
#
|
4151
4316
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageSummary AWS API Documentation
|
4152
4317
|
#
|
4153
4318
|
class ImageSummary < Struct.new(
|
@@ -4165,7 +4330,8 @@ module Aws::Imagebuilder
|
|
4165
4330
|
:build_type,
|
4166
4331
|
:image_source,
|
4167
4332
|
:deprecation_time,
|
4168
|
-
:lifecycle_execution_id
|
4333
|
+
:lifecycle_execution_id,
|
4334
|
+
:logging_configuration)
|
4169
4335
|
SENSITIVE = []
|
4170
4336
|
include Aws::Structure
|
4171
4337
|
end
|
@@ -4372,7 +4538,14 @@ module Aws::Imagebuilder
|
|
4372
4538
|
# @return [String]
|
4373
4539
|
#
|
4374
4540
|
# @!attribute [rw] kms_key_id
|
4375
|
-
# The
|
4541
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the KMS key
|
4542
|
+
# used to encrypt this component. This can be either the Key ARN or
|
4543
|
+
# the Alias ARN. For more information, see [Key identifiers
|
4544
|
+
# (KeyId)][1] in the *Key Management Service Developer Guide*.
|
4545
|
+
#
|
4546
|
+
#
|
4547
|
+
#
|
4548
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
4376
4549
|
# @return [String]
|
4377
4550
|
#
|
4378
4551
|
# @!attribute [rw] tags
|
@@ -4473,6 +4646,10 @@ module Aws::Imagebuilder
|
|
4473
4646
|
# The `uri` of the ISO disk file that's stored in Amazon S3.
|
4474
4647
|
# @return [String]
|
4475
4648
|
#
|
4649
|
+
# @!attribute [rw] logging_configuration
|
4650
|
+
# Define logging configuration for the image build process.
|
4651
|
+
# @return [Types::ImageLoggingConfiguration]
|
4652
|
+
#
|
4476
4653
|
# @!attribute [rw] tags
|
4477
4654
|
# Tags that are attached to image resources created from the import.
|
4478
4655
|
# @return [Hash<String,String>]
|
@@ -4501,6 +4678,7 @@ module Aws::Imagebuilder
|
|
4501
4678
|
:execution_role,
|
4502
4679
|
:infrastructure_configuration_arn,
|
4503
4680
|
:uri,
|
4681
|
+
:logging_configuration,
|
4504
4682
|
:tags,
|
4505
4683
|
:client_token)
|
4506
4684
|
SENSITIVE = []
|
@@ -4571,6 +4749,10 @@ module Aws::Imagebuilder
|
|
4571
4749
|
# as the base image for your recipe.
|
4572
4750
|
# @return [String]
|
4573
4751
|
#
|
4752
|
+
# @!attribute [rw] logging_configuration
|
4753
|
+
# Define logging configuration for the image build process.
|
4754
|
+
# @return [Types::ImageLoggingConfiguration]
|
4755
|
+
#
|
4574
4756
|
# @!attribute [rw] tags
|
4575
4757
|
# Tags that are attached to the import resources.
|
4576
4758
|
# @return [Hash<String,String>]
|
@@ -4597,6 +4779,7 @@ module Aws::Imagebuilder
|
|
4597
4779
|
:platform,
|
4598
4780
|
:os_version,
|
4599
4781
|
:vm_import_task_id,
|
4782
|
+
:logging_configuration,
|
4600
4783
|
:tags,
|
4601
4784
|
:client_token)
|
4602
4785
|
SENSITIVE = []
|
@@ -5661,7 +5844,7 @@ module Aws::Imagebuilder
|
|
5661
5844
|
# @return [String]
|
5662
5845
|
#
|
5663
5846
|
# @!attribute [rw] max_results
|
5664
|
-
#
|
5847
|
+
# Specify the maximum number of items to return in a request.
|
5665
5848
|
# @return [Integer]
|
5666
5849
|
#
|
5667
5850
|
# @!attribute [rw] next_token
|
@@ -5733,7 +5916,7 @@ module Aws::Imagebuilder
|
|
5733
5916
|
# @return [Boolean]
|
5734
5917
|
#
|
5735
5918
|
# @!attribute [rw] max_results
|
5736
|
-
#
|
5919
|
+
# Specify the maximum number of items to return in a request.
|
5737
5920
|
# @return [Integer]
|
5738
5921
|
#
|
5739
5922
|
# @!attribute [rw] next_token
|
@@ -5803,7 +5986,7 @@ module Aws::Imagebuilder
|
|
5803
5986
|
# @return [Array<Types::Filter>]
|
5804
5987
|
#
|
5805
5988
|
# @!attribute [rw] max_results
|
5806
|
-
#
|
5989
|
+
# Specify the maximum number of items to return in a request.
|
5807
5990
|
# @return [Integer]
|
5808
5991
|
#
|
5809
5992
|
# @!attribute [rw] next_token
|
@@ -5852,7 +6035,7 @@ module Aws::Imagebuilder
|
|
5852
6035
|
# @return [Array<Types::Filter>]
|
5853
6036
|
#
|
5854
6037
|
# @!attribute [rw] max_results
|
5855
|
-
#
|
6038
|
+
# Specify the maximum number of items to return in a request.
|
5856
6039
|
# @return [Integer]
|
5857
6040
|
#
|
5858
6041
|
# @!attribute [rw] next_token
|
@@ -5915,7 +6098,7 @@ module Aws::Imagebuilder
|
|
5915
6098
|
# @return [Array<Types::Filter>]
|
5916
6099
|
#
|
5917
6100
|
# @!attribute [rw] max_results
|
5918
|
-
#
|
6101
|
+
# Specify the maximum number of items to return in a request.
|
5919
6102
|
# @return [Integer]
|
5920
6103
|
#
|
5921
6104
|
# @!attribute [rw] next_token
|
@@ -5965,7 +6148,7 @@ module Aws::Imagebuilder
|
|
5965
6148
|
# @return [String]
|
5966
6149
|
#
|
5967
6150
|
# @!attribute [rw] max_results
|
5968
|
-
#
|
6151
|
+
# Specify the maximum number of items to return in a request.
|
5969
6152
|
# @return [Integer]
|
5970
6153
|
#
|
5971
6154
|
# @!attribute [rw] next_token
|
@@ -6022,7 +6205,7 @@ module Aws::Imagebuilder
|
|
6022
6205
|
# @return [Array<Types::Filter>]
|
6023
6206
|
#
|
6024
6207
|
# @!attribute [rw] max_results
|
6025
|
-
#
|
6208
|
+
# Specify the maximum number of items to return in a request.
|
6026
6209
|
# @return [Integer]
|
6027
6210
|
#
|
6028
6211
|
# @!attribute [rw] next_token
|
@@ -6083,7 +6266,7 @@ module Aws::Imagebuilder
|
|
6083
6266
|
# @return [Array<Types::Filter>]
|
6084
6267
|
#
|
6085
6268
|
# @!attribute [rw] max_results
|
6086
|
-
#
|
6269
|
+
# Specify the maximum number of items to return in a request.
|
6087
6270
|
# @return [Integer]
|
6088
6271
|
#
|
6089
6272
|
# @!attribute [rw] next_token
|
@@ -6127,11 +6310,10 @@ module Aws::Imagebuilder
|
|
6127
6310
|
end
|
6128
6311
|
|
6129
6312
|
# @!attribute [rw] owner
|
6130
|
-
#
|
6131
|
-
# this request will only show image recipes owned by your
|
6132
|
-
#
|
6133
|
-
#
|
6134
|
-
# shared with you by other customers.
|
6313
|
+
# You can specify the recipe owner to filter results by that owner. By
|
6314
|
+
# default, this request will only show image recipes owned by your
|
6315
|
+
# account. To filter by a different owner, specify one of the `Valid
|
6316
|
+
# Values` that are listed for this parameter.
|
6135
6317
|
# @return [String]
|
6136
6318
|
#
|
6137
6319
|
# @!attribute [rw] filters
|
@@ -6145,7 +6327,7 @@ module Aws::Imagebuilder
|
|
6145
6327
|
# @return [Array<Types::Filter>]
|
6146
6328
|
#
|
6147
6329
|
# @!attribute [rw] max_results
|
6148
|
-
#
|
6330
|
+
# Specify the maximum number of items to return in a request.
|
6149
6331
|
# @return [Integer]
|
6150
6332
|
#
|
6151
6333
|
# @!attribute [rw] next_token
|
@@ -6169,7 +6351,10 @@ module Aws::Imagebuilder
|
|
6169
6351
|
# @return [String]
|
6170
6352
|
#
|
6171
6353
|
# @!attribute [rw] image_recipe_summary_list
|
6172
|
-
#
|
6354
|
+
# A list of `ImageRecipeSummary` objects that contain identifying
|
6355
|
+
# characteristics for the image recipe, such as the name, the Amazon
|
6356
|
+
# Resource Name (ARN), and the date created, along with other key
|
6357
|
+
# details.
|
6173
6358
|
# @return [Array<Types::ImageRecipeSummary>]
|
6174
6359
|
#
|
6175
6360
|
# @!attribute [rw] next_token
|
@@ -6275,7 +6460,7 @@ module Aws::Imagebuilder
|
|
6275
6460
|
# @return [Array<Types::ImageScanFindingsFilter>]
|
6276
6461
|
#
|
6277
6462
|
# @!attribute [rw] max_results
|
6278
|
-
#
|
6463
|
+
# Specify the maximum number of items to return in a request.
|
6279
6464
|
# @return [Integer]
|
6280
6465
|
#
|
6281
6466
|
# @!attribute [rw] next_token
|
@@ -6346,7 +6531,7 @@ module Aws::Imagebuilder
|
|
6346
6531
|
# @return [Boolean]
|
6347
6532
|
#
|
6348
6533
|
# @!attribute [rw] max_results
|
6349
|
-
#
|
6534
|
+
# Specify the maximum number of items to return in a request.
|
6350
6535
|
# @return [Integer]
|
6351
6536
|
#
|
6352
6537
|
# @!attribute [rw] next_token
|
@@ -6413,7 +6598,7 @@ module Aws::Imagebuilder
|
|
6413
6598
|
# @return [Array<Types::Filter>]
|
6414
6599
|
#
|
6415
6600
|
# @!attribute [rw] max_results
|
6416
|
-
#
|
6601
|
+
# Specify the maximum number of items to return in a request.
|
6417
6602
|
# @return [Integer]
|
6418
6603
|
#
|
6419
6604
|
# @!attribute [rw] next_token
|
@@ -6473,7 +6658,7 @@ module Aws::Imagebuilder
|
|
6473
6658
|
# @return [String]
|
6474
6659
|
#
|
6475
6660
|
# @!attribute [rw] max_results
|
6476
|
-
#
|
6661
|
+
# Specify the maximum number of items to return in a request.
|
6477
6662
|
# @return [Integer]
|
6478
6663
|
#
|
6479
6664
|
# @!attribute [rw] next_token
|
@@ -6524,7 +6709,7 @@ module Aws::Imagebuilder
|
|
6524
6709
|
end
|
6525
6710
|
|
6526
6711
|
# @!attribute [rw] max_results
|
6527
|
-
#
|
6712
|
+
# Specify the maximum number of items to return in a request.
|
6528
6713
|
# @return [Integer]
|
6529
6714
|
#
|
6530
6715
|
# @!attribute [rw] next_token
|
@@ -6573,7 +6758,7 @@ module Aws::Imagebuilder
|
|
6573
6758
|
# @return [Array<Types::Filter>]
|
6574
6759
|
#
|
6575
6760
|
# @!attribute [rw] max_results
|
6576
|
-
#
|
6761
|
+
# Specify the maximum number of items to return in a request.
|
6577
6762
|
# @return [Integer]
|
6578
6763
|
#
|
6579
6764
|
# @!attribute [rw] next_token
|
@@ -6638,7 +6823,7 @@ module Aws::Imagebuilder
|
|
6638
6823
|
end
|
6639
6824
|
|
6640
6825
|
# @!attribute [rw] max_results
|
6641
|
-
#
|
6826
|
+
# Specify the maximum number of items to return in a request.
|
6642
6827
|
# @return [Integer]
|
6643
6828
|
#
|
6644
6829
|
# @!attribute [rw] next_token
|
@@ -6682,7 +6867,7 @@ module Aws::Imagebuilder
|
|
6682
6867
|
# @return [String]
|
6683
6868
|
#
|
6684
6869
|
# @!attribute [rw] max_results
|
6685
|
-
#
|
6870
|
+
# Specify the maximum number of items to return in a request.
|
6686
6871
|
# @return [Integer]
|
6687
6872
|
#
|
6688
6873
|
# @!attribute [rw] next_token
|
@@ -6722,7 +6907,7 @@ module Aws::Imagebuilder
|
|
6722
6907
|
end
|
6723
6908
|
|
6724
6909
|
# @!attribute [rw] max_results
|
6725
|
-
#
|
6910
|
+
# Specify the maximum number of items to return in a request.
|
6726
6911
|
# @return [Integer]
|
6727
6912
|
#
|
6728
6913
|
# @!attribute [rw] next_token
|
@@ -6783,7 +6968,7 @@ module Aws::Imagebuilder
|
|
6783
6968
|
end
|
6784
6969
|
|
6785
6970
|
# @!attribute [rw] max_results
|
6786
|
-
#
|
6971
|
+
# Specify the maximum number of items to return in a request.
|
6787
6972
|
# @return [Integer]
|
6788
6973
|
#
|
6789
6974
|
# @!attribute [rw] next_token
|
@@ -6869,7 +7054,7 @@ module Aws::Imagebuilder
|
|
6869
7054
|
# @return [Boolean]
|
6870
7055
|
#
|
6871
7056
|
# @!attribute [rw] max_results
|
6872
|
-
#
|
7057
|
+
# Specify the maximum number of items to return in a request.
|
6873
7058
|
# @return [Integer]
|
6874
7059
|
#
|
6875
7060
|
# @!attribute [rw] next_token
|
@@ -7007,6 +7192,29 @@ module Aws::Imagebuilder
|
|
7007
7192
|
include Aws::Structure
|
7008
7193
|
end
|
7009
7194
|
|
7195
|
+
# The logging configuration that's defined for pipeline execution.
|
7196
|
+
#
|
7197
|
+
# @!attribute [rw] image_log_group_name
|
7198
|
+
# The log group name that Image Builder uses for image creation. If
|
7199
|
+
# not specified, the log group name defaults to
|
7200
|
+
# `/aws/imagebuilder/image-name`.
|
7201
|
+
# @return [String]
|
7202
|
+
#
|
7203
|
+
# @!attribute [rw] pipeline_log_group_name
|
7204
|
+
# The log group name that Image Builder uses for the log output during
|
7205
|
+
# creation of a new pipeline. If not specified, the pipeline log group
|
7206
|
+
# name defaults to `/aws/imagebuilder/pipeline/pipeline-name`.
|
7207
|
+
# @return [String]
|
7208
|
+
#
|
7209
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PipelineLoggingConfiguration AWS API Documentation
|
7210
|
+
#
|
7211
|
+
class PipelineLoggingConfiguration < Struct.new(
|
7212
|
+
:image_log_group_name,
|
7213
|
+
:pipeline_log_group_name)
|
7214
|
+
SENSITIVE = []
|
7215
|
+
include Aws::Structure
|
7216
|
+
end
|
7217
|
+
|
7010
7218
|
# By default, EC2 instances run on shared tenancy hardware. This means
|
7011
7219
|
# that multiple Amazon Web Services accounts might share the same
|
7012
7220
|
# physical hardware. When you use dedicated hardware, the physical
|
@@ -7482,12 +7690,18 @@ module Aws::Imagebuilder
|
|
7482
7690
|
# [1]: https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html
|
7483
7691
|
# @return [String]
|
7484
7692
|
#
|
7693
|
+
# @!attribute [rw] auto_disable_policy
|
7694
|
+
# The policy that configures when Image Builder should automatically
|
7695
|
+
# disable a pipeline that is failing.
|
7696
|
+
# @return [Types::AutoDisablePolicy]
|
7697
|
+
#
|
7485
7698
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Schedule AWS API Documentation
|
7486
7699
|
#
|
7487
7700
|
class Schedule < Struct.new(
|
7488
7701
|
:schedule_expression,
|
7489
7702
|
:timezone,
|
7490
|
-
:pipeline_execution_start_condition
|
7703
|
+
:pipeline_execution_start_condition,
|
7704
|
+
:auto_disable_policy)
|
7491
7705
|
SENSITIVE = []
|
7492
7706
|
include Aws::Structure
|
7493
7707
|
end
|
@@ -7684,11 +7898,17 @@ module Aws::Imagebuilder
|
|
7684
7898
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
7685
7899
|
# @return [String]
|
7686
7900
|
#
|
7901
|
+
# @!attribute [rw] tags
|
7902
|
+
# Specify tags for Image Builder to apply to the image resource
|
7903
|
+
# that's created When it starts pipeline execution.
|
7904
|
+
# @return [Hash<String,String>]
|
7905
|
+
#
|
7687
7906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/StartImagePipelineExecutionRequest AWS API Documentation
|
7688
7907
|
#
|
7689
7908
|
class StartImagePipelineExecutionRequest < Struct.new(
|
7690
7909
|
:image_pipeline_arn,
|
7691
|
-
:client_token
|
7910
|
+
:client_token,
|
7911
|
+
:tags)
|
7692
7912
|
SENSITIVE = []
|
7693
7913
|
include Aws::Structure
|
7694
7914
|
end
|
@@ -7798,7 +8018,10 @@ module Aws::Imagebuilder
|
|
7798
8018
|
# final build image, prior to creating the new AMI. If this is set to
|
7799
8019
|
# true, then the agent is removed from the final image. If it's set
|
7800
8020
|
# to false, then the agent is left in, so that it is included in the
|
7801
|
-
# new AMI.
|
8021
|
+
# new AMI. default value is false.
|
8022
|
+
#
|
8023
|
+
# The default behavior of uninstallAfterBuild is to remove the SSM
|
8024
|
+
# Agent if it was installed by EC2 Image Builder
|
7802
8025
|
# @return [Boolean]
|
7803
8026
|
#
|
7804
8027
|
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/SystemsManagerAgent AWS API Documentation
|
@@ -8003,6 +8226,11 @@ module Aws::Imagebuilder
|
|
8003
8226
|
# Contains the workflows to run for the pipeline.
|
8004
8227
|
# @return [Array<Types::WorkflowConfiguration>]
|
8005
8228
|
#
|
8229
|
+
# @!attribute [rw] logging_configuration
|
8230
|
+
# Update logging configuration for the output image that's created
|
8231
|
+
# when the pipeline runs.
|
8232
|
+
# @return [Types::PipelineLoggingConfiguration]
|
8233
|
+
#
|
8006
8234
|
# @!attribute [rw] execution_role
|
8007
8235
|
# The name or Amazon Resource Name (ARN) for the IAM role you create
|
8008
8236
|
# that grants Image Builder access to perform workflow actions.
|
@@ -8024,6 +8252,7 @@ module Aws::Imagebuilder
|
|
8024
8252
|
:client_token,
|
8025
8253
|
:image_scanning_configuration,
|
8026
8254
|
:workflows,
|
8255
|
+
:logging_configuration,
|
8027
8256
|
:execution_role)
|
8028
8257
|
SENSITIVE = []
|
8029
8258
|
include Aws::Structure
|
@@ -8392,7 +8621,14 @@ module Aws::Imagebuilder
|
|
8392
8621
|
# @return [String]
|
8393
8622
|
#
|
8394
8623
|
# @!attribute [rw] kms_key_id
|
8395
|
-
# The KMS key identifier used to encrypt the workflow resource.
|
8624
|
+
# The KMS key identifier used to encrypt the workflow resource. This
|
8625
|
+
# can be either the Key ARN or the Alias ARN. For more information,
|
8626
|
+
# see [Key identifiers (KeyId)][1] in the *Key Management Service
|
8627
|
+
# Developer Guide*.
|
8628
|
+
#
|
8629
|
+
#
|
8630
|
+
#
|
8631
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
8396
8632
|
# @return [String]
|
8397
8633
|
#
|
8398
8634
|
# @!attribute [rw] date_created
|