aws-sdk-imagebuilder 1.0.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 +7 -0
- data/lib/aws-sdk-imagebuilder.rb +47 -0
- data/lib/aws-sdk-imagebuilder/client.rb +2526 -0
- data/lib/aws-sdk-imagebuilder/client_api.rb +1640 -0
- data/lib/aws-sdk-imagebuilder/customizations.rb +0 -0
- data/lib/aws-sdk-imagebuilder/errors.rb +270 -0
- data/lib/aws-sdk-imagebuilder/resource.rb +23 -0
- data/lib/aws-sdk-imagebuilder/types.rb +3823 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,270 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::Imagebuilder
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
class CallRateLimitExceededException < ServiceError
|
14
|
+
|
15
|
+
# @param [Seahorse::Client::RequestContext] context
|
16
|
+
# @param [String] message
|
17
|
+
# @param [Aws::Imagebuilder::Types::CallRateLimitExceededException] data
|
18
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
19
|
+
super(context, message, data)
|
20
|
+
end
|
21
|
+
|
22
|
+
# @return [String]
|
23
|
+
def message
|
24
|
+
@message || @data[:message]
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
|
29
|
+
class ClientException < ServiceError
|
30
|
+
|
31
|
+
# @param [Seahorse::Client::RequestContext] context
|
32
|
+
# @param [String] message
|
33
|
+
# @param [Aws::Imagebuilder::Types::ClientException] data
|
34
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
35
|
+
super(context, message, data)
|
36
|
+
end
|
37
|
+
|
38
|
+
# @return [String]
|
39
|
+
def message
|
40
|
+
@message || @data[:message]
|
41
|
+
end
|
42
|
+
|
43
|
+
end
|
44
|
+
|
45
|
+
class ForbiddenException < ServiceError
|
46
|
+
|
47
|
+
# @param [Seahorse::Client::RequestContext] context
|
48
|
+
# @param [String] message
|
49
|
+
# @param [Aws::Imagebuilder::Types::ForbiddenException] data
|
50
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
51
|
+
super(context, message, data)
|
52
|
+
end
|
53
|
+
|
54
|
+
# @return [String]
|
55
|
+
def message
|
56
|
+
@message || @data[:message]
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|
60
|
+
|
61
|
+
class IdempotentParameterMismatchException < ServiceError
|
62
|
+
|
63
|
+
# @param [Seahorse::Client::RequestContext] context
|
64
|
+
# @param [String] message
|
65
|
+
# @param [Aws::Imagebuilder::Types::IdempotentParameterMismatchException] data
|
66
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
67
|
+
super(context, message, data)
|
68
|
+
end
|
69
|
+
|
70
|
+
# @return [String]
|
71
|
+
def message
|
72
|
+
@message || @data[:message]
|
73
|
+
end
|
74
|
+
|
75
|
+
end
|
76
|
+
|
77
|
+
class InvalidPaginationTokenException < ServiceError
|
78
|
+
|
79
|
+
# @param [Seahorse::Client::RequestContext] context
|
80
|
+
# @param [String] message
|
81
|
+
# @param [Aws::Imagebuilder::Types::InvalidPaginationTokenException] data
|
82
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
83
|
+
super(context, message, data)
|
84
|
+
end
|
85
|
+
|
86
|
+
# @return [String]
|
87
|
+
def message
|
88
|
+
@message || @data[:message]
|
89
|
+
end
|
90
|
+
|
91
|
+
end
|
92
|
+
|
93
|
+
class InvalidParameterCombinationException < ServiceError
|
94
|
+
|
95
|
+
# @param [Seahorse::Client::RequestContext] context
|
96
|
+
# @param [String] message
|
97
|
+
# @param [Aws::Imagebuilder::Types::InvalidParameterCombinationException] data
|
98
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
99
|
+
super(context, message, data)
|
100
|
+
end
|
101
|
+
|
102
|
+
# @return [String]
|
103
|
+
def message
|
104
|
+
@message || @data[:message]
|
105
|
+
end
|
106
|
+
|
107
|
+
end
|
108
|
+
|
109
|
+
class InvalidParameterException < ServiceError
|
110
|
+
|
111
|
+
# @param [Seahorse::Client::RequestContext] context
|
112
|
+
# @param [String] message
|
113
|
+
# @param [Aws::Imagebuilder::Types::InvalidParameterException] data
|
114
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
115
|
+
super(context, message, data)
|
116
|
+
end
|
117
|
+
|
118
|
+
# @return [String]
|
119
|
+
def message
|
120
|
+
@message || @data[:message]
|
121
|
+
end
|
122
|
+
|
123
|
+
end
|
124
|
+
|
125
|
+
class InvalidParameterValueException < ServiceError
|
126
|
+
|
127
|
+
# @param [Seahorse::Client::RequestContext] context
|
128
|
+
# @param [String] message
|
129
|
+
# @param [Aws::Imagebuilder::Types::InvalidParameterValueException] data
|
130
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
131
|
+
super(context, message, data)
|
132
|
+
end
|
133
|
+
|
134
|
+
# @return [String]
|
135
|
+
def message
|
136
|
+
@message || @data[:message]
|
137
|
+
end
|
138
|
+
|
139
|
+
end
|
140
|
+
|
141
|
+
class InvalidRequestException < ServiceError
|
142
|
+
|
143
|
+
# @param [Seahorse::Client::RequestContext] context
|
144
|
+
# @param [String] message
|
145
|
+
# @param [Aws::Imagebuilder::Types::InvalidRequestException] data
|
146
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
147
|
+
super(context, message, data)
|
148
|
+
end
|
149
|
+
|
150
|
+
# @return [String]
|
151
|
+
def message
|
152
|
+
@message || @data[:message]
|
153
|
+
end
|
154
|
+
|
155
|
+
end
|
156
|
+
|
157
|
+
class InvalidVersionNumberException < ServiceError
|
158
|
+
|
159
|
+
# @param [Seahorse::Client::RequestContext] context
|
160
|
+
# @param [String] message
|
161
|
+
# @param [Aws::Imagebuilder::Types::InvalidVersionNumberException] data
|
162
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
163
|
+
super(context, message, data)
|
164
|
+
end
|
165
|
+
|
166
|
+
# @return [String]
|
167
|
+
def message
|
168
|
+
@message || @data[:message]
|
169
|
+
end
|
170
|
+
|
171
|
+
end
|
172
|
+
|
173
|
+
class ResourceAlreadyExistsException < ServiceError
|
174
|
+
|
175
|
+
# @param [Seahorse::Client::RequestContext] context
|
176
|
+
# @param [String] message
|
177
|
+
# @param [Aws::Imagebuilder::Types::ResourceAlreadyExistsException] data
|
178
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
179
|
+
super(context, message, data)
|
180
|
+
end
|
181
|
+
|
182
|
+
# @return [String]
|
183
|
+
def message
|
184
|
+
@message || @data[:message]
|
185
|
+
end
|
186
|
+
|
187
|
+
end
|
188
|
+
|
189
|
+
class ResourceDependencyException < ServiceError
|
190
|
+
|
191
|
+
# @param [Seahorse::Client::RequestContext] context
|
192
|
+
# @param [String] message
|
193
|
+
# @param [Aws::Imagebuilder::Types::ResourceDependencyException] data
|
194
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
195
|
+
super(context, message, data)
|
196
|
+
end
|
197
|
+
|
198
|
+
# @return [String]
|
199
|
+
def message
|
200
|
+
@message || @data[:message]
|
201
|
+
end
|
202
|
+
|
203
|
+
end
|
204
|
+
|
205
|
+
class ResourceInUseException < ServiceError
|
206
|
+
|
207
|
+
# @param [Seahorse::Client::RequestContext] context
|
208
|
+
# @param [String] message
|
209
|
+
# @param [Aws::Imagebuilder::Types::ResourceInUseException] data
|
210
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
211
|
+
super(context, message, data)
|
212
|
+
end
|
213
|
+
|
214
|
+
# @return [String]
|
215
|
+
def message
|
216
|
+
@message || @data[:message]
|
217
|
+
end
|
218
|
+
|
219
|
+
end
|
220
|
+
|
221
|
+
class ResourceNotFoundException < ServiceError
|
222
|
+
|
223
|
+
# @param [Seahorse::Client::RequestContext] context
|
224
|
+
# @param [String] message
|
225
|
+
# @param [Aws::Imagebuilder::Types::ResourceNotFoundException] data
|
226
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
227
|
+
super(context, message, data)
|
228
|
+
end
|
229
|
+
|
230
|
+
# @return [String]
|
231
|
+
def message
|
232
|
+
@message || @data[:message]
|
233
|
+
end
|
234
|
+
|
235
|
+
end
|
236
|
+
|
237
|
+
class ServiceException < ServiceError
|
238
|
+
|
239
|
+
# @param [Seahorse::Client::RequestContext] context
|
240
|
+
# @param [String] message
|
241
|
+
# @param [Aws::Imagebuilder::Types::ServiceException] data
|
242
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
243
|
+
super(context, message, data)
|
244
|
+
end
|
245
|
+
|
246
|
+
# @return [String]
|
247
|
+
def message
|
248
|
+
@message || @data[:message]
|
249
|
+
end
|
250
|
+
|
251
|
+
end
|
252
|
+
|
253
|
+
class ServiceUnavailableException < ServiceError
|
254
|
+
|
255
|
+
# @param [Seahorse::Client::RequestContext] context
|
256
|
+
# @param [String] message
|
257
|
+
# @param [Aws::Imagebuilder::Types::ServiceUnavailableException] data
|
258
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
259
|
+
super(context, message, data)
|
260
|
+
end
|
261
|
+
|
262
|
+
# @return [String]
|
263
|
+
def message
|
264
|
+
@message || @data[:message]
|
265
|
+
end
|
266
|
+
|
267
|
+
end
|
268
|
+
|
269
|
+
end
|
270
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::Imagebuilder
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,3823 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::Imagebuilder
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# Details of an EC2 AMI.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] region
|
14
|
+
# The region of the EC2 AMI.
|
15
|
+
# @return [String]
|
16
|
+
#
|
17
|
+
# @!attribute [rw] image
|
18
|
+
# The AMI ID of the EC2 AMI.
|
19
|
+
# @return [String]
|
20
|
+
#
|
21
|
+
# @!attribute [rw] name
|
22
|
+
# The name of the EC2 AMI.
|
23
|
+
# @return [String]
|
24
|
+
#
|
25
|
+
# @!attribute [rw] description
|
26
|
+
# The description of the EC2 AMI.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] state
|
30
|
+
# Image state shows the images status and the reason for that status.
|
31
|
+
# @return [Types::ImageState]
|
32
|
+
#
|
33
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Ami AWS API Documentation
|
34
|
+
#
|
35
|
+
class Ami < Struct.new(
|
36
|
+
:region,
|
37
|
+
:image,
|
38
|
+
:name,
|
39
|
+
:description,
|
40
|
+
:state)
|
41
|
+
include Aws::Structure
|
42
|
+
end
|
43
|
+
|
44
|
+
# Define and configure the outputs AMIs of the pipeline.
|
45
|
+
#
|
46
|
+
# @note When making an API call, you may pass AmiDistributionConfiguration
|
47
|
+
# data as a hash:
|
48
|
+
#
|
49
|
+
# {
|
50
|
+
# name: "NonEmptyString",
|
51
|
+
# description: "NonEmptyString",
|
52
|
+
# ami_tags: {
|
53
|
+
# "TagKey" => "TagValue",
|
54
|
+
# },
|
55
|
+
# launch_permission: {
|
56
|
+
# user_ids: ["NonEmptyString"],
|
57
|
+
# user_groups: ["NonEmptyString"],
|
58
|
+
# },
|
59
|
+
# }
|
60
|
+
#
|
61
|
+
# @!attribute [rw] name
|
62
|
+
# The name of the distribution configuration.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] description
|
66
|
+
# The description of the distribution configuration.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] ami_tags
|
70
|
+
# The tags to apply to AMIs distributed to this region.
|
71
|
+
# @return [Hash<String,String>]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] launch_permission
|
74
|
+
# Launch permissions can be used to configure which AWS accounts can
|
75
|
+
# use the AMI to launch instances.
|
76
|
+
# @return [Types::LaunchPermissionConfiguration]
|
77
|
+
#
|
78
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/AmiDistributionConfiguration AWS API Documentation
|
79
|
+
#
|
80
|
+
class AmiDistributionConfiguration < Struct.new(
|
81
|
+
:name,
|
82
|
+
:description,
|
83
|
+
:ami_tags,
|
84
|
+
:launch_permission)
|
85
|
+
include Aws::Structure
|
86
|
+
end
|
87
|
+
|
88
|
+
# You have exceeded the permitted request rate for the specific
|
89
|
+
# operation.
|
90
|
+
#
|
91
|
+
# @!attribute [rw] message
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CallRateLimitExceededException AWS API Documentation
|
95
|
+
#
|
96
|
+
class CallRateLimitExceededException < Struct.new(
|
97
|
+
:message)
|
98
|
+
include Aws::Structure
|
99
|
+
end
|
100
|
+
|
101
|
+
# @note When making an API call, you may pass CancelImageCreationRequest
|
102
|
+
# data as a hash:
|
103
|
+
#
|
104
|
+
# {
|
105
|
+
# image_build_version_arn: "ImageBuildVersionArn", # required
|
106
|
+
# client_token: "ClientToken", # required
|
107
|
+
# }
|
108
|
+
#
|
109
|
+
# @!attribute [rw] image_build_version_arn
|
110
|
+
# The Amazon Resource Name (ARN) of the image whose creation you wish
|
111
|
+
# to cancel.
|
112
|
+
# @return [String]
|
113
|
+
#
|
114
|
+
# @!attribute [rw] client_token
|
115
|
+
# The idempotency token used to make this request idempotent.
|
116
|
+
# @return [String]
|
117
|
+
#
|
118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CancelImageCreationRequest AWS API Documentation
|
119
|
+
#
|
120
|
+
class CancelImageCreationRequest < Struct.new(
|
121
|
+
:image_build_version_arn,
|
122
|
+
:client_token)
|
123
|
+
include Aws::Structure
|
124
|
+
end
|
125
|
+
|
126
|
+
# @!attribute [rw] request_id
|
127
|
+
# The request ID that uniquely identifies this request.
|
128
|
+
# @return [String]
|
129
|
+
#
|
130
|
+
# @!attribute [rw] client_token
|
131
|
+
# The idempotency token used to make this request idempotent.
|
132
|
+
# @return [String]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] image_build_version_arn
|
135
|
+
# The Amazon Resource Name (ARN) of the image whose creation has been
|
136
|
+
# cancelled.
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CancelImageCreationResponse AWS API Documentation
|
140
|
+
#
|
141
|
+
class CancelImageCreationResponse < Struct.new(
|
142
|
+
:request_id,
|
143
|
+
:client_token,
|
144
|
+
:image_build_version_arn)
|
145
|
+
include Aws::Structure
|
146
|
+
end
|
147
|
+
|
148
|
+
# These errors are usually caused by a client action, such as using an
|
149
|
+
# action or resource on behalf of a user that doesn't have permissions
|
150
|
+
# to use the action or resource, or specifying an invalid resource
|
151
|
+
# identifier.
|
152
|
+
#
|
153
|
+
# @!attribute [rw] message
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ClientException AWS API Documentation
|
157
|
+
#
|
158
|
+
class ClientException < Struct.new(
|
159
|
+
:message)
|
160
|
+
include Aws::Structure
|
161
|
+
end
|
162
|
+
|
163
|
+
# A detailed view of a component.
|
164
|
+
#
|
165
|
+
# @!attribute [rw] arn
|
166
|
+
# The Amazon Resource Name (ARN) of the component.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] name
|
170
|
+
# The name of the component.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] version
|
174
|
+
# The version of the component.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] description
|
178
|
+
# The description of the component.
|
179
|
+
# @return [String]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] change_description
|
182
|
+
# The change description of the component.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @!attribute [rw] type
|
186
|
+
# The type of the component denotes whether the component is used to
|
187
|
+
# build the image or only to test it.
|
188
|
+
# @return [String]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] platform
|
191
|
+
# The platform of the component.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] owner
|
195
|
+
# The owner of the component.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] data
|
199
|
+
# The data of the component.
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] kms_key_id
|
203
|
+
# The KMS key identifier used to encrypt the component.
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @!attribute [rw] encrypted
|
207
|
+
# The encryption status of the component.
|
208
|
+
# @return [Boolean]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] date_created
|
211
|
+
# The date that the component was created.
|
212
|
+
# @return [String]
|
213
|
+
#
|
214
|
+
# @!attribute [rw] tags
|
215
|
+
# The tags associated with the component.
|
216
|
+
# @return [Hash<String,String>]
|
217
|
+
#
|
218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Component AWS API Documentation
|
219
|
+
#
|
220
|
+
class Component < Struct.new(
|
221
|
+
:arn,
|
222
|
+
:name,
|
223
|
+
:version,
|
224
|
+
:description,
|
225
|
+
:change_description,
|
226
|
+
:type,
|
227
|
+
:platform,
|
228
|
+
:owner,
|
229
|
+
:data,
|
230
|
+
:kms_key_id,
|
231
|
+
:encrypted,
|
232
|
+
:date_created,
|
233
|
+
:tags)
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
237
|
+
# Configuration details of the component.
|
238
|
+
#
|
239
|
+
# @note When making an API call, you may pass ComponentConfiguration
|
240
|
+
# data as a hash:
|
241
|
+
#
|
242
|
+
# {
|
243
|
+
# component_arn: "ComponentBuildVersionArn", # required
|
244
|
+
# }
|
245
|
+
#
|
246
|
+
# @!attribute [rw] component_arn
|
247
|
+
# The Amazon Resource Name (ARN) of the component.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ComponentConfiguration AWS API Documentation
|
251
|
+
#
|
252
|
+
class ComponentConfiguration < Struct.new(
|
253
|
+
:component_arn)
|
254
|
+
include Aws::Structure
|
255
|
+
end
|
256
|
+
|
257
|
+
# A high level summary of a component.
|
258
|
+
#
|
259
|
+
# @!attribute [rw] arn
|
260
|
+
# The Amazon Resource Name (ARN) of the component.
|
261
|
+
# @return [String]
|
262
|
+
#
|
263
|
+
# @!attribute [rw] name
|
264
|
+
# The name of the component.
|
265
|
+
# @return [String]
|
266
|
+
#
|
267
|
+
# @!attribute [rw] version
|
268
|
+
# The version of the component.
|
269
|
+
# @return [String]
|
270
|
+
#
|
271
|
+
# @!attribute [rw] platform
|
272
|
+
# The platform of the component.
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] type
|
276
|
+
# The type of the component denotes whether the component is used to
|
277
|
+
# build the image or only to test it.
|
278
|
+
# @return [String]
|
279
|
+
#
|
280
|
+
# @!attribute [rw] owner
|
281
|
+
# The owner of the component.
|
282
|
+
# @return [String]
|
283
|
+
#
|
284
|
+
# @!attribute [rw] description
|
285
|
+
# The description of the component.
|
286
|
+
# @return [String]
|
287
|
+
#
|
288
|
+
# @!attribute [rw] change_description
|
289
|
+
# The change description of the component.
|
290
|
+
# @return [String]
|
291
|
+
#
|
292
|
+
# @!attribute [rw] date_created
|
293
|
+
# The date that the component was created.
|
294
|
+
# @return [String]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] tags
|
297
|
+
# The tags associated with the component.
|
298
|
+
# @return [Hash<String,String>]
|
299
|
+
#
|
300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ComponentSummary AWS API Documentation
|
301
|
+
#
|
302
|
+
class ComponentSummary < Struct.new(
|
303
|
+
:arn,
|
304
|
+
:name,
|
305
|
+
:version,
|
306
|
+
:platform,
|
307
|
+
:type,
|
308
|
+
:owner,
|
309
|
+
:description,
|
310
|
+
:change_description,
|
311
|
+
:date_created,
|
312
|
+
:tags)
|
313
|
+
include Aws::Structure
|
314
|
+
end
|
315
|
+
|
316
|
+
# A high level overview of a component semantic version.
|
317
|
+
#
|
318
|
+
# @!attribute [rw] arn
|
319
|
+
# The Amazon Resource Name (ARN) of the component.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @!attribute [rw] name
|
323
|
+
# The name of the component.
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] version
|
327
|
+
# The semantic version of the component.
|
328
|
+
# @return [String]
|
329
|
+
#
|
330
|
+
# @!attribute [rw] description
|
331
|
+
# The description of the component.
|
332
|
+
# @return [String]
|
333
|
+
#
|
334
|
+
# @!attribute [rw] platform
|
335
|
+
# The platform of the component.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] type
|
339
|
+
# The type of the component denotes whether the component is used to
|
340
|
+
# build the image or only to test it.
|
341
|
+
# @return [String]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] owner
|
344
|
+
# The owner of the component.
|
345
|
+
# @return [String]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] date_created
|
348
|
+
# The date that the component was created.
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ComponentVersion AWS API Documentation
|
352
|
+
#
|
353
|
+
class ComponentVersion < Struct.new(
|
354
|
+
:arn,
|
355
|
+
:name,
|
356
|
+
:version,
|
357
|
+
:description,
|
358
|
+
:platform,
|
359
|
+
:type,
|
360
|
+
:owner,
|
361
|
+
:date_created)
|
362
|
+
include Aws::Structure
|
363
|
+
end
|
364
|
+
|
365
|
+
# @note When making an API call, you may pass CreateComponentRequest
|
366
|
+
# data as a hash:
|
367
|
+
#
|
368
|
+
# {
|
369
|
+
# name: "ResourceName", # required
|
370
|
+
# semantic_version: "VersionNumber", # required
|
371
|
+
# description: "NonEmptyString",
|
372
|
+
# change_description: "NonEmptyString",
|
373
|
+
# platform: "Windows", # required, accepts Windows, Linux
|
374
|
+
# data: "InlineComponentData",
|
375
|
+
# uri: "Uri",
|
376
|
+
# kms_key_id: "NonEmptyString",
|
377
|
+
# tags: {
|
378
|
+
# "TagKey" => "TagValue",
|
379
|
+
# },
|
380
|
+
# client_token: "ClientToken", # required
|
381
|
+
# }
|
382
|
+
#
|
383
|
+
# @!attribute [rw] name
|
384
|
+
# The name of the component.
|
385
|
+
# @return [String]
|
386
|
+
#
|
387
|
+
# @!attribute [rw] semantic_version
|
388
|
+
# The semantic version of the component. This version to follow the
|
389
|
+
# semantic version syntax. i.e. major.minor.patch. This could be
|
390
|
+
# versioned like software 2.0.1 or date like 2019.12.01.
|
391
|
+
# @return [String]
|
392
|
+
#
|
393
|
+
# @!attribute [rw] description
|
394
|
+
# CThe description of the component. Describes the contents of the
|
395
|
+
# component.
|
396
|
+
# @return [String]
|
397
|
+
#
|
398
|
+
# @!attribute [rw] change_description
|
399
|
+
# CThe change description of the component. Describes what change has
|
400
|
+
# been made in this version. In other words what makes this version
|
401
|
+
# different from other versions of this component.
|
402
|
+
# @return [String]
|
403
|
+
#
|
404
|
+
# @!attribute [rw] platform
|
405
|
+
# CThe platform of the component.
|
406
|
+
# @return [String]
|
407
|
+
#
|
408
|
+
# @!attribute [rw] data
|
409
|
+
# CThe data of the component.
|
410
|
+
# @return [String]
|
411
|
+
#
|
412
|
+
# @!attribute [rw] uri
|
413
|
+
# CThe uri of the component.
|
414
|
+
# @return [String]
|
415
|
+
#
|
416
|
+
# @!attribute [rw] kms_key_id
|
417
|
+
# The ID of the KMS key that should be used to encrypt this component.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] tags
|
421
|
+
# CThe tags of the component.
|
422
|
+
# @return [Hash<String,String>]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] client_token
|
425
|
+
# CThe idempotency token of the component.
|
426
|
+
#
|
427
|
+
# **A suitable default value is auto-generated.** You should normally
|
428
|
+
# not need to pass this option.
|
429
|
+
# @return [String]
|
430
|
+
#
|
431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateComponentRequest AWS API Documentation
|
432
|
+
#
|
433
|
+
class CreateComponentRequest < Struct.new(
|
434
|
+
:name,
|
435
|
+
:semantic_version,
|
436
|
+
:description,
|
437
|
+
:change_description,
|
438
|
+
:platform,
|
439
|
+
:data,
|
440
|
+
:uri,
|
441
|
+
:kms_key_id,
|
442
|
+
:tags,
|
443
|
+
:client_token)
|
444
|
+
include Aws::Structure
|
445
|
+
end
|
446
|
+
|
447
|
+
# @!attribute [rw] request_id
|
448
|
+
# CThe request ID that uniquely identifies this request.
|
449
|
+
# @return [String]
|
450
|
+
#
|
451
|
+
# @!attribute [rw] client_token
|
452
|
+
# CThe idempotency token used to make this request idempotent.
|
453
|
+
# @return [String]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] component_build_version_arn
|
456
|
+
# CThe Amazon Resource Name (ARN) of the component that was created by
|
457
|
+
# this request.
|
458
|
+
# @return [String]
|
459
|
+
#
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateComponentResponse AWS API Documentation
|
461
|
+
#
|
462
|
+
class CreateComponentResponse < Struct.new(
|
463
|
+
:request_id,
|
464
|
+
:client_token,
|
465
|
+
:component_build_version_arn)
|
466
|
+
include Aws::Structure
|
467
|
+
end
|
468
|
+
|
469
|
+
# @note When making an API call, you may pass CreateDistributionConfigurationRequest
|
470
|
+
# data as a hash:
|
471
|
+
#
|
472
|
+
# {
|
473
|
+
# name: "ResourceName", # required
|
474
|
+
# description: "NonEmptyString",
|
475
|
+
# distributions: [ # required
|
476
|
+
# {
|
477
|
+
# region: "NonEmptyString", # required
|
478
|
+
# ami_distribution_configuration: {
|
479
|
+
# name: "NonEmptyString",
|
480
|
+
# description: "NonEmptyString",
|
481
|
+
# ami_tags: {
|
482
|
+
# "TagKey" => "TagValue",
|
483
|
+
# },
|
484
|
+
# launch_permission: {
|
485
|
+
# user_ids: ["NonEmptyString"],
|
486
|
+
# user_groups: ["NonEmptyString"],
|
487
|
+
# },
|
488
|
+
# },
|
489
|
+
# license_configuration_arns: ["Arn"],
|
490
|
+
# },
|
491
|
+
# ],
|
492
|
+
# tags: {
|
493
|
+
# "TagKey" => "TagValue",
|
494
|
+
# },
|
495
|
+
# client_token: "ClientToken", # required
|
496
|
+
# }
|
497
|
+
#
|
498
|
+
# @!attribute [rw] name
|
499
|
+
# The name of the distribution configuration.
|
500
|
+
# @return [String]
|
501
|
+
#
|
502
|
+
# @!attribute [rw] description
|
503
|
+
# The description of the distribution configuration.
|
504
|
+
# @return [String]
|
505
|
+
#
|
506
|
+
# @!attribute [rw] distributions
|
507
|
+
# The distributions of the distribution configuration.
|
508
|
+
# @return [Array<Types::Distribution>]
|
509
|
+
#
|
510
|
+
# @!attribute [rw] tags
|
511
|
+
# The tags of the distribution configuration.
|
512
|
+
# @return [Hash<String,String>]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] client_token
|
515
|
+
# The idempotency token of the distribution configuration.
|
516
|
+
#
|
517
|
+
# **A suitable default value is auto-generated.** You should normally
|
518
|
+
# not need to pass this option.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateDistributionConfigurationRequest AWS API Documentation
|
522
|
+
#
|
523
|
+
class CreateDistributionConfigurationRequest < Struct.new(
|
524
|
+
:name,
|
525
|
+
:description,
|
526
|
+
:distributions,
|
527
|
+
:tags,
|
528
|
+
:client_token)
|
529
|
+
include Aws::Structure
|
530
|
+
end
|
531
|
+
|
532
|
+
# @!attribute [rw] request_id
|
533
|
+
# The request ID that uniquely identifies this request.
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] client_token
|
537
|
+
# The idempotency token used to make this request idempotent.
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] distribution_configuration_arn
|
541
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
542
|
+
# that was created by this request.
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateDistributionConfigurationResponse AWS API Documentation
|
546
|
+
#
|
547
|
+
class CreateDistributionConfigurationResponse < Struct.new(
|
548
|
+
:request_id,
|
549
|
+
:client_token,
|
550
|
+
:distribution_configuration_arn)
|
551
|
+
include Aws::Structure
|
552
|
+
end
|
553
|
+
|
554
|
+
# @note When making an API call, you may pass CreateImagePipelineRequest
|
555
|
+
# data as a hash:
|
556
|
+
#
|
557
|
+
# {
|
558
|
+
# name: "ResourceName", # required
|
559
|
+
# description: "NonEmptyString",
|
560
|
+
# image_recipe_arn: "ImageRecipeArn", # required
|
561
|
+
# infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
|
562
|
+
# distribution_configuration_arn: "DistributionConfigurationArn",
|
563
|
+
# image_tests_configuration: {
|
564
|
+
# image_tests_enabled: false,
|
565
|
+
# timeout_minutes: 1,
|
566
|
+
# },
|
567
|
+
# schedule: {
|
568
|
+
# schedule_expression: "NonEmptyString",
|
569
|
+
# pipeline_execution_start_condition: "EXPRESSION_MATCH_ONLY", # accepts EXPRESSION_MATCH_ONLY, EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
|
570
|
+
# },
|
571
|
+
# status: "DISABLED", # accepts DISABLED, ENABLED
|
572
|
+
# tags: {
|
573
|
+
# "TagKey" => "TagValue",
|
574
|
+
# },
|
575
|
+
# client_token: "ClientToken", # required
|
576
|
+
# }
|
577
|
+
#
|
578
|
+
# @!attribute [rw] name
|
579
|
+
# The name of the image pipeline.
|
580
|
+
# @return [String]
|
581
|
+
#
|
582
|
+
# @!attribute [rw] description
|
583
|
+
# The description of the image pipeline.
|
584
|
+
# @return [String]
|
585
|
+
#
|
586
|
+
# @!attribute [rw] image_recipe_arn
|
587
|
+
# The Amazon Resource Name (ARN) of the image recipe that will be used
|
588
|
+
# to configure images created by this image pipeline.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
592
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
593
|
+
# that will be used to build images created by this image pipeline.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] distribution_configuration_arn
|
597
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
598
|
+
# that will be used to configure and distribute images created by this
|
599
|
+
# image pipeline.
|
600
|
+
# @return [String]
|
601
|
+
#
|
602
|
+
# @!attribute [rw] image_tests_configuration
|
603
|
+
# The image test configuration of the image pipeline.
|
604
|
+
# @return [Types::ImageTestsConfiguration]
|
605
|
+
#
|
606
|
+
# @!attribute [rw] schedule
|
607
|
+
# The schedule of the image pipeline.
|
608
|
+
# @return [Types::Schedule]
|
609
|
+
#
|
610
|
+
# @!attribute [rw] status
|
611
|
+
# The status of the image pipeline.
|
612
|
+
# @return [String]
|
613
|
+
#
|
614
|
+
# @!attribute [rw] tags
|
615
|
+
# The tags of the image pipeline.
|
616
|
+
# @return [Hash<String,String>]
|
617
|
+
#
|
618
|
+
# @!attribute [rw] client_token
|
619
|
+
# The idempotency token used to make this request idempotent.
|
620
|
+
#
|
621
|
+
# **A suitable default value is auto-generated.** You should normally
|
622
|
+
# not need to pass this option.
|
623
|
+
# @return [String]
|
624
|
+
#
|
625
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImagePipelineRequest AWS API Documentation
|
626
|
+
#
|
627
|
+
class CreateImagePipelineRequest < Struct.new(
|
628
|
+
:name,
|
629
|
+
:description,
|
630
|
+
:image_recipe_arn,
|
631
|
+
:infrastructure_configuration_arn,
|
632
|
+
:distribution_configuration_arn,
|
633
|
+
:image_tests_configuration,
|
634
|
+
:schedule,
|
635
|
+
:status,
|
636
|
+
:tags,
|
637
|
+
:client_token)
|
638
|
+
include Aws::Structure
|
639
|
+
end
|
640
|
+
|
641
|
+
# @!attribute [rw] request_id
|
642
|
+
# The request ID that uniquely identifies this request.
|
643
|
+
# @return [String]
|
644
|
+
#
|
645
|
+
# @!attribute [rw] client_token
|
646
|
+
# The idempotency token used to make this request idempotent.
|
647
|
+
# @return [String]
|
648
|
+
#
|
649
|
+
# @!attribute [rw] image_pipeline_arn
|
650
|
+
# The Amazon Resource Name (ARN) of the image pipeline that was
|
651
|
+
# created by this request.
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImagePipelineResponse AWS API Documentation
|
655
|
+
#
|
656
|
+
class CreateImagePipelineResponse < Struct.new(
|
657
|
+
:request_id,
|
658
|
+
:client_token,
|
659
|
+
:image_pipeline_arn)
|
660
|
+
include Aws::Structure
|
661
|
+
end
|
662
|
+
|
663
|
+
# @note When making an API call, you may pass CreateImageRecipeRequest
|
664
|
+
# data as a hash:
|
665
|
+
#
|
666
|
+
# {
|
667
|
+
# name: "ResourceName", # required
|
668
|
+
# description: "NonEmptyString",
|
669
|
+
# semantic_version: "VersionNumber", # required
|
670
|
+
# components: [ # required
|
671
|
+
# {
|
672
|
+
# component_arn: "ComponentBuildVersionArn", # required
|
673
|
+
# },
|
674
|
+
# ],
|
675
|
+
# parent_image: "NonEmptyString", # required
|
676
|
+
# block_device_mappings: [
|
677
|
+
# {
|
678
|
+
# device_name: "NonEmptyString",
|
679
|
+
# ebs: {
|
680
|
+
# encrypted: false,
|
681
|
+
# delete_on_termination: false,
|
682
|
+
# iops: 1,
|
683
|
+
# kms_key_id: "NonEmptyString",
|
684
|
+
# snapshot_id: "NonEmptyString",
|
685
|
+
# volume_size: 1,
|
686
|
+
# volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
|
687
|
+
# },
|
688
|
+
# virtual_name: "NonEmptyString",
|
689
|
+
# no_device: "NonEmptyString",
|
690
|
+
# },
|
691
|
+
# ],
|
692
|
+
# tags: {
|
693
|
+
# "TagKey" => "TagValue",
|
694
|
+
# },
|
695
|
+
# client_token: "ClientToken", # required
|
696
|
+
# }
|
697
|
+
#
|
698
|
+
# @!attribute [rw] name
|
699
|
+
# The name of the image recipe.
|
700
|
+
# @return [String]
|
701
|
+
#
|
702
|
+
# @!attribute [rw] description
|
703
|
+
# The description of the image recipe.
|
704
|
+
# @return [String]
|
705
|
+
#
|
706
|
+
# @!attribute [rw] semantic_version
|
707
|
+
# The semantic version of the image recipe.
|
708
|
+
# @return [String]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] components
|
711
|
+
# The components of the image recipe.
|
712
|
+
# @return [Array<Types::ComponentConfiguration>]
|
713
|
+
#
|
714
|
+
# @!attribute [rw] parent_image
|
715
|
+
# The parent image of the image recipe.
|
716
|
+
# @return [String]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] block_device_mappings
|
719
|
+
# The block device mappings of the image recipe.
|
720
|
+
# @return [Array<Types::InstanceBlockDeviceMapping>]
|
721
|
+
#
|
722
|
+
# @!attribute [rw] tags
|
723
|
+
# The tags of the image recipe.
|
724
|
+
# @return [Hash<String,String>]
|
725
|
+
#
|
726
|
+
# @!attribute [rw] client_token
|
727
|
+
# The idempotency token used to make this request idempotent.
|
728
|
+
#
|
729
|
+
# **A suitable default value is auto-generated.** You should normally
|
730
|
+
# not need to pass this option.
|
731
|
+
# @return [String]
|
732
|
+
#
|
733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRecipeRequest AWS API Documentation
|
734
|
+
#
|
735
|
+
class CreateImageRecipeRequest < Struct.new(
|
736
|
+
:name,
|
737
|
+
:description,
|
738
|
+
:semantic_version,
|
739
|
+
:components,
|
740
|
+
:parent_image,
|
741
|
+
:block_device_mappings,
|
742
|
+
:tags,
|
743
|
+
:client_token)
|
744
|
+
include Aws::Structure
|
745
|
+
end
|
746
|
+
|
747
|
+
# @!attribute [rw] request_id
|
748
|
+
# The request ID that uniquely identifies this request.
|
749
|
+
# @return [String]
|
750
|
+
#
|
751
|
+
# @!attribute [rw] client_token
|
752
|
+
# The idempotency token used to make this request idempotent.
|
753
|
+
# @return [String]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] image_recipe_arn
|
756
|
+
# The Amazon Resource Name (ARN) of the image recipe that was created
|
757
|
+
# by this request.
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRecipeResponse AWS API Documentation
|
761
|
+
#
|
762
|
+
class CreateImageRecipeResponse < Struct.new(
|
763
|
+
:request_id,
|
764
|
+
:client_token,
|
765
|
+
:image_recipe_arn)
|
766
|
+
include Aws::Structure
|
767
|
+
end
|
768
|
+
|
769
|
+
# @note When making an API call, you may pass CreateImageRequest
|
770
|
+
# data as a hash:
|
771
|
+
#
|
772
|
+
# {
|
773
|
+
# image_recipe_arn: "ImageRecipeArn", # required
|
774
|
+
# distribution_configuration_arn: "DistributionConfigurationArn",
|
775
|
+
# infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
|
776
|
+
# image_tests_configuration: {
|
777
|
+
# image_tests_enabled: false,
|
778
|
+
# timeout_minutes: 1,
|
779
|
+
# },
|
780
|
+
# tags: {
|
781
|
+
# "TagKey" => "TagValue",
|
782
|
+
# },
|
783
|
+
# client_token: "ClientToken", # required
|
784
|
+
# }
|
785
|
+
#
|
786
|
+
# @!attribute [rw] image_recipe_arn
|
787
|
+
# The Amazon Resource Name (ARN) of the image recipe that defines how
|
788
|
+
# images are configured, tested and assessed.
|
789
|
+
# @return [String]
|
790
|
+
#
|
791
|
+
# @!attribute [rw] distribution_configuration_arn
|
792
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
793
|
+
# that defines and configures the outputs of your pipeline.
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
797
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
798
|
+
# that defines the environment in which your image will be built and
|
799
|
+
# tested.
|
800
|
+
# @return [String]
|
801
|
+
#
|
802
|
+
# @!attribute [rw] image_tests_configuration
|
803
|
+
# The image tests configuration of the image.
|
804
|
+
# @return [Types::ImageTestsConfiguration]
|
805
|
+
#
|
806
|
+
# @!attribute [rw] tags
|
807
|
+
# The tags of the image.
|
808
|
+
# @return [Hash<String,String>]
|
809
|
+
#
|
810
|
+
# @!attribute [rw] client_token
|
811
|
+
# The idempotency token used to make this request idempotent.
|
812
|
+
#
|
813
|
+
# **A suitable default value is auto-generated.** You should normally
|
814
|
+
# not need to pass this option.
|
815
|
+
# @return [String]
|
816
|
+
#
|
817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageRequest AWS API Documentation
|
818
|
+
#
|
819
|
+
class CreateImageRequest < Struct.new(
|
820
|
+
:image_recipe_arn,
|
821
|
+
:distribution_configuration_arn,
|
822
|
+
:infrastructure_configuration_arn,
|
823
|
+
:image_tests_configuration,
|
824
|
+
:tags,
|
825
|
+
:client_token)
|
826
|
+
include Aws::Structure
|
827
|
+
end
|
828
|
+
|
829
|
+
# @!attribute [rw] request_id
|
830
|
+
# The request ID that uniquely identifies this request.
|
831
|
+
# @return [String]
|
832
|
+
#
|
833
|
+
# @!attribute [rw] client_token
|
834
|
+
# The idempotency token used to make this request idempotent.
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] image_build_version_arn
|
838
|
+
# The Amazon Resource Name (ARN) of the image that was created by this
|
839
|
+
# request.
|
840
|
+
# @return [String]
|
841
|
+
#
|
842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateImageResponse AWS API Documentation
|
843
|
+
#
|
844
|
+
class CreateImageResponse < Struct.new(
|
845
|
+
:request_id,
|
846
|
+
:client_token,
|
847
|
+
:image_build_version_arn)
|
848
|
+
include Aws::Structure
|
849
|
+
end
|
850
|
+
|
851
|
+
# @note When making an API call, you may pass CreateInfrastructureConfigurationRequest
|
852
|
+
# data as a hash:
|
853
|
+
#
|
854
|
+
# {
|
855
|
+
# name: "ResourceName", # required
|
856
|
+
# description: "NonEmptyString",
|
857
|
+
# instance_types: ["InstanceType"],
|
858
|
+
# instance_profile_name: "NonEmptyString", # required
|
859
|
+
# security_group_ids: ["NonEmptyString"],
|
860
|
+
# subnet_id: "NonEmptyString",
|
861
|
+
# logging: {
|
862
|
+
# s3_logs: {
|
863
|
+
# s3_bucket_name: "NonEmptyString",
|
864
|
+
# s3_key_prefix: "NonEmptyString",
|
865
|
+
# },
|
866
|
+
# },
|
867
|
+
# key_pair: "NonEmptyString",
|
868
|
+
# terminate_instance_on_failure: false,
|
869
|
+
# sns_topic_arn: "NonEmptyString",
|
870
|
+
# tags: {
|
871
|
+
# "TagKey" => "TagValue",
|
872
|
+
# },
|
873
|
+
# client_token: "ClientToken", # required
|
874
|
+
# }
|
875
|
+
#
|
876
|
+
# @!attribute [rw] name
|
877
|
+
# The name of the infrastructure configuration.
|
878
|
+
# @return [String]
|
879
|
+
#
|
880
|
+
# @!attribute [rw] description
|
881
|
+
# The description of the infrastructure configuration.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @!attribute [rw] instance_types
|
885
|
+
# The instance types of the infrastructure configuration. You may
|
886
|
+
# specify one or more instance types to use for this build, the
|
887
|
+
# service will pick one of these instance types based on availability.
|
888
|
+
# @return [Array<String>]
|
889
|
+
#
|
890
|
+
# @!attribute [rw] instance_profile_name
|
891
|
+
# The instance profile to associate with the instance used to
|
892
|
+
# customize your EC2 AMI.
|
893
|
+
# @return [String]
|
894
|
+
#
|
895
|
+
# @!attribute [rw] security_group_ids
|
896
|
+
# The security group IDs to associate with the instance used to
|
897
|
+
# customize your EC2 AMI.
|
898
|
+
# @return [Array<String>]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] subnet_id
|
901
|
+
# The subnet ID to place the instance used to customize your EC2 AMI
|
902
|
+
# in.
|
903
|
+
# @return [String]
|
904
|
+
#
|
905
|
+
# @!attribute [rw] logging
|
906
|
+
# The logging configuration of the infrastructure configuration.
|
907
|
+
# @return [Types::Logging]
|
908
|
+
#
|
909
|
+
# @!attribute [rw] key_pair
|
910
|
+
# The key pair of the infrastructure configuration. This can be used
|
911
|
+
# to log onto and debug the instance used to create your image.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] terminate_instance_on_failure
|
915
|
+
# The terminate instance on failure setting of the infrastructure
|
916
|
+
# configuration. Set to false if you wish for Image Builder to retain
|
917
|
+
# the instance used to configure your AMI in the event that the build
|
918
|
+
# or test phase of your workflow failed.
|
919
|
+
# @return [Boolean]
|
920
|
+
#
|
921
|
+
# @!attribute [rw] sns_topic_arn
|
922
|
+
# The SNS topic on which to send image build events.
|
923
|
+
# @return [String]
|
924
|
+
#
|
925
|
+
# @!attribute [rw] tags
|
926
|
+
# The tags of the infrastructure configuration.
|
927
|
+
# @return [Hash<String,String>]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] client_token
|
930
|
+
# The idempotency token used to make this request idempotent.
|
931
|
+
#
|
932
|
+
# **A suitable default value is auto-generated.** You should normally
|
933
|
+
# not need to pass this option.
|
934
|
+
# @return [String]
|
935
|
+
#
|
936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateInfrastructureConfigurationRequest AWS API Documentation
|
937
|
+
#
|
938
|
+
class CreateInfrastructureConfigurationRequest < Struct.new(
|
939
|
+
:name,
|
940
|
+
:description,
|
941
|
+
:instance_types,
|
942
|
+
:instance_profile_name,
|
943
|
+
:security_group_ids,
|
944
|
+
:subnet_id,
|
945
|
+
:logging,
|
946
|
+
:key_pair,
|
947
|
+
:terminate_instance_on_failure,
|
948
|
+
:sns_topic_arn,
|
949
|
+
:tags,
|
950
|
+
:client_token)
|
951
|
+
include Aws::Structure
|
952
|
+
end
|
953
|
+
|
954
|
+
# @!attribute [rw] request_id
|
955
|
+
# The request ID that uniquely identifies this request.
|
956
|
+
# @return [String]
|
957
|
+
#
|
958
|
+
# @!attribute [rw] client_token
|
959
|
+
# The idempotency token used to make this request idempotent.
|
960
|
+
# @return [String]
|
961
|
+
#
|
962
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
963
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
964
|
+
# that was created by this request.
|
965
|
+
# @return [String]
|
966
|
+
#
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/CreateInfrastructureConfigurationResponse AWS API Documentation
|
968
|
+
#
|
969
|
+
class CreateInfrastructureConfigurationResponse < Struct.new(
|
970
|
+
:request_id,
|
971
|
+
:client_token,
|
972
|
+
:infrastructure_configuration_arn)
|
973
|
+
include Aws::Structure
|
974
|
+
end
|
975
|
+
|
976
|
+
# @note When making an API call, you may pass DeleteComponentRequest
|
977
|
+
# data as a hash:
|
978
|
+
#
|
979
|
+
# {
|
980
|
+
# component_build_version_arn: "ComponentBuildVersionArn", # required
|
981
|
+
# }
|
982
|
+
#
|
983
|
+
# @!attribute [rw] component_build_version_arn
|
984
|
+
# The Amazon Resource Name (ARN) of the component build version to
|
985
|
+
# delete.
|
986
|
+
# @return [String]
|
987
|
+
#
|
988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteComponentRequest AWS API Documentation
|
989
|
+
#
|
990
|
+
class DeleteComponentRequest < Struct.new(
|
991
|
+
:component_build_version_arn)
|
992
|
+
include Aws::Structure
|
993
|
+
end
|
994
|
+
|
995
|
+
# @!attribute [rw] request_id
|
996
|
+
# The request ID that uniquely identifies this request.
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] component_build_version_arn
|
1000
|
+
# The Amazon Resource Name (ARN) of the component build version that
|
1001
|
+
# was deleted.
|
1002
|
+
# @return [String]
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteComponentResponse AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class DeleteComponentResponse < Struct.new(
|
1007
|
+
:request_id,
|
1008
|
+
:component_build_version_arn)
|
1009
|
+
include Aws::Structure
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
# @note When making an API call, you may pass DeleteDistributionConfigurationRequest
|
1013
|
+
# data as a hash:
|
1014
|
+
#
|
1015
|
+
# {
|
1016
|
+
# distribution_configuration_arn: "DistributionConfigurationArn", # required
|
1017
|
+
# }
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] distribution_configuration_arn
|
1020
|
+
# The Amazon Resource Name (ARN) of the distribution configuration to
|
1021
|
+
# delete.
|
1022
|
+
# @return [String]
|
1023
|
+
#
|
1024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteDistributionConfigurationRequest AWS API Documentation
|
1025
|
+
#
|
1026
|
+
class DeleteDistributionConfigurationRequest < Struct.new(
|
1027
|
+
:distribution_configuration_arn)
|
1028
|
+
include Aws::Structure
|
1029
|
+
end
|
1030
|
+
|
1031
|
+
# @!attribute [rw] request_id
|
1032
|
+
# The request ID that uniquely identifies this request.
|
1033
|
+
# @return [String]
|
1034
|
+
#
|
1035
|
+
# @!attribute [rw] distribution_configuration_arn
|
1036
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
1037
|
+
# that was deleted.
|
1038
|
+
# @return [String]
|
1039
|
+
#
|
1040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteDistributionConfigurationResponse AWS API Documentation
|
1041
|
+
#
|
1042
|
+
class DeleteDistributionConfigurationResponse < Struct.new(
|
1043
|
+
:request_id,
|
1044
|
+
:distribution_configuration_arn)
|
1045
|
+
include Aws::Structure
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
# @note When making an API call, you may pass DeleteImagePipelineRequest
|
1049
|
+
# data as a hash:
|
1050
|
+
#
|
1051
|
+
# {
|
1052
|
+
# image_pipeline_arn: "ImagePipelineArn", # required
|
1053
|
+
# }
|
1054
|
+
#
|
1055
|
+
# @!attribute [rw] image_pipeline_arn
|
1056
|
+
# The Amazon Resource Name (ARN) of the image pipeline to delete.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImagePipelineRequest AWS API Documentation
|
1060
|
+
#
|
1061
|
+
class DeleteImagePipelineRequest < Struct.new(
|
1062
|
+
:image_pipeline_arn)
|
1063
|
+
include Aws::Structure
|
1064
|
+
end
|
1065
|
+
|
1066
|
+
# @!attribute [rw] request_id
|
1067
|
+
# The request ID that uniquely identifies this request.
|
1068
|
+
# @return [String]
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] image_pipeline_arn
|
1071
|
+
# The Amazon Resource Name (ARN) of the image pipeline that was
|
1072
|
+
# deleted.
|
1073
|
+
# @return [String]
|
1074
|
+
#
|
1075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImagePipelineResponse AWS API Documentation
|
1076
|
+
#
|
1077
|
+
class DeleteImagePipelineResponse < Struct.new(
|
1078
|
+
:request_id,
|
1079
|
+
:image_pipeline_arn)
|
1080
|
+
include Aws::Structure
|
1081
|
+
end
|
1082
|
+
|
1083
|
+
# @note When making an API call, you may pass DeleteImageRecipeRequest
|
1084
|
+
# data as a hash:
|
1085
|
+
#
|
1086
|
+
# {
|
1087
|
+
# image_recipe_arn: "ImageRecipeArn", # required
|
1088
|
+
# }
|
1089
|
+
#
|
1090
|
+
# @!attribute [rw] image_recipe_arn
|
1091
|
+
# The Amazon Resource Name (ARN) of the image recipe to delete.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImageRecipeRequest AWS API Documentation
|
1095
|
+
#
|
1096
|
+
class DeleteImageRecipeRequest < Struct.new(
|
1097
|
+
:image_recipe_arn)
|
1098
|
+
include Aws::Structure
|
1099
|
+
end
|
1100
|
+
|
1101
|
+
# @!attribute [rw] request_id
|
1102
|
+
# The request ID that uniquely identifies this request.
|
1103
|
+
# @return [String]
|
1104
|
+
#
|
1105
|
+
# @!attribute [rw] image_recipe_arn
|
1106
|
+
# The Amazon Resource Name (ARN) of the image recipe that was deleted.
|
1107
|
+
# @return [String]
|
1108
|
+
#
|
1109
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImageRecipeResponse AWS API Documentation
|
1110
|
+
#
|
1111
|
+
class DeleteImageRecipeResponse < Struct.new(
|
1112
|
+
:request_id,
|
1113
|
+
:image_recipe_arn)
|
1114
|
+
include Aws::Structure
|
1115
|
+
end
|
1116
|
+
|
1117
|
+
# @note When making an API call, you may pass DeleteImageRequest
|
1118
|
+
# data as a hash:
|
1119
|
+
#
|
1120
|
+
# {
|
1121
|
+
# image_build_version_arn: "ImageBuildVersionArn", # required
|
1122
|
+
# }
|
1123
|
+
#
|
1124
|
+
# @!attribute [rw] image_build_version_arn
|
1125
|
+
# The Amazon Resource Name (ARN) of the image to delete.
|
1126
|
+
# @return [String]
|
1127
|
+
#
|
1128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImageRequest AWS API Documentation
|
1129
|
+
#
|
1130
|
+
class DeleteImageRequest < Struct.new(
|
1131
|
+
:image_build_version_arn)
|
1132
|
+
include Aws::Structure
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
# @!attribute [rw] request_id
|
1136
|
+
# The request ID that uniquely identifies this request.
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] image_build_version_arn
|
1140
|
+
# The Amazon Resource Name (ARN) of the image that was deleted.
|
1141
|
+
# @return [String]
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteImageResponse AWS API Documentation
|
1144
|
+
#
|
1145
|
+
class DeleteImageResponse < Struct.new(
|
1146
|
+
:request_id,
|
1147
|
+
:image_build_version_arn)
|
1148
|
+
include Aws::Structure
|
1149
|
+
end
|
1150
|
+
|
1151
|
+
# @note When making an API call, you may pass DeleteInfrastructureConfigurationRequest
|
1152
|
+
# data as a hash:
|
1153
|
+
#
|
1154
|
+
# {
|
1155
|
+
# infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
|
1156
|
+
# }
|
1157
|
+
#
|
1158
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
1159
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
1160
|
+
# to delete.
|
1161
|
+
# @return [String]
|
1162
|
+
#
|
1163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteInfrastructureConfigurationRequest AWS API Documentation
|
1164
|
+
#
|
1165
|
+
class DeleteInfrastructureConfigurationRequest < Struct.new(
|
1166
|
+
:infrastructure_configuration_arn)
|
1167
|
+
include Aws::Structure
|
1168
|
+
end
|
1169
|
+
|
1170
|
+
# @!attribute [rw] request_id
|
1171
|
+
# The request ID that uniquely identifies this request.
|
1172
|
+
# @return [String]
|
1173
|
+
#
|
1174
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
1175
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
1176
|
+
# that was deleted.
|
1177
|
+
# @return [String]
|
1178
|
+
#
|
1179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DeleteInfrastructureConfigurationResponse AWS API Documentation
|
1180
|
+
#
|
1181
|
+
class DeleteInfrastructureConfigurationResponse < Struct.new(
|
1182
|
+
:request_id,
|
1183
|
+
:infrastructure_configuration_arn)
|
1184
|
+
include Aws::Structure
|
1185
|
+
end
|
1186
|
+
|
1187
|
+
# @note When making an API call, you may pass Distribution
|
1188
|
+
# data as a hash:
|
1189
|
+
#
|
1190
|
+
# {
|
1191
|
+
# region: "NonEmptyString", # required
|
1192
|
+
# ami_distribution_configuration: {
|
1193
|
+
# name: "NonEmptyString",
|
1194
|
+
# description: "NonEmptyString",
|
1195
|
+
# ami_tags: {
|
1196
|
+
# "TagKey" => "TagValue",
|
1197
|
+
# },
|
1198
|
+
# launch_permission: {
|
1199
|
+
# user_ids: ["NonEmptyString"],
|
1200
|
+
# user_groups: ["NonEmptyString"],
|
1201
|
+
# },
|
1202
|
+
# },
|
1203
|
+
# license_configuration_arns: ["Arn"],
|
1204
|
+
# }
|
1205
|
+
#
|
1206
|
+
# @!attribute [rw] region
|
1207
|
+
# @return [String]
|
1208
|
+
#
|
1209
|
+
# @!attribute [rw] ami_distribution_configuration
|
1210
|
+
# @return [Types::AmiDistributionConfiguration]
|
1211
|
+
#
|
1212
|
+
# @!attribute [rw] license_configuration_arns
|
1213
|
+
# @return [Array<String>]
|
1214
|
+
#
|
1215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Distribution AWS API Documentation
|
1216
|
+
#
|
1217
|
+
class Distribution < Struct.new(
|
1218
|
+
:region,
|
1219
|
+
:ami_distribution_configuration,
|
1220
|
+
:license_configuration_arns)
|
1221
|
+
include Aws::Structure
|
1222
|
+
end
|
1223
|
+
|
1224
|
+
# A distribution configuration.
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] arn
|
1227
|
+
# The Amazon Resource Name (ARN) of the distribution configuration.
|
1228
|
+
# @return [String]
|
1229
|
+
#
|
1230
|
+
# @!attribute [rw] name
|
1231
|
+
# The name of the distribution configuration.
|
1232
|
+
# @return [String]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] description
|
1235
|
+
# The description of the distribution configuration.
|
1236
|
+
# @return [String]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] distributions
|
1239
|
+
# The distributions of the distribution configuration.
|
1240
|
+
# @return [Array<Types::Distribution>]
|
1241
|
+
#
|
1242
|
+
# @!attribute [rw] timeout_minutes
|
1243
|
+
# The maximum duration in minutes for this distribution configuration.
|
1244
|
+
# @return [Integer]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] date_created
|
1247
|
+
# The date on which this distribution configuration was created.
|
1248
|
+
# @return [String]
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] date_updated
|
1251
|
+
# The date on which this distribution configuration was last updated.
|
1252
|
+
# @return [String]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] tags
|
1255
|
+
# The tags of the distribution configuration.
|
1256
|
+
# @return [Hash<String,String>]
|
1257
|
+
#
|
1258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DistributionConfiguration AWS API Documentation
|
1259
|
+
#
|
1260
|
+
class DistributionConfiguration < Struct.new(
|
1261
|
+
:arn,
|
1262
|
+
:name,
|
1263
|
+
:description,
|
1264
|
+
:distributions,
|
1265
|
+
:timeout_minutes,
|
1266
|
+
:date_created,
|
1267
|
+
:date_updated,
|
1268
|
+
:tags)
|
1269
|
+
include Aws::Structure
|
1270
|
+
end
|
1271
|
+
|
1272
|
+
# A high level overview a distribution configuration.
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] arn
|
1275
|
+
# The Amazon Resource Name (ARN) of the distribution configuration.
|
1276
|
+
# @return [String]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] name
|
1279
|
+
# The name of the distribution configuration.
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] description
|
1283
|
+
# The description of the distribution configuration.
|
1284
|
+
# @return [String]
|
1285
|
+
#
|
1286
|
+
# @!attribute [rw] date_created
|
1287
|
+
# The date on which the distribution configuration was created.
|
1288
|
+
# @return [String]
|
1289
|
+
#
|
1290
|
+
# @!attribute [rw] date_updated
|
1291
|
+
# The date on which the distribution configuration was updated.
|
1292
|
+
# @return [String]
|
1293
|
+
#
|
1294
|
+
# @!attribute [rw] tags
|
1295
|
+
# The tags associated with the distribution configuration.
|
1296
|
+
# @return [Hash<String,String>]
|
1297
|
+
#
|
1298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/DistributionConfigurationSummary AWS API Documentation
|
1299
|
+
#
|
1300
|
+
class DistributionConfigurationSummary < Struct.new(
|
1301
|
+
:arn,
|
1302
|
+
:name,
|
1303
|
+
:description,
|
1304
|
+
:date_created,
|
1305
|
+
:date_updated,
|
1306
|
+
:tags)
|
1307
|
+
include Aws::Structure
|
1308
|
+
end
|
1309
|
+
|
1310
|
+
# EBS specific block device mapping specifications.
|
1311
|
+
#
|
1312
|
+
# @note When making an API call, you may pass EbsInstanceBlockDeviceSpecification
|
1313
|
+
# data as a hash:
|
1314
|
+
#
|
1315
|
+
# {
|
1316
|
+
# encrypted: false,
|
1317
|
+
# delete_on_termination: false,
|
1318
|
+
# iops: 1,
|
1319
|
+
# kms_key_id: "NonEmptyString",
|
1320
|
+
# snapshot_id: "NonEmptyString",
|
1321
|
+
# volume_size: 1,
|
1322
|
+
# volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
|
1323
|
+
# }
|
1324
|
+
#
|
1325
|
+
# @!attribute [rw] encrypted
|
1326
|
+
# Use to configure device encryption.
|
1327
|
+
# @return [Boolean]
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] delete_on_termination
|
1330
|
+
# Use to configure delete on termination of the associated device.
|
1331
|
+
# @return [Boolean]
|
1332
|
+
#
|
1333
|
+
# @!attribute [rw] iops
|
1334
|
+
# Use to configure device IOPS.
|
1335
|
+
# @return [Integer]
|
1336
|
+
#
|
1337
|
+
# @!attribute [rw] kms_key_id
|
1338
|
+
# Use to configure the KMS key to use when encrypting the device.
|
1339
|
+
# @return [String]
|
1340
|
+
#
|
1341
|
+
# @!attribute [rw] snapshot_id
|
1342
|
+
# The snapshot that defines the device contents.
|
1343
|
+
# @return [String]
|
1344
|
+
#
|
1345
|
+
# @!attribute [rw] volume_size
|
1346
|
+
# Use to override the device's volume size.
|
1347
|
+
# @return [Integer]
|
1348
|
+
#
|
1349
|
+
# @!attribute [rw] volume_type
|
1350
|
+
# Use to override the device's volume type.
|
1351
|
+
# @return [String]
|
1352
|
+
#
|
1353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/EbsInstanceBlockDeviceSpecification AWS API Documentation
|
1354
|
+
#
|
1355
|
+
class EbsInstanceBlockDeviceSpecification < Struct.new(
|
1356
|
+
:encrypted,
|
1357
|
+
:delete_on_termination,
|
1358
|
+
:iops,
|
1359
|
+
:kms_key_id,
|
1360
|
+
:snapshot_id,
|
1361
|
+
:volume_size,
|
1362
|
+
:volume_type)
|
1363
|
+
include Aws::Structure
|
1364
|
+
end
|
1365
|
+
|
1366
|
+
# @note When making an API call, you may pass Filter
|
1367
|
+
# data as a hash:
|
1368
|
+
#
|
1369
|
+
# {
|
1370
|
+
# name: "FilterName",
|
1371
|
+
# values: ["FilterValue"],
|
1372
|
+
# }
|
1373
|
+
#
|
1374
|
+
# @!attribute [rw] name
|
1375
|
+
# @return [String]
|
1376
|
+
#
|
1377
|
+
# @!attribute [rw] values
|
1378
|
+
# @return [Array<String>]
|
1379
|
+
#
|
1380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Filter AWS API Documentation
|
1381
|
+
#
|
1382
|
+
class Filter < Struct.new(
|
1383
|
+
:name,
|
1384
|
+
:values)
|
1385
|
+
include Aws::Structure
|
1386
|
+
end
|
1387
|
+
|
1388
|
+
# You are not authorized to perform the requested operation.
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] message
|
1391
|
+
# @return [String]
|
1392
|
+
#
|
1393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ForbiddenException AWS API Documentation
|
1394
|
+
#
|
1395
|
+
class ForbiddenException < Struct.new(
|
1396
|
+
:message)
|
1397
|
+
include Aws::Structure
|
1398
|
+
end
|
1399
|
+
|
1400
|
+
# @note When making an API call, you may pass GetComponentPolicyRequest
|
1401
|
+
# data as a hash:
|
1402
|
+
#
|
1403
|
+
# {
|
1404
|
+
# component_arn: "ComponentBuildVersionArn", # required
|
1405
|
+
# }
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] component_arn
|
1408
|
+
# The Amazon Resource Name (ARN) of the component whose policy you
|
1409
|
+
# wish to retrieve.
|
1410
|
+
# @return [String]
|
1411
|
+
#
|
1412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentPolicyRequest AWS API Documentation
|
1413
|
+
#
|
1414
|
+
class GetComponentPolicyRequest < Struct.new(
|
1415
|
+
:component_arn)
|
1416
|
+
include Aws::Structure
|
1417
|
+
end
|
1418
|
+
|
1419
|
+
# @!attribute [rw] request_id
|
1420
|
+
# The request ID that uniquely identifies this request.
|
1421
|
+
# @return [String]
|
1422
|
+
#
|
1423
|
+
# @!attribute [rw] policy
|
1424
|
+
# The component policy.
|
1425
|
+
# @return [String]
|
1426
|
+
#
|
1427
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentPolicyResponse AWS API Documentation
|
1428
|
+
#
|
1429
|
+
class GetComponentPolicyResponse < Struct.new(
|
1430
|
+
:request_id,
|
1431
|
+
:policy)
|
1432
|
+
include Aws::Structure
|
1433
|
+
end
|
1434
|
+
|
1435
|
+
# @note When making an API call, you may pass GetComponentRequest
|
1436
|
+
# data as a hash:
|
1437
|
+
#
|
1438
|
+
# {
|
1439
|
+
# component_build_version_arn: "ComponentBuildVersionArn", # required
|
1440
|
+
# }
|
1441
|
+
#
|
1442
|
+
# @!attribute [rw] component_build_version_arn
|
1443
|
+
# The Amazon Resource Name (ARN) of the component that you wish to
|
1444
|
+
# retrieve.
|
1445
|
+
# @return [String]
|
1446
|
+
#
|
1447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentRequest AWS API Documentation
|
1448
|
+
#
|
1449
|
+
class GetComponentRequest < Struct.new(
|
1450
|
+
:component_build_version_arn)
|
1451
|
+
include Aws::Structure
|
1452
|
+
end
|
1453
|
+
|
1454
|
+
# @!attribute [rw] request_id
|
1455
|
+
# The request ID that uniquely identifies this request.
|
1456
|
+
# @return [String]
|
1457
|
+
#
|
1458
|
+
# @!attribute [rw] component
|
1459
|
+
# The component object associated with the specified ARN.
|
1460
|
+
# @return [Types::Component]
|
1461
|
+
#
|
1462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetComponentResponse AWS API Documentation
|
1463
|
+
#
|
1464
|
+
class GetComponentResponse < Struct.new(
|
1465
|
+
:request_id,
|
1466
|
+
:component)
|
1467
|
+
include Aws::Structure
|
1468
|
+
end
|
1469
|
+
|
1470
|
+
# @note When making an API call, you may pass GetDistributionConfigurationRequest
|
1471
|
+
# data as a hash:
|
1472
|
+
#
|
1473
|
+
# {
|
1474
|
+
# distribution_configuration_arn: "DistributionConfigurationArn", # required
|
1475
|
+
# }
|
1476
|
+
#
|
1477
|
+
# @!attribute [rw] distribution_configuration_arn
|
1478
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
1479
|
+
# that you wish to retrieve.
|
1480
|
+
# @return [String]
|
1481
|
+
#
|
1482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetDistributionConfigurationRequest AWS API Documentation
|
1483
|
+
#
|
1484
|
+
class GetDistributionConfigurationRequest < Struct.new(
|
1485
|
+
:distribution_configuration_arn)
|
1486
|
+
include Aws::Structure
|
1487
|
+
end
|
1488
|
+
|
1489
|
+
# @!attribute [rw] request_id
|
1490
|
+
# The request ID that uniquely identifies this request.
|
1491
|
+
# @return [String]
|
1492
|
+
#
|
1493
|
+
# @!attribute [rw] distribution_configuration
|
1494
|
+
# The distribution configuration object.
|
1495
|
+
# @return [Types::DistributionConfiguration]
|
1496
|
+
#
|
1497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetDistributionConfigurationResponse AWS API Documentation
|
1498
|
+
#
|
1499
|
+
class GetDistributionConfigurationResponse < Struct.new(
|
1500
|
+
:request_id,
|
1501
|
+
:distribution_configuration)
|
1502
|
+
include Aws::Structure
|
1503
|
+
end
|
1504
|
+
|
1505
|
+
# @note When making an API call, you may pass GetImagePipelineRequest
|
1506
|
+
# data as a hash:
|
1507
|
+
#
|
1508
|
+
# {
|
1509
|
+
# image_pipeline_arn: "ImagePipelineArn", # required
|
1510
|
+
# }
|
1511
|
+
#
|
1512
|
+
# @!attribute [rw] image_pipeline_arn
|
1513
|
+
# The Amazon Resource Name (ARN) of the image pipeline that you wish
|
1514
|
+
# to retrieve.
|
1515
|
+
# @return [String]
|
1516
|
+
#
|
1517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImagePipelineRequest AWS API Documentation
|
1518
|
+
#
|
1519
|
+
class GetImagePipelineRequest < Struct.new(
|
1520
|
+
:image_pipeline_arn)
|
1521
|
+
include Aws::Structure
|
1522
|
+
end
|
1523
|
+
|
1524
|
+
# @!attribute [rw] request_id
|
1525
|
+
# The request ID that uniquely identifies this request.
|
1526
|
+
# @return [String]
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] image_pipeline
|
1529
|
+
# The image pipeline object.
|
1530
|
+
# @return [Types::ImagePipeline]
|
1531
|
+
#
|
1532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImagePipelineResponse AWS API Documentation
|
1533
|
+
#
|
1534
|
+
class GetImagePipelineResponse < Struct.new(
|
1535
|
+
:request_id,
|
1536
|
+
:image_pipeline)
|
1537
|
+
include Aws::Structure
|
1538
|
+
end
|
1539
|
+
|
1540
|
+
# @note When making an API call, you may pass GetImagePolicyRequest
|
1541
|
+
# data as a hash:
|
1542
|
+
#
|
1543
|
+
# {
|
1544
|
+
# image_arn: "ImageBuildVersionArn", # required
|
1545
|
+
# }
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] image_arn
|
1548
|
+
# The Amazon Resource Name (ARN) of the image whose policy you wish to
|
1549
|
+
# retrieve.
|
1550
|
+
# @return [String]
|
1551
|
+
#
|
1552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImagePolicyRequest AWS API Documentation
|
1553
|
+
#
|
1554
|
+
class GetImagePolicyRequest < Struct.new(
|
1555
|
+
:image_arn)
|
1556
|
+
include Aws::Structure
|
1557
|
+
end
|
1558
|
+
|
1559
|
+
# @!attribute [rw] request_id
|
1560
|
+
# The request ID that uniquely identifies this request.
|
1561
|
+
# @return [String]
|
1562
|
+
#
|
1563
|
+
# @!attribute [rw] policy
|
1564
|
+
# The image policy object.
|
1565
|
+
# @return [String]
|
1566
|
+
#
|
1567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImagePolicyResponse AWS API Documentation
|
1568
|
+
#
|
1569
|
+
class GetImagePolicyResponse < Struct.new(
|
1570
|
+
:request_id,
|
1571
|
+
:policy)
|
1572
|
+
include Aws::Structure
|
1573
|
+
end
|
1574
|
+
|
1575
|
+
# @note When making an API call, you may pass GetImageRecipePolicyRequest
|
1576
|
+
# data as a hash:
|
1577
|
+
#
|
1578
|
+
# {
|
1579
|
+
# image_recipe_arn: "ImageRecipeArn", # required
|
1580
|
+
# }
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] image_recipe_arn
|
1583
|
+
# The Amazon Resource Name (ARN) of the image recipe whose policy you
|
1584
|
+
# wish to retrieve.
|
1585
|
+
# @return [String]
|
1586
|
+
#
|
1587
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipePolicyRequest AWS API Documentation
|
1588
|
+
#
|
1589
|
+
class GetImageRecipePolicyRequest < Struct.new(
|
1590
|
+
:image_recipe_arn)
|
1591
|
+
include Aws::Structure
|
1592
|
+
end
|
1593
|
+
|
1594
|
+
# @!attribute [rw] request_id
|
1595
|
+
# The request ID that uniquely identifies this request.
|
1596
|
+
# @return [String]
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] policy
|
1599
|
+
# The image recipe policy object.
|
1600
|
+
# @return [String]
|
1601
|
+
#
|
1602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipePolicyResponse AWS API Documentation
|
1603
|
+
#
|
1604
|
+
class GetImageRecipePolicyResponse < Struct.new(
|
1605
|
+
:request_id,
|
1606
|
+
:policy)
|
1607
|
+
include Aws::Structure
|
1608
|
+
end
|
1609
|
+
|
1610
|
+
# @note When making an API call, you may pass GetImageRecipeRequest
|
1611
|
+
# data as a hash:
|
1612
|
+
#
|
1613
|
+
# {
|
1614
|
+
# image_recipe_arn: "ImageRecipeArn", # required
|
1615
|
+
# }
|
1616
|
+
#
|
1617
|
+
# @!attribute [rw] image_recipe_arn
|
1618
|
+
# The Amazon Resource Name (ARN) of the image recipe that you wish to
|
1619
|
+
# retrieve.
|
1620
|
+
# @return [String]
|
1621
|
+
#
|
1622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipeRequest AWS API Documentation
|
1623
|
+
#
|
1624
|
+
class GetImageRecipeRequest < Struct.new(
|
1625
|
+
:image_recipe_arn)
|
1626
|
+
include Aws::Structure
|
1627
|
+
end
|
1628
|
+
|
1629
|
+
# @!attribute [rw] request_id
|
1630
|
+
# The request ID that uniquely identifies this request.
|
1631
|
+
# @return [String]
|
1632
|
+
#
|
1633
|
+
# @!attribute [rw] image_recipe
|
1634
|
+
# The image recipe object.
|
1635
|
+
# @return [Types::ImageRecipe]
|
1636
|
+
#
|
1637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRecipeResponse AWS API Documentation
|
1638
|
+
#
|
1639
|
+
class GetImageRecipeResponse < Struct.new(
|
1640
|
+
:request_id,
|
1641
|
+
:image_recipe)
|
1642
|
+
include Aws::Structure
|
1643
|
+
end
|
1644
|
+
|
1645
|
+
# @note When making an API call, you may pass GetImageRequest
|
1646
|
+
# data as a hash:
|
1647
|
+
#
|
1648
|
+
# {
|
1649
|
+
# image_build_version_arn: "ImageBuildVersionArn", # required
|
1650
|
+
# }
|
1651
|
+
#
|
1652
|
+
# @!attribute [rw] image_build_version_arn
|
1653
|
+
# The Amazon Resource Name (ARN) of the image that you wish to
|
1654
|
+
# retrieve.
|
1655
|
+
# @return [String]
|
1656
|
+
#
|
1657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageRequest AWS API Documentation
|
1658
|
+
#
|
1659
|
+
class GetImageRequest < Struct.new(
|
1660
|
+
:image_build_version_arn)
|
1661
|
+
include Aws::Structure
|
1662
|
+
end
|
1663
|
+
|
1664
|
+
# @!attribute [rw] request_id
|
1665
|
+
# The request ID that uniquely identifies this request.
|
1666
|
+
# @return [String]
|
1667
|
+
#
|
1668
|
+
# @!attribute [rw] image
|
1669
|
+
# The image object.
|
1670
|
+
# @return [Types::Image]
|
1671
|
+
#
|
1672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetImageResponse AWS API Documentation
|
1673
|
+
#
|
1674
|
+
class GetImageResponse < Struct.new(
|
1675
|
+
:request_id,
|
1676
|
+
:image)
|
1677
|
+
include Aws::Structure
|
1678
|
+
end
|
1679
|
+
|
1680
|
+
# GetInfrastructureConfiguration request object.
|
1681
|
+
#
|
1682
|
+
# @note When making an API call, you may pass GetInfrastructureConfigurationRequest
|
1683
|
+
# data as a hash:
|
1684
|
+
#
|
1685
|
+
# {
|
1686
|
+
# infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
|
1687
|
+
# }
|
1688
|
+
#
|
1689
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
1690
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
1691
|
+
# that you wish to retrieve.
|
1692
|
+
# @return [String]
|
1693
|
+
#
|
1694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetInfrastructureConfigurationRequest AWS API Documentation
|
1695
|
+
#
|
1696
|
+
class GetInfrastructureConfigurationRequest < Struct.new(
|
1697
|
+
:infrastructure_configuration_arn)
|
1698
|
+
include Aws::Structure
|
1699
|
+
end
|
1700
|
+
|
1701
|
+
# GetInfrastructureConfiguration response object.
|
1702
|
+
#
|
1703
|
+
# @!attribute [rw] request_id
|
1704
|
+
# The request ID that uniquely identifies this request.
|
1705
|
+
# @return [String]
|
1706
|
+
#
|
1707
|
+
# @!attribute [rw] infrastructure_configuration
|
1708
|
+
# The infrastructure configuration object.
|
1709
|
+
# @return [Types::InfrastructureConfiguration]
|
1710
|
+
#
|
1711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/GetInfrastructureConfigurationResponse AWS API Documentation
|
1712
|
+
#
|
1713
|
+
class GetInfrastructureConfigurationResponse < Struct.new(
|
1714
|
+
:request_id,
|
1715
|
+
:infrastructure_configuration)
|
1716
|
+
include Aws::Structure
|
1717
|
+
end
|
1718
|
+
|
1719
|
+
# You have specified an client token for an operation using parameter
|
1720
|
+
# values that differ from a previous request that used the same client
|
1721
|
+
# token.
|
1722
|
+
#
|
1723
|
+
# @!attribute [rw] message
|
1724
|
+
# @return [String]
|
1725
|
+
#
|
1726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/IdempotentParameterMismatchException AWS API Documentation
|
1727
|
+
#
|
1728
|
+
class IdempotentParameterMismatchException < Struct.new(
|
1729
|
+
:message)
|
1730
|
+
include Aws::Structure
|
1731
|
+
end
|
1732
|
+
|
1733
|
+
# An image build version.
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] arn
|
1736
|
+
# The Amazon Resource Name (ARN) of the image.
|
1737
|
+
# @return [String]
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] name
|
1740
|
+
# The name of the image.
|
1741
|
+
# @return [String]
|
1742
|
+
#
|
1743
|
+
# @!attribute [rw] version
|
1744
|
+
# The semantic version of the image.
|
1745
|
+
# @return [String]
|
1746
|
+
#
|
1747
|
+
# @!attribute [rw] platform
|
1748
|
+
# The platform of the image.
|
1749
|
+
# @return [String]
|
1750
|
+
#
|
1751
|
+
# @!attribute [rw] state
|
1752
|
+
# The state of the image.
|
1753
|
+
# @return [Types::ImageState]
|
1754
|
+
#
|
1755
|
+
# @!attribute [rw] image_recipe
|
1756
|
+
# The image recipe used when creating the image.
|
1757
|
+
# @return [Types::ImageRecipe]
|
1758
|
+
#
|
1759
|
+
# @!attribute [rw] source_pipeline_name
|
1760
|
+
# The name of the image pipeline that created this image.
|
1761
|
+
# @return [String]
|
1762
|
+
#
|
1763
|
+
# @!attribute [rw] source_pipeline_arn
|
1764
|
+
# The Amazon Resource Name (ARN) of the image pipeline that created
|
1765
|
+
# this image.
|
1766
|
+
# @return [String]
|
1767
|
+
#
|
1768
|
+
# @!attribute [rw] infrastructure_configuration
|
1769
|
+
# The infrastructure used when creating this image.
|
1770
|
+
# @return [Types::InfrastructureConfiguration]
|
1771
|
+
#
|
1772
|
+
# @!attribute [rw] distribution_configuration
|
1773
|
+
# The distribution configuration used when creating this image.
|
1774
|
+
# @return [Types::DistributionConfiguration]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] image_tests_configuration
|
1777
|
+
# The image tests configuration used when creating this image.
|
1778
|
+
# @return [Types::ImageTestsConfiguration]
|
1779
|
+
#
|
1780
|
+
# @!attribute [rw] date_created
|
1781
|
+
# The date on which this image was created.
|
1782
|
+
# @return [String]
|
1783
|
+
#
|
1784
|
+
# @!attribute [rw] output_resources
|
1785
|
+
# The output resources produced when creating this image.
|
1786
|
+
# @return [Types::OutputResources]
|
1787
|
+
#
|
1788
|
+
# @!attribute [rw] tags
|
1789
|
+
# The tags of the image.
|
1790
|
+
# @return [Hash<String,String>]
|
1791
|
+
#
|
1792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Image AWS API Documentation
|
1793
|
+
#
|
1794
|
+
class Image < Struct.new(
|
1795
|
+
:arn,
|
1796
|
+
:name,
|
1797
|
+
:version,
|
1798
|
+
:platform,
|
1799
|
+
:state,
|
1800
|
+
:image_recipe,
|
1801
|
+
:source_pipeline_name,
|
1802
|
+
:source_pipeline_arn,
|
1803
|
+
:infrastructure_configuration,
|
1804
|
+
:distribution_configuration,
|
1805
|
+
:image_tests_configuration,
|
1806
|
+
:date_created,
|
1807
|
+
:output_resources,
|
1808
|
+
:tags)
|
1809
|
+
include Aws::Structure
|
1810
|
+
end
|
1811
|
+
|
1812
|
+
# Details of an image pipeline.
|
1813
|
+
#
|
1814
|
+
# @!attribute [rw] arn
|
1815
|
+
# The Amazon Resource Name (ARN) of the image pipeline.
|
1816
|
+
# @return [String]
|
1817
|
+
#
|
1818
|
+
# @!attribute [rw] name
|
1819
|
+
# The name of the image pipeline.
|
1820
|
+
# @return [String]
|
1821
|
+
#
|
1822
|
+
# @!attribute [rw] description
|
1823
|
+
# The description of the image pipeline.
|
1824
|
+
# @return [String]
|
1825
|
+
#
|
1826
|
+
# @!attribute [rw] platform
|
1827
|
+
# The platform of the image pipeline.
|
1828
|
+
# @return [String]
|
1829
|
+
#
|
1830
|
+
# @!attribute [rw] image_recipe_arn
|
1831
|
+
# The Amazon Resource Name (ARN) of the image recipe associated with
|
1832
|
+
# this image pipeline.
|
1833
|
+
# @return [String]
|
1834
|
+
#
|
1835
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
1836
|
+
# The Amazon Resource Name (ARN) of the infrastruction configuration
|
1837
|
+
# associated with this image pipeline.
|
1838
|
+
# @return [String]
|
1839
|
+
#
|
1840
|
+
# @!attribute [rw] distribution_configuration_arn
|
1841
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
1842
|
+
# associated with this image pipeline.
|
1843
|
+
# @return [String]
|
1844
|
+
#
|
1845
|
+
# @!attribute [rw] image_tests_configuration
|
1846
|
+
# The image tests configuration of the image pipeline.
|
1847
|
+
# @return [Types::ImageTestsConfiguration]
|
1848
|
+
#
|
1849
|
+
# @!attribute [rw] schedule
|
1850
|
+
# The schedule of the image pipeline.
|
1851
|
+
# @return [Types::Schedule]
|
1852
|
+
#
|
1853
|
+
# @!attribute [rw] status
|
1854
|
+
# The status of the image pipeline.
|
1855
|
+
# @return [String]
|
1856
|
+
#
|
1857
|
+
# @!attribute [rw] date_created
|
1858
|
+
# The date on which this image pipeline was created.
|
1859
|
+
# @return [String]
|
1860
|
+
#
|
1861
|
+
# @!attribute [rw] date_updated
|
1862
|
+
# The date on which this image pipeline was last updated.
|
1863
|
+
# @return [String]
|
1864
|
+
#
|
1865
|
+
# @!attribute [rw] date_last_run
|
1866
|
+
# The date on which this image pipeline was last run.
|
1867
|
+
# @return [String]
|
1868
|
+
#
|
1869
|
+
# @!attribute [rw] date_next_run
|
1870
|
+
# The date on which this image pipeline will next be run.
|
1871
|
+
# @return [String]
|
1872
|
+
#
|
1873
|
+
# @!attribute [rw] tags
|
1874
|
+
# The tags of this image pipeline.
|
1875
|
+
# @return [Hash<String,String>]
|
1876
|
+
#
|
1877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImagePipeline AWS API Documentation
|
1878
|
+
#
|
1879
|
+
class ImagePipeline < Struct.new(
|
1880
|
+
:arn,
|
1881
|
+
:name,
|
1882
|
+
:description,
|
1883
|
+
:platform,
|
1884
|
+
:image_recipe_arn,
|
1885
|
+
:infrastructure_configuration_arn,
|
1886
|
+
:distribution_configuration_arn,
|
1887
|
+
:image_tests_configuration,
|
1888
|
+
:schedule,
|
1889
|
+
:status,
|
1890
|
+
:date_created,
|
1891
|
+
:date_updated,
|
1892
|
+
:date_last_run,
|
1893
|
+
:date_next_run,
|
1894
|
+
:tags)
|
1895
|
+
include Aws::Structure
|
1896
|
+
end
|
1897
|
+
|
1898
|
+
# An image recipe.
|
1899
|
+
#
|
1900
|
+
# @!attribute [rw] arn
|
1901
|
+
# The Amazon Resource Name (ARN) of the image recipe.
|
1902
|
+
# @return [String]
|
1903
|
+
#
|
1904
|
+
# @!attribute [rw] name
|
1905
|
+
# The name of the image recipe.
|
1906
|
+
# @return [String]
|
1907
|
+
#
|
1908
|
+
# @!attribute [rw] description
|
1909
|
+
# The description of the image recipe.
|
1910
|
+
# @return [String]
|
1911
|
+
#
|
1912
|
+
# @!attribute [rw] platform
|
1913
|
+
# The platform of the image recipe.
|
1914
|
+
# @return [String]
|
1915
|
+
#
|
1916
|
+
# @!attribute [rw] owner
|
1917
|
+
# The owner of the image recipe.
|
1918
|
+
# @return [String]
|
1919
|
+
#
|
1920
|
+
# @!attribute [rw] version
|
1921
|
+
# The version of the image recipe.
|
1922
|
+
# @return [String]
|
1923
|
+
#
|
1924
|
+
# @!attribute [rw] components
|
1925
|
+
# The components of the image recipe.
|
1926
|
+
# @return [Array<Types::ComponentConfiguration>]
|
1927
|
+
#
|
1928
|
+
# @!attribute [rw] parent_image
|
1929
|
+
# The parent image of the image recipe.
|
1930
|
+
# @return [String]
|
1931
|
+
#
|
1932
|
+
# @!attribute [rw] block_device_mappings
|
1933
|
+
# The block device mappings to apply when creating images from this
|
1934
|
+
# recipe.
|
1935
|
+
# @return [Array<Types::InstanceBlockDeviceMapping>]
|
1936
|
+
#
|
1937
|
+
# @!attribute [rw] date_created
|
1938
|
+
# The date on which this image recipe was created.
|
1939
|
+
# @return [String]
|
1940
|
+
#
|
1941
|
+
# @!attribute [rw] tags
|
1942
|
+
# The tags of the image recipe.
|
1943
|
+
# @return [Hash<String,String>]
|
1944
|
+
#
|
1945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageRecipe AWS API Documentation
|
1946
|
+
#
|
1947
|
+
class ImageRecipe < Struct.new(
|
1948
|
+
:arn,
|
1949
|
+
:name,
|
1950
|
+
:description,
|
1951
|
+
:platform,
|
1952
|
+
:owner,
|
1953
|
+
:version,
|
1954
|
+
:components,
|
1955
|
+
:parent_image,
|
1956
|
+
:block_device_mappings,
|
1957
|
+
:date_created,
|
1958
|
+
:tags)
|
1959
|
+
include Aws::Structure
|
1960
|
+
end
|
1961
|
+
|
1962
|
+
# A summary of an image recipe.
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] arn
|
1965
|
+
# The Amazon Resource Name (ARN) of the image recipe.
|
1966
|
+
# @return [String]
|
1967
|
+
#
|
1968
|
+
# @!attribute [rw] name
|
1969
|
+
# The name of the image recipe.
|
1970
|
+
# @return [String]
|
1971
|
+
#
|
1972
|
+
# @!attribute [rw] platform
|
1973
|
+
# The platform of the image recipe.
|
1974
|
+
# @return [String]
|
1975
|
+
#
|
1976
|
+
# @!attribute [rw] owner
|
1977
|
+
# The owner of the image recipe.
|
1978
|
+
# @return [String]
|
1979
|
+
#
|
1980
|
+
# @!attribute [rw] parent_image
|
1981
|
+
# The parent image of the image recipe.
|
1982
|
+
# @return [String]
|
1983
|
+
#
|
1984
|
+
# @!attribute [rw] date_created
|
1985
|
+
# The date on which this image recipe was created.
|
1986
|
+
# @return [String]
|
1987
|
+
#
|
1988
|
+
# @!attribute [rw] tags
|
1989
|
+
# The tags of the image recipe.
|
1990
|
+
# @return [Hash<String,String>]
|
1991
|
+
#
|
1992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageRecipeSummary AWS API Documentation
|
1993
|
+
#
|
1994
|
+
class ImageRecipeSummary < Struct.new(
|
1995
|
+
:arn,
|
1996
|
+
:name,
|
1997
|
+
:platform,
|
1998
|
+
:owner,
|
1999
|
+
:parent_image,
|
2000
|
+
:date_created,
|
2001
|
+
:tags)
|
2002
|
+
include Aws::Structure
|
2003
|
+
end
|
2004
|
+
|
2005
|
+
# Image state shows the images status and the reason for that status.
|
2006
|
+
#
|
2007
|
+
# @!attribute [rw] status
|
2008
|
+
# The status of the image.
|
2009
|
+
# @return [String]
|
2010
|
+
#
|
2011
|
+
# @!attribute [rw] reason
|
2012
|
+
# The reason for the image's status.
|
2013
|
+
# @return [String]
|
2014
|
+
#
|
2015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageState AWS API Documentation
|
2016
|
+
#
|
2017
|
+
class ImageState < Struct.new(
|
2018
|
+
:status,
|
2019
|
+
:reason)
|
2020
|
+
include Aws::Structure
|
2021
|
+
end
|
2022
|
+
|
2023
|
+
# An image summary.
|
2024
|
+
#
|
2025
|
+
# @!attribute [rw] arn
|
2026
|
+
# The Amazon Resource Name (ARN) of the image.
|
2027
|
+
# @return [String]
|
2028
|
+
#
|
2029
|
+
# @!attribute [rw] name
|
2030
|
+
# The name of the image.
|
2031
|
+
# @return [String]
|
2032
|
+
#
|
2033
|
+
# @!attribute [rw] version
|
2034
|
+
# The version of the image.
|
2035
|
+
# @return [String]
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] platform
|
2038
|
+
# The platform of the image.
|
2039
|
+
# @return [String]
|
2040
|
+
#
|
2041
|
+
# @!attribute [rw] state
|
2042
|
+
# The state of the image.
|
2043
|
+
# @return [Types::ImageState]
|
2044
|
+
#
|
2045
|
+
# @!attribute [rw] owner
|
2046
|
+
# The owner of the image.
|
2047
|
+
# @return [String]
|
2048
|
+
#
|
2049
|
+
# @!attribute [rw] date_created
|
2050
|
+
# The date on which this image was created.
|
2051
|
+
# @return [String]
|
2052
|
+
#
|
2053
|
+
# @!attribute [rw] output_resources
|
2054
|
+
# The output resources produced when creating this image.
|
2055
|
+
# @return [Types::OutputResources]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] tags
|
2058
|
+
# The tags of the image.
|
2059
|
+
# @return [Hash<String,String>]
|
2060
|
+
#
|
2061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageSummary AWS API Documentation
|
2062
|
+
#
|
2063
|
+
class ImageSummary < Struct.new(
|
2064
|
+
:arn,
|
2065
|
+
:name,
|
2066
|
+
:version,
|
2067
|
+
:platform,
|
2068
|
+
:state,
|
2069
|
+
:owner,
|
2070
|
+
:date_created,
|
2071
|
+
:output_resources,
|
2072
|
+
:tags)
|
2073
|
+
include Aws::Structure
|
2074
|
+
end
|
2075
|
+
|
2076
|
+
# Image tests configuration.
|
2077
|
+
#
|
2078
|
+
# @note When making an API call, you may pass ImageTestsConfiguration
|
2079
|
+
# data as a hash:
|
2080
|
+
#
|
2081
|
+
# {
|
2082
|
+
# image_tests_enabled: false,
|
2083
|
+
# timeout_minutes: 1,
|
2084
|
+
# }
|
2085
|
+
#
|
2086
|
+
# @!attribute [rw] image_tests_enabled
|
2087
|
+
# Defines if tests should be executed when building this image.
|
2088
|
+
# @return [Boolean]
|
2089
|
+
#
|
2090
|
+
# @!attribute [rw] timeout_minutes
|
2091
|
+
# The maximum time in minutes that tests are permitted to run for.
|
2092
|
+
# @return [Integer]
|
2093
|
+
#
|
2094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageTestsConfiguration AWS API Documentation
|
2095
|
+
#
|
2096
|
+
class ImageTestsConfiguration < Struct.new(
|
2097
|
+
:image_tests_enabled,
|
2098
|
+
:timeout_minutes)
|
2099
|
+
include Aws::Structure
|
2100
|
+
end
|
2101
|
+
|
2102
|
+
# An image semantic version.
|
2103
|
+
#
|
2104
|
+
# @!attribute [rw] arn
|
2105
|
+
# The Amazon Resource Name (ARN) of the image semantic verion.
|
2106
|
+
# @return [String]
|
2107
|
+
#
|
2108
|
+
# @!attribute [rw] name
|
2109
|
+
# The name of the image semantic version.
|
2110
|
+
# @return [String]
|
2111
|
+
#
|
2112
|
+
# @!attribute [rw] version
|
2113
|
+
# The semantic version of the image semantic version.
|
2114
|
+
# @return [String]
|
2115
|
+
#
|
2116
|
+
# @!attribute [rw] platform
|
2117
|
+
# The platform of the image semantic version.
|
2118
|
+
# @return [String]
|
2119
|
+
#
|
2120
|
+
# @!attribute [rw] owner
|
2121
|
+
# The owner of the image semantic version.
|
2122
|
+
# @return [String]
|
2123
|
+
#
|
2124
|
+
# @!attribute [rw] date_created
|
2125
|
+
# The date at which this image semantic version was created.
|
2126
|
+
# @return [String]
|
2127
|
+
#
|
2128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImageVersion AWS API Documentation
|
2129
|
+
#
|
2130
|
+
class ImageVersion < Struct.new(
|
2131
|
+
:arn,
|
2132
|
+
:name,
|
2133
|
+
:version,
|
2134
|
+
:platform,
|
2135
|
+
:owner,
|
2136
|
+
:date_created)
|
2137
|
+
include Aws::Structure
|
2138
|
+
end
|
2139
|
+
|
2140
|
+
# @note When making an API call, you may pass ImportComponentRequest
|
2141
|
+
# data as a hash:
|
2142
|
+
#
|
2143
|
+
# {
|
2144
|
+
# name: "ResourceName", # required
|
2145
|
+
# semantic_version: "VersionNumber", # required
|
2146
|
+
# description: "NonEmptyString",
|
2147
|
+
# change_description: "NonEmptyString",
|
2148
|
+
# type: "BUILD", # required, accepts BUILD, TEST
|
2149
|
+
# format: "SHELL", # required, accepts SHELL
|
2150
|
+
# platform: "Windows", # required, accepts Windows, Linux
|
2151
|
+
# data: "NonEmptyString",
|
2152
|
+
# uri: "Uri",
|
2153
|
+
# kms_key_id: "NonEmptyString",
|
2154
|
+
# tags: {
|
2155
|
+
# "TagKey" => "TagValue",
|
2156
|
+
# },
|
2157
|
+
# client_token: "ClientToken", # required
|
2158
|
+
# }
|
2159
|
+
#
|
2160
|
+
# @!attribute [rw] name
|
2161
|
+
# The name of the component.
|
2162
|
+
# @return [String]
|
2163
|
+
#
|
2164
|
+
# @!attribute [rw] semantic_version
|
2165
|
+
# The semantic version of the component. This version to follow the
|
2166
|
+
# semantic version syntax. i.e. major.minor.patch. This could be
|
2167
|
+
# versioned like software 2.0.1 or date like 2019.12.01.
|
2168
|
+
# @return [String]
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] description
|
2171
|
+
# The description of the component. Describes the contents of the
|
2172
|
+
# component.
|
2173
|
+
# @return [String]
|
2174
|
+
#
|
2175
|
+
# @!attribute [rw] change_description
|
2176
|
+
# The change description of the component. Describes what change has
|
2177
|
+
# been made in this version. In other words what makes this version
|
2178
|
+
# different from other versions of this component.
|
2179
|
+
# @return [String]
|
2180
|
+
#
|
2181
|
+
# @!attribute [rw] type
|
2182
|
+
# The type of the component denotes whether the component is used to
|
2183
|
+
# build the image or only to test it.
|
2184
|
+
# @return [String]
|
2185
|
+
#
|
2186
|
+
# @!attribute [rw] format
|
2187
|
+
# The format of the resource that you wish to import as a component.
|
2188
|
+
# @return [String]
|
2189
|
+
#
|
2190
|
+
# @!attribute [rw] platform
|
2191
|
+
# The platform of the component.
|
2192
|
+
# @return [String]
|
2193
|
+
#
|
2194
|
+
# @!attribute [rw] data
|
2195
|
+
# The data of the component.
|
2196
|
+
# @return [String]
|
2197
|
+
#
|
2198
|
+
# @!attribute [rw] uri
|
2199
|
+
# The uri of the component.
|
2200
|
+
# @return [String]
|
2201
|
+
#
|
2202
|
+
# @!attribute [rw] kms_key_id
|
2203
|
+
# The ID of the KMS key that should be used to encrypt this component.
|
2204
|
+
# @return [String]
|
2205
|
+
#
|
2206
|
+
# @!attribute [rw] tags
|
2207
|
+
# The tags of the component.
|
2208
|
+
# @return [Hash<String,String>]
|
2209
|
+
#
|
2210
|
+
# @!attribute [rw] client_token
|
2211
|
+
# The idempotency token of the component.
|
2212
|
+
#
|
2213
|
+
# **A suitable default value is auto-generated.** You should normally
|
2214
|
+
# not need to pass this option.
|
2215
|
+
# @return [String]
|
2216
|
+
#
|
2217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImportComponentRequest AWS API Documentation
|
2218
|
+
#
|
2219
|
+
class ImportComponentRequest < Struct.new(
|
2220
|
+
:name,
|
2221
|
+
:semantic_version,
|
2222
|
+
:description,
|
2223
|
+
:change_description,
|
2224
|
+
:type,
|
2225
|
+
:format,
|
2226
|
+
:platform,
|
2227
|
+
:data,
|
2228
|
+
:uri,
|
2229
|
+
:kms_key_id,
|
2230
|
+
:tags,
|
2231
|
+
:client_token)
|
2232
|
+
include Aws::Structure
|
2233
|
+
end
|
2234
|
+
|
2235
|
+
# @!attribute [rw] request_id
|
2236
|
+
# The request ID that uniquely identifies this request.
|
2237
|
+
# @return [String]
|
2238
|
+
#
|
2239
|
+
# @!attribute [rw] client_token
|
2240
|
+
# The idempotency token used to make this request idempotent.
|
2241
|
+
# @return [String]
|
2242
|
+
#
|
2243
|
+
# @!attribute [rw] component_build_version_arn
|
2244
|
+
# The Amazon Resource Name (ARN) of the imported component.
|
2245
|
+
# @return [String]
|
2246
|
+
#
|
2247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImportComponentResponse AWS API Documentation
|
2248
|
+
#
|
2249
|
+
class ImportComponentResponse < Struct.new(
|
2250
|
+
:request_id,
|
2251
|
+
:client_token,
|
2252
|
+
:component_build_version_arn)
|
2253
|
+
include Aws::Structure
|
2254
|
+
end
|
2255
|
+
|
2256
|
+
# Details of the infrastructure configuration.
|
2257
|
+
#
|
2258
|
+
# @!attribute [rw] arn
|
2259
|
+
# The Amazon Resource Name (ARN) of the infrastruction configuration.
|
2260
|
+
# @return [String]
|
2261
|
+
#
|
2262
|
+
# @!attribute [rw] name
|
2263
|
+
# The name of the infrastruction configuration.
|
2264
|
+
# @return [String]
|
2265
|
+
#
|
2266
|
+
# @!attribute [rw] description
|
2267
|
+
# The description of the infrastruction configuration.
|
2268
|
+
# @return [String]
|
2269
|
+
#
|
2270
|
+
# @!attribute [rw] instance_types
|
2271
|
+
# The instance types of the infrastruction configuration.
|
2272
|
+
# @return [Array<String>]
|
2273
|
+
#
|
2274
|
+
# @!attribute [rw] instance_profile_name
|
2275
|
+
# The instance profile of the infrastruction configuration.
|
2276
|
+
# @return [String]
|
2277
|
+
#
|
2278
|
+
# @!attribute [rw] security_group_ids
|
2279
|
+
# The security group IDs of the infrastruction configuration.
|
2280
|
+
# @return [Array<String>]
|
2281
|
+
#
|
2282
|
+
# @!attribute [rw] subnet_id
|
2283
|
+
# The subnet ID of the infrastruction configuration.
|
2284
|
+
# @return [String]
|
2285
|
+
#
|
2286
|
+
# @!attribute [rw] logging
|
2287
|
+
# The logging configuration of the infrastruction configuration.
|
2288
|
+
# @return [Types::Logging]
|
2289
|
+
#
|
2290
|
+
# @!attribute [rw] key_pair
|
2291
|
+
# The EC2 key pair of the infrastruction configuration.
|
2292
|
+
# @return [String]
|
2293
|
+
#
|
2294
|
+
# @!attribute [rw] terminate_instance_on_failure
|
2295
|
+
# The terminate instance on failure configuration of the
|
2296
|
+
# infrastruction configuration.
|
2297
|
+
# @return [Boolean]
|
2298
|
+
#
|
2299
|
+
# @!attribute [rw] sns_topic_arn
|
2300
|
+
# The SNS Topic Amazon Resource Name (ARN) of the infrastruction
|
2301
|
+
# configuration.
|
2302
|
+
# @return [String]
|
2303
|
+
#
|
2304
|
+
# @!attribute [rw] date_created
|
2305
|
+
# The date on which the infrastructure configuration was created.
|
2306
|
+
# @return [String]
|
2307
|
+
#
|
2308
|
+
# @!attribute [rw] date_updated
|
2309
|
+
# The date on which the infrastructure configuration was last updated.
|
2310
|
+
# @return [String]
|
2311
|
+
#
|
2312
|
+
# @!attribute [rw] tags
|
2313
|
+
# The tags of the infrastruction configuration.
|
2314
|
+
# @return [Hash<String,String>]
|
2315
|
+
#
|
2316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InfrastructureConfiguration AWS API Documentation
|
2317
|
+
#
|
2318
|
+
class InfrastructureConfiguration < Struct.new(
|
2319
|
+
:arn,
|
2320
|
+
:name,
|
2321
|
+
:description,
|
2322
|
+
:instance_types,
|
2323
|
+
:instance_profile_name,
|
2324
|
+
:security_group_ids,
|
2325
|
+
:subnet_id,
|
2326
|
+
:logging,
|
2327
|
+
:key_pair,
|
2328
|
+
:terminate_instance_on_failure,
|
2329
|
+
:sns_topic_arn,
|
2330
|
+
:date_created,
|
2331
|
+
:date_updated,
|
2332
|
+
:tags)
|
2333
|
+
include Aws::Structure
|
2334
|
+
end
|
2335
|
+
|
2336
|
+
# The infrastructure used when building EC2 AMIs.
|
2337
|
+
#
|
2338
|
+
# @!attribute [rw] arn
|
2339
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration.
|
2340
|
+
# @return [String]
|
2341
|
+
#
|
2342
|
+
# @!attribute [rw] name
|
2343
|
+
# The name of the infrastructure configuration.
|
2344
|
+
# @return [String]
|
2345
|
+
#
|
2346
|
+
# @!attribute [rw] description
|
2347
|
+
# The description of the infrastructure configuration.
|
2348
|
+
# @return [String]
|
2349
|
+
#
|
2350
|
+
# @!attribute [rw] date_created
|
2351
|
+
# The date on which the infrastructure configuration was created.
|
2352
|
+
# @return [String]
|
2353
|
+
#
|
2354
|
+
# @!attribute [rw] date_updated
|
2355
|
+
# The date on which the infrastructure configuration was last updated.
|
2356
|
+
# @return [String]
|
2357
|
+
#
|
2358
|
+
# @!attribute [rw] tags
|
2359
|
+
# The tags of the infrastructure configuration.
|
2360
|
+
# @return [Hash<String,String>]
|
2361
|
+
#
|
2362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InfrastructureConfigurationSummary AWS API Documentation
|
2363
|
+
#
|
2364
|
+
class InfrastructureConfigurationSummary < Struct.new(
|
2365
|
+
:arn,
|
2366
|
+
:name,
|
2367
|
+
:description,
|
2368
|
+
:date_created,
|
2369
|
+
:date_updated,
|
2370
|
+
:tags)
|
2371
|
+
include Aws::Structure
|
2372
|
+
end
|
2373
|
+
|
2374
|
+
# Defines block device mappings for the instance used to configure your
|
2375
|
+
# image.
|
2376
|
+
#
|
2377
|
+
# @note When making an API call, you may pass InstanceBlockDeviceMapping
|
2378
|
+
# data as a hash:
|
2379
|
+
#
|
2380
|
+
# {
|
2381
|
+
# device_name: "NonEmptyString",
|
2382
|
+
# ebs: {
|
2383
|
+
# encrypted: false,
|
2384
|
+
# delete_on_termination: false,
|
2385
|
+
# iops: 1,
|
2386
|
+
# kms_key_id: "NonEmptyString",
|
2387
|
+
# snapshot_id: "NonEmptyString",
|
2388
|
+
# volume_size: 1,
|
2389
|
+
# volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
|
2390
|
+
# },
|
2391
|
+
# virtual_name: "NonEmptyString",
|
2392
|
+
# no_device: "NonEmptyString",
|
2393
|
+
# }
|
2394
|
+
#
|
2395
|
+
# @!attribute [rw] device_name
|
2396
|
+
# The device to which these mappings apply.
|
2397
|
+
# @return [String]
|
2398
|
+
#
|
2399
|
+
# @!attribute [rw] ebs
|
2400
|
+
# Use to manage EBS specific configuration for this mapping.
|
2401
|
+
# @return [Types::EbsInstanceBlockDeviceSpecification]
|
2402
|
+
#
|
2403
|
+
# @!attribute [rw] virtual_name
|
2404
|
+
# Use to manage instance ephemeral devices.
|
2405
|
+
# @return [String]
|
2406
|
+
#
|
2407
|
+
# @!attribute [rw] no_device
|
2408
|
+
# Use to remove a mapping from the parent image.
|
2409
|
+
# @return [String]
|
2410
|
+
#
|
2411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InstanceBlockDeviceMapping AWS API Documentation
|
2412
|
+
#
|
2413
|
+
class InstanceBlockDeviceMapping < Struct.new(
|
2414
|
+
:device_name,
|
2415
|
+
:ebs,
|
2416
|
+
:virtual_name,
|
2417
|
+
:no_device)
|
2418
|
+
include Aws::Structure
|
2419
|
+
end
|
2420
|
+
|
2421
|
+
# You have provided an invalid pagination token in your request.
|
2422
|
+
#
|
2423
|
+
# @!attribute [rw] message
|
2424
|
+
# @return [String]
|
2425
|
+
#
|
2426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InvalidPaginationTokenException AWS API Documentation
|
2427
|
+
#
|
2428
|
+
class InvalidPaginationTokenException < Struct.new(
|
2429
|
+
:message)
|
2430
|
+
include Aws::Structure
|
2431
|
+
end
|
2432
|
+
|
2433
|
+
# You have specified two or more mutually exclusive parameters. Review
|
2434
|
+
# the error message for details.
|
2435
|
+
#
|
2436
|
+
# @!attribute [rw] message
|
2437
|
+
# @return [String]
|
2438
|
+
#
|
2439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InvalidParameterCombinationException AWS API Documentation
|
2440
|
+
#
|
2441
|
+
class InvalidParameterCombinationException < Struct.new(
|
2442
|
+
:message)
|
2443
|
+
include Aws::Structure
|
2444
|
+
end
|
2445
|
+
|
2446
|
+
# The specified parameter is invalid. Review the available parameters
|
2447
|
+
# for the API request.
|
2448
|
+
#
|
2449
|
+
# @!attribute [rw] message
|
2450
|
+
# @return [String]
|
2451
|
+
#
|
2452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InvalidParameterException AWS API Documentation
|
2453
|
+
#
|
2454
|
+
class InvalidParameterException < Struct.new(
|
2455
|
+
:message)
|
2456
|
+
include Aws::Structure
|
2457
|
+
end
|
2458
|
+
|
2459
|
+
# The value that you provided for the specified parameter is invalid.
|
2460
|
+
#
|
2461
|
+
# @!attribute [rw] message
|
2462
|
+
# @return [String]
|
2463
|
+
#
|
2464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InvalidParameterValueException AWS API Documentation
|
2465
|
+
#
|
2466
|
+
class InvalidParameterValueException < Struct.new(
|
2467
|
+
:message)
|
2468
|
+
include Aws::Structure
|
2469
|
+
end
|
2470
|
+
|
2471
|
+
# You have made a request for an action that is not supported by the
|
2472
|
+
# service.
|
2473
|
+
#
|
2474
|
+
# @!attribute [rw] message
|
2475
|
+
# @return [String]
|
2476
|
+
#
|
2477
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InvalidRequestException AWS API Documentation
|
2478
|
+
#
|
2479
|
+
class InvalidRequestException < Struct.new(
|
2480
|
+
:message)
|
2481
|
+
include Aws::Structure
|
2482
|
+
end
|
2483
|
+
|
2484
|
+
# Your version number is out of bounds or does not follow the required
|
2485
|
+
# syntax.
|
2486
|
+
#
|
2487
|
+
# @!attribute [rw] message
|
2488
|
+
# @return [String]
|
2489
|
+
#
|
2490
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/InvalidVersionNumberException AWS API Documentation
|
2491
|
+
#
|
2492
|
+
class InvalidVersionNumberException < Struct.new(
|
2493
|
+
:message)
|
2494
|
+
include Aws::Structure
|
2495
|
+
end
|
2496
|
+
|
2497
|
+
# @note When making an API call, you may pass LaunchPermissionConfiguration
|
2498
|
+
# data as a hash:
|
2499
|
+
#
|
2500
|
+
# {
|
2501
|
+
# user_ids: ["NonEmptyString"],
|
2502
|
+
# user_groups: ["NonEmptyString"],
|
2503
|
+
# }
|
2504
|
+
#
|
2505
|
+
# @!attribute [rw] user_ids
|
2506
|
+
# @return [Array<String>]
|
2507
|
+
#
|
2508
|
+
# @!attribute [rw] user_groups
|
2509
|
+
# @return [Array<String>]
|
2510
|
+
#
|
2511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/LaunchPermissionConfiguration AWS API Documentation
|
2512
|
+
#
|
2513
|
+
class LaunchPermissionConfiguration < Struct.new(
|
2514
|
+
:user_ids,
|
2515
|
+
:user_groups)
|
2516
|
+
include Aws::Structure
|
2517
|
+
end
|
2518
|
+
|
2519
|
+
# @note When making an API call, you may pass ListComponentBuildVersionsRequest
|
2520
|
+
# data as a hash:
|
2521
|
+
#
|
2522
|
+
# {
|
2523
|
+
# component_version_arn: "ComponentVersionArn", # required
|
2524
|
+
# max_results: 1,
|
2525
|
+
# next_token: "NonEmptyString",
|
2526
|
+
# }
|
2527
|
+
#
|
2528
|
+
# @!attribute [rw] component_version_arn
|
2529
|
+
# The component version arn whose versions you wish to list.
|
2530
|
+
# @return [String]
|
2531
|
+
#
|
2532
|
+
# @!attribute [rw] max_results
|
2533
|
+
# The maximum items to return in a request.
|
2534
|
+
# @return [Integer]
|
2535
|
+
#
|
2536
|
+
# @!attribute [rw] next_token
|
2537
|
+
# A token to specify where to start paginating. This is the NextToken
|
2538
|
+
# from a previously truncated response.
|
2539
|
+
# @return [String]
|
2540
|
+
#
|
2541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListComponentBuildVersionsRequest AWS API Documentation
|
2542
|
+
#
|
2543
|
+
class ListComponentBuildVersionsRequest < Struct.new(
|
2544
|
+
:component_version_arn,
|
2545
|
+
:max_results,
|
2546
|
+
:next_token)
|
2547
|
+
include Aws::Structure
|
2548
|
+
end
|
2549
|
+
|
2550
|
+
# @!attribute [rw] request_id
|
2551
|
+
# The request ID that uniquely identifies this request.
|
2552
|
+
# @return [String]
|
2553
|
+
#
|
2554
|
+
# @!attribute [rw] component_summary_list
|
2555
|
+
# The list of component summaries for the specified semantic version.
|
2556
|
+
# @return [Array<Types::ComponentSummary>]
|
2557
|
+
#
|
2558
|
+
# @!attribute [rw] next_token
|
2559
|
+
# The next token used for paginated responses. When this is not empty
|
2560
|
+
# then there are additional elements that the service that not include
|
2561
|
+
# in this request. Use this token with the next request to retrieve
|
2562
|
+
# additional object.
|
2563
|
+
# @return [String]
|
2564
|
+
#
|
2565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListComponentBuildVersionsResponse AWS API Documentation
|
2566
|
+
#
|
2567
|
+
class ListComponentBuildVersionsResponse < Struct.new(
|
2568
|
+
:request_id,
|
2569
|
+
:component_summary_list,
|
2570
|
+
:next_token)
|
2571
|
+
include Aws::Structure
|
2572
|
+
end
|
2573
|
+
|
2574
|
+
# @note When making an API call, you may pass ListComponentsRequest
|
2575
|
+
# data as a hash:
|
2576
|
+
#
|
2577
|
+
# {
|
2578
|
+
# owner: "Self", # accepts Self, Shared, Amazon
|
2579
|
+
# filters: [
|
2580
|
+
# {
|
2581
|
+
# name: "FilterName",
|
2582
|
+
# values: ["FilterValue"],
|
2583
|
+
# },
|
2584
|
+
# ],
|
2585
|
+
# max_results: 1,
|
2586
|
+
# next_token: "NonEmptyString",
|
2587
|
+
# }
|
2588
|
+
#
|
2589
|
+
# @!attribute [rw] owner
|
2590
|
+
# The owner defines whose components you wish to list. By default this
|
2591
|
+
# request will only show components owned by your account. You may use
|
2592
|
+
# this field to specify if you wish to view components owned by
|
2593
|
+
# yourself, Amazon, or those components that have been shared with you
|
2594
|
+
# by other customers.
|
2595
|
+
# @return [String]
|
2596
|
+
#
|
2597
|
+
# @!attribute [rw] filters
|
2598
|
+
# @return [Array<Types::Filter>]
|
2599
|
+
#
|
2600
|
+
# @!attribute [rw] max_results
|
2601
|
+
# The maximum items to return in a request.
|
2602
|
+
# @return [Integer]
|
2603
|
+
#
|
2604
|
+
# @!attribute [rw] next_token
|
2605
|
+
# A token to specify where to start paginating. This is the NextToken
|
2606
|
+
# from a previously truncated response.
|
2607
|
+
# @return [String]
|
2608
|
+
#
|
2609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListComponentsRequest AWS API Documentation
|
2610
|
+
#
|
2611
|
+
class ListComponentsRequest < Struct.new(
|
2612
|
+
:owner,
|
2613
|
+
:filters,
|
2614
|
+
:max_results,
|
2615
|
+
:next_token)
|
2616
|
+
include Aws::Structure
|
2617
|
+
end
|
2618
|
+
|
2619
|
+
# @!attribute [rw] request_id
|
2620
|
+
# The request ID that uniquely identifies this request.
|
2621
|
+
# @return [String]
|
2622
|
+
#
|
2623
|
+
# @!attribute [rw] component_version_list
|
2624
|
+
# The list of component semantic versions.
|
2625
|
+
# @return [Array<Types::ComponentVersion>]
|
2626
|
+
#
|
2627
|
+
# @!attribute [rw] next_token
|
2628
|
+
# The next token used for paginated responses. When this is not empty
|
2629
|
+
# then there are additional elements that the service that not include
|
2630
|
+
# in this request. Use this token with the next request to retrieve
|
2631
|
+
# additional object.
|
2632
|
+
# @return [String]
|
2633
|
+
#
|
2634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListComponentsResponse AWS API Documentation
|
2635
|
+
#
|
2636
|
+
class ListComponentsResponse < Struct.new(
|
2637
|
+
:request_id,
|
2638
|
+
:component_version_list,
|
2639
|
+
:next_token)
|
2640
|
+
include Aws::Structure
|
2641
|
+
end
|
2642
|
+
|
2643
|
+
# @note When making an API call, you may pass ListDistributionConfigurationsRequest
|
2644
|
+
# data as a hash:
|
2645
|
+
#
|
2646
|
+
# {
|
2647
|
+
# filters: [
|
2648
|
+
# {
|
2649
|
+
# name: "FilterName",
|
2650
|
+
# values: ["FilterValue"],
|
2651
|
+
# },
|
2652
|
+
# ],
|
2653
|
+
# max_results: 1,
|
2654
|
+
# next_token: "NonEmptyString",
|
2655
|
+
# }
|
2656
|
+
#
|
2657
|
+
# @!attribute [rw] filters
|
2658
|
+
# @return [Array<Types::Filter>]
|
2659
|
+
#
|
2660
|
+
# @!attribute [rw] max_results
|
2661
|
+
# The maximum items to return in a request.
|
2662
|
+
# @return [Integer]
|
2663
|
+
#
|
2664
|
+
# @!attribute [rw] next_token
|
2665
|
+
# A token to specify where to start paginating. This is the NextToken
|
2666
|
+
# from a previously truncated response.
|
2667
|
+
# @return [String]
|
2668
|
+
#
|
2669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListDistributionConfigurationsRequest AWS API Documentation
|
2670
|
+
#
|
2671
|
+
class ListDistributionConfigurationsRequest < Struct.new(
|
2672
|
+
:filters,
|
2673
|
+
:max_results,
|
2674
|
+
:next_token)
|
2675
|
+
include Aws::Structure
|
2676
|
+
end
|
2677
|
+
|
2678
|
+
# @!attribute [rw] request_id
|
2679
|
+
# The request ID that uniquely identifies this request.
|
2680
|
+
# @return [String]
|
2681
|
+
#
|
2682
|
+
# @!attribute [rw] distribution_configuration_summary_list
|
2683
|
+
# The list of distributions.
|
2684
|
+
# @return [Array<Types::DistributionConfigurationSummary>]
|
2685
|
+
#
|
2686
|
+
# @!attribute [rw] next_token
|
2687
|
+
# The next token used for paginated responses. When this is not empty
|
2688
|
+
# then there are additional elements that the service that not include
|
2689
|
+
# in this request. Use this token with the next request to retrieve
|
2690
|
+
# additional object.
|
2691
|
+
# @return [String]
|
2692
|
+
#
|
2693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListDistributionConfigurationsResponse AWS API Documentation
|
2694
|
+
#
|
2695
|
+
class ListDistributionConfigurationsResponse < Struct.new(
|
2696
|
+
:request_id,
|
2697
|
+
:distribution_configuration_summary_list,
|
2698
|
+
:next_token)
|
2699
|
+
include Aws::Structure
|
2700
|
+
end
|
2701
|
+
|
2702
|
+
# @note When making an API call, you may pass ListImageBuildVersionsRequest
|
2703
|
+
# data as a hash:
|
2704
|
+
#
|
2705
|
+
# {
|
2706
|
+
# image_version_arn: "ImageVersionArn", # required
|
2707
|
+
# filters: [
|
2708
|
+
# {
|
2709
|
+
# name: "FilterName",
|
2710
|
+
# values: ["FilterValue"],
|
2711
|
+
# },
|
2712
|
+
# ],
|
2713
|
+
# max_results: 1,
|
2714
|
+
# next_token: "NonEmptyString",
|
2715
|
+
# }
|
2716
|
+
#
|
2717
|
+
# @!attribute [rw] image_version_arn
|
2718
|
+
# The Amazon Resource Name (ARN) of the image whose build versions you
|
2719
|
+
# wish to retrieve.
|
2720
|
+
# @return [String]
|
2721
|
+
#
|
2722
|
+
# @!attribute [rw] filters
|
2723
|
+
# @return [Array<Types::Filter>]
|
2724
|
+
#
|
2725
|
+
# @!attribute [rw] max_results
|
2726
|
+
# The maximum items to return in a request.
|
2727
|
+
# @return [Integer]
|
2728
|
+
#
|
2729
|
+
# @!attribute [rw] next_token
|
2730
|
+
# A token to specify where to start paginating. This is the NextToken
|
2731
|
+
# from a previously truncated response.
|
2732
|
+
# @return [String]
|
2733
|
+
#
|
2734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImageBuildVersionsRequest AWS API Documentation
|
2735
|
+
#
|
2736
|
+
class ListImageBuildVersionsRequest < Struct.new(
|
2737
|
+
:image_version_arn,
|
2738
|
+
:filters,
|
2739
|
+
:max_results,
|
2740
|
+
:next_token)
|
2741
|
+
include Aws::Structure
|
2742
|
+
end
|
2743
|
+
|
2744
|
+
# @!attribute [rw] request_id
|
2745
|
+
# The request ID that uniquely identifies this request.
|
2746
|
+
# @return [String]
|
2747
|
+
#
|
2748
|
+
# @!attribute [rw] image_summary_list
|
2749
|
+
# The list of image build versions.
|
2750
|
+
# @return [Array<Types::ImageSummary>]
|
2751
|
+
#
|
2752
|
+
# @!attribute [rw] next_token
|
2753
|
+
# The next token used for paginated responses. When this is not empty
|
2754
|
+
# then there are additional elements that the service that not include
|
2755
|
+
# in this request. Use this token with the next request to retrieve
|
2756
|
+
# additional object.
|
2757
|
+
# @return [String]
|
2758
|
+
#
|
2759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImageBuildVersionsResponse AWS API Documentation
|
2760
|
+
#
|
2761
|
+
class ListImageBuildVersionsResponse < Struct.new(
|
2762
|
+
:request_id,
|
2763
|
+
:image_summary_list,
|
2764
|
+
:next_token)
|
2765
|
+
include Aws::Structure
|
2766
|
+
end
|
2767
|
+
|
2768
|
+
# @note When making an API call, you may pass ListImagePipelineImagesRequest
|
2769
|
+
# data as a hash:
|
2770
|
+
#
|
2771
|
+
# {
|
2772
|
+
# image_pipeline_arn: "ImagePipelineArn",
|
2773
|
+
# filters: [
|
2774
|
+
# {
|
2775
|
+
# name: "FilterName",
|
2776
|
+
# values: ["FilterValue"],
|
2777
|
+
# },
|
2778
|
+
# ],
|
2779
|
+
# max_results: 1,
|
2780
|
+
# next_token: "NonEmptyString",
|
2781
|
+
# }
|
2782
|
+
#
|
2783
|
+
# @!attribute [rw] image_pipeline_arn
|
2784
|
+
# The Amazon Resource Name (ARN) of the image pipeline whose images
|
2785
|
+
# you wish to view.
|
2786
|
+
# @return [String]
|
2787
|
+
#
|
2788
|
+
# @!attribute [rw] filters
|
2789
|
+
# @return [Array<Types::Filter>]
|
2790
|
+
#
|
2791
|
+
# @!attribute [rw] max_results
|
2792
|
+
# The maximum items to return in a request.
|
2793
|
+
# @return [Integer]
|
2794
|
+
#
|
2795
|
+
# @!attribute [rw] next_token
|
2796
|
+
# A token to specify where to start paginating. This is the NextToken
|
2797
|
+
# from a previously truncated response.
|
2798
|
+
# @return [String]
|
2799
|
+
#
|
2800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagePipelineImagesRequest AWS API Documentation
|
2801
|
+
#
|
2802
|
+
class ListImagePipelineImagesRequest < Struct.new(
|
2803
|
+
:image_pipeline_arn,
|
2804
|
+
:filters,
|
2805
|
+
:max_results,
|
2806
|
+
:next_token)
|
2807
|
+
include Aws::Structure
|
2808
|
+
end
|
2809
|
+
|
2810
|
+
# @!attribute [rw] request_id
|
2811
|
+
# The request ID that uniquely identifies this request.
|
2812
|
+
# @return [String]
|
2813
|
+
#
|
2814
|
+
# @!attribute [rw] image_summary_list
|
2815
|
+
# The list of images built by this pipeline.
|
2816
|
+
# @return [Array<Types::ImageSummary>]
|
2817
|
+
#
|
2818
|
+
# @!attribute [rw] next_token
|
2819
|
+
# The next token used for paginated responses. When this is not empty
|
2820
|
+
# then there are additional elements that the service that not include
|
2821
|
+
# in this request. Use this token with the next request to retrieve
|
2822
|
+
# additional object.
|
2823
|
+
# @return [String]
|
2824
|
+
#
|
2825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagePipelineImagesResponse AWS API Documentation
|
2826
|
+
#
|
2827
|
+
class ListImagePipelineImagesResponse < Struct.new(
|
2828
|
+
:request_id,
|
2829
|
+
:image_summary_list,
|
2830
|
+
:next_token)
|
2831
|
+
include Aws::Structure
|
2832
|
+
end
|
2833
|
+
|
2834
|
+
# @note When making an API call, you may pass ListImagePipelinesRequest
|
2835
|
+
# data as a hash:
|
2836
|
+
#
|
2837
|
+
# {
|
2838
|
+
# filters: [
|
2839
|
+
# {
|
2840
|
+
# name: "FilterName",
|
2841
|
+
# values: ["FilterValue"],
|
2842
|
+
# },
|
2843
|
+
# ],
|
2844
|
+
# max_results: 1,
|
2845
|
+
# next_token: "NonEmptyString",
|
2846
|
+
# }
|
2847
|
+
#
|
2848
|
+
# @!attribute [rw] filters
|
2849
|
+
# @return [Array<Types::Filter>]
|
2850
|
+
#
|
2851
|
+
# @!attribute [rw] max_results
|
2852
|
+
# The maximum items to return in a request.
|
2853
|
+
# @return [Integer]
|
2854
|
+
#
|
2855
|
+
# @!attribute [rw] next_token
|
2856
|
+
# A token to specify where to start paginating. This is the NextToken
|
2857
|
+
# from a previously truncated response.
|
2858
|
+
# @return [String]
|
2859
|
+
#
|
2860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagePipelinesRequest AWS API Documentation
|
2861
|
+
#
|
2862
|
+
class ListImagePipelinesRequest < Struct.new(
|
2863
|
+
:filters,
|
2864
|
+
:max_results,
|
2865
|
+
:next_token)
|
2866
|
+
include Aws::Structure
|
2867
|
+
end
|
2868
|
+
|
2869
|
+
# @!attribute [rw] request_id
|
2870
|
+
# The request ID that uniquely identifies this request.
|
2871
|
+
# @return [String]
|
2872
|
+
#
|
2873
|
+
# @!attribute [rw] image_pipeline_list
|
2874
|
+
# The list of image pipelines.
|
2875
|
+
# @return [Array<Types::ImagePipeline>]
|
2876
|
+
#
|
2877
|
+
# @!attribute [rw] next_token
|
2878
|
+
# The next token used for paginated responses. When this is not empty
|
2879
|
+
# then there are additional elements that the service that not include
|
2880
|
+
# in this request. Use this token with the next request to retrieve
|
2881
|
+
# additional object.
|
2882
|
+
# @return [String]
|
2883
|
+
#
|
2884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagePipelinesResponse AWS API Documentation
|
2885
|
+
#
|
2886
|
+
class ListImagePipelinesResponse < Struct.new(
|
2887
|
+
:request_id,
|
2888
|
+
:image_pipeline_list,
|
2889
|
+
:next_token)
|
2890
|
+
include Aws::Structure
|
2891
|
+
end
|
2892
|
+
|
2893
|
+
# @note When making an API call, you may pass ListImageRecipesRequest
|
2894
|
+
# data as a hash:
|
2895
|
+
#
|
2896
|
+
# {
|
2897
|
+
# owner: "Self", # accepts Self, Shared, Amazon
|
2898
|
+
# filters: [
|
2899
|
+
# {
|
2900
|
+
# name: "FilterName",
|
2901
|
+
# values: ["FilterValue"],
|
2902
|
+
# },
|
2903
|
+
# ],
|
2904
|
+
# max_results: 1,
|
2905
|
+
# next_token: "NonEmptyString",
|
2906
|
+
# }
|
2907
|
+
#
|
2908
|
+
# @!attribute [rw] owner
|
2909
|
+
# The owner defines whose image recipes you wish to list. By default
|
2910
|
+
# this request will only show image recipes owned by your account. You
|
2911
|
+
# may use this field to specify if you wish to view image recipes
|
2912
|
+
# owned by yourself, Amazon, or those image recipes that have been
|
2913
|
+
# shared with you by other customers.
|
2914
|
+
# @return [String]
|
2915
|
+
#
|
2916
|
+
# @!attribute [rw] filters
|
2917
|
+
# @return [Array<Types::Filter>]
|
2918
|
+
#
|
2919
|
+
# @!attribute [rw] max_results
|
2920
|
+
# The maximum items to return in a request.
|
2921
|
+
# @return [Integer]
|
2922
|
+
#
|
2923
|
+
# @!attribute [rw] next_token
|
2924
|
+
# A token to specify where to start paginating. This is the NextToken
|
2925
|
+
# from a previously truncated response.
|
2926
|
+
# @return [String]
|
2927
|
+
#
|
2928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImageRecipesRequest AWS API Documentation
|
2929
|
+
#
|
2930
|
+
class ListImageRecipesRequest < Struct.new(
|
2931
|
+
:owner,
|
2932
|
+
:filters,
|
2933
|
+
:max_results,
|
2934
|
+
:next_token)
|
2935
|
+
include Aws::Structure
|
2936
|
+
end
|
2937
|
+
|
2938
|
+
# @!attribute [rw] request_id
|
2939
|
+
# The request ID that uniquely identifies this request.
|
2940
|
+
# @return [String]
|
2941
|
+
#
|
2942
|
+
# @!attribute [rw] image_recipe_summary_list
|
2943
|
+
# The list of image pipelines.
|
2944
|
+
# @return [Array<Types::ImageRecipeSummary>]
|
2945
|
+
#
|
2946
|
+
# @!attribute [rw] next_token
|
2947
|
+
# The next token used for paginated responses. When this is not empty
|
2948
|
+
# then there are additional elements that the service that not include
|
2949
|
+
# in this request. Use this token with the next request to retrieve
|
2950
|
+
# additional object.
|
2951
|
+
# @return [String]
|
2952
|
+
#
|
2953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImageRecipesResponse AWS API Documentation
|
2954
|
+
#
|
2955
|
+
class ListImageRecipesResponse < Struct.new(
|
2956
|
+
:request_id,
|
2957
|
+
:image_recipe_summary_list,
|
2958
|
+
:next_token)
|
2959
|
+
include Aws::Structure
|
2960
|
+
end
|
2961
|
+
|
2962
|
+
# @note When making an API call, you may pass ListImagesRequest
|
2963
|
+
# data as a hash:
|
2964
|
+
#
|
2965
|
+
# {
|
2966
|
+
# owner: "Self", # accepts Self, Shared, Amazon
|
2967
|
+
# filters: [
|
2968
|
+
# {
|
2969
|
+
# name: "FilterName",
|
2970
|
+
# values: ["FilterValue"],
|
2971
|
+
# },
|
2972
|
+
# ],
|
2973
|
+
# max_results: 1,
|
2974
|
+
# next_token: "NonEmptyString",
|
2975
|
+
# }
|
2976
|
+
#
|
2977
|
+
# @!attribute [rw] owner
|
2978
|
+
# The owner defines whose images you wish to list. By default this
|
2979
|
+
# request will only show images owned by your account. You may use
|
2980
|
+
# this field to specify if you wish to view images owned by yourself,
|
2981
|
+
# Amazon, or those images that have been shared with you by other
|
2982
|
+
# customers.
|
2983
|
+
# @return [String]
|
2984
|
+
#
|
2985
|
+
# @!attribute [rw] filters
|
2986
|
+
# @return [Array<Types::Filter>]
|
2987
|
+
#
|
2988
|
+
# @!attribute [rw] max_results
|
2989
|
+
# The maximum items to return in a request.
|
2990
|
+
# @return [Integer]
|
2991
|
+
#
|
2992
|
+
# @!attribute [rw] next_token
|
2993
|
+
# A token to specify where to start paginating. This is the NextToken
|
2994
|
+
# from a previously truncated response.
|
2995
|
+
# @return [String]
|
2996
|
+
#
|
2997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagesRequest AWS API Documentation
|
2998
|
+
#
|
2999
|
+
class ListImagesRequest < Struct.new(
|
3000
|
+
:owner,
|
3001
|
+
:filters,
|
3002
|
+
:max_results,
|
3003
|
+
:next_token)
|
3004
|
+
include Aws::Structure
|
3005
|
+
end
|
3006
|
+
|
3007
|
+
# @!attribute [rw] request_id
|
3008
|
+
# The request ID that uniquely identifies this request.
|
3009
|
+
# @return [String]
|
3010
|
+
#
|
3011
|
+
# @!attribute [rw] image_version_list
|
3012
|
+
# The list of image semantic versions.
|
3013
|
+
# @return [Array<Types::ImageVersion>]
|
3014
|
+
#
|
3015
|
+
# @!attribute [rw] next_token
|
3016
|
+
# The next token used for paginated responses. When this is not empty
|
3017
|
+
# then there are additional elements that the service that not include
|
3018
|
+
# in this request. Use this token with the next request to retrieve
|
3019
|
+
# additional object.
|
3020
|
+
# @return [String]
|
3021
|
+
#
|
3022
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListImagesResponse AWS API Documentation
|
3023
|
+
#
|
3024
|
+
class ListImagesResponse < Struct.new(
|
3025
|
+
:request_id,
|
3026
|
+
:image_version_list,
|
3027
|
+
:next_token)
|
3028
|
+
include Aws::Structure
|
3029
|
+
end
|
3030
|
+
|
3031
|
+
# @note When making an API call, you may pass ListInfrastructureConfigurationsRequest
|
3032
|
+
# data as a hash:
|
3033
|
+
#
|
3034
|
+
# {
|
3035
|
+
# filters: [
|
3036
|
+
# {
|
3037
|
+
# name: "FilterName",
|
3038
|
+
# values: ["FilterValue"],
|
3039
|
+
# },
|
3040
|
+
# ],
|
3041
|
+
# max_results: 1,
|
3042
|
+
# next_token: "NonEmptyString",
|
3043
|
+
# }
|
3044
|
+
#
|
3045
|
+
# @!attribute [rw] filters
|
3046
|
+
# @return [Array<Types::Filter>]
|
3047
|
+
#
|
3048
|
+
# @!attribute [rw] max_results
|
3049
|
+
# The maximum items to return in a request.
|
3050
|
+
# @return [Integer]
|
3051
|
+
#
|
3052
|
+
# @!attribute [rw] next_token
|
3053
|
+
# A token to specify where to start paginating. This is the NextToken
|
3054
|
+
# from a previously truncated response.
|
3055
|
+
# @return [String]
|
3056
|
+
#
|
3057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListInfrastructureConfigurationsRequest AWS API Documentation
|
3058
|
+
#
|
3059
|
+
class ListInfrastructureConfigurationsRequest < Struct.new(
|
3060
|
+
:filters,
|
3061
|
+
:max_results,
|
3062
|
+
:next_token)
|
3063
|
+
include Aws::Structure
|
3064
|
+
end
|
3065
|
+
|
3066
|
+
# @!attribute [rw] request_id
|
3067
|
+
# The request ID that uniquely identifies this request.
|
3068
|
+
# @return [String]
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] infrastructure_configuration_summary_list
|
3071
|
+
# The list of infrastructure configurations.
|
3072
|
+
# @return [Array<Types::InfrastructureConfigurationSummary>]
|
3073
|
+
#
|
3074
|
+
# @!attribute [rw] next_token
|
3075
|
+
# The next token used for paginated responses. When this is not empty
|
3076
|
+
# then there are additional elements that the service that not include
|
3077
|
+
# in this request. Use this token with the next request to retrieve
|
3078
|
+
# additional object.
|
3079
|
+
# @return [String]
|
3080
|
+
#
|
3081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListInfrastructureConfigurationsResponse AWS API Documentation
|
3082
|
+
#
|
3083
|
+
class ListInfrastructureConfigurationsResponse < Struct.new(
|
3084
|
+
:request_id,
|
3085
|
+
:infrastructure_configuration_summary_list,
|
3086
|
+
:next_token)
|
3087
|
+
include Aws::Structure
|
3088
|
+
end
|
3089
|
+
|
3090
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
3091
|
+
# data as a hash:
|
3092
|
+
#
|
3093
|
+
# {
|
3094
|
+
# resource_arn: "ImageBuilderArn", # required
|
3095
|
+
# }
|
3096
|
+
#
|
3097
|
+
# @!attribute [rw] resource_arn
|
3098
|
+
# The Amazon Resource Name (ARN) of the resource whose tags you wish
|
3099
|
+
# to retrieve.
|
3100
|
+
# @return [String]
|
3101
|
+
#
|
3102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListTagsForResourceRequest AWS API Documentation
|
3103
|
+
#
|
3104
|
+
class ListTagsForResourceRequest < Struct.new(
|
3105
|
+
:resource_arn)
|
3106
|
+
include Aws::Structure
|
3107
|
+
end
|
3108
|
+
|
3109
|
+
# @!attribute [rw] tags
|
3110
|
+
# The tags for the specified resource.
|
3111
|
+
# @return [Hash<String,String>]
|
3112
|
+
#
|
3113
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ListTagsForResourceResponse AWS API Documentation
|
3114
|
+
#
|
3115
|
+
class ListTagsForResourceResponse < Struct.new(
|
3116
|
+
:tags)
|
3117
|
+
include Aws::Structure
|
3118
|
+
end
|
3119
|
+
|
3120
|
+
# Logging configuration defines where Image Builder uploads your logs
|
3121
|
+
# to.
|
3122
|
+
#
|
3123
|
+
# @note When making an API call, you may pass Logging
|
3124
|
+
# data as a hash:
|
3125
|
+
#
|
3126
|
+
# {
|
3127
|
+
# s3_logs: {
|
3128
|
+
# s3_bucket_name: "NonEmptyString",
|
3129
|
+
# s3_key_prefix: "NonEmptyString",
|
3130
|
+
# },
|
3131
|
+
# }
|
3132
|
+
#
|
3133
|
+
# @!attribute [rw] s3_logs
|
3134
|
+
# The S3 logging configuration.
|
3135
|
+
# @return [Types::S3Logs]
|
3136
|
+
#
|
3137
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Logging AWS API Documentation
|
3138
|
+
#
|
3139
|
+
class Logging < Struct.new(
|
3140
|
+
:s3_logs)
|
3141
|
+
include Aws::Structure
|
3142
|
+
end
|
3143
|
+
|
3144
|
+
# The resources produced by this image.
|
3145
|
+
#
|
3146
|
+
# @!attribute [rw] amis
|
3147
|
+
# The EC2 AMIs created by this image.
|
3148
|
+
# @return [Array<Types::Ami>]
|
3149
|
+
#
|
3150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/OutputResources AWS API Documentation
|
3151
|
+
#
|
3152
|
+
class OutputResources < Struct.new(
|
3153
|
+
:amis)
|
3154
|
+
include Aws::Structure
|
3155
|
+
end
|
3156
|
+
|
3157
|
+
# @note When making an API call, you may pass PutComponentPolicyRequest
|
3158
|
+
# data as a hash:
|
3159
|
+
#
|
3160
|
+
# {
|
3161
|
+
# component_arn: "ComponentBuildVersionArn", # required
|
3162
|
+
# policy: "NonEmptyString", # required
|
3163
|
+
# }
|
3164
|
+
#
|
3165
|
+
# @!attribute [rw] component_arn
|
3166
|
+
# The Amazon Resource Name (ARN) of the component that this policy
|
3167
|
+
# should be applied to.
|
3168
|
+
# @return [String]
|
3169
|
+
#
|
3170
|
+
# @!attribute [rw] policy
|
3171
|
+
# The policy to apply.
|
3172
|
+
# @return [String]
|
3173
|
+
#
|
3174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PutComponentPolicyRequest AWS API Documentation
|
3175
|
+
#
|
3176
|
+
class PutComponentPolicyRequest < Struct.new(
|
3177
|
+
:component_arn,
|
3178
|
+
:policy)
|
3179
|
+
include Aws::Structure
|
3180
|
+
end
|
3181
|
+
|
3182
|
+
# @!attribute [rw] request_id
|
3183
|
+
# The request ID that uniquely identifies this request.
|
3184
|
+
# @return [String]
|
3185
|
+
#
|
3186
|
+
# @!attribute [rw] component_arn
|
3187
|
+
# The Amazon Resource Name (ARN) of the component that this policy was
|
3188
|
+
# applied to.
|
3189
|
+
# @return [String]
|
3190
|
+
#
|
3191
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PutComponentPolicyResponse AWS API Documentation
|
3192
|
+
#
|
3193
|
+
class PutComponentPolicyResponse < Struct.new(
|
3194
|
+
:request_id,
|
3195
|
+
:component_arn)
|
3196
|
+
include Aws::Structure
|
3197
|
+
end
|
3198
|
+
|
3199
|
+
# @note When making an API call, you may pass PutImagePolicyRequest
|
3200
|
+
# data as a hash:
|
3201
|
+
#
|
3202
|
+
# {
|
3203
|
+
# image_arn: "ImageBuildVersionArn", # required
|
3204
|
+
# policy: "NonEmptyString", # required
|
3205
|
+
# }
|
3206
|
+
#
|
3207
|
+
# @!attribute [rw] image_arn
|
3208
|
+
# The Amazon Resource Name (ARN) of the image that this policy should
|
3209
|
+
# be applied to.
|
3210
|
+
# @return [String]
|
3211
|
+
#
|
3212
|
+
# @!attribute [rw] policy
|
3213
|
+
# The policy to apply.
|
3214
|
+
# @return [String]
|
3215
|
+
#
|
3216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PutImagePolicyRequest AWS API Documentation
|
3217
|
+
#
|
3218
|
+
class PutImagePolicyRequest < Struct.new(
|
3219
|
+
:image_arn,
|
3220
|
+
:policy)
|
3221
|
+
include Aws::Structure
|
3222
|
+
end
|
3223
|
+
|
3224
|
+
# @!attribute [rw] request_id
|
3225
|
+
# The request ID that uniquely identifies this request.
|
3226
|
+
# @return [String]
|
3227
|
+
#
|
3228
|
+
# @!attribute [rw] image_arn
|
3229
|
+
# The Amazon Resource Name (ARN) of the image that this policy was
|
3230
|
+
# applied to.
|
3231
|
+
# @return [String]
|
3232
|
+
#
|
3233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PutImagePolicyResponse AWS API Documentation
|
3234
|
+
#
|
3235
|
+
class PutImagePolicyResponse < Struct.new(
|
3236
|
+
:request_id,
|
3237
|
+
:image_arn)
|
3238
|
+
include Aws::Structure
|
3239
|
+
end
|
3240
|
+
|
3241
|
+
# @note When making an API call, you may pass PutImageRecipePolicyRequest
|
3242
|
+
# data as a hash:
|
3243
|
+
#
|
3244
|
+
# {
|
3245
|
+
# image_recipe_arn: "ImageRecipeArn", # required
|
3246
|
+
# policy: "NonEmptyString", # required
|
3247
|
+
# }
|
3248
|
+
#
|
3249
|
+
# @!attribute [rw] image_recipe_arn
|
3250
|
+
# The Amazon Resource Name (ARN) of the image recipe that this policy
|
3251
|
+
# should be applied to.
|
3252
|
+
# @return [String]
|
3253
|
+
#
|
3254
|
+
# @!attribute [rw] policy
|
3255
|
+
# The policy to apply.
|
3256
|
+
# @return [String]
|
3257
|
+
#
|
3258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PutImageRecipePolicyRequest AWS API Documentation
|
3259
|
+
#
|
3260
|
+
class PutImageRecipePolicyRequest < Struct.new(
|
3261
|
+
:image_recipe_arn,
|
3262
|
+
:policy)
|
3263
|
+
include Aws::Structure
|
3264
|
+
end
|
3265
|
+
|
3266
|
+
# @!attribute [rw] request_id
|
3267
|
+
# The request ID that uniquely identifies this request.
|
3268
|
+
# @return [String]
|
3269
|
+
#
|
3270
|
+
# @!attribute [rw] image_recipe_arn
|
3271
|
+
# The Amazon Resource Name (ARN) of the image recipe that this policy
|
3272
|
+
# was applied to.
|
3273
|
+
# @return [String]
|
3274
|
+
#
|
3275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/PutImageRecipePolicyResponse AWS API Documentation
|
3276
|
+
#
|
3277
|
+
class PutImageRecipePolicyResponse < Struct.new(
|
3278
|
+
:request_id,
|
3279
|
+
:image_recipe_arn)
|
3280
|
+
include Aws::Structure
|
3281
|
+
end
|
3282
|
+
|
3283
|
+
# The resource that you are trying to create already exists.
|
3284
|
+
#
|
3285
|
+
# @!attribute [rw] message
|
3286
|
+
# @return [String]
|
3287
|
+
#
|
3288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ResourceAlreadyExistsException AWS API Documentation
|
3289
|
+
#
|
3290
|
+
class ResourceAlreadyExistsException < Struct.new(
|
3291
|
+
:message)
|
3292
|
+
include Aws::Structure
|
3293
|
+
end
|
3294
|
+
|
3295
|
+
# You have attempted to mutate or delete a resource with a dependency
|
3296
|
+
# that is prohibitting this action. See the error message for more
|
3297
|
+
# details.
|
3298
|
+
#
|
3299
|
+
# @!attribute [rw] message
|
3300
|
+
# @return [String]
|
3301
|
+
#
|
3302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ResourceDependencyException AWS API Documentation
|
3303
|
+
#
|
3304
|
+
class ResourceDependencyException < Struct.new(
|
3305
|
+
:message)
|
3306
|
+
include Aws::Structure
|
3307
|
+
end
|
3308
|
+
|
3309
|
+
# The resource that you are trying to operate on is currently in use.
|
3310
|
+
# Review the message details, and retry later.
|
3311
|
+
#
|
3312
|
+
# @!attribute [rw] message
|
3313
|
+
# @return [String]
|
3314
|
+
#
|
3315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ResourceInUseException AWS API Documentation
|
3316
|
+
#
|
3317
|
+
class ResourceInUseException < Struct.new(
|
3318
|
+
:message)
|
3319
|
+
include Aws::Structure
|
3320
|
+
end
|
3321
|
+
|
3322
|
+
# At least one of the resources referenced by your request does not
|
3323
|
+
# exist.
|
3324
|
+
#
|
3325
|
+
# @!attribute [rw] message
|
3326
|
+
# @return [String]
|
3327
|
+
#
|
3328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ResourceNotFoundException AWS API Documentation
|
3329
|
+
#
|
3330
|
+
class ResourceNotFoundException < Struct.new(
|
3331
|
+
:message)
|
3332
|
+
include Aws::Structure
|
3333
|
+
end
|
3334
|
+
|
3335
|
+
# S3 Logging configuration.
|
3336
|
+
#
|
3337
|
+
# @note When making an API call, you may pass S3Logs
|
3338
|
+
# data as a hash:
|
3339
|
+
#
|
3340
|
+
# {
|
3341
|
+
# s3_bucket_name: "NonEmptyString",
|
3342
|
+
# s3_key_prefix: "NonEmptyString",
|
3343
|
+
# }
|
3344
|
+
#
|
3345
|
+
# @!attribute [rw] s3_bucket_name
|
3346
|
+
# The S3 bucket in which to store the logs.
|
3347
|
+
# @return [String]
|
3348
|
+
#
|
3349
|
+
# @!attribute [rw] s3_key_prefix
|
3350
|
+
# The S3 path in which to store the logs.
|
3351
|
+
# @return [String]
|
3352
|
+
#
|
3353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/S3Logs AWS API Documentation
|
3354
|
+
#
|
3355
|
+
class S3Logs < Struct.new(
|
3356
|
+
:s3_bucket_name,
|
3357
|
+
:s3_key_prefix)
|
3358
|
+
include Aws::Structure
|
3359
|
+
end
|
3360
|
+
|
3361
|
+
# A schedule configures how often and when a pipeline will automatically
|
3362
|
+
# create a new image.
|
3363
|
+
#
|
3364
|
+
# @note When making an API call, you may pass Schedule
|
3365
|
+
# data as a hash:
|
3366
|
+
#
|
3367
|
+
# {
|
3368
|
+
# schedule_expression: "NonEmptyString",
|
3369
|
+
# pipeline_execution_start_condition: "EXPRESSION_MATCH_ONLY", # accepts EXPRESSION_MATCH_ONLY, EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
|
3370
|
+
# }
|
3371
|
+
#
|
3372
|
+
# @!attribute [rw] schedule_expression
|
3373
|
+
# The expression determines how often a pipeline starts the creation
|
3374
|
+
# of new images.
|
3375
|
+
# @return [String]
|
3376
|
+
#
|
3377
|
+
# @!attribute [rw] pipeline_execution_start_condition
|
3378
|
+
# The condition configures when the pipeline should trigger a new
|
3379
|
+
# image build.
|
3380
|
+
# @return [String]
|
3381
|
+
#
|
3382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/Schedule AWS API Documentation
|
3383
|
+
#
|
3384
|
+
class Schedule < Struct.new(
|
3385
|
+
:schedule_expression,
|
3386
|
+
:pipeline_execution_start_condition)
|
3387
|
+
include Aws::Structure
|
3388
|
+
end
|
3389
|
+
|
3390
|
+
# This exception is thrown when the service encounters an unrecoverable
|
3391
|
+
# exception.
|
3392
|
+
#
|
3393
|
+
# @!attribute [rw] message
|
3394
|
+
# @return [String]
|
3395
|
+
#
|
3396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ServiceException AWS API Documentation
|
3397
|
+
#
|
3398
|
+
class ServiceException < Struct.new(
|
3399
|
+
:message)
|
3400
|
+
include Aws::Structure
|
3401
|
+
end
|
3402
|
+
|
3403
|
+
# The service is unable to process your request at this time.
|
3404
|
+
#
|
3405
|
+
# @!attribute [rw] message
|
3406
|
+
# @return [String]
|
3407
|
+
#
|
3408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ServiceUnavailableException AWS API Documentation
|
3409
|
+
#
|
3410
|
+
class ServiceUnavailableException < Struct.new(
|
3411
|
+
:message)
|
3412
|
+
include Aws::Structure
|
3413
|
+
end
|
3414
|
+
|
3415
|
+
# @note When making an API call, you may pass StartImagePipelineExecutionRequest
|
3416
|
+
# data as a hash:
|
3417
|
+
#
|
3418
|
+
# {
|
3419
|
+
# image_pipeline_arn: "ImagePipelineArn", # required
|
3420
|
+
# client_token: "ClientToken", # required
|
3421
|
+
# }
|
3422
|
+
#
|
3423
|
+
# @!attribute [rw] image_pipeline_arn
|
3424
|
+
# The Amazon Resource Name (ARN) of the image pipeline that you wish
|
3425
|
+
# to manually invoke.
|
3426
|
+
# @return [String]
|
3427
|
+
#
|
3428
|
+
# @!attribute [rw] client_token
|
3429
|
+
# The idempotency token used to make this request idempotent.
|
3430
|
+
#
|
3431
|
+
# **A suitable default value is auto-generated.** You should normally
|
3432
|
+
# not need to pass this option.
|
3433
|
+
# @return [String]
|
3434
|
+
#
|
3435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/StartImagePipelineExecutionRequest AWS API Documentation
|
3436
|
+
#
|
3437
|
+
class StartImagePipelineExecutionRequest < Struct.new(
|
3438
|
+
:image_pipeline_arn,
|
3439
|
+
:client_token)
|
3440
|
+
include Aws::Structure
|
3441
|
+
end
|
3442
|
+
|
3443
|
+
# @!attribute [rw] request_id
|
3444
|
+
# The request ID that uniquely identifies this request.
|
3445
|
+
# @return [String]
|
3446
|
+
#
|
3447
|
+
# @!attribute [rw] client_token
|
3448
|
+
# The idempotency token used to make this request idempotent.
|
3449
|
+
# @return [String]
|
3450
|
+
#
|
3451
|
+
# @!attribute [rw] image_build_version_arn
|
3452
|
+
# The Amazon Resource Name (ARN) of the image that was created by this
|
3453
|
+
# request.
|
3454
|
+
# @return [String]
|
3455
|
+
#
|
3456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/StartImagePipelineExecutionResponse AWS API Documentation
|
3457
|
+
#
|
3458
|
+
class StartImagePipelineExecutionResponse < Struct.new(
|
3459
|
+
:request_id,
|
3460
|
+
:client_token,
|
3461
|
+
:image_build_version_arn)
|
3462
|
+
include Aws::Structure
|
3463
|
+
end
|
3464
|
+
|
3465
|
+
# @note When making an API call, you may pass TagResourceRequest
|
3466
|
+
# data as a hash:
|
3467
|
+
#
|
3468
|
+
# {
|
3469
|
+
# resource_arn: "ImageBuilderArn", # required
|
3470
|
+
# tags: { # required
|
3471
|
+
# "TagKey" => "TagValue",
|
3472
|
+
# },
|
3473
|
+
# }
|
3474
|
+
#
|
3475
|
+
# @!attribute [rw] resource_arn
|
3476
|
+
# The Amazon Resource Name (ARN) of the resource that you wish to tag.
|
3477
|
+
# @return [String]
|
3478
|
+
#
|
3479
|
+
# @!attribute [rw] tags
|
3480
|
+
# The tags to apply to the resource.
|
3481
|
+
# @return [Hash<String,String>]
|
3482
|
+
#
|
3483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/TagResourceRequest AWS API Documentation
|
3484
|
+
#
|
3485
|
+
class TagResourceRequest < Struct.new(
|
3486
|
+
:resource_arn,
|
3487
|
+
:tags)
|
3488
|
+
include Aws::Structure
|
3489
|
+
end
|
3490
|
+
|
3491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/TagResourceResponse AWS API Documentation
|
3492
|
+
#
|
3493
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
3494
|
+
|
3495
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
3496
|
+
# data as a hash:
|
3497
|
+
#
|
3498
|
+
# {
|
3499
|
+
# resource_arn: "ImageBuilderArn", # required
|
3500
|
+
# tag_keys: ["TagKey"], # required
|
3501
|
+
# }
|
3502
|
+
#
|
3503
|
+
# @!attribute [rw] resource_arn
|
3504
|
+
# The Amazon Resource Name (ARN) of the resource that you wish to
|
3505
|
+
# untag.
|
3506
|
+
# @return [String]
|
3507
|
+
#
|
3508
|
+
# @!attribute [rw] tag_keys
|
3509
|
+
# The tag keys to remove from the resource.
|
3510
|
+
# @return [Array<String>]
|
3511
|
+
#
|
3512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UntagResourceRequest AWS API Documentation
|
3513
|
+
#
|
3514
|
+
class UntagResourceRequest < Struct.new(
|
3515
|
+
:resource_arn,
|
3516
|
+
:tag_keys)
|
3517
|
+
include Aws::Structure
|
3518
|
+
end
|
3519
|
+
|
3520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UntagResourceResponse AWS API Documentation
|
3521
|
+
#
|
3522
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
3523
|
+
|
3524
|
+
# @note When making an API call, you may pass UpdateDistributionConfigurationRequest
|
3525
|
+
# data as a hash:
|
3526
|
+
#
|
3527
|
+
# {
|
3528
|
+
# distribution_configuration_arn: "DistributionConfigurationArn", # required
|
3529
|
+
# description: "NonEmptyString",
|
3530
|
+
# distributions: [
|
3531
|
+
# {
|
3532
|
+
# region: "NonEmptyString", # required
|
3533
|
+
# ami_distribution_configuration: {
|
3534
|
+
# name: "NonEmptyString",
|
3535
|
+
# description: "NonEmptyString",
|
3536
|
+
# ami_tags: {
|
3537
|
+
# "TagKey" => "TagValue",
|
3538
|
+
# },
|
3539
|
+
# launch_permission: {
|
3540
|
+
# user_ids: ["NonEmptyString"],
|
3541
|
+
# user_groups: ["NonEmptyString"],
|
3542
|
+
# },
|
3543
|
+
# },
|
3544
|
+
# license_configuration_arns: ["Arn"],
|
3545
|
+
# },
|
3546
|
+
# ],
|
3547
|
+
# client_token: "ClientToken", # required
|
3548
|
+
# }
|
3549
|
+
#
|
3550
|
+
# @!attribute [rw] distribution_configuration_arn
|
3551
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
3552
|
+
# that you wish to update.
|
3553
|
+
# @return [String]
|
3554
|
+
#
|
3555
|
+
# @!attribute [rw] description
|
3556
|
+
# The description of the distribution configuration.
|
3557
|
+
# @return [String]
|
3558
|
+
#
|
3559
|
+
# @!attribute [rw] distributions
|
3560
|
+
# The distributions of the distribution configuration.
|
3561
|
+
# @return [Array<Types::Distribution>]
|
3562
|
+
#
|
3563
|
+
# @!attribute [rw] client_token
|
3564
|
+
# The idempotency token of the distribution configuration.
|
3565
|
+
#
|
3566
|
+
# **A suitable default value is auto-generated.** You should normally
|
3567
|
+
# not need to pass this option.
|
3568
|
+
# @return [String]
|
3569
|
+
#
|
3570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateDistributionConfigurationRequest AWS API Documentation
|
3571
|
+
#
|
3572
|
+
class UpdateDistributionConfigurationRequest < Struct.new(
|
3573
|
+
:distribution_configuration_arn,
|
3574
|
+
:description,
|
3575
|
+
:distributions,
|
3576
|
+
:client_token)
|
3577
|
+
include Aws::Structure
|
3578
|
+
end
|
3579
|
+
|
3580
|
+
# @!attribute [rw] request_id
|
3581
|
+
# The request ID that uniquely identifies this request.
|
3582
|
+
# @return [String]
|
3583
|
+
#
|
3584
|
+
# @!attribute [rw] client_token
|
3585
|
+
# The idempotency token used to make this request idempotent.
|
3586
|
+
# @return [String]
|
3587
|
+
#
|
3588
|
+
# @!attribute [rw] distribution_configuration_arn
|
3589
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
3590
|
+
# that was updated by this request.
|
3591
|
+
# @return [String]
|
3592
|
+
#
|
3593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateDistributionConfigurationResponse AWS API Documentation
|
3594
|
+
#
|
3595
|
+
class UpdateDistributionConfigurationResponse < Struct.new(
|
3596
|
+
:request_id,
|
3597
|
+
:client_token,
|
3598
|
+
:distribution_configuration_arn)
|
3599
|
+
include Aws::Structure
|
3600
|
+
end
|
3601
|
+
|
3602
|
+
# @note When making an API call, you may pass UpdateImagePipelineRequest
|
3603
|
+
# data as a hash:
|
3604
|
+
#
|
3605
|
+
# {
|
3606
|
+
# image_pipeline_arn: "ImagePipelineArn", # required
|
3607
|
+
# description: "NonEmptyString",
|
3608
|
+
# image_recipe_arn: "ImageRecipeArn",
|
3609
|
+
# infrastructure_configuration_arn: "InfrastructureConfigurationArn",
|
3610
|
+
# distribution_configuration_arn: "DistributionConfigurationArn",
|
3611
|
+
# image_tests_configuration: {
|
3612
|
+
# image_tests_enabled: false,
|
3613
|
+
# timeout_minutes: 1,
|
3614
|
+
# },
|
3615
|
+
# schedule: {
|
3616
|
+
# schedule_expression: "NonEmptyString",
|
3617
|
+
# pipeline_execution_start_condition: "EXPRESSION_MATCH_ONLY", # accepts EXPRESSION_MATCH_ONLY, EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
|
3618
|
+
# },
|
3619
|
+
# status: "DISABLED", # accepts DISABLED, ENABLED
|
3620
|
+
# client_token: "ClientToken", # required
|
3621
|
+
# }
|
3622
|
+
#
|
3623
|
+
# @!attribute [rw] image_pipeline_arn
|
3624
|
+
# The Amazon Resource Name (ARN) of the image pipeline that you wish
|
3625
|
+
# to update.
|
3626
|
+
# @return [String]
|
3627
|
+
#
|
3628
|
+
# @!attribute [rw] description
|
3629
|
+
# The description of the image pipeline.
|
3630
|
+
# @return [String]
|
3631
|
+
#
|
3632
|
+
# @!attribute [rw] image_recipe_arn
|
3633
|
+
# The Amazon Resource Name (ARN) of the image recipe that will be used
|
3634
|
+
# to configure images updated by this image pipeline.
|
3635
|
+
# @return [String]
|
3636
|
+
#
|
3637
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
3638
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
3639
|
+
# that will be used to build images updated by this image pipeline.
|
3640
|
+
# @return [String]
|
3641
|
+
#
|
3642
|
+
# @!attribute [rw] distribution_configuration_arn
|
3643
|
+
# The Amazon Resource Name (ARN) of the distribution configuration
|
3644
|
+
# that will be used to configure and distribute images updated by this
|
3645
|
+
# image pipeline.
|
3646
|
+
# @return [String]
|
3647
|
+
#
|
3648
|
+
# @!attribute [rw] image_tests_configuration
|
3649
|
+
# The image test configuration of the image pipeline.
|
3650
|
+
# @return [Types::ImageTestsConfiguration]
|
3651
|
+
#
|
3652
|
+
# @!attribute [rw] schedule
|
3653
|
+
# The schedule of the image pipeline.
|
3654
|
+
# @return [Types::Schedule]
|
3655
|
+
#
|
3656
|
+
# @!attribute [rw] status
|
3657
|
+
# The status of the image pipeline.
|
3658
|
+
# @return [String]
|
3659
|
+
#
|
3660
|
+
# @!attribute [rw] client_token
|
3661
|
+
# The idempotency token used to make this request idempotent.
|
3662
|
+
#
|
3663
|
+
# **A suitable default value is auto-generated.** You should normally
|
3664
|
+
# not need to pass this option.
|
3665
|
+
# @return [String]
|
3666
|
+
#
|
3667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateImagePipelineRequest AWS API Documentation
|
3668
|
+
#
|
3669
|
+
class UpdateImagePipelineRequest < Struct.new(
|
3670
|
+
:image_pipeline_arn,
|
3671
|
+
:description,
|
3672
|
+
:image_recipe_arn,
|
3673
|
+
:infrastructure_configuration_arn,
|
3674
|
+
:distribution_configuration_arn,
|
3675
|
+
:image_tests_configuration,
|
3676
|
+
:schedule,
|
3677
|
+
:status,
|
3678
|
+
:client_token)
|
3679
|
+
include Aws::Structure
|
3680
|
+
end
|
3681
|
+
|
3682
|
+
# @!attribute [rw] request_id
|
3683
|
+
# The request ID that uniquely identifies this request.
|
3684
|
+
# @return [String]
|
3685
|
+
#
|
3686
|
+
# @!attribute [rw] client_token
|
3687
|
+
# The idempotency token used to make this request idempotent.
|
3688
|
+
# @return [String]
|
3689
|
+
#
|
3690
|
+
# @!attribute [rw] image_pipeline_arn
|
3691
|
+
# The Amazon Resource Name (ARN) of the image pipeline that was
|
3692
|
+
# updated by this request.
|
3693
|
+
# @return [String]
|
3694
|
+
#
|
3695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateImagePipelineResponse AWS API Documentation
|
3696
|
+
#
|
3697
|
+
class UpdateImagePipelineResponse < Struct.new(
|
3698
|
+
:request_id,
|
3699
|
+
:client_token,
|
3700
|
+
:image_pipeline_arn)
|
3701
|
+
include Aws::Structure
|
3702
|
+
end
|
3703
|
+
|
3704
|
+
# @note When making an API call, you may pass UpdateInfrastructureConfigurationRequest
|
3705
|
+
# data as a hash:
|
3706
|
+
#
|
3707
|
+
# {
|
3708
|
+
# infrastructure_configuration_arn: "InfrastructureConfigurationArn", # required
|
3709
|
+
# description: "NonEmptyString",
|
3710
|
+
# instance_types: ["InstanceType"],
|
3711
|
+
# instance_profile_name: "NonEmptyString",
|
3712
|
+
# security_group_ids: ["NonEmptyString"],
|
3713
|
+
# subnet_id: "NonEmptyString",
|
3714
|
+
# logging: {
|
3715
|
+
# s3_logs: {
|
3716
|
+
# s3_bucket_name: "NonEmptyString",
|
3717
|
+
# s3_key_prefix: "NonEmptyString",
|
3718
|
+
# },
|
3719
|
+
# },
|
3720
|
+
# key_pair: "NonEmptyString",
|
3721
|
+
# terminate_instance_on_failure: false,
|
3722
|
+
# sns_topic_arn: "NonEmptyString",
|
3723
|
+
# client_token: "ClientToken", # required
|
3724
|
+
# }
|
3725
|
+
#
|
3726
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
3727
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
3728
|
+
# that you wish to update.
|
3729
|
+
# @return [String]
|
3730
|
+
#
|
3731
|
+
# @!attribute [rw] description
|
3732
|
+
# The description of the infrastructure configuration.
|
3733
|
+
# @return [String]
|
3734
|
+
#
|
3735
|
+
# @!attribute [rw] instance_types
|
3736
|
+
# The instance types of the infrastructure configuration. You may
|
3737
|
+
# specify one or more instance types to use for this build, the
|
3738
|
+
# service will pick one of these instance types based on availability.
|
3739
|
+
# @return [Array<String>]
|
3740
|
+
#
|
3741
|
+
# @!attribute [rw] instance_profile_name
|
3742
|
+
# The instance profile to associate with the instance used to
|
3743
|
+
# customize your EC2 AMI.
|
3744
|
+
# @return [String]
|
3745
|
+
#
|
3746
|
+
# @!attribute [rw] security_group_ids
|
3747
|
+
# The security group IDs to associate with the instance used to
|
3748
|
+
# customize your EC2 AMI.
|
3749
|
+
# @return [Array<String>]
|
3750
|
+
#
|
3751
|
+
# @!attribute [rw] subnet_id
|
3752
|
+
# The subnet ID to place the instance used to customize your EC2 AMI
|
3753
|
+
# in.
|
3754
|
+
# @return [String]
|
3755
|
+
#
|
3756
|
+
# @!attribute [rw] logging
|
3757
|
+
# The logging configuration of the infrastructure configuration.
|
3758
|
+
# @return [Types::Logging]
|
3759
|
+
#
|
3760
|
+
# @!attribute [rw] key_pair
|
3761
|
+
# The key pair of the infrastructure configuration. This can be used
|
3762
|
+
# to log onto and debug the instance used to create your image.
|
3763
|
+
# @return [String]
|
3764
|
+
#
|
3765
|
+
# @!attribute [rw] terminate_instance_on_failure
|
3766
|
+
# The terminate instance on failure setting of the infrastructure
|
3767
|
+
# configuration. Set to false if you wish for Image Builder to retain
|
3768
|
+
# the instance used to configure your AMI in the event that the build
|
3769
|
+
# or test phase of your workflow failed.
|
3770
|
+
# @return [Boolean]
|
3771
|
+
#
|
3772
|
+
# @!attribute [rw] sns_topic_arn
|
3773
|
+
# The SNS topic on which to send image build events.
|
3774
|
+
# @return [String]
|
3775
|
+
#
|
3776
|
+
# @!attribute [rw] client_token
|
3777
|
+
# The idempotency token used to make this request idempotent.
|
3778
|
+
#
|
3779
|
+
# **A suitable default value is auto-generated.** You should normally
|
3780
|
+
# not need to pass this option.
|
3781
|
+
# @return [String]
|
3782
|
+
#
|
3783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateInfrastructureConfigurationRequest AWS API Documentation
|
3784
|
+
#
|
3785
|
+
class UpdateInfrastructureConfigurationRequest < Struct.new(
|
3786
|
+
:infrastructure_configuration_arn,
|
3787
|
+
:description,
|
3788
|
+
:instance_types,
|
3789
|
+
:instance_profile_name,
|
3790
|
+
:security_group_ids,
|
3791
|
+
:subnet_id,
|
3792
|
+
:logging,
|
3793
|
+
:key_pair,
|
3794
|
+
:terminate_instance_on_failure,
|
3795
|
+
:sns_topic_arn,
|
3796
|
+
:client_token)
|
3797
|
+
include Aws::Structure
|
3798
|
+
end
|
3799
|
+
|
3800
|
+
# @!attribute [rw] request_id
|
3801
|
+
# The request ID that uniquely identifies this request.
|
3802
|
+
# @return [String]
|
3803
|
+
#
|
3804
|
+
# @!attribute [rw] client_token
|
3805
|
+
# The idempotency token used to make this request idempotent.
|
3806
|
+
# @return [String]
|
3807
|
+
#
|
3808
|
+
# @!attribute [rw] infrastructure_configuration_arn
|
3809
|
+
# The Amazon Resource Name (ARN) of the infrastructure configuration
|
3810
|
+
# that was updated by this request.
|
3811
|
+
# @return [String]
|
3812
|
+
#
|
3813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/UpdateInfrastructureConfigurationResponse AWS API Documentation
|
3814
|
+
#
|
3815
|
+
class UpdateInfrastructureConfigurationResponse < Struct.new(
|
3816
|
+
:request_id,
|
3817
|
+
:client_token,
|
3818
|
+
:infrastructure_configuration_arn)
|
3819
|
+
include Aws::Structure
|
3820
|
+
end
|
3821
|
+
|
3822
|
+
end
|
3823
|
+
end
|