aws-sdk-elasticbeanstalk 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-elasticbeanstalk.rb +47 -0
- data/lib/aws-sdk-elasticbeanstalk/client.rb +2207 -0
- data/lib/aws-sdk-elasticbeanstalk/client_api.rb +1193 -0
- data/lib/aws-sdk-elasticbeanstalk/customizations.rb +7 -0
- data/lib/aws-sdk-elasticbeanstalk/errors.rb +23 -0
- data/lib/aws-sdk-elasticbeanstalk/resource.rb +25 -0
- data/lib/aws-sdk-elasticbeanstalk/types.rb +3164 -0
- metadata +80 -0
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module ElasticBeanstalk
|
10
|
+
module Errors
|
11
|
+
|
12
|
+
extend Aws::Errors::DynamicErrors
|
13
|
+
|
14
|
+
# Raised when calling #load or #data on a resource class that can not be
|
15
|
+
# loaded. This can happen when:
|
16
|
+
#
|
17
|
+
# * A resource class has identifiers, but no data attributes.
|
18
|
+
# * Resource data is only available when making an API call that
|
19
|
+
# enumerates all resources of that type.
|
20
|
+
class ResourceNotLoadable < RuntimeError; end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module ElasticBeanstalk
|
10
|
+
class Resource
|
11
|
+
|
12
|
+
# @param options ({})
|
13
|
+
# @option options [Client] :client
|
14
|
+
def initialize(options = {})
|
15
|
+
@client = options[:client] || Client.new(options)
|
16
|
+
end
|
17
|
+
|
18
|
+
# @return [Client]
|
19
|
+
def client
|
20
|
+
@client
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,3164 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module ElasticBeanstalk
|
10
|
+
module Types
|
11
|
+
|
12
|
+
# @note When making an API call, pass AbortEnvironmentUpdateMessage
|
13
|
+
# data as a hash:
|
14
|
+
#
|
15
|
+
# {
|
16
|
+
# environment_id: "EnvironmentId",
|
17
|
+
# environment_name: "EnvironmentName",
|
18
|
+
# }
|
19
|
+
# @!attribute [rw] environment_id
|
20
|
+
# This specifies the ID of the environment with the in-progress update
|
21
|
+
# that you want to cancel.
|
22
|
+
# @return [String]
|
23
|
+
#
|
24
|
+
# @!attribute [rw] environment_name
|
25
|
+
# This specifies the name of the environment with the in-progress
|
26
|
+
# update that you want to cancel.
|
27
|
+
# @return [String]
|
28
|
+
class AbortEnvironmentUpdateMessage < Struct.new(
|
29
|
+
:environment_id,
|
30
|
+
:environment_name)
|
31
|
+
include Aws::Structure
|
32
|
+
end
|
33
|
+
|
34
|
+
# Describes the properties of an application.
|
35
|
+
# @!attribute [rw] application_name
|
36
|
+
# The name of the application.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] description
|
40
|
+
# User-defined description of the application.
|
41
|
+
# @return [String]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] date_created
|
44
|
+
# The date when the application was created.
|
45
|
+
# @return [Time]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] date_updated
|
48
|
+
# The date when the application was last modified.
|
49
|
+
# @return [Time]
|
50
|
+
#
|
51
|
+
# @!attribute [rw] versions
|
52
|
+
# The names of the versions for this application.
|
53
|
+
# @return [Array<String>]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] configuration_templates
|
56
|
+
# The names of the configuration templates associated with this
|
57
|
+
# application.
|
58
|
+
# @return [Array<String>]
|
59
|
+
class ApplicationDescription < Struct.new(
|
60
|
+
:application_name,
|
61
|
+
:description,
|
62
|
+
:date_created,
|
63
|
+
:date_updated,
|
64
|
+
:versions,
|
65
|
+
:configuration_templates)
|
66
|
+
include Aws::Structure
|
67
|
+
end
|
68
|
+
|
69
|
+
# Result message containing a single description of an application.
|
70
|
+
# @!attribute [rw] application
|
71
|
+
# The ApplicationDescription of the application.
|
72
|
+
# @return [Types::ApplicationDescription]
|
73
|
+
class ApplicationDescriptionMessage < Struct.new(
|
74
|
+
:application)
|
75
|
+
include Aws::Structure
|
76
|
+
end
|
77
|
+
|
78
|
+
# Result message containing a list of application descriptions.
|
79
|
+
# @!attribute [rw] applications
|
80
|
+
# This parameter contains a list of ApplicationDescription.
|
81
|
+
# @return [Array<Types::ApplicationDescription>]
|
82
|
+
class ApplicationDescriptionsMessage < Struct.new(
|
83
|
+
:applications)
|
84
|
+
include Aws::Structure
|
85
|
+
end
|
86
|
+
|
87
|
+
# Represents the application metrics for a specified environment.
|
88
|
+
# @!attribute [rw] duration
|
89
|
+
# The amount of time that the metrics cover (usually 10 seconds). For
|
90
|
+
# example, you might have 5 requests (`request_count`) within the most
|
91
|
+
# recent time slice of 10 seconds (`duration`).
|
92
|
+
# @return [Integer]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] request_count
|
95
|
+
# Average number of requests handled by the web server per second over
|
96
|
+
# the last 10 seconds.
|
97
|
+
# @return [Integer]
|
98
|
+
#
|
99
|
+
# @!attribute [rw] status_codes
|
100
|
+
# Represents the percentage of requests over the last 10 seconds that
|
101
|
+
# resulted in each type of status code response.
|
102
|
+
# @return [Types::StatusCodes]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] latency
|
105
|
+
# Represents the average latency for the slowest X percent of requests
|
106
|
+
# over the last 10 seconds. Latencies are in seconds with one
|
107
|
+
# milisecond resolution.
|
108
|
+
# @return [Types::Latency]
|
109
|
+
class ApplicationMetrics < Struct.new(
|
110
|
+
:duration,
|
111
|
+
:request_count,
|
112
|
+
:status_codes,
|
113
|
+
:latency)
|
114
|
+
include Aws::Structure
|
115
|
+
end
|
116
|
+
|
117
|
+
# Describes the properties of an application version.
|
118
|
+
# @!attribute [rw] application_name
|
119
|
+
# The name of the application associated with this release.
|
120
|
+
# @return [String]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] description
|
123
|
+
# The description of this application version.
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
# @!attribute [rw] version_label
|
127
|
+
# A label uniquely identifying the version for the associated
|
128
|
+
# application.
|
129
|
+
# @return [String]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] source_build_information
|
132
|
+
# @return [Types::SourceBuildInformation]
|
133
|
+
#
|
134
|
+
# @!attribute [rw] source_bundle
|
135
|
+
# The location where the source bundle is located for this version.
|
136
|
+
# @return [Types::S3Location]
|
137
|
+
#
|
138
|
+
# @!attribute [rw] date_created
|
139
|
+
# The creation date of the application version.
|
140
|
+
# @return [Time]
|
141
|
+
#
|
142
|
+
# @!attribute [rw] date_updated
|
143
|
+
# The last modified date of the application version.
|
144
|
+
# @return [Time]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] status
|
147
|
+
# The processing status of the application version.
|
148
|
+
# @return [String]
|
149
|
+
class ApplicationVersionDescription < Struct.new(
|
150
|
+
:application_name,
|
151
|
+
:description,
|
152
|
+
:version_label,
|
153
|
+
:source_build_information,
|
154
|
+
:source_bundle,
|
155
|
+
:date_created,
|
156
|
+
:date_updated,
|
157
|
+
:status)
|
158
|
+
include Aws::Structure
|
159
|
+
end
|
160
|
+
|
161
|
+
# Result message wrapping a single description of an application
|
162
|
+
# version.
|
163
|
+
# @!attribute [rw] application_version
|
164
|
+
# The ApplicationVersionDescription of the application version.
|
165
|
+
# @return [Types::ApplicationVersionDescription]
|
166
|
+
class ApplicationVersionDescriptionMessage < Struct.new(
|
167
|
+
:application_version)
|
168
|
+
include Aws::Structure
|
169
|
+
end
|
170
|
+
|
171
|
+
# Result message wrapping a list of application version descriptions.
|
172
|
+
# @!attribute [rw] application_versions
|
173
|
+
# List of `ApplicationVersionDescription` objects sorted by order of
|
174
|
+
# creation.
|
175
|
+
# @return [Array<Types::ApplicationVersionDescription>]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] next_token
|
178
|
+
# For a paginated request, the token that you can pass in a subsequent
|
179
|
+
# request to get the next page.
|
180
|
+
# @return [String]
|
181
|
+
class ApplicationVersionDescriptionsMessage < Struct.new(
|
182
|
+
:application_versions,
|
183
|
+
:next_token)
|
184
|
+
include Aws::Structure
|
185
|
+
end
|
186
|
+
|
187
|
+
# Request to execute a scheduled managed action immediately.
|
188
|
+
# @note When making an API call, pass ApplyEnvironmentManagedActionRequest
|
189
|
+
# data as a hash:
|
190
|
+
#
|
191
|
+
# {
|
192
|
+
# environment_name: "String",
|
193
|
+
# environment_id: "String",
|
194
|
+
# action_id: "String", # required
|
195
|
+
# }
|
196
|
+
# @!attribute [rw] environment_name
|
197
|
+
# The name of the target environment.
|
198
|
+
# @return [String]
|
199
|
+
#
|
200
|
+
# @!attribute [rw] environment_id
|
201
|
+
# The environment ID of the target environment.
|
202
|
+
# @return [String]
|
203
|
+
#
|
204
|
+
# @!attribute [rw] action_id
|
205
|
+
# The action ID of the scheduled managed action to execute.
|
206
|
+
# @return [String]
|
207
|
+
class ApplyEnvironmentManagedActionRequest < Struct.new(
|
208
|
+
:environment_name,
|
209
|
+
:environment_id,
|
210
|
+
:action_id)
|
211
|
+
include Aws::Structure
|
212
|
+
end
|
213
|
+
|
214
|
+
# The result message containing information about the managed action.
|
215
|
+
# @!attribute [rw] action_id
|
216
|
+
# The action ID of the managed action.
|
217
|
+
# @return [String]
|
218
|
+
#
|
219
|
+
# @!attribute [rw] action_description
|
220
|
+
# A description of the managed action.
|
221
|
+
# @return [String]
|
222
|
+
#
|
223
|
+
# @!attribute [rw] action_type
|
224
|
+
# The type of managed action.
|
225
|
+
# @return [String]
|
226
|
+
#
|
227
|
+
# @!attribute [rw] status
|
228
|
+
# The status of the managed action.
|
229
|
+
# @return [String]
|
230
|
+
class ApplyEnvironmentManagedActionResult < Struct.new(
|
231
|
+
:action_id,
|
232
|
+
:action_description,
|
233
|
+
:action_type,
|
234
|
+
:status)
|
235
|
+
include Aws::Structure
|
236
|
+
end
|
237
|
+
|
238
|
+
# Describes an Auto Scaling launch configuration.
|
239
|
+
# @!attribute [rw] name
|
240
|
+
# The name of the `AutoScalingGroup` .
|
241
|
+
# @return [String]
|
242
|
+
class AutoScalingGroup < Struct.new(
|
243
|
+
:name)
|
244
|
+
include Aws::Structure
|
245
|
+
end
|
246
|
+
|
247
|
+
# Represents CPU utilization information from the specified instance
|
248
|
+
# that belongs to the AWS Elastic Beanstalk environment. Use the
|
249
|
+
# `instanceId` property to specify the application instance for which
|
250
|
+
# you'd like to return data.
|
251
|
+
# @!attribute [rw] user
|
252
|
+
# Percentage of time that the CPU has spent in the `User` state over
|
253
|
+
# the last 10 seconds.
|
254
|
+
# @return [Float]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] nice
|
257
|
+
# Percentage of time that the CPU has spent in the `Nice` state over
|
258
|
+
# the last 10 seconds.
|
259
|
+
# @return [Float]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] system
|
262
|
+
# Percentage of time that the CPU has spent in the `System` state over
|
263
|
+
# the last 10 seconds.
|
264
|
+
# @return [Float]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] idle
|
267
|
+
# Percentage of time that the CPU has spent in the `Idle` state over
|
268
|
+
# the last 10 seconds.
|
269
|
+
# @return [Float]
|
270
|
+
#
|
271
|
+
# @!attribute [rw] io_wait
|
272
|
+
# Percentage of time that the CPU has spent in the `I/O Wait` state
|
273
|
+
# over the last 10 seconds.
|
274
|
+
# @return [Float]
|
275
|
+
#
|
276
|
+
# @!attribute [rw] irq
|
277
|
+
# Percentage of time that the CPU has spent in the `IRQ` state over
|
278
|
+
# the last 10 seconds.
|
279
|
+
# @return [Float]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] soft_irq
|
282
|
+
# Percentage of time that the CPU has spent in the `SoftIRQ` state
|
283
|
+
# over the last 10 seconds.
|
284
|
+
# @return [Float]
|
285
|
+
class CPUUtilization < Struct.new(
|
286
|
+
:user,
|
287
|
+
:nice,
|
288
|
+
:system,
|
289
|
+
:idle,
|
290
|
+
:io_wait,
|
291
|
+
:irq,
|
292
|
+
:soft_irq)
|
293
|
+
include Aws::Structure
|
294
|
+
end
|
295
|
+
|
296
|
+
# Results message indicating whether a CNAME is available.
|
297
|
+
# @note When making an API call, pass CheckDNSAvailabilityMessage
|
298
|
+
# data as a hash:
|
299
|
+
#
|
300
|
+
# {
|
301
|
+
# cname_prefix: "DNSCnamePrefix", # required
|
302
|
+
# }
|
303
|
+
# @!attribute [rw] cname_prefix
|
304
|
+
# The prefix used when this CNAME is reserved.
|
305
|
+
# @return [String]
|
306
|
+
class CheckDNSAvailabilityMessage < Struct.new(
|
307
|
+
:cname_prefix)
|
308
|
+
include Aws::Structure
|
309
|
+
end
|
310
|
+
|
311
|
+
# Indicates if the specified CNAME is available.
|
312
|
+
# @!attribute [rw] available
|
313
|
+
# Indicates if the specified CNAME is available:
|
314
|
+
#
|
315
|
+
# * `true`\: The CNAME is available.
|
316
|
+
#
|
317
|
+
# * `false`\: The CNAME is not available.
|
318
|
+
# @return [Boolean]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] fully_qualified_cname
|
321
|
+
# The fully qualified CNAME to reserve when CreateEnvironment is
|
322
|
+
# called with the provided prefix.
|
323
|
+
# @return [String]
|
324
|
+
class CheckDNSAvailabilityResultMessage < Struct.new(
|
325
|
+
:available,
|
326
|
+
:fully_qualified_cname)
|
327
|
+
include Aws::Structure
|
328
|
+
end
|
329
|
+
|
330
|
+
# Request to create or update a group of environments.
|
331
|
+
# @note When making an API call, pass ComposeEnvironmentsMessage
|
332
|
+
# data as a hash:
|
333
|
+
#
|
334
|
+
# {
|
335
|
+
# application_name: "ApplicationName",
|
336
|
+
# group_name: "GroupName",
|
337
|
+
# version_labels: ["VersionLabel"],
|
338
|
+
# }
|
339
|
+
# @!attribute [rw] application_name
|
340
|
+
# The name of the application to which the specified source bundles
|
341
|
+
# belong.
|
342
|
+
# @return [String]
|
343
|
+
#
|
344
|
+
# @!attribute [rw] group_name
|
345
|
+
# The name of the group to which the target environments belong.
|
346
|
+
# Specify a group name only if the environment name defined in each
|
347
|
+
# target environment's manifest ends with a + (plus) character. See
|
348
|
+
# [Environment Manifest (env.yaml)][1] for details.
|
349
|
+
#
|
350
|
+
#
|
351
|
+
#
|
352
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] version_labels
|
356
|
+
# A list of version labels, specifying one or more application source
|
357
|
+
# bundles that belong to the target application. Each source bundle
|
358
|
+
# must include an environment manifest that specifies the name of the
|
359
|
+
# environment and the name of the solution stack to use, and
|
360
|
+
# optionally can specify environment links to create.
|
361
|
+
# @return [Array<String>]
|
362
|
+
class ComposeEnvironmentsMessage < Struct.new(
|
363
|
+
:application_name,
|
364
|
+
:group_name,
|
365
|
+
:version_labels)
|
366
|
+
include Aws::Structure
|
367
|
+
end
|
368
|
+
|
369
|
+
# Describes the possible values for a configuration option.
|
370
|
+
# @!attribute [rw] namespace
|
371
|
+
# A unique namespace identifying the option's associated AWS
|
372
|
+
# resource.
|
373
|
+
# @return [String]
|
374
|
+
#
|
375
|
+
# @!attribute [rw] name
|
376
|
+
# The name of the configuration option.
|
377
|
+
# @return [String]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] default_value
|
380
|
+
# The default value for this configuration option.
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @!attribute [rw] change_severity
|
384
|
+
# An indication of which action is required if the value for this
|
385
|
+
# configuration option changes:
|
386
|
+
#
|
387
|
+
# * `NoInterruption`\: There is no interruption to the environment or
|
388
|
+
# application availability.
|
389
|
+
#
|
390
|
+
# * `RestartEnvironment`\: The environment is entirely restarted, all
|
391
|
+
# AWS resources are deleted and recreated, and the environment is
|
392
|
+
# unavailable during the process.
|
393
|
+
#
|
394
|
+
# * `RestartApplicationServer`\: The environment is available the
|
395
|
+
# entire time. However, a short application outage occurs when the
|
396
|
+
# application servers on the running Amazon EC2 instances are
|
397
|
+
# restarted.
|
398
|
+
# @return [String]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] user_defined
|
401
|
+
# An indication of whether the user defined this configuration option:
|
402
|
+
#
|
403
|
+
# * `true`\: This configuration option was defined by the user. It is
|
404
|
+
# a valid choice for specifying if this as an `Option to Remove`
|
405
|
+
# when updating configuration settings.
|
406
|
+
#
|
407
|
+
# * `false`\: This configuration was not defined by the user.
|
408
|
+
#
|
409
|
+
# Constraint: You can remove only `UserDefined` options from a
|
410
|
+
# configuration.
|
411
|
+
#
|
412
|
+
# Valid Values: `true` \| `false`
|
413
|
+
# @return [Boolean]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] value_type
|
416
|
+
# An indication of which type of values this option has and whether it
|
417
|
+
# is allowable to select one or more than one of the possible values:
|
418
|
+
#
|
419
|
+
# * `Scalar`\: Values for this option are a single selection from the
|
420
|
+
# possible values, or an unformatted string, or numeric value
|
421
|
+
# governed by the `MIN/MAX/Regex` constraints.
|
422
|
+
#
|
423
|
+
# * `List`\: Values for this option are multiple selections from the
|
424
|
+
# possible values.
|
425
|
+
#
|
426
|
+
# * `Boolean`\: Values for this option are either `true` or `false` .
|
427
|
+
#
|
428
|
+
# * `Json`\: Values for this option are a JSON representation of a
|
429
|
+
# `ConfigDocument`.
|
430
|
+
# @return [String]
|
431
|
+
#
|
432
|
+
# @!attribute [rw] value_options
|
433
|
+
# If specified, values for the configuration option are selected from
|
434
|
+
# this list.
|
435
|
+
# @return [Array<String>]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] min_value
|
438
|
+
# If specified, the configuration option must be a numeric value
|
439
|
+
# greater than this value.
|
440
|
+
# @return [Integer]
|
441
|
+
#
|
442
|
+
# @!attribute [rw] max_value
|
443
|
+
# If specified, the configuration option must be a numeric value less
|
444
|
+
# than this value.
|
445
|
+
# @return [Integer]
|
446
|
+
#
|
447
|
+
# @!attribute [rw] max_length
|
448
|
+
# If specified, the configuration option must be a string value no
|
449
|
+
# longer than this value.
|
450
|
+
# @return [Integer]
|
451
|
+
#
|
452
|
+
# @!attribute [rw] regex
|
453
|
+
# If specified, the configuration option must be a string value that
|
454
|
+
# satisfies this regular expression.
|
455
|
+
# @return [Types::OptionRestrictionRegex]
|
456
|
+
class ConfigurationOptionDescription < Struct.new(
|
457
|
+
:namespace,
|
458
|
+
:name,
|
459
|
+
:default_value,
|
460
|
+
:change_severity,
|
461
|
+
:user_defined,
|
462
|
+
:value_type,
|
463
|
+
:value_options,
|
464
|
+
:min_value,
|
465
|
+
:max_value,
|
466
|
+
:max_length,
|
467
|
+
:regex)
|
468
|
+
include Aws::Structure
|
469
|
+
end
|
470
|
+
|
471
|
+
# A specification identifying an individual configuration option along
|
472
|
+
# with its current value. For a list of possible option values, go to
|
473
|
+
# [Option Values][1] in the *AWS Elastic Beanstalk Developer Guide*.
|
474
|
+
#
|
475
|
+
#
|
476
|
+
#
|
477
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html
|
478
|
+
# @note When making an API call, pass ConfigurationOptionSetting
|
479
|
+
# data as a hash:
|
480
|
+
#
|
481
|
+
# {
|
482
|
+
# resource_name: "ResourceName",
|
483
|
+
# namespace: "OptionNamespace",
|
484
|
+
# option_name: "ConfigurationOptionName",
|
485
|
+
# value: "ConfigurationOptionValue",
|
486
|
+
# }
|
487
|
+
# @!attribute [rw] resource_name
|
488
|
+
# A unique resource name for a time-based scaling configuration
|
489
|
+
# option.
|
490
|
+
# @return [String]
|
491
|
+
#
|
492
|
+
# @!attribute [rw] namespace
|
493
|
+
# A unique namespace identifying the option's associated AWS
|
494
|
+
# resource.
|
495
|
+
# @return [String]
|
496
|
+
#
|
497
|
+
# @!attribute [rw] option_name
|
498
|
+
# The name of the configuration option.
|
499
|
+
# @return [String]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] value
|
502
|
+
# The current value for the configuration option.
|
503
|
+
# @return [String]
|
504
|
+
class ConfigurationOptionSetting < Struct.new(
|
505
|
+
:resource_name,
|
506
|
+
:namespace,
|
507
|
+
:option_name,
|
508
|
+
:value)
|
509
|
+
include Aws::Structure
|
510
|
+
end
|
511
|
+
|
512
|
+
# Describes the settings for a specified configuration set.
|
513
|
+
# @!attribute [rw] solution_stack_name
|
514
|
+
# The name of the solution stack these configuration options belong
|
515
|
+
# to.
|
516
|
+
# @return [String]
|
517
|
+
#
|
518
|
+
# @!attribute [rw] options
|
519
|
+
# A list of ConfigurationOptionDescription.
|
520
|
+
# @return [Array<Types::ConfigurationOptionDescription>]
|
521
|
+
class ConfigurationOptionsDescription < Struct.new(
|
522
|
+
:solution_stack_name,
|
523
|
+
:options)
|
524
|
+
include Aws::Structure
|
525
|
+
end
|
526
|
+
|
527
|
+
# Describes the settings for a configuration set.
|
528
|
+
# @!attribute [rw] solution_stack_name
|
529
|
+
# The name of the solution stack this configuration set uses.
|
530
|
+
# @return [String]
|
531
|
+
#
|
532
|
+
# @!attribute [rw] application_name
|
533
|
+
# The name of the application associated with this configuration set.
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] template_name
|
537
|
+
# If not `null`, the name of the configuration template for this
|
538
|
+
# configuration set.
|
539
|
+
# @return [String]
|
540
|
+
#
|
541
|
+
# @!attribute [rw] description
|
542
|
+
# Describes this configuration set.
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @!attribute [rw] environment_name
|
546
|
+
# If not `null`, the name of the environment for this configuration
|
547
|
+
# set.
|
548
|
+
# @return [String]
|
549
|
+
#
|
550
|
+
# @!attribute [rw] deployment_status
|
551
|
+
# If this configuration set is associated with an environment, the
|
552
|
+
# `DeploymentStatus` parameter indicates the deployment status of this
|
553
|
+
# configuration set:
|
554
|
+
#
|
555
|
+
# * `null`\: This configuration is not associated with a running
|
556
|
+
# environment.
|
557
|
+
#
|
558
|
+
# * `pending`\: This is a draft configuration that is not deployed to
|
559
|
+
# the associated environment but is in the process of deploying.
|
560
|
+
#
|
561
|
+
# * `deployed`\: This is the configuration that is currently deployed
|
562
|
+
# to the associated running environment.
|
563
|
+
#
|
564
|
+
# * `failed`\: This is a draft configuration that failed to
|
565
|
+
# successfully deploy.
|
566
|
+
# @return [String]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] date_created
|
569
|
+
# The date (in UTC time) when this configuration set was created.
|
570
|
+
# @return [Time]
|
571
|
+
#
|
572
|
+
# @!attribute [rw] date_updated
|
573
|
+
# The date (in UTC time) when this configuration set was last
|
574
|
+
# modified.
|
575
|
+
# @return [Time]
|
576
|
+
#
|
577
|
+
# @!attribute [rw] option_settings
|
578
|
+
# A list of the configuration options and their values in this
|
579
|
+
# configuration set.
|
580
|
+
# @return [Array<Types::ConfigurationOptionSetting>]
|
581
|
+
class ConfigurationSettingsDescription < Struct.new(
|
582
|
+
:solution_stack_name,
|
583
|
+
:application_name,
|
584
|
+
:template_name,
|
585
|
+
:description,
|
586
|
+
:environment_name,
|
587
|
+
:deployment_status,
|
588
|
+
:date_created,
|
589
|
+
:date_updated,
|
590
|
+
:option_settings)
|
591
|
+
include Aws::Structure
|
592
|
+
end
|
593
|
+
|
594
|
+
# The results from a request to change the configuration settings of an
|
595
|
+
# environment.
|
596
|
+
# @!attribute [rw] configuration_settings
|
597
|
+
# A list of ConfigurationSettingsDescription.
|
598
|
+
# @return [Array<Types::ConfigurationSettingsDescription>]
|
599
|
+
class ConfigurationSettingsDescriptions < Struct.new(
|
600
|
+
:configuration_settings)
|
601
|
+
include Aws::Structure
|
602
|
+
end
|
603
|
+
|
604
|
+
# Provides a list of validation messages.
|
605
|
+
# @!attribute [rw] messages
|
606
|
+
# A list of ValidationMessage.
|
607
|
+
# @return [Array<Types::ValidationMessage>]
|
608
|
+
class ConfigurationSettingsValidationMessages < Struct.new(
|
609
|
+
:messages)
|
610
|
+
include Aws::Structure
|
611
|
+
end
|
612
|
+
|
613
|
+
# Request to create an application.
|
614
|
+
# @note When making an API call, pass CreateApplicationMessage
|
615
|
+
# data as a hash:
|
616
|
+
#
|
617
|
+
# {
|
618
|
+
# application_name: "ApplicationName", # required
|
619
|
+
# description: "Description",
|
620
|
+
# }
|
621
|
+
# @!attribute [rw] application_name
|
622
|
+
# The name of the application.
|
623
|
+
#
|
624
|
+
# Constraint: This name must be unique within your account. If the
|
625
|
+
# specified name already exists, the action returns an
|
626
|
+
# `InvalidParameterValue` error.
|
627
|
+
# @return [String]
|
628
|
+
#
|
629
|
+
# @!attribute [rw] description
|
630
|
+
# Describes the application.
|
631
|
+
# @return [String]
|
632
|
+
class CreateApplicationMessage < Struct.new(
|
633
|
+
:application_name,
|
634
|
+
:description)
|
635
|
+
include Aws::Structure
|
636
|
+
end
|
637
|
+
|
638
|
+
# @note When making an API call, pass CreateApplicationVersionMessage
|
639
|
+
# data as a hash:
|
640
|
+
#
|
641
|
+
# {
|
642
|
+
# application_name: "ApplicationName", # required
|
643
|
+
# version_label: "VersionLabel", # required
|
644
|
+
# description: "Description",
|
645
|
+
# source_build_information: {
|
646
|
+
# source_type: "Git", # required, accepts Git
|
647
|
+
# source_repository: "CodeCommit", # required, accepts CodeCommit
|
648
|
+
# source_location: "SourceLocation", # required
|
649
|
+
# },
|
650
|
+
# source_bundle: {
|
651
|
+
# s3_bucket: "S3Bucket",
|
652
|
+
# s3_key: "S3Key",
|
653
|
+
# },
|
654
|
+
# auto_create_application: false,
|
655
|
+
# process: false,
|
656
|
+
# }
|
657
|
+
# @!attribute [rw] application_name
|
658
|
+
# The name of the application. If no application is found with this
|
659
|
+
# name, and `AutoCreateApplication` is `false`, returns an
|
660
|
+
# `InvalidParameterValue` error.
|
661
|
+
# @return [String]
|
662
|
+
#
|
663
|
+
# @!attribute [rw] version_label
|
664
|
+
# A label identifying this version.
|
665
|
+
#
|
666
|
+
# Constraint: Must be unique per application. If an application
|
667
|
+
# version already exists with this label for the specified
|
668
|
+
# application, AWS Elastic Beanstalk returns an
|
669
|
+
# `InvalidParameterValue` error.
|
670
|
+
# @return [String]
|
671
|
+
#
|
672
|
+
# @!attribute [rw] description
|
673
|
+
# Describes this version.
|
674
|
+
# @return [String]
|
675
|
+
#
|
676
|
+
# @!attribute [rw] source_build_information
|
677
|
+
# @return [Types::SourceBuildInformation]
|
678
|
+
#
|
679
|
+
# @!attribute [rw] source_bundle
|
680
|
+
# The Amazon S3 bucket and key that identify the location of the
|
681
|
+
# source bundle for this version.
|
682
|
+
#
|
683
|
+
# If data found at the Amazon S3 location exceeds the maximum allowed
|
684
|
+
# source bundle size, AWS Elastic Beanstalk returns an
|
685
|
+
# `InvalidParameterValue` error. The maximum size allowed is 512 MB.
|
686
|
+
#
|
687
|
+
# Default: If not specified, AWS Elastic Beanstalk uses a sample
|
688
|
+
# application. If only partially specified (for example, a bucket is
|
689
|
+
# provided but not the key) or if no data is found at the Amazon S3
|
690
|
+
# location, AWS Elastic Beanstalk returns an
|
691
|
+
# `InvalidParameterCombination` error.
|
692
|
+
# @return [Types::S3Location]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] auto_create_application
|
695
|
+
# Determines how the system behaves if the specified application for
|
696
|
+
# this version does not already exist:
|
697
|
+
#
|
698
|
+
# * `true`\: Automatically creates the specified application for this
|
699
|
+
# release if it does not already exist.
|
700
|
+
#
|
701
|
+
# * `false`\: Throws an `InvalidParameterValue` if the specified
|
702
|
+
# application for this release does not already exist.
|
703
|
+
#
|
704
|
+
# Default: `false`
|
705
|
+
#
|
706
|
+
# Valid Values: `true` \| `false`
|
707
|
+
# @return [Boolean]
|
708
|
+
#
|
709
|
+
# @!attribute [rw] process
|
710
|
+
# Preprocesses and validates the environment manifest and
|
711
|
+
# configuration files in the source bundle. Validating configuration
|
712
|
+
# files can identify issues prior to deploying the application version
|
713
|
+
# to an environment.
|
714
|
+
# @return [Boolean]
|
715
|
+
class CreateApplicationVersionMessage < Struct.new(
|
716
|
+
:application_name,
|
717
|
+
:version_label,
|
718
|
+
:description,
|
719
|
+
:source_build_information,
|
720
|
+
:source_bundle,
|
721
|
+
:auto_create_application,
|
722
|
+
:process)
|
723
|
+
include Aws::Structure
|
724
|
+
end
|
725
|
+
|
726
|
+
# Request to create a configuration template.
|
727
|
+
# @note When making an API call, pass CreateConfigurationTemplateMessage
|
728
|
+
# data as a hash:
|
729
|
+
#
|
730
|
+
# {
|
731
|
+
# application_name: "ApplicationName", # required
|
732
|
+
# template_name: "ConfigurationTemplateName", # required
|
733
|
+
# solution_stack_name: "SolutionStackName",
|
734
|
+
# source_configuration: {
|
735
|
+
# application_name: "ApplicationName",
|
736
|
+
# template_name: "ConfigurationTemplateName",
|
737
|
+
# },
|
738
|
+
# environment_id: "EnvironmentId",
|
739
|
+
# description: "Description",
|
740
|
+
# option_settings: [
|
741
|
+
# {
|
742
|
+
# resource_name: "ResourceName",
|
743
|
+
# namespace: "OptionNamespace",
|
744
|
+
# option_name: "ConfigurationOptionName",
|
745
|
+
# value: "ConfigurationOptionValue",
|
746
|
+
# },
|
747
|
+
# ],
|
748
|
+
# }
|
749
|
+
# @!attribute [rw] application_name
|
750
|
+
# The name of the application to associate with this configuration
|
751
|
+
# template. If no application is found with this name, AWS Elastic
|
752
|
+
# Beanstalk returns an `InvalidParameterValue` error.
|
753
|
+
# @return [String]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] template_name
|
756
|
+
# The name of the configuration template.
|
757
|
+
#
|
758
|
+
# Constraint: This name must be unique per application.
|
759
|
+
#
|
760
|
+
# Default: If a configuration template already exists with this name,
|
761
|
+
# AWS Elastic Beanstalk returns an `InvalidParameterValue` error.
|
762
|
+
# @return [String]
|
763
|
+
#
|
764
|
+
# @!attribute [rw] solution_stack_name
|
765
|
+
# The name of the solution stack used by this configuration. The
|
766
|
+
# solution stack specifies the operating system, architecture, and
|
767
|
+
# application server for a configuration template. It determines the
|
768
|
+
# set of configuration options as well as the possible and default
|
769
|
+
# values.
|
770
|
+
#
|
771
|
+
# Use ListAvailableSolutionStacks to obtain a list of available
|
772
|
+
# solution stacks.
|
773
|
+
#
|
774
|
+
# A solution stack name or a source configuration parameter must be
|
775
|
+
# specified, otherwise AWS Elastic Beanstalk returns an
|
776
|
+
# `InvalidParameterValue` error.
|
777
|
+
#
|
778
|
+
# If a solution stack name is not specified and the source
|
779
|
+
# configuration parameter is specified, AWS Elastic Beanstalk uses the
|
780
|
+
# same solution stack as the source configuration template.
|
781
|
+
# @return [String]
|
782
|
+
#
|
783
|
+
# @!attribute [rw] source_configuration
|
784
|
+
# If specified, AWS Elastic Beanstalk uses the configuration values
|
785
|
+
# from the specified configuration template to create a new
|
786
|
+
# configuration.
|
787
|
+
#
|
788
|
+
# Values specified in the `OptionSettings` parameter of this call
|
789
|
+
# overrides any values obtained from the `SourceConfiguration`.
|
790
|
+
#
|
791
|
+
# If no configuration template is found, returns an
|
792
|
+
# `InvalidParameterValue` error.
|
793
|
+
#
|
794
|
+
# Constraint: If both the solution stack name parameter and the source
|
795
|
+
# configuration parameters are specified, the solution stack of the
|
796
|
+
# source configuration template must match the specified solution
|
797
|
+
# stack name or else AWS Elastic Beanstalk returns an
|
798
|
+
# `InvalidParameterCombination` error.
|
799
|
+
# @return [Types::SourceConfiguration]
|
800
|
+
#
|
801
|
+
# @!attribute [rw] environment_id
|
802
|
+
# The ID of the environment used with this configuration template.
|
803
|
+
# @return [String]
|
804
|
+
#
|
805
|
+
# @!attribute [rw] description
|
806
|
+
# Describes this configuration.
|
807
|
+
# @return [String]
|
808
|
+
#
|
809
|
+
# @!attribute [rw] option_settings
|
810
|
+
# If specified, AWS Elastic Beanstalk sets the specified configuration
|
811
|
+
# option to the requested value. The new value overrides the value
|
812
|
+
# obtained from the solution stack or the source configuration
|
813
|
+
# template.
|
814
|
+
# @return [Array<Types::ConfigurationOptionSetting>]
|
815
|
+
class CreateConfigurationTemplateMessage < Struct.new(
|
816
|
+
:application_name,
|
817
|
+
:template_name,
|
818
|
+
:solution_stack_name,
|
819
|
+
:source_configuration,
|
820
|
+
:environment_id,
|
821
|
+
:description,
|
822
|
+
:option_settings)
|
823
|
+
include Aws::Structure
|
824
|
+
end
|
825
|
+
|
826
|
+
# @note When making an API call, pass CreateEnvironmentMessage
|
827
|
+
# data as a hash:
|
828
|
+
#
|
829
|
+
# {
|
830
|
+
# application_name: "ApplicationName", # required
|
831
|
+
# environment_name: "EnvironmentName",
|
832
|
+
# group_name: "GroupName",
|
833
|
+
# description: "Description",
|
834
|
+
# cname_prefix: "DNSCnamePrefix",
|
835
|
+
# tier: {
|
836
|
+
# name: "String",
|
837
|
+
# type: "String",
|
838
|
+
# version: "String",
|
839
|
+
# },
|
840
|
+
# tags: [
|
841
|
+
# {
|
842
|
+
# key: "TagKey",
|
843
|
+
# value: "TagValue",
|
844
|
+
# },
|
845
|
+
# ],
|
846
|
+
# version_label: "VersionLabel",
|
847
|
+
# template_name: "ConfigurationTemplateName",
|
848
|
+
# solution_stack_name: "SolutionStackName",
|
849
|
+
# option_settings: [
|
850
|
+
# {
|
851
|
+
# resource_name: "ResourceName",
|
852
|
+
# namespace: "OptionNamespace",
|
853
|
+
# option_name: "ConfigurationOptionName",
|
854
|
+
# value: "ConfigurationOptionValue",
|
855
|
+
# },
|
856
|
+
# ],
|
857
|
+
# options_to_remove: [
|
858
|
+
# {
|
859
|
+
# resource_name: "ResourceName",
|
860
|
+
# namespace: "OptionNamespace",
|
861
|
+
# option_name: "ConfigurationOptionName",
|
862
|
+
# },
|
863
|
+
# ],
|
864
|
+
# }
|
865
|
+
# @!attribute [rw] application_name
|
866
|
+
# The name of the application that contains the version to be
|
867
|
+
# deployed.
|
868
|
+
#
|
869
|
+
# If no application is found with this name, `CreateEnvironment`
|
870
|
+
# returns an `InvalidParameterValue` error.
|
871
|
+
# @return [String]
|
872
|
+
#
|
873
|
+
# @!attribute [rw] environment_name
|
874
|
+
# A unique name for the deployment environment. Used in the
|
875
|
+
# application URL.
|
876
|
+
#
|
877
|
+
# Constraint: Must be from 4 to 40 characters in length. The name can
|
878
|
+
# contain only letters, numbers, and hyphens. It cannot start or end
|
879
|
+
# with a hyphen. This name must be unique in your account. If the
|
880
|
+
# specified name already exists, AWS Elastic Beanstalk returns an
|
881
|
+
# `InvalidParameterValue` error.
|
882
|
+
#
|
883
|
+
# Default: If the CNAME parameter is not specified, the environment
|
884
|
+
# name becomes part of the CNAME, and therefore part of the visible
|
885
|
+
# URL for your application.
|
886
|
+
# @return [String]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] group_name
|
889
|
+
# The name of the group to which the target environment belongs.
|
890
|
+
# Specify a group name only if the environment's name is specified in
|
891
|
+
# an environment manifest and not with the environment name parameter.
|
892
|
+
# See [Environment Manifest (env.yaml)][1] for details.
|
893
|
+
#
|
894
|
+
#
|
895
|
+
#
|
896
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
|
897
|
+
# @return [String]
|
898
|
+
#
|
899
|
+
# @!attribute [rw] description
|
900
|
+
# Describes this environment.
|
901
|
+
# @return [String]
|
902
|
+
#
|
903
|
+
# @!attribute [rw] cname_prefix
|
904
|
+
# If specified, the environment attempts to use this value as the
|
905
|
+
# prefix for the CNAME. If not specified, the CNAME is generated
|
906
|
+
# automatically by appending a random alphanumeric string to the
|
907
|
+
# environment name.
|
908
|
+
# @return [String]
|
909
|
+
#
|
910
|
+
# @!attribute [rw] tier
|
911
|
+
# This specifies the tier to use for creating this environment.
|
912
|
+
# @return [Types::EnvironmentTier]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] tags
|
915
|
+
# This specifies the tags applied to resources in the environment.
|
916
|
+
# @return [Array<Types::Tag>]
|
917
|
+
#
|
918
|
+
# @!attribute [rw] version_label
|
919
|
+
# The name of the application version to deploy.
|
920
|
+
#
|
921
|
+
# If the specified application has no associated application versions,
|
922
|
+
# AWS Elastic Beanstalk `UpdateEnvironment` returns an
|
923
|
+
# `InvalidParameterValue` error.
|
924
|
+
#
|
925
|
+
# Default: If not specified, AWS Elastic Beanstalk attempts to launch
|
926
|
+
# the sample application in the container.
|
927
|
+
# @return [String]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] template_name
|
930
|
+
# The name of the configuration template to use in deployment. If no
|
931
|
+
# configuration template is found with this name, AWS Elastic
|
932
|
+
# Beanstalk returns an `InvalidParameterValue` error.
|
933
|
+
#
|
934
|
+
# Condition: You must specify either this parameter or a
|
935
|
+
# `SolutionStackName`, but not both. If you specify both, AWS Elastic
|
936
|
+
# Beanstalk returns an `InvalidParameterCombination` error. If you do
|
937
|
+
# not specify either, AWS Elastic Beanstalk returns a
|
938
|
+
# `MissingRequiredParameter` error.
|
939
|
+
# @return [String]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] solution_stack_name
|
942
|
+
# This is an alternative to specifying a template name. If specified,
|
943
|
+
# AWS Elastic Beanstalk sets the configuration values to the default
|
944
|
+
# values associated with the specified solution stack.
|
945
|
+
#
|
946
|
+
# Condition: You must specify either this or a `TemplateName`, but not
|
947
|
+
# both. If you specify both, AWS Elastic Beanstalk returns an
|
948
|
+
# `InvalidParameterCombination` error. If you do not specify either,
|
949
|
+
# AWS Elastic Beanstalk returns a `MissingRequiredParameter` error.
|
950
|
+
# @return [String]
|
951
|
+
#
|
952
|
+
# @!attribute [rw] option_settings
|
953
|
+
# If specified, AWS Elastic Beanstalk sets the specified configuration
|
954
|
+
# options to the requested value in the configuration set for the new
|
955
|
+
# environment. These override the values obtained from the solution
|
956
|
+
# stack or the configuration template.
|
957
|
+
# @return [Array<Types::ConfigurationOptionSetting>]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] options_to_remove
|
960
|
+
# A list of custom user-defined configuration options to remove from
|
961
|
+
# the configuration set for this new environment.
|
962
|
+
# @return [Array<Types::OptionSpecification>]
|
963
|
+
class CreateEnvironmentMessage < Struct.new(
|
964
|
+
:application_name,
|
965
|
+
:environment_name,
|
966
|
+
:group_name,
|
967
|
+
:description,
|
968
|
+
:cname_prefix,
|
969
|
+
:tier,
|
970
|
+
:tags,
|
971
|
+
:version_label,
|
972
|
+
:template_name,
|
973
|
+
:solution_stack_name,
|
974
|
+
:option_settings,
|
975
|
+
:options_to_remove)
|
976
|
+
include Aws::Structure
|
977
|
+
end
|
978
|
+
|
979
|
+
# Results of a CreateStorageLocationResult call.
|
980
|
+
# @!attribute [rw] s3_bucket
|
981
|
+
# The name of the Amazon S3 bucket created.
|
982
|
+
# @return [String]
|
983
|
+
class CreateStorageLocationResultMessage < Struct.new(
|
984
|
+
:s3_bucket)
|
985
|
+
include Aws::Structure
|
986
|
+
end
|
987
|
+
|
988
|
+
# Request to delete an application.
|
989
|
+
# @note When making an API call, pass DeleteApplicationMessage
|
990
|
+
# data as a hash:
|
991
|
+
#
|
992
|
+
# {
|
993
|
+
# application_name: "ApplicationName", # required
|
994
|
+
# terminate_env_by_force: false,
|
995
|
+
# }
|
996
|
+
# @!attribute [rw] application_name
|
997
|
+
# The name of the application to delete.
|
998
|
+
# @return [String]
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] terminate_env_by_force
|
1001
|
+
# When set to true, running environments will be terminated before
|
1002
|
+
# deleting the application.
|
1003
|
+
# @return [Boolean]
|
1004
|
+
class DeleteApplicationMessage < Struct.new(
|
1005
|
+
:application_name,
|
1006
|
+
:terminate_env_by_force)
|
1007
|
+
include Aws::Structure
|
1008
|
+
end
|
1009
|
+
|
1010
|
+
# Request to delete an application version.
|
1011
|
+
# @note When making an API call, pass DeleteApplicationVersionMessage
|
1012
|
+
# data as a hash:
|
1013
|
+
#
|
1014
|
+
# {
|
1015
|
+
# application_name: "ApplicationName", # required
|
1016
|
+
# version_label: "VersionLabel", # required
|
1017
|
+
# delete_source_bundle: false,
|
1018
|
+
# }
|
1019
|
+
# @!attribute [rw] application_name
|
1020
|
+
# The name of the application to delete releases from.
|
1021
|
+
# @return [String]
|
1022
|
+
#
|
1023
|
+
# @!attribute [rw] version_label
|
1024
|
+
# The label of the version to delete.
|
1025
|
+
# @return [String]
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] delete_source_bundle
|
1028
|
+
# Indicates whether to delete the associated source bundle from Amazon
|
1029
|
+
# S3:
|
1030
|
+
#
|
1031
|
+
# * `true`\: An attempt is made to delete the associated Amazon S3
|
1032
|
+
# source bundle specified at time of creation.
|
1033
|
+
#
|
1034
|
+
# * `false`\: No action is taken on the Amazon S3 source bundle
|
1035
|
+
# specified at time of creation.
|
1036
|
+
#
|
1037
|
+
# Valid Values: `true` \| `false`
|
1038
|
+
# @return [Boolean]
|
1039
|
+
class DeleteApplicationVersionMessage < Struct.new(
|
1040
|
+
:application_name,
|
1041
|
+
:version_label,
|
1042
|
+
:delete_source_bundle)
|
1043
|
+
include Aws::Structure
|
1044
|
+
end
|
1045
|
+
|
1046
|
+
# Request to delete a configuration template.
|
1047
|
+
# @note When making an API call, pass DeleteConfigurationTemplateMessage
|
1048
|
+
# data as a hash:
|
1049
|
+
#
|
1050
|
+
# {
|
1051
|
+
# application_name: "ApplicationName", # required
|
1052
|
+
# template_name: "ConfigurationTemplateName", # required
|
1053
|
+
# }
|
1054
|
+
# @!attribute [rw] application_name
|
1055
|
+
# The name of the application to delete the configuration template
|
1056
|
+
# from.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] template_name
|
1060
|
+
# The name of the configuration template to delete.
|
1061
|
+
# @return [String]
|
1062
|
+
class DeleteConfigurationTemplateMessage < Struct.new(
|
1063
|
+
:application_name,
|
1064
|
+
:template_name)
|
1065
|
+
include Aws::Structure
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
# Request to delete a draft environment configuration.
|
1069
|
+
# @note When making an API call, pass DeleteEnvironmentConfigurationMessage
|
1070
|
+
# data as a hash:
|
1071
|
+
#
|
1072
|
+
# {
|
1073
|
+
# application_name: "ApplicationName", # required
|
1074
|
+
# environment_name: "EnvironmentName", # required
|
1075
|
+
# }
|
1076
|
+
# @!attribute [rw] application_name
|
1077
|
+
# The name of the application the environment is associated with.
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] environment_name
|
1081
|
+
# The name of the environment to delete the draft configuration from.
|
1082
|
+
# @return [String]
|
1083
|
+
class DeleteEnvironmentConfigurationMessage < Struct.new(
|
1084
|
+
:application_name,
|
1085
|
+
:environment_name)
|
1086
|
+
include Aws::Structure
|
1087
|
+
end
|
1088
|
+
|
1089
|
+
# Information about an application version deployment.
|
1090
|
+
# @!attribute [rw] version_label
|
1091
|
+
# The version label of the application version in the deployment.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] deployment_id
|
1095
|
+
# The ID of the deployment. This number increases by one each time
|
1096
|
+
# that you deploy source code or change instance configuration
|
1097
|
+
# settings.
|
1098
|
+
# @return [Integer]
|
1099
|
+
#
|
1100
|
+
# @!attribute [rw] status
|
1101
|
+
# The status of the deployment:
|
1102
|
+
#
|
1103
|
+
# * `In Progress`\: The deployment is in progress.
|
1104
|
+
#
|
1105
|
+
# * `Deployed`\: The deployment succeeded.
|
1106
|
+
#
|
1107
|
+
# * `Failed`\: The deployment failed.
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] deployment_time
|
1111
|
+
# For in-progress deployments, the time that the deloyment started.
|
1112
|
+
#
|
1113
|
+
# For completed deployments, the time that the deployment ended.
|
1114
|
+
# @return [Time]
|
1115
|
+
class Deployment < Struct.new(
|
1116
|
+
:version_label,
|
1117
|
+
:deployment_id,
|
1118
|
+
:status,
|
1119
|
+
:deployment_time)
|
1120
|
+
include Aws::Structure
|
1121
|
+
end
|
1122
|
+
|
1123
|
+
# Result message containing a list of configuration descriptions.
|
1124
|
+
# @note When making an API call, pass DescribeApplicationVersionsMessage
|
1125
|
+
# data as a hash:
|
1126
|
+
#
|
1127
|
+
# {
|
1128
|
+
# application_name: "ApplicationName",
|
1129
|
+
# version_labels: ["VersionLabel"],
|
1130
|
+
# max_records: 1,
|
1131
|
+
# next_token: "Token",
|
1132
|
+
# }
|
1133
|
+
# @!attribute [rw] application_name
|
1134
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1135
|
+
# descriptions to only include ones that are associated with the
|
1136
|
+
# specified application.
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] version_labels
|
1140
|
+
# If specified, restricts the returned descriptions to only include
|
1141
|
+
# ones that have the specified version labels.
|
1142
|
+
# @return [Array<String>]
|
1143
|
+
#
|
1144
|
+
# @!attribute [rw] max_records
|
1145
|
+
# Specify a maximum number of application versions to paginate in the
|
1146
|
+
# request.
|
1147
|
+
# @return [Integer]
|
1148
|
+
#
|
1149
|
+
# @!attribute [rw] next_token
|
1150
|
+
# Specify a next token to retrieve the next page in a paginated
|
1151
|
+
# request.
|
1152
|
+
# @return [String]
|
1153
|
+
class DescribeApplicationVersionsMessage < Struct.new(
|
1154
|
+
:application_name,
|
1155
|
+
:version_labels,
|
1156
|
+
:max_records,
|
1157
|
+
:next_token)
|
1158
|
+
include Aws::Structure
|
1159
|
+
end
|
1160
|
+
|
1161
|
+
# Request to describe one or more applications.
|
1162
|
+
# @note When making an API call, pass DescribeApplicationsMessage
|
1163
|
+
# data as a hash:
|
1164
|
+
#
|
1165
|
+
# {
|
1166
|
+
# application_names: ["ApplicationName"],
|
1167
|
+
# }
|
1168
|
+
# @!attribute [rw] application_names
|
1169
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1170
|
+
# descriptions to only include those with the specified names.
|
1171
|
+
# @return [Array<String>]
|
1172
|
+
class DescribeApplicationsMessage < Struct.new(
|
1173
|
+
:application_names)
|
1174
|
+
include Aws::Structure
|
1175
|
+
end
|
1176
|
+
|
1177
|
+
# Result message containig a list of application version descriptions.
|
1178
|
+
# @note When making an API call, pass DescribeConfigurationOptionsMessage
|
1179
|
+
# data as a hash:
|
1180
|
+
#
|
1181
|
+
# {
|
1182
|
+
# application_name: "ApplicationName",
|
1183
|
+
# template_name: "ConfigurationTemplateName",
|
1184
|
+
# environment_name: "EnvironmentName",
|
1185
|
+
# solution_stack_name: "SolutionStackName",
|
1186
|
+
# options: [
|
1187
|
+
# {
|
1188
|
+
# resource_name: "ResourceName",
|
1189
|
+
# namespace: "OptionNamespace",
|
1190
|
+
# option_name: "ConfigurationOptionName",
|
1191
|
+
# },
|
1192
|
+
# ],
|
1193
|
+
# }
|
1194
|
+
# @!attribute [rw] application_name
|
1195
|
+
# The name of the application associated with the configuration
|
1196
|
+
# template or environment. Only needed if you want to describe the
|
1197
|
+
# configuration options associated with either the configuration
|
1198
|
+
# template or environment.
|
1199
|
+
# @return [String]
|
1200
|
+
#
|
1201
|
+
# @!attribute [rw] template_name
|
1202
|
+
# The name of the configuration template whose configuration options
|
1203
|
+
# you want to describe.
|
1204
|
+
# @return [String]
|
1205
|
+
#
|
1206
|
+
# @!attribute [rw] environment_name
|
1207
|
+
# The name of the environment whose configuration options you want to
|
1208
|
+
# describe.
|
1209
|
+
# @return [String]
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] solution_stack_name
|
1212
|
+
# The name of the solution stack whose configuration options you want
|
1213
|
+
# to describe.
|
1214
|
+
# @return [String]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] options
|
1217
|
+
# If specified, restricts the descriptions to only the specified
|
1218
|
+
# options.
|
1219
|
+
# @return [Array<Types::OptionSpecification>]
|
1220
|
+
class DescribeConfigurationOptionsMessage < Struct.new(
|
1221
|
+
:application_name,
|
1222
|
+
:template_name,
|
1223
|
+
:environment_name,
|
1224
|
+
:solution_stack_name,
|
1225
|
+
:options)
|
1226
|
+
include Aws::Structure
|
1227
|
+
end
|
1228
|
+
|
1229
|
+
# Result message containing all of the configuration settings for a
|
1230
|
+
# specified solution stack or configuration template.
|
1231
|
+
# @note When making an API call, pass DescribeConfigurationSettingsMessage
|
1232
|
+
# data as a hash:
|
1233
|
+
#
|
1234
|
+
# {
|
1235
|
+
# application_name: "ApplicationName", # required
|
1236
|
+
# template_name: "ConfigurationTemplateName",
|
1237
|
+
# environment_name: "EnvironmentName",
|
1238
|
+
# }
|
1239
|
+
# @!attribute [rw] application_name
|
1240
|
+
# The application for the environment or configuration template.
|
1241
|
+
# @return [String]
|
1242
|
+
#
|
1243
|
+
# @!attribute [rw] template_name
|
1244
|
+
# The name of the configuration template to describe.
|
1245
|
+
#
|
1246
|
+
# Conditional: You must specify either this parameter or an
|
1247
|
+
# EnvironmentName, but not both. If you specify both, AWS Elastic
|
1248
|
+
# Beanstalk returns an `InvalidParameterCombination` error. If you do
|
1249
|
+
# not specify either, AWS Elastic Beanstalk returns a
|
1250
|
+
# `MissingRequiredParameter` error.
|
1251
|
+
# @return [String]
|
1252
|
+
#
|
1253
|
+
# @!attribute [rw] environment_name
|
1254
|
+
# The name of the environment to describe.
|
1255
|
+
#
|
1256
|
+
# Condition: You must specify either this or a TemplateName, but not
|
1257
|
+
# both. If you specify both, AWS Elastic Beanstalk returns an
|
1258
|
+
# `InvalidParameterCombination` error. If you do not specify either,
|
1259
|
+
# AWS Elastic Beanstalk returns `MissingRequiredParameter` error.
|
1260
|
+
# @return [String]
|
1261
|
+
class DescribeConfigurationSettingsMessage < Struct.new(
|
1262
|
+
:application_name,
|
1263
|
+
:template_name,
|
1264
|
+
:environment_name)
|
1265
|
+
include Aws::Structure
|
1266
|
+
end
|
1267
|
+
|
1268
|
+
# See the example below to learn how to create a request body.
|
1269
|
+
# @note When making an API call, pass DescribeEnvironmentHealthRequest
|
1270
|
+
# data as a hash:
|
1271
|
+
#
|
1272
|
+
# {
|
1273
|
+
# environment_name: "EnvironmentName",
|
1274
|
+
# environment_id: "EnvironmentId",
|
1275
|
+
# attribute_names: ["Status"], # accepts Status, Color, Causes, ApplicationMetrics, InstancesHealth, All, HealthStatus, RefreshedAt
|
1276
|
+
# }
|
1277
|
+
# @!attribute [rw] environment_name
|
1278
|
+
# Specifies the AWS Elastic Beanstalk environment name.
|
1279
|
+
#
|
1280
|
+
# Condition: You must specify either this or an EnvironmentId, or
|
1281
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1282
|
+
# `MissingRequiredParameter` error.
|
1283
|
+
# @return [String]
|
1284
|
+
#
|
1285
|
+
# @!attribute [rw] environment_id
|
1286
|
+
# Specifies the AWS Elastic Beanstalk environment ID.
|
1287
|
+
#
|
1288
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1289
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1290
|
+
# `MissingRequiredParameter` error.
|
1291
|
+
# @return [String]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] attribute_names
|
1294
|
+
# Specifies the response elements you wish to receive. If no attribute
|
1295
|
+
# names are specified, AWS Elastic Beanstalk only returns the name of
|
1296
|
+
# the environment.
|
1297
|
+
# @return [Array<String>]
|
1298
|
+
class DescribeEnvironmentHealthRequest < Struct.new(
|
1299
|
+
:environment_name,
|
1300
|
+
:environment_id,
|
1301
|
+
:attribute_names)
|
1302
|
+
include Aws::Structure
|
1303
|
+
end
|
1304
|
+
|
1305
|
+
# See the example below for a sample response.
|
1306
|
+
# @!attribute [rw] environment_name
|
1307
|
+
# The AWS Elastic Beanstalk environment name.
|
1308
|
+
# @return [String]
|
1309
|
+
#
|
1310
|
+
# @!attribute [rw] health_status
|
1311
|
+
# Contains the response body with information about the health of the
|
1312
|
+
# environment.
|
1313
|
+
# @return [String]
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] status
|
1316
|
+
# Returns the health status value of the environment. For more
|
1317
|
+
# information, see [Health Colors and Statuses][1].
|
1318
|
+
#
|
1319
|
+
#
|
1320
|
+
#
|
1321
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
|
1322
|
+
# @return [String]
|
1323
|
+
#
|
1324
|
+
# @!attribute [rw] color
|
1325
|
+
# Returns the color indicator that tells you information about the
|
1326
|
+
# health of the environment. For more information, see [Health Colors
|
1327
|
+
# and Statuses][1].
|
1328
|
+
#
|
1329
|
+
#
|
1330
|
+
#
|
1331
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
|
1332
|
+
# @return [String]
|
1333
|
+
#
|
1334
|
+
# @!attribute [rw] causes
|
1335
|
+
# Returns potential causes for the reported status.
|
1336
|
+
# @return [Array<String>]
|
1337
|
+
#
|
1338
|
+
# @!attribute [rw] application_metrics
|
1339
|
+
# Represents the application metrics for a specified environment.
|
1340
|
+
# @return [Types::ApplicationMetrics]
|
1341
|
+
#
|
1342
|
+
# @!attribute [rw] instances_health
|
1343
|
+
# Represents summary information about the health of an instance. For
|
1344
|
+
# more information, see [Health Colors and Statuses][1].
|
1345
|
+
#
|
1346
|
+
#
|
1347
|
+
#
|
1348
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
|
1349
|
+
# @return [Types::InstanceHealthSummary]
|
1350
|
+
#
|
1351
|
+
# @!attribute [rw] refreshed_at
|
1352
|
+
# The date and time the information was last refreshed.
|
1353
|
+
# @return [Time]
|
1354
|
+
class DescribeEnvironmentHealthResult < Struct.new(
|
1355
|
+
:environment_name,
|
1356
|
+
:health_status,
|
1357
|
+
:status,
|
1358
|
+
:color,
|
1359
|
+
:causes,
|
1360
|
+
:application_metrics,
|
1361
|
+
:instances_health,
|
1362
|
+
:refreshed_at)
|
1363
|
+
include Aws::Structure
|
1364
|
+
end
|
1365
|
+
|
1366
|
+
# Request to list completed and failed managed actions.
|
1367
|
+
# @note When making an API call, pass DescribeEnvironmentManagedActionHistoryRequest
|
1368
|
+
# data as a hash:
|
1369
|
+
#
|
1370
|
+
# {
|
1371
|
+
# environment_id: "EnvironmentId",
|
1372
|
+
# environment_name: "EnvironmentName",
|
1373
|
+
# next_token: "String",
|
1374
|
+
# max_items: 1,
|
1375
|
+
# }
|
1376
|
+
# @!attribute [rw] environment_id
|
1377
|
+
# The environment ID of the target environment.
|
1378
|
+
# @return [String]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] environment_name
|
1381
|
+
# The name of the target environment.
|
1382
|
+
# @return [String]
|
1383
|
+
#
|
1384
|
+
# @!attribute [rw] next_token
|
1385
|
+
# The pagination token returned by a previous request.
|
1386
|
+
# @return [String]
|
1387
|
+
#
|
1388
|
+
# @!attribute [rw] max_items
|
1389
|
+
# The maximum number of items to return for a single request.
|
1390
|
+
# @return [Integer]
|
1391
|
+
class DescribeEnvironmentManagedActionHistoryRequest < Struct.new(
|
1392
|
+
:environment_id,
|
1393
|
+
:environment_name,
|
1394
|
+
:next_token,
|
1395
|
+
:max_items)
|
1396
|
+
include Aws::Structure
|
1397
|
+
end
|
1398
|
+
|
1399
|
+
# A result message containing a list of completed and failed managed
|
1400
|
+
# actions.
|
1401
|
+
# @!attribute [rw] managed_action_history_items
|
1402
|
+
# A list of completed and failed managed actions.
|
1403
|
+
# @return [Array<Types::ManagedActionHistoryItem>]
|
1404
|
+
#
|
1405
|
+
# @!attribute [rw] next_token
|
1406
|
+
# A pagination token that you pass to
|
1407
|
+
# DescribeEnvironmentManagedActionHistory to get the next page of
|
1408
|
+
# results.
|
1409
|
+
# @return [String]
|
1410
|
+
class DescribeEnvironmentManagedActionHistoryResult < Struct.new(
|
1411
|
+
:managed_action_history_items,
|
1412
|
+
:next_token)
|
1413
|
+
include Aws::Structure
|
1414
|
+
end
|
1415
|
+
|
1416
|
+
# Request to list an environment's upcoming and in-progress managed
|
1417
|
+
# actions.
|
1418
|
+
# @note When making an API call, pass DescribeEnvironmentManagedActionsRequest
|
1419
|
+
# data as a hash:
|
1420
|
+
#
|
1421
|
+
# {
|
1422
|
+
# environment_name: "String",
|
1423
|
+
# environment_id: "String",
|
1424
|
+
# status: "Scheduled", # accepts Scheduled, Pending, Running, Unknown
|
1425
|
+
# }
|
1426
|
+
# @!attribute [rw] environment_name
|
1427
|
+
# The name of the target environment.
|
1428
|
+
# @return [String]
|
1429
|
+
#
|
1430
|
+
# @!attribute [rw] environment_id
|
1431
|
+
# The environment ID of the target environment.
|
1432
|
+
# @return [String]
|
1433
|
+
#
|
1434
|
+
# @!attribute [rw] status
|
1435
|
+
# To show only actions with a particular status, specify a status.
|
1436
|
+
# @return [String]
|
1437
|
+
class DescribeEnvironmentManagedActionsRequest < Struct.new(
|
1438
|
+
:environment_name,
|
1439
|
+
:environment_id,
|
1440
|
+
:status)
|
1441
|
+
include Aws::Structure
|
1442
|
+
end
|
1443
|
+
|
1444
|
+
# The result message containing a list of managed actions.
|
1445
|
+
# @!attribute [rw] managed_actions
|
1446
|
+
# A list of upcoming and in-progress managed actions.
|
1447
|
+
# @return [Array<Types::ManagedAction>]
|
1448
|
+
class DescribeEnvironmentManagedActionsResult < Struct.new(
|
1449
|
+
:managed_actions)
|
1450
|
+
include Aws::Structure
|
1451
|
+
end
|
1452
|
+
|
1453
|
+
# Request to describe the resources in an environment.
|
1454
|
+
# @note When making an API call, pass DescribeEnvironmentResourcesMessage
|
1455
|
+
# data as a hash:
|
1456
|
+
#
|
1457
|
+
# {
|
1458
|
+
# environment_id: "EnvironmentId",
|
1459
|
+
# environment_name: "EnvironmentName",
|
1460
|
+
# }
|
1461
|
+
# @!attribute [rw] environment_id
|
1462
|
+
# The ID of the environment to retrieve AWS resource usage data.
|
1463
|
+
#
|
1464
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
1465
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1466
|
+
# `MissingRequiredParameter` error.
|
1467
|
+
# @return [String]
|
1468
|
+
#
|
1469
|
+
# @!attribute [rw] environment_name
|
1470
|
+
# The name of the environment to retrieve AWS resource usage data.
|
1471
|
+
#
|
1472
|
+
# Condition: You must specify either this or an EnvironmentId, or
|
1473
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
1474
|
+
# `MissingRequiredParameter` error.
|
1475
|
+
# @return [String]
|
1476
|
+
class DescribeEnvironmentResourcesMessage < Struct.new(
|
1477
|
+
:environment_id,
|
1478
|
+
:environment_name)
|
1479
|
+
include Aws::Structure
|
1480
|
+
end
|
1481
|
+
|
1482
|
+
# Request to describe one or more environments.
|
1483
|
+
# @note When making an API call, pass DescribeEnvironmentsMessage
|
1484
|
+
# data as a hash:
|
1485
|
+
#
|
1486
|
+
# {
|
1487
|
+
# application_name: "ApplicationName",
|
1488
|
+
# version_label: "VersionLabel",
|
1489
|
+
# environment_ids: ["EnvironmentId"],
|
1490
|
+
# environment_names: ["EnvironmentName"],
|
1491
|
+
# include_deleted: false,
|
1492
|
+
# included_deleted_back_to: Time.now,
|
1493
|
+
# }
|
1494
|
+
# @!attribute [rw] application_name
|
1495
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1496
|
+
# descriptions to include only those that are associated with this
|
1497
|
+
# application.
|
1498
|
+
# @return [String]
|
1499
|
+
#
|
1500
|
+
# @!attribute [rw] version_label
|
1501
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1502
|
+
# descriptions to include only those that are associated with this
|
1503
|
+
# application version.
|
1504
|
+
# @return [String]
|
1505
|
+
#
|
1506
|
+
# @!attribute [rw] environment_ids
|
1507
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1508
|
+
# descriptions to include only those that have the specified IDs.
|
1509
|
+
# @return [Array<String>]
|
1510
|
+
#
|
1511
|
+
# @!attribute [rw] environment_names
|
1512
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1513
|
+
# descriptions to include only those that have the specified names.
|
1514
|
+
# @return [Array<String>]
|
1515
|
+
#
|
1516
|
+
# @!attribute [rw] include_deleted
|
1517
|
+
# Indicates whether to include deleted environments:
|
1518
|
+
#
|
1519
|
+
# `true`\: Environments that have been deleted after
|
1520
|
+
# `IncludedDeletedBackTo` are displayed.
|
1521
|
+
#
|
1522
|
+
# `false`\: Do not include deleted environments.
|
1523
|
+
# @return [Boolean]
|
1524
|
+
#
|
1525
|
+
# @!attribute [rw] included_deleted_back_to
|
1526
|
+
# If specified when `IncludeDeleted` is set to `true`, then
|
1527
|
+
# environments deleted after this date are displayed.
|
1528
|
+
# @return [Time]
|
1529
|
+
class DescribeEnvironmentsMessage < Struct.new(
|
1530
|
+
:application_name,
|
1531
|
+
:version_label,
|
1532
|
+
:environment_ids,
|
1533
|
+
:environment_names,
|
1534
|
+
:include_deleted,
|
1535
|
+
:included_deleted_back_to)
|
1536
|
+
include Aws::Structure
|
1537
|
+
end
|
1538
|
+
|
1539
|
+
# Request to retrieve a list of events for an environment.
|
1540
|
+
# @note When making an API call, pass DescribeEventsMessage
|
1541
|
+
# data as a hash:
|
1542
|
+
#
|
1543
|
+
# {
|
1544
|
+
# application_name: "ApplicationName",
|
1545
|
+
# version_label: "VersionLabel",
|
1546
|
+
# template_name: "ConfigurationTemplateName",
|
1547
|
+
# environment_id: "EnvironmentId",
|
1548
|
+
# environment_name: "EnvironmentName",
|
1549
|
+
# request_id: "RequestId",
|
1550
|
+
# severity: "TRACE", # accepts TRACE, DEBUG, INFO, WARN, ERROR, FATAL
|
1551
|
+
# start_time: Time.now,
|
1552
|
+
# end_time: Time.now,
|
1553
|
+
# max_records: 1,
|
1554
|
+
# next_token: "Token",
|
1555
|
+
# }
|
1556
|
+
# @!attribute [rw] application_name
|
1557
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1558
|
+
# descriptions to include only those associated with this application.
|
1559
|
+
# @return [String]
|
1560
|
+
#
|
1561
|
+
# @!attribute [rw] version_label
|
1562
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1563
|
+
# descriptions to those associated with this application version.
|
1564
|
+
# @return [String]
|
1565
|
+
#
|
1566
|
+
# @!attribute [rw] template_name
|
1567
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1568
|
+
# descriptions to those that are associated with this environment
|
1569
|
+
# configuration.
|
1570
|
+
# @return [String]
|
1571
|
+
#
|
1572
|
+
# @!attribute [rw] environment_id
|
1573
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1574
|
+
# descriptions to those associated with this environment.
|
1575
|
+
# @return [String]
|
1576
|
+
#
|
1577
|
+
# @!attribute [rw] environment_name
|
1578
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1579
|
+
# descriptions to those associated with this environment.
|
1580
|
+
# @return [String]
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] request_id
|
1583
|
+
# If specified, AWS Elastic Beanstalk restricts the described events
|
1584
|
+
# to include only those associated with this request ID.
|
1585
|
+
# @return [String]
|
1586
|
+
#
|
1587
|
+
# @!attribute [rw] severity
|
1588
|
+
# If specified, limits the events returned from this call to include
|
1589
|
+
# only those with the specified severity or higher.
|
1590
|
+
# @return [String]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] start_time
|
1593
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1594
|
+
# descriptions to those that occur on or after this time.
|
1595
|
+
# @return [Time]
|
1596
|
+
#
|
1597
|
+
# @!attribute [rw] end_time
|
1598
|
+
# If specified, AWS Elastic Beanstalk restricts the returned
|
1599
|
+
# descriptions to those that occur up to, but not including, the
|
1600
|
+
# `EndTime`.
|
1601
|
+
# @return [Time]
|
1602
|
+
#
|
1603
|
+
# @!attribute [rw] max_records
|
1604
|
+
# Specifies the maximum number of events that can be returned,
|
1605
|
+
# beginning with the most recent event.
|
1606
|
+
# @return [Integer]
|
1607
|
+
#
|
1608
|
+
# @!attribute [rw] next_token
|
1609
|
+
# Pagination token. If specified, the events return the next batch of
|
1610
|
+
# results.
|
1611
|
+
# @return [String]
|
1612
|
+
class DescribeEventsMessage < Struct.new(
|
1613
|
+
:application_name,
|
1614
|
+
:version_label,
|
1615
|
+
:template_name,
|
1616
|
+
:environment_id,
|
1617
|
+
:environment_name,
|
1618
|
+
:request_id,
|
1619
|
+
:severity,
|
1620
|
+
:start_time,
|
1621
|
+
:end_time,
|
1622
|
+
:max_records,
|
1623
|
+
:next_token)
|
1624
|
+
include Aws::Structure
|
1625
|
+
end
|
1626
|
+
|
1627
|
+
# See the example below to learn how to create a request body.
|
1628
|
+
# @note When making an API call, pass DescribeInstancesHealthRequest
|
1629
|
+
# data as a hash:
|
1630
|
+
#
|
1631
|
+
# {
|
1632
|
+
# environment_name: "EnvironmentName",
|
1633
|
+
# environment_id: "EnvironmentId",
|
1634
|
+
# attribute_names: ["HealthStatus"], # accepts HealthStatus, Color, Causes, ApplicationMetrics, RefreshedAt, LaunchedAt, System, Deployment, AvailabilityZone, InstanceType, All
|
1635
|
+
# next_token: "NextToken",
|
1636
|
+
# }
|
1637
|
+
# @!attribute [rw] environment_name
|
1638
|
+
# Specifies the AWS Elastic Beanstalk environment name.
|
1639
|
+
# @return [String]
|
1640
|
+
#
|
1641
|
+
# @!attribute [rw] environment_id
|
1642
|
+
# Specifies the AWS Elastic Beanstalk environment ID.
|
1643
|
+
# @return [String]
|
1644
|
+
#
|
1645
|
+
# @!attribute [rw] attribute_names
|
1646
|
+
# Specifies the response elements you wish to receive. If no attribute
|
1647
|
+
# names are specified, AWS Elastic Beanstalk only returns a list of
|
1648
|
+
# instances.
|
1649
|
+
# @return [Array<String>]
|
1650
|
+
#
|
1651
|
+
# @!attribute [rw] next_token
|
1652
|
+
# Specifies the next token of the request.
|
1653
|
+
# @return [String]
|
1654
|
+
class DescribeInstancesHealthRequest < Struct.new(
|
1655
|
+
:environment_name,
|
1656
|
+
:environment_id,
|
1657
|
+
:attribute_names,
|
1658
|
+
:next_token)
|
1659
|
+
include Aws::Structure
|
1660
|
+
end
|
1661
|
+
|
1662
|
+
# See the example below for a sample response.
|
1663
|
+
# @!attribute [rw] instance_health_list
|
1664
|
+
# Contains the response body with information about the health of the
|
1665
|
+
# instance.
|
1666
|
+
# @return [Array<Types::SingleInstanceHealth>]
|
1667
|
+
#
|
1668
|
+
# @!attribute [rw] refreshed_at
|
1669
|
+
# The date and time the information was last refreshed.
|
1670
|
+
# @return [Time]
|
1671
|
+
#
|
1672
|
+
# @!attribute [rw] next_token
|
1673
|
+
# The next token.
|
1674
|
+
# @return [String]
|
1675
|
+
class DescribeInstancesHealthResult < Struct.new(
|
1676
|
+
:instance_health_list,
|
1677
|
+
:refreshed_at,
|
1678
|
+
:next_token)
|
1679
|
+
include Aws::Structure
|
1680
|
+
end
|
1681
|
+
|
1682
|
+
# Describes the properties of an environment.
|
1683
|
+
# @!attribute [rw] environment_name
|
1684
|
+
# The name of this environment.
|
1685
|
+
# @return [String]
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] environment_id
|
1688
|
+
# The ID of this environment.
|
1689
|
+
# @return [String]
|
1690
|
+
#
|
1691
|
+
# @!attribute [rw] application_name
|
1692
|
+
# The name of the application associated with this environment.
|
1693
|
+
# @return [String]
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] version_label
|
1696
|
+
# The application version deployed in this environment.
|
1697
|
+
# @return [String]
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] solution_stack_name
|
1700
|
+
# The name of the `SolutionStack` deployed with this environment.
|
1701
|
+
# @return [String]
|
1702
|
+
#
|
1703
|
+
# @!attribute [rw] template_name
|
1704
|
+
# The name of the configuration template used to originally launch
|
1705
|
+
# this environment.
|
1706
|
+
# @return [String]
|
1707
|
+
#
|
1708
|
+
# @!attribute [rw] description
|
1709
|
+
# Describes this environment.
|
1710
|
+
# @return [String]
|
1711
|
+
#
|
1712
|
+
# @!attribute [rw] endpoint_url
|
1713
|
+
# For load-balanced, autoscaling environments, the URL to the
|
1714
|
+
# LoadBalancer. For single-instance environments, the IP address of
|
1715
|
+
# the instance.
|
1716
|
+
# @return [String]
|
1717
|
+
#
|
1718
|
+
# @!attribute [rw] cname
|
1719
|
+
# The URL to the CNAME for this environment.
|
1720
|
+
# @return [String]
|
1721
|
+
#
|
1722
|
+
# @!attribute [rw] date_created
|
1723
|
+
# The creation date for this environment.
|
1724
|
+
# @return [Time]
|
1725
|
+
#
|
1726
|
+
# @!attribute [rw] date_updated
|
1727
|
+
# The last modified date for this environment.
|
1728
|
+
# @return [Time]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] status
|
1731
|
+
# The current operational status of the environment:
|
1732
|
+
#
|
1733
|
+
# * `Launching`\: Environment is in the process of initial deployment.
|
1734
|
+
#
|
1735
|
+
# * `Updating`\: Environment is in the process of updating its
|
1736
|
+
# configuration settings or application version.
|
1737
|
+
#
|
1738
|
+
# * `Ready`\: Environment is available to have an action performed on
|
1739
|
+
# it, such as update or terminate.
|
1740
|
+
#
|
1741
|
+
# * `Terminating`\: Environment is in the shut-down process.
|
1742
|
+
#
|
1743
|
+
# * `Terminated`\: Environment is not running.
|
1744
|
+
# @return [String]
|
1745
|
+
#
|
1746
|
+
# @!attribute [rw] abortable_operation_in_progress
|
1747
|
+
# Indicates if there is an in-progress environment configuration
|
1748
|
+
# update or application version deployment that you can cancel.
|
1749
|
+
#
|
1750
|
+
# `true:` There is an update in progress.
|
1751
|
+
#
|
1752
|
+
# `false:` There are no updates currently in progress.
|
1753
|
+
# @return [Boolean]
|
1754
|
+
#
|
1755
|
+
# @!attribute [rw] health
|
1756
|
+
# Describes the health status of the environment. AWS Elastic
|
1757
|
+
# Beanstalk indicates the failure levels for a running environment:
|
1758
|
+
#
|
1759
|
+
# * `Red`\: Indicates the environment is not responsive. Occurs when
|
1760
|
+
# three or more consecutive failures occur for an environment.
|
1761
|
+
#
|
1762
|
+
# * `Yellow`\: Indicates that something is wrong. Occurs when two
|
1763
|
+
# consecutive failures occur for an environment.
|
1764
|
+
#
|
1765
|
+
# * `Green`\: Indicates the environment is healthy and fully
|
1766
|
+
# functional.
|
1767
|
+
#
|
1768
|
+
# * `Grey`\: Default health for a new environment. The environment is
|
1769
|
+
# not fully launched and health checks have not started or health
|
1770
|
+
# checks are suspended during an `UpdateEnvironment` or
|
1771
|
+
# `RestartEnvironement` request.
|
1772
|
+
#
|
1773
|
+
# Default: `Grey`
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] health_status
|
1777
|
+
# Returns the health status of the application running in your
|
1778
|
+
# environment. For more information, see [Health Colors and
|
1779
|
+
# Statuses][1].
|
1780
|
+
#
|
1781
|
+
#
|
1782
|
+
#
|
1783
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
|
1784
|
+
# @return [String]
|
1785
|
+
#
|
1786
|
+
# @!attribute [rw] resources
|
1787
|
+
# The description of the AWS resources used by this environment.
|
1788
|
+
# @return [Types::EnvironmentResourcesDescription]
|
1789
|
+
#
|
1790
|
+
# @!attribute [rw] tier
|
1791
|
+
# Describes the current tier of this environment.
|
1792
|
+
# @return [Types::EnvironmentTier]
|
1793
|
+
#
|
1794
|
+
# @!attribute [rw] environment_links
|
1795
|
+
# A list of links to other environments in the same group.
|
1796
|
+
# @return [Array<Types::EnvironmentLink>]
|
1797
|
+
class EnvironmentDescription < Struct.new(
|
1798
|
+
:environment_name,
|
1799
|
+
:environment_id,
|
1800
|
+
:application_name,
|
1801
|
+
:version_label,
|
1802
|
+
:solution_stack_name,
|
1803
|
+
:template_name,
|
1804
|
+
:description,
|
1805
|
+
:endpoint_url,
|
1806
|
+
:cname,
|
1807
|
+
:date_created,
|
1808
|
+
:date_updated,
|
1809
|
+
:status,
|
1810
|
+
:abortable_operation_in_progress,
|
1811
|
+
:health,
|
1812
|
+
:health_status,
|
1813
|
+
:resources,
|
1814
|
+
:tier,
|
1815
|
+
:environment_links)
|
1816
|
+
include Aws::Structure
|
1817
|
+
end
|
1818
|
+
|
1819
|
+
# Result message containing a list of environment descriptions.
|
1820
|
+
# @!attribute [rw] environments
|
1821
|
+
# Returns an EnvironmentDescription list.
|
1822
|
+
# @return [Array<Types::EnvironmentDescription>]
|
1823
|
+
class EnvironmentDescriptionsMessage < Struct.new(
|
1824
|
+
:environments)
|
1825
|
+
include Aws::Structure
|
1826
|
+
end
|
1827
|
+
|
1828
|
+
# The information retrieved from the Amazon EC2 instances.
|
1829
|
+
# @!attribute [rw] info_type
|
1830
|
+
# The type of information retrieved.
|
1831
|
+
# @return [String]
|
1832
|
+
#
|
1833
|
+
# @!attribute [rw] ec2_instance_id
|
1834
|
+
# The Amazon EC2 Instance ID for this information.
|
1835
|
+
# @return [String]
|
1836
|
+
#
|
1837
|
+
# @!attribute [rw] sample_timestamp
|
1838
|
+
# The time stamp when this information was retrieved.
|
1839
|
+
# @return [Time]
|
1840
|
+
#
|
1841
|
+
# @!attribute [rw] message
|
1842
|
+
# The retrieved information.
|
1843
|
+
# @return [String]
|
1844
|
+
class EnvironmentInfoDescription < Struct.new(
|
1845
|
+
:info_type,
|
1846
|
+
:ec2_instance_id,
|
1847
|
+
:sample_timestamp,
|
1848
|
+
:message)
|
1849
|
+
include Aws::Structure
|
1850
|
+
end
|
1851
|
+
|
1852
|
+
# A link to another environment, defined in the environment's manifest.
|
1853
|
+
# Links provide connection information in system properties that can be
|
1854
|
+
# used to connect to another environment in the same group. See
|
1855
|
+
# [Environment Manifest (env.yaml)][1] for details.
|
1856
|
+
#
|
1857
|
+
#
|
1858
|
+
#
|
1859
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
|
1860
|
+
# @!attribute [rw] link_name
|
1861
|
+
# The name of the link.
|
1862
|
+
# @return [String]
|
1863
|
+
#
|
1864
|
+
# @!attribute [rw] environment_name
|
1865
|
+
# The name of the linked environment (the dependency).
|
1866
|
+
# @return [String]
|
1867
|
+
class EnvironmentLink < Struct.new(
|
1868
|
+
:link_name,
|
1869
|
+
:environment_name)
|
1870
|
+
include Aws::Structure
|
1871
|
+
end
|
1872
|
+
|
1873
|
+
# Describes the AWS resources in use by this environment. This data is
|
1874
|
+
# live.
|
1875
|
+
# @!attribute [rw] environment_name
|
1876
|
+
# The name of the environment.
|
1877
|
+
# @return [String]
|
1878
|
+
#
|
1879
|
+
# @!attribute [rw] auto_scaling_groups
|
1880
|
+
# The `AutoScalingGroups` used by this environment.
|
1881
|
+
# @return [Array<Types::AutoScalingGroup>]
|
1882
|
+
#
|
1883
|
+
# @!attribute [rw] instances
|
1884
|
+
# The Amazon EC2 instances used by this environment.
|
1885
|
+
# @return [Array<Types::Instance>]
|
1886
|
+
#
|
1887
|
+
# @!attribute [rw] launch_configurations
|
1888
|
+
# The Auto Scaling launch configurations in use by this environment.
|
1889
|
+
# @return [Array<Types::LaunchConfiguration>]
|
1890
|
+
#
|
1891
|
+
# @!attribute [rw] load_balancers
|
1892
|
+
# The LoadBalancers in use by this environment.
|
1893
|
+
# @return [Array<Types::LoadBalancer>]
|
1894
|
+
#
|
1895
|
+
# @!attribute [rw] triggers
|
1896
|
+
# The `AutoScaling` triggers in use by this environment.
|
1897
|
+
# @return [Array<Types::Trigger>]
|
1898
|
+
#
|
1899
|
+
# @!attribute [rw] queues
|
1900
|
+
# The queues used by this environment.
|
1901
|
+
# @return [Array<Types::Queue>]
|
1902
|
+
class EnvironmentResourceDescription < Struct.new(
|
1903
|
+
:environment_name,
|
1904
|
+
:auto_scaling_groups,
|
1905
|
+
:instances,
|
1906
|
+
:launch_configurations,
|
1907
|
+
:load_balancers,
|
1908
|
+
:triggers,
|
1909
|
+
:queues)
|
1910
|
+
include Aws::Structure
|
1911
|
+
end
|
1912
|
+
|
1913
|
+
# Result message containing a list of environment resource descriptions.
|
1914
|
+
# @!attribute [rw] environment_resources
|
1915
|
+
# A list of EnvironmentResourceDescription.
|
1916
|
+
# @return [Types::EnvironmentResourceDescription]
|
1917
|
+
class EnvironmentResourceDescriptionsMessage < Struct.new(
|
1918
|
+
:environment_resources)
|
1919
|
+
include Aws::Structure
|
1920
|
+
end
|
1921
|
+
|
1922
|
+
# Describes the AWS resources in use by this environment. This data is
|
1923
|
+
# not live data.
|
1924
|
+
# @!attribute [rw] load_balancer
|
1925
|
+
# Describes the LoadBalancer.
|
1926
|
+
# @return [Types::LoadBalancerDescription]
|
1927
|
+
class EnvironmentResourcesDescription < Struct.new(
|
1928
|
+
:load_balancer)
|
1929
|
+
include Aws::Structure
|
1930
|
+
end
|
1931
|
+
|
1932
|
+
# Describes the properties of an environment tier
|
1933
|
+
# @note When making an API call, pass EnvironmentTier
|
1934
|
+
# data as a hash:
|
1935
|
+
#
|
1936
|
+
# {
|
1937
|
+
# name: "String",
|
1938
|
+
# type: "String",
|
1939
|
+
# version: "String",
|
1940
|
+
# }
|
1941
|
+
# @!attribute [rw] name
|
1942
|
+
# The name of this environment tier.
|
1943
|
+
# @return [String]
|
1944
|
+
#
|
1945
|
+
# @!attribute [rw] type
|
1946
|
+
# The type of this environment tier.
|
1947
|
+
# @return [String]
|
1948
|
+
#
|
1949
|
+
# @!attribute [rw] version
|
1950
|
+
# The version of this environment tier.
|
1951
|
+
# @return [String]
|
1952
|
+
class EnvironmentTier < Struct.new(
|
1953
|
+
:name,
|
1954
|
+
:type,
|
1955
|
+
:version)
|
1956
|
+
include Aws::Structure
|
1957
|
+
end
|
1958
|
+
|
1959
|
+
# Describes an event.
|
1960
|
+
# @!attribute [rw] event_date
|
1961
|
+
# The date when the event occurred.
|
1962
|
+
# @return [Time]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] message
|
1965
|
+
# The event message.
|
1966
|
+
# @return [String]
|
1967
|
+
#
|
1968
|
+
# @!attribute [rw] application_name
|
1969
|
+
# The application associated with the event.
|
1970
|
+
# @return [String]
|
1971
|
+
#
|
1972
|
+
# @!attribute [rw] version_label
|
1973
|
+
# The release label for the application version associated with this
|
1974
|
+
# event.
|
1975
|
+
# @return [String]
|
1976
|
+
#
|
1977
|
+
# @!attribute [rw] template_name
|
1978
|
+
# The name of the configuration associated with this event.
|
1979
|
+
# @return [String]
|
1980
|
+
#
|
1981
|
+
# @!attribute [rw] environment_name
|
1982
|
+
# The name of the environment associated with this event.
|
1983
|
+
# @return [String]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] request_id
|
1986
|
+
# The web service request ID for the activity of this event.
|
1987
|
+
# @return [String]
|
1988
|
+
#
|
1989
|
+
# @!attribute [rw] severity
|
1990
|
+
# The severity level of this event.
|
1991
|
+
# @return [String]
|
1992
|
+
class EventDescription < Struct.new(
|
1993
|
+
:event_date,
|
1994
|
+
:message,
|
1995
|
+
:application_name,
|
1996
|
+
:version_label,
|
1997
|
+
:template_name,
|
1998
|
+
:environment_name,
|
1999
|
+
:request_id,
|
2000
|
+
:severity)
|
2001
|
+
include Aws::Structure
|
2002
|
+
end
|
2003
|
+
|
2004
|
+
# Result message wrapping a list of event descriptions.
|
2005
|
+
# @!attribute [rw] events
|
2006
|
+
# A list of EventDescription.
|
2007
|
+
# @return [Array<Types::EventDescription>]
|
2008
|
+
#
|
2009
|
+
# @!attribute [rw] next_token
|
2010
|
+
# If returned, this indicates that there are more results to obtain.
|
2011
|
+
# Use this token in the next DescribeEvents call to get the next batch
|
2012
|
+
# of events.
|
2013
|
+
# @return [String]
|
2014
|
+
class EventDescriptionsMessage < Struct.new(
|
2015
|
+
:events,
|
2016
|
+
:next_token)
|
2017
|
+
include Aws::Structure
|
2018
|
+
end
|
2019
|
+
|
2020
|
+
# The description of an Amazon EC2 instance.
|
2021
|
+
# @!attribute [rw] id
|
2022
|
+
# The ID of the Amazon EC2 instance.
|
2023
|
+
# @return [String]
|
2024
|
+
class Instance < Struct.new(
|
2025
|
+
:id)
|
2026
|
+
include Aws::Structure
|
2027
|
+
end
|
2028
|
+
|
2029
|
+
# Represents summary information about the health of an instance. For
|
2030
|
+
# more information, see [Health Colors and Statuses][1].
|
2031
|
+
#
|
2032
|
+
#
|
2033
|
+
#
|
2034
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
|
2035
|
+
# @!attribute [rw] no_data
|
2036
|
+
# **Grey.** AWS Elastic Beanstalk and the health agent are reporting
|
2037
|
+
# no data on an instance.
|
2038
|
+
# @return [Integer]
|
2039
|
+
#
|
2040
|
+
# @!attribute [rw] unknown
|
2041
|
+
# **Grey.** AWS Elastic Beanstalk and the health agent are reporting
|
2042
|
+
# an insufficient amount of data on an instance.
|
2043
|
+
# @return [Integer]
|
2044
|
+
#
|
2045
|
+
# @!attribute [rw] pending
|
2046
|
+
# **Grey.** An operation is in progress on an instance within the
|
2047
|
+
# command timeout.
|
2048
|
+
# @return [Integer]
|
2049
|
+
#
|
2050
|
+
# @!attribute [rw] ok
|
2051
|
+
# **Green.** An instance is passing health checks and the health agent
|
2052
|
+
# is not reporting any problems.
|
2053
|
+
# @return [Integer]
|
2054
|
+
#
|
2055
|
+
# @!attribute [rw] info
|
2056
|
+
# **Green.** An operation is in progress on an instance.
|
2057
|
+
# @return [Integer]
|
2058
|
+
#
|
2059
|
+
# @!attribute [rw] warning
|
2060
|
+
# **Yellow.** The health agent is reporting a moderate number of
|
2061
|
+
# request failures or other issues for an instance or environment.
|
2062
|
+
# @return [Integer]
|
2063
|
+
#
|
2064
|
+
# @!attribute [rw] degraded
|
2065
|
+
# **Red.** The health agent is reporting a high number of request
|
2066
|
+
# failures or other issues for an instance or environment.
|
2067
|
+
# @return [Integer]
|
2068
|
+
#
|
2069
|
+
# @!attribute [rw] severe
|
2070
|
+
# **Red.** The health agent is reporting a very high number of request
|
2071
|
+
# failures or other issues for an instance or environment.
|
2072
|
+
# @return [Integer]
|
2073
|
+
class InstanceHealthSummary < Struct.new(
|
2074
|
+
:no_data,
|
2075
|
+
:unknown,
|
2076
|
+
:pending,
|
2077
|
+
:ok,
|
2078
|
+
:info,
|
2079
|
+
:warning,
|
2080
|
+
:degraded,
|
2081
|
+
:severe)
|
2082
|
+
include Aws::Structure
|
2083
|
+
end
|
2084
|
+
|
2085
|
+
# Represents the average latency for the slowest X percent of requests
|
2086
|
+
# over the last 10 seconds.
|
2087
|
+
# @!attribute [rw] p999
|
2088
|
+
# The average latency for the slowest 0.1 percent of requests over the
|
2089
|
+
# last 10 seconds.
|
2090
|
+
# @return [Float]
|
2091
|
+
#
|
2092
|
+
# @!attribute [rw] p99
|
2093
|
+
# The average latency for the slowest 1 percent of requests over the
|
2094
|
+
# last 10 seconds.
|
2095
|
+
# @return [Float]
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] p95
|
2098
|
+
# The average latency for the slowest 5 percent of requests over the
|
2099
|
+
# last 10 seconds.
|
2100
|
+
# @return [Float]
|
2101
|
+
#
|
2102
|
+
# @!attribute [rw] p90
|
2103
|
+
# The average latency for the slowest 10 percent of requests over the
|
2104
|
+
# last 10 seconds.
|
2105
|
+
# @return [Float]
|
2106
|
+
#
|
2107
|
+
# @!attribute [rw] p85
|
2108
|
+
# The average latency for the slowest 15 percent of requests over the
|
2109
|
+
# last 10 seconds.
|
2110
|
+
# @return [Float]
|
2111
|
+
#
|
2112
|
+
# @!attribute [rw] p75
|
2113
|
+
# The average latency for the slowest 25 percent of requests over the
|
2114
|
+
# last 10 seconds.
|
2115
|
+
# @return [Float]
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] p50
|
2118
|
+
# The average latency for the slowest 50 percent of requests over the
|
2119
|
+
# last 10 seconds.
|
2120
|
+
# @return [Float]
|
2121
|
+
#
|
2122
|
+
# @!attribute [rw] p10
|
2123
|
+
# The average latency for the slowest 90 percent of requests over the
|
2124
|
+
# last 10 seconds.
|
2125
|
+
# @return [Float]
|
2126
|
+
class Latency < Struct.new(
|
2127
|
+
:p999,
|
2128
|
+
:p99,
|
2129
|
+
:p95,
|
2130
|
+
:p90,
|
2131
|
+
:p85,
|
2132
|
+
:p75,
|
2133
|
+
:p50,
|
2134
|
+
:p10)
|
2135
|
+
include Aws::Structure
|
2136
|
+
end
|
2137
|
+
|
2138
|
+
# Describes an Auto Scaling launch configuration.
|
2139
|
+
# @!attribute [rw] name
|
2140
|
+
# The name of the launch configuration.
|
2141
|
+
# @return [String]
|
2142
|
+
class LaunchConfiguration < Struct.new(
|
2143
|
+
:name)
|
2144
|
+
include Aws::Structure
|
2145
|
+
end
|
2146
|
+
|
2147
|
+
# A list of available AWS Elastic Beanstalk solution stacks.
|
2148
|
+
# @!attribute [rw] solution_stacks
|
2149
|
+
# A list of available solution stacks.
|
2150
|
+
# @return [Array<String>]
|
2151
|
+
#
|
2152
|
+
# @!attribute [rw] solution_stack_details
|
2153
|
+
# A list of available solution stacks and their
|
2154
|
+
# SolutionStackDescription.
|
2155
|
+
# @return [Array<Types::SolutionStackDescription>]
|
2156
|
+
class ListAvailableSolutionStacksResultMessage < Struct.new(
|
2157
|
+
:solution_stacks,
|
2158
|
+
:solution_stack_details)
|
2159
|
+
include Aws::Structure
|
2160
|
+
end
|
2161
|
+
|
2162
|
+
# Describes the properties of a Listener for the LoadBalancer.
|
2163
|
+
# @!attribute [rw] protocol
|
2164
|
+
# The protocol that is used by the Listener.
|
2165
|
+
# @return [String]
|
2166
|
+
#
|
2167
|
+
# @!attribute [rw] port
|
2168
|
+
# The port that is used by the Listener.
|
2169
|
+
# @return [Integer]
|
2170
|
+
class Listener < Struct.new(
|
2171
|
+
:protocol,
|
2172
|
+
:port)
|
2173
|
+
include Aws::Structure
|
2174
|
+
end
|
2175
|
+
|
2176
|
+
# Describes a LoadBalancer.
|
2177
|
+
# @!attribute [rw] name
|
2178
|
+
# The name of the LoadBalancer.
|
2179
|
+
# @return [String]
|
2180
|
+
class LoadBalancer < Struct.new(
|
2181
|
+
:name)
|
2182
|
+
include Aws::Structure
|
2183
|
+
end
|
2184
|
+
|
2185
|
+
# Describes the details of a LoadBalancer.
|
2186
|
+
# @!attribute [rw] load_balancer_name
|
2187
|
+
# The name of the LoadBalancer.
|
2188
|
+
# @return [String]
|
2189
|
+
#
|
2190
|
+
# @!attribute [rw] domain
|
2191
|
+
# The domain name of the LoadBalancer.
|
2192
|
+
# @return [String]
|
2193
|
+
#
|
2194
|
+
# @!attribute [rw] listeners
|
2195
|
+
# A list of Listeners used by the LoadBalancer.
|
2196
|
+
# @return [Array<Types::Listener>]
|
2197
|
+
class LoadBalancerDescription < Struct.new(
|
2198
|
+
:load_balancer_name,
|
2199
|
+
:domain,
|
2200
|
+
:listeners)
|
2201
|
+
include Aws::Structure
|
2202
|
+
end
|
2203
|
+
|
2204
|
+
# The record of an upcoming or in-progress managed action.
|
2205
|
+
# @!attribute [rw] action_id
|
2206
|
+
# A unique identifier for the managed action.
|
2207
|
+
# @return [String]
|
2208
|
+
#
|
2209
|
+
# @!attribute [rw] action_description
|
2210
|
+
# A description of the managed action.
|
2211
|
+
# @return [String]
|
2212
|
+
#
|
2213
|
+
# @!attribute [rw] action_type
|
2214
|
+
# The type of managed action.
|
2215
|
+
# @return [String]
|
2216
|
+
#
|
2217
|
+
# @!attribute [rw] status
|
2218
|
+
# The status of the managed action. If the action is `Scheduled`, you
|
2219
|
+
# can apply it immediately with ApplyEnvironmentManagedAction.
|
2220
|
+
# @return [String]
|
2221
|
+
#
|
2222
|
+
# @!attribute [rw] window_start_time
|
2223
|
+
# The start time of the maintenance window in which the managed action
|
2224
|
+
# will execute.
|
2225
|
+
# @return [Time]
|
2226
|
+
class ManagedAction < Struct.new(
|
2227
|
+
:action_id,
|
2228
|
+
:action_description,
|
2229
|
+
:action_type,
|
2230
|
+
:status,
|
2231
|
+
:window_start_time)
|
2232
|
+
include Aws::Structure
|
2233
|
+
end
|
2234
|
+
|
2235
|
+
# The record of a completed or failed managed action.
|
2236
|
+
# @!attribute [rw] action_id
|
2237
|
+
# A unique identifier for the managed action.
|
2238
|
+
# @return [String]
|
2239
|
+
#
|
2240
|
+
# @!attribute [rw] action_type
|
2241
|
+
# The type of the managed action.
|
2242
|
+
# @return [String]
|
2243
|
+
#
|
2244
|
+
# @!attribute [rw] action_description
|
2245
|
+
# A description of the managed action.
|
2246
|
+
# @return [String]
|
2247
|
+
#
|
2248
|
+
# @!attribute [rw] failure_type
|
2249
|
+
# If the action failed, the type of failure.
|
2250
|
+
# @return [String]
|
2251
|
+
#
|
2252
|
+
# @!attribute [rw] status
|
2253
|
+
# The status of the action.
|
2254
|
+
# @return [String]
|
2255
|
+
#
|
2256
|
+
# @!attribute [rw] failure_description
|
2257
|
+
# If the action failed, a description of the failure.
|
2258
|
+
# @return [String]
|
2259
|
+
#
|
2260
|
+
# @!attribute [rw] executed_time
|
2261
|
+
# The date and time that the action started executing.
|
2262
|
+
# @return [Time]
|
2263
|
+
#
|
2264
|
+
# @!attribute [rw] finished_time
|
2265
|
+
# The date and time that the action finished executing.
|
2266
|
+
# @return [Time]
|
2267
|
+
class ManagedActionHistoryItem < Struct.new(
|
2268
|
+
:action_id,
|
2269
|
+
:action_type,
|
2270
|
+
:action_description,
|
2271
|
+
:failure_type,
|
2272
|
+
:status,
|
2273
|
+
:failure_description,
|
2274
|
+
:executed_time,
|
2275
|
+
:finished_time)
|
2276
|
+
include Aws::Structure
|
2277
|
+
end
|
2278
|
+
|
2279
|
+
# A regular expression representing a restriction on a string
|
2280
|
+
# configuration option value.
|
2281
|
+
# @!attribute [rw] pattern
|
2282
|
+
# The regular expression pattern that a string configuration option
|
2283
|
+
# value with this restriction must match.
|
2284
|
+
# @return [String]
|
2285
|
+
#
|
2286
|
+
# @!attribute [rw] label
|
2287
|
+
# A unique name representing this regular expression.
|
2288
|
+
# @return [String]
|
2289
|
+
class OptionRestrictionRegex < Struct.new(
|
2290
|
+
:pattern,
|
2291
|
+
:label)
|
2292
|
+
include Aws::Structure
|
2293
|
+
end
|
2294
|
+
|
2295
|
+
# A specification identifying an individual configuration option.
|
2296
|
+
# @note When making an API call, pass OptionSpecification
|
2297
|
+
# data as a hash:
|
2298
|
+
#
|
2299
|
+
# {
|
2300
|
+
# resource_name: "ResourceName",
|
2301
|
+
# namespace: "OptionNamespace",
|
2302
|
+
# option_name: "ConfigurationOptionName",
|
2303
|
+
# }
|
2304
|
+
# @!attribute [rw] resource_name
|
2305
|
+
# A unique resource name for a time-based scaling configuration
|
2306
|
+
# option.
|
2307
|
+
# @return [String]
|
2308
|
+
#
|
2309
|
+
# @!attribute [rw] namespace
|
2310
|
+
# A unique namespace identifying the option's associated AWS
|
2311
|
+
# resource.
|
2312
|
+
# @return [String]
|
2313
|
+
#
|
2314
|
+
# @!attribute [rw] option_name
|
2315
|
+
# The name of the configuration option.
|
2316
|
+
# @return [String]
|
2317
|
+
class OptionSpecification < Struct.new(
|
2318
|
+
:resource_name,
|
2319
|
+
:namespace,
|
2320
|
+
:option_name)
|
2321
|
+
include Aws::Structure
|
2322
|
+
end
|
2323
|
+
|
2324
|
+
# Describes a queue.
|
2325
|
+
# @!attribute [rw] name
|
2326
|
+
# The name of the queue.
|
2327
|
+
# @return [String]
|
2328
|
+
#
|
2329
|
+
# @!attribute [rw] url
|
2330
|
+
# The URL of the queue.
|
2331
|
+
# @return [String]
|
2332
|
+
class Queue < Struct.new(
|
2333
|
+
:name,
|
2334
|
+
:url)
|
2335
|
+
include Aws::Structure
|
2336
|
+
end
|
2337
|
+
|
2338
|
+
# @note When making an API call, pass RebuildEnvironmentMessage
|
2339
|
+
# data as a hash:
|
2340
|
+
#
|
2341
|
+
# {
|
2342
|
+
# environment_id: "EnvironmentId",
|
2343
|
+
# environment_name: "EnvironmentName",
|
2344
|
+
# }
|
2345
|
+
# @!attribute [rw] environment_id
|
2346
|
+
# The ID of the environment to rebuild.
|
2347
|
+
#
|
2348
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
2349
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2350
|
+
# `MissingRequiredParameter` error.
|
2351
|
+
# @return [String]
|
2352
|
+
#
|
2353
|
+
# @!attribute [rw] environment_name
|
2354
|
+
# The name of the environment to rebuild.
|
2355
|
+
#
|
2356
|
+
# Condition: You must specify either this or an EnvironmentId, or
|
2357
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2358
|
+
# `MissingRequiredParameter` error.
|
2359
|
+
# @return [String]
|
2360
|
+
class RebuildEnvironmentMessage < Struct.new(
|
2361
|
+
:environment_id,
|
2362
|
+
:environment_name)
|
2363
|
+
include Aws::Structure
|
2364
|
+
end
|
2365
|
+
|
2366
|
+
# Request to retrieve logs from an environment and store them in your
|
2367
|
+
# Elastic Beanstalk storage bucket.
|
2368
|
+
# @note When making an API call, pass RequestEnvironmentInfoMessage
|
2369
|
+
# data as a hash:
|
2370
|
+
#
|
2371
|
+
# {
|
2372
|
+
# environment_id: "EnvironmentId",
|
2373
|
+
# environment_name: "EnvironmentName",
|
2374
|
+
# info_type: "tail", # required, accepts tail, bundle
|
2375
|
+
# }
|
2376
|
+
# @!attribute [rw] environment_id
|
2377
|
+
# The ID of the environment of the requested data.
|
2378
|
+
#
|
2379
|
+
# If no such environment is found, `RequestEnvironmentInfo` returns an
|
2380
|
+
# `InvalidParameterValue` error.
|
2381
|
+
#
|
2382
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
2383
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2384
|
+
# `MissingRequiredParameter` error.
|
2385
|
+
# @return [String]
|
2386
|
+
#
|
2387
|
+
# @!attribute [rw] environment_name
|
2388
|
+
# The name of the environment of the requested data.
|
2389
|
+
#
|
2390
|
+
# If no such environment is found, `RequestEnvironmentInfo` returns an
|
2391
|
+
# `InvalidParameterValue` error.
|
2392
|
+
#
|
2393
|
+
# Condition: You must specify either this or an EnvironmentId, or
|
2394
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2395
|
+
# `MissingRequiredParameter` error.
|
2396
|
+
# @return [String]
|
2397
|
+
#
|
2398
|
+
# @!attribute [rw] info_type
|
2399
|
+
# The type of information to request.
|
2400
|
+
# @return [String]
|
2401
|
+
class RequestEnvironmentInfoMessage < Struct.new(
|
2402
|
+
:environment_id,
|
2403
|
+
:environment_name,
|
2404
|
+
:info_type)
|
2405
|
+
include Aws::Structure
|
2406
|
+
end
|
2407
|
+
|
2408
|
+
# @note When making an API call, pass RestartAppServerMessage
|
2409
|
+
# data as a hash:
|
2410
|
+
#
|
2411
|
+
# {
|
2412
|
+
# environment_id: "EnvironmentId",
|
2413
|
+
# environment_name: "EnvironmentName",
|
2414
|
+
# }
|
2415
|
+
# @!attribute [rw] environment_id
|
2416
|
+
# The ID of the environment to restart the server for.
|
2417
|
+
#
|
2418
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
2419
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2420
|
+
# `MissingRequiredParameter` error.
|
2421
|
+
# @return [String]
|
2422
|
+
#
|
2423
|
+
# @!attribute [rw] environment_name
|
2424
|
+
# The name of the environment to restart the server for.
|
2425
|
+
#
|
2426
|
+
# Condition: You must specify either this or an EnvironmentId, or
|
2427
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2428
|
+
# `MissingRequiredParameter` error.
|
2429
|
+
# @return [String]
|
2430
|
+
class RestartAppServerMessage < Struct.new(
|
2431
|
+
:environment_id,
|
2432
|
+
:environment_name)
|
2433
|
+
include Aws::Structure
|
2434
|
+
end
|
2435
|
+
|
2436
|
+
# Request to download logs retrieved with RequestEnvironmentInfo.
|
2437
|
+
# @note When making an API call, pass RetrieveEnvironmentInfoMessage
|
2438
|
+
# data as a hash:
|
2439
|
+
#
|
2440
|
+
# {
|
2441
|
+
# environment_id: "EnvironmentId",
|
2442
|
+
# environment_name: "EnvironmentName",
|
2443
|
+
# info_type: "tail", # required, accepts tail, bundle
|
2444
|
+
# }
|
2445
|
+
# @!attribute [rw] environment_id
|
2446
|
+
# The ID of the data's environment.
|
2447
|
+
#
|
2448
|
+
# If no such environment is found, returns an `InvalidParameterValue`
|
2449
|
+
# error.
|
2450
|
+
#
|
2451
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
2452
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2453
|
+
# `MissingRequiredParameter` error.
|
2454
|
+
# @return [String]
|
2455
|
+
#
|
2456
|
+
# @!attribute [rw] environment_name
|
2457
|
+
# The name of the data's environment.
|
2458
|
+
#
|
2459
|
+
# If no such environment is found, returns an `InvalidParameterValue`
|
2460
|
+
# error.
|
2461
|
+
#
|
2462
|
+
# Condition: You must specify either this or an EnvironmentId, or
|
2463
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2464
|
+
# `MissingRequiredParameter` error.
|
2465
|
+
# @return [String]
|
2466
|
+
#
|
2467
|
+
# @!attribute [rw] info_type
|
2468
|
+
# The type of information to retrieve.
|
2469
|
+
# @return [String]
|
2470
|
+
class RetrieveEnvironmentInfoMessage < Struct.new(
|
2471
|
+
:environment_id,
|
2472
|
+
:environment_name,
|
2473
|
+
:info_type)
|
2474
|
+
include Aws::Structure
|
2475
|
+
end
|
2476
|
+
|
2477
|
+
# Result message containing a description of the requested environment
|
2478
|
+
# info.
|
2479
|
+
# @!attribute [rw] environment_info
|
2480
|
+
# The EnvironmentInfoDescription of the environment.
|
2481
|
+
# @return [Array<Types::EnvironmentInfoDescription>]
|
2482
|
+
class RetrieveEnvironmentInfoResultMessage < Struct.new(
|
2483
|
+
:environment_info)
|
2484
|
+
include Aws::Structure
|
2485
|
+
end
|
2486
|
+
|
2487
|
+
# A specification of a location in Amazon S3.
|
2488
|
+
# @note When making an API call, pass S3Location
|
2489
|
+
# data as a hash:
|
2490
|
+
#
|
2491
|
+
# {
|
2492
|
+
# s3_bucket: "S3Bucket",
|
2493
|
+
# s3_key: "S3Key",
|
2494
|
+
# }
|
2495
|
+
# @!attribute [rw] s3_bucket
|
2496
|
+
# The Amazon S3 bucket where the data is located.
|
2497
|
+
# @return [String]
|
2498
|
+
#
|
2499
|
+
# @!attribute [rw] s3_key
|
2500
|
+
# The Amazon S3 key where the data is located.
|
2501
|
+
# @return [String]
|
2502
|
+
class S3Location < Struct.new(
|
2503
|
+
:s3_bucket,
|
2504
|
+
:s3_key)
|
2505
|
+
include Aws::Structure
|
2506
|
+
end
|
2507
|
+
|
2508
|
+
# Represents health information from the specified instance that belongs
|
2509
|
+
# to the AWS Elastic Beanstalk environment. Use the `InstanceId`
|
2510
|
+
# property to specify the application instance for which you'd like to
|
2511
|
+
# return data.
|
2512
|
+
# @!attribute [rw] instance_id
|
2513
|
+
# The ID of the Amazon EC2 instance.
|
2514
|
+
# @return [String]
|
2515
|
+
#
|
2516
|
+
# @!attribute [rw] health_status
|
2517
|
+
# Returns the health status of the specified instance. For more
|
2518
|
+
# information, see [Health Colors and Statuses][1].
|
2519
|
+
#
|
2520
|
+
#
|
2521
|
+
#
|
2522
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
|
2523
|
+
# @return [String]
|
2524
|
+
#
|
2525
|
+
# @!attribute [rw] color
|
2526
|
+
# Represents the color indicator that gives you information about the
|
2527
|
+
# health of the EC2 instance. For more information, see [Health Colors
|
2528
|
+
# and Statuses][1].
|
2529
|
+
#
|
2530
|
+
#
|
2531
|
+
#
|
2532
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html
|
2533
|
+
# @return [String]
|
2534
|
+
#
|
2535
|
+
# @!attribute [rw] causes
|
2536
|
+
# Represents the causes, which provide more information about the
|
2537
|
+
# current health status.
|
2538
|
+
# @return [Array<String>]
|
2539
|
+
#
|
2540
|
+
# @!attribute [rw] launched_at
|
2541
|
+
# The time at which the EC2 instance was launched.
|
2542
|
+
# @return [Time]
|
2543
|
+
#
|
2544
|
+
# @!attribute [rw] application_metrics
|
2545
|
+
# Represents the application metrics for a specified environment.
|
2546
|
+
# @return [Types::ApplicationMetrics]
|
2547
|
+
#
|
2548
|
+
# @!attribute [rw] system
|
2549
|
+
# Represents CPU utilization and load average information for
|
2550
|
+
# applications running in the specified environment.
|
2551
|
+
# @return [Types::SystemStatus]
|
2552
|
+
#
|
2553
|
+
# @!attribute [rw] deployment
|
2554
|
+
# Information about the most recent deployment to an instance.
|
2555
|
+
# @return [Types::Deployment]
|
2556
|
+
#
|
2557
|
+
# @!attribute [rw] availability_zone
|
2558
|
+
# The availability zone in which the instance runs.
|
2559
|
+
# @return [String]
|
2560
|
+
#
|
2561
|
+
# @!attribute [rw] instance_type
|
2562
|
+
# The instance's type.
|
2563
|
+
# @return [String]
|
2564
|
+
class SingleInstanceHealth < Struct.new(
|
2565
|
+
:instance_id,
|
2566
|
+
:health_status,
|
2567
|
+
:color,
|
2568
|
+
:causes,
|
2569
|
+
:launched_at,
|
2570
|
+
:application_metrics,
|
2571
|
+
:system,
|
2572
|
+
:deployment,
|
2573
|
+
:availability_zone,
|
2574
|
+
:instance_type)
|
2575
|
+
include Aws::Structure
|
2576
|
+
end
|
2577
|
+
|
2578
|
+
# Describes the solution stack.
|
2579
|
+
# @!attribute [rw] solution_stack_name
|
2580
|
+
# The name of the solution stack.
|
2581
|
+
# @return [String]
|
2582
|
+
#
|
2583
|
+
# @!attribute [rw] permitted_file_types
|
2584
|
+
# The permitted file types allowed for a solution stack.
|
2585
|
+
# @return [Array<String>]
|
2586
|
+
class SolutionStackDescription < Struct.new(
|
2587
|
+
:solution_stack_name,
|
2588
|
+
:permitted_file_types)
|
2589
|
+
include Aws::Structure
|
2590
|
+
end
|
2591
|
+
|
2592
|
+
# @note When making an API call, pass SourceBuildInformation
|
2593
|
+
# data as a hash:
|
2594
|
+
#
|
2595
|
+
# {
|
2596
|
+
# source_type: "Git", # required, accepts Git
|
2597
|
+
# source_repository: "CodeCommit", # required, accepts CodeCommit
|
2598
|
+
# source_location: "SourceLocation", # required
|
2599
|
+
# }
|
2600
|
+
# @!attribute [rw] source_type
|
2601
|
+
# @return [String]
|
2602
|
+
#
|
2603
|
+
# @!attribute [rw] source_repository
|
2604
|
+
# @return [String]
|
2605
|
+
#
|
2606
|
+
# @!attribute [rw] source_location
|
2607
|
+
# @return [String]
|
2608
|
+
class SourceBuildInformation < Struct.new(
|
2609
|
+
:source_type,
|
2610
|
+
:source_repository,
|
2611
|
+
:source_location)
|
2612
|
+
include Aws::Structure
|
2613
|
+
end
|
2614
|
+
|
2615
|
+
# A specification for an environment configuration
|
2616
|
+
# @note When making an API call, pass SourceConfiguration
|
2617
|
+
# data as a hash:
|
2618
|
+
#
|
2619
|
+
# {
|
2620
|
+
# application_name: "ApplicationName",
|
2621
|
+
# template_name: "ConfigurationTemplateName",
|
2622
|
+
# }
|
2623
|
+
# @!attribute [rw] application_name
|
2624
|
+
# The name of the application associated with the configuration.
|
2625
|
+
# @return [String]
|
2626
|
+
#
|
2627
|
+
# @!attribute [rw] template_name
|
2628
|
+
# The name of the configuration template.
|
2629
|
+
# @return [String]
|
2630
|
+
class SourceConfiguration < Struct.new(
|
2631
|
+
:application_name,
|
2632
|
+
:template_name)
|
2633
|
+
include Aws::Structure
|
2634
|
+
end
|
2635
|
+
|
2636
|
+
# Represents the percentage of requests over the last 10 seconds that
|
2637
|
+
# resulted in each type of status code response. For more information,
|
2638
|
+
# see [Status Code Definitions][1].
|
2639
|
+
#
|
2640
|
+
#
|
2641
|
+
#
|
2642
|
+
# [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
|
2643
|
+
# @!attribute [rw] status_2xx
|
2644
|
+
# The percentage of requests over the last 10 seconds that resulted in
|
2645
|
+
# a 2xx (200, 201, etc.) status code.
|
2646
|
+
# @return [Integer]
|
2647
|
+
#
|
2648
|
+
# @!attribute [rw] status_3xx
|
2649
|
+
# The percentage of requests over the last 10 seconds that resulted in
|
2650
|
+
# a 3xx (300, 301, etc.) status code.
|
2651
|
+
# @return [Integer]
|
2652
|
+
#
|
2653
|
+
# @!attribute [rw] status_4xx
|
2654
|
+
# The percentage of requests over the last 10 seconds that resulted in
|
2655
|
+
# a 4xx (400, 401, etc.) status code.
|
2656
|
+
# @return [Integer]
|
2657
|
+
#
|
2658
|
+
# @!attribute [rw] status_5xx
|
2659
|
+
# The percentage of requests over the last 10 seconds that resulted in
|
2660
|
+
# a 5xx (500, 501, etc.) status code.
|
2661
|
+
# @return [Integer]
|
2662
|
+
class StatusCodes < Struct.new(
|
2663
|
+
:status_2xx,
|
2664
|
+
:status_3xx,
|
2665
|
+
:status_4xx,
|
2666
|
+
:status_5xx)
|
2667
|
+
include Aws::Structure
|
2668
|
+
end
|
2669
|
+
|
2670
|
+
# Swaps the CNAMEs of two environments.
|
2671
|
+
# @note When making an API call, pass SwapEnvironmentCNAMEsMessage
|
2672
|
+
# data as a hash:
|
2673
|
+
#
|
2674
|
+
# {
|
2675
|
+
# source_environment_id: "EnvironmentId",
|
2676
|
+
# source_environment_name: "EnvironmentName",
|
2677
|
+
# destination_environment_id: "EnvironmentId",
|
2678
|
+
# destination_environment_name: "EnvironmentName",
|
2679
|
+
# }
|
2680
|
+
# @!attribute [rw] source_environment_id
|
2681
|
+
# The ID of the source environment.
|
2682
|
+
#
|
2683
|
+
# Condition: You must specify at least the `SourceEnvironmentID` or
|
2684
|
+
# the `SourceEnvironmentName`. You may also specify both. If you
|
2685
|
+
# specify the `SourceEnvironmentId`, you must specify the
|
2686
|
+
# `DestinationEnvironmentId`.
|
2687
|
+
# @return [String]
|
2688
|
+
#
|
2689
|
+
# @!attribute [rw] source_environment_name
|
2690
|
+
# The name of the source environment.
|
2691
|
+
#
|
2692
|
+
# Condition: You must specify at least the `SourceEnvironmentID` or
|
2693
|
+
# the `SourceEnvironmentName`. You may also specify both. If you
|
2694
|
+
# specify the `SourceEnvironmentName`, you must specify the
|
2695
|
+
# `DestinationEnvironmentName`.
|
2696
|
+
# @return [String]
|
2697
|
+
#
|
2698
|
+
# @!attribute [rw] destination_environment_id
|
2699
|
+
# The ID of the destination environment.
|
2700
|
+
#
|
2701
|
+
# Condition: You must specify at least the `DestinationEnvironmentID`
|
2702
|
+
# or the `DestinationEnvironmentName`. You may also specify both. You
|
2703
|
+
# must specify the `SourceEnvironmentId` with the
|
2704
|
+
# `DestinationEnvironmentId`.
|
2705
|
+
# @return [String]
|
2706
|
+
#
|
2707
|
+
# @!attribute [rw] destination_environment_name
|
2708
|
+
# The name of the destination environment.
|
2709
|
+
#
|
2710
|
+
# Condition: You must specify at least the `DestinationEnvironmentID`
|
2711
|
+
# or the `DestinationEnvironmentName`. You may also specify both. You
|
2712
|
+
# must specify the `SourceEnvironmentName` with the
|
2713
|
+
# `DestinationEnvironmentName`.
|
2714
|
+
# @return [String]
|
2715
|
+
class SwapEnvironmentCNAMEsMessage < Struct.new(
|
2716
|
+
:source_environment_id,
|
2717
|
+
:source_environment_name,
|
2718
|
+
:destination_environment_id,
|
2719
|
+
:destination_environment_name)
|
2720
|
+
include Aws::Structure
|
2721
|
+
end
|
2722
|
+
|
2723
|
+
# Represents CPU utilization and load average information for
|
2724
|
+
# applications running in the specified environment.
|
2725
|
+
# @!attribute [rw] cpu_utilization
|
2726
|
+
# Represents CPU utilization information from the specified instance
|
2727
|
+
# that belongs to the AWS Elastic Beanstalk environment. Use the
|
2728
|
+
# `instanceId` property to specify the application instance for which
|
2729
|
+
# you'd like to return data.
|
2730
|
+
# @return [Types::CPUUtilization]
|
2731
|
+
#
|
2732
|
+
# @!attribute [rw] load_average
|
2733
|
+
# Load average in the last 1-minute and 5-minute periods. For more
|
2734
|
+
# information, see [Operating System Metrics][1].
|
2735
|
+
#
|
2736
|
+
#
|
2737
|
+
#
|
2738
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-metrics.html#health-enhanced-metrics-os
|
2739
|
+
# @return [Array<Float>]
|
2740
|
+
class SystemStatus < Struct.new(
|
2741
|
+
:cpu_utilization,
|
2742
|
+
:load_average)
|
2743
|
+
include Aws::Structure
|
2744
|
+
end
|
2745
|
+
|
2746
|
+
# Describes a tag applied to a resource in an environment.
|
2747
|
+
# @note When making an API call, pass Tag
|
2748
|
+
# data as a hash:
|
2749
|
+
#
|
2750
|
+
# {
|
2751
|
+
# key: "TagKey",
|
2752
|
+
# value: "TagValue",
|
2753
|
+
# }
|
2754
|
+
# @!attribute [rw] key
|
2755
|
+
# The key of the tag.
|
2756
|
+
# @return [String]
|
2757
|
+
#
|
2758
|
+
# @!attribute [rw] value
|
2759
|
+
# The value of the tag.
|
2760
|
+
# @return [String]
|
2761
|
+
class Tag < Struct.new(
|
2762
|
+
:key,
|
2763
|
+
:value)
|
2764
|
+
include Aws::Structure
|
2765
|
+
end
|
2766
|
+
|
2767
|
+
# Request to terminate an environment.
|
2768
|
+
# @note When making an API call, pass TerminateEnvironmentMessage
|
2769
|
+
# data as a hash:
|
2770
|
+
#
|
2771
|
+
# {
|
2772
|
+
# environment_id: "EnvironmentId",
|
2773
|
+
# environment_name: "EnvironmentName",
|
2774
|
+
# terminate_resources: false,
|
2775
|
+
# force_terminate: false,
|
2776
|
+
# }
|
2777
|
+
# @!attribute [rw] environment_id
|
2778
|
+
# The ID of the environment to terminate.
|
2779
|
+
#
|
2780
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
2781
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2782
|
+
# `MissingRequiredParameter` error.
|
2783
|
+
# @return [String]
|
2784
|
+
#
|
2785
|
+
# @!attribute [rw] environment_name
|
2786
|
+
# The name of the environment to terminate.
|
2787
|
+
#
|
2788
|
+
# Condition: You must specify either this or an EnvironmentId, or
|
2789
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
2790
|
+
# `MissingRequiredParameter` error.
|
2791
|
+
# @return [String]
|
2792
|
+
#
|
2793
|
+
# @!attribute [rw] terminate_resources
|
2794
|
+
# Indicates whether the associated AWS resources should shut down when
|
2795
|
+
# the environment is terminated:
|
2796
|
+
#
|
2797
|
+
# * `true`\: The specified environment as well as the associated AWS
|
2798
|
+
# resources, such as Auto Scaling group and LoadBalancer, are
|
2799
|
+
# terminated.
|
2800
|
+
#
|
2801
|
+
# * `false`\: AWS Elastic Beanstalk resource management is removed
|
2802
|
+
# from the environment, but the AWS resources continue to operate.
|
2803
|
+
#
|
2804
|
+
# For more information, see the [ AWS Elastic Beanstalk User Guide.
|
2805
|
+
# ][1]
|
2806
|
+
#
|
2807
|
+
# Default: `true`
|
2808
|
+
#
|
2809
|
+
# Valid Values: `true` \| `false`
|
2810
|
+
#
|
2811
|
+
#
|
2812
|
+
#
|
2813
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/ug/
|
2814
|
+
# @return [Boolean]
|
2815
|
+
#
|
2816
|
+
# @!attribute [rw] force_terminate
|
2817
|
+
# Terminates the target environment even if another environment in the
|
2818
|
+
# same group is dependent on it.
|
2819
|
+
# @return [Boolean]
|
2820
|
+
class TerminateEnvironmentMessage < Struct.new(
|
2821
|
+
:environment_id,
|
2822
|
+
:environment_name,
|
2823
|
+
:terminate_resources,
|
2824
|
+
:force_terminate)
|
2825
|
+
include Aws::Structure
|
2826
|
+
end
|
2827
|
+
|
2828
|
+
# Describes a trigger.
|
2829
|
+
# @!attribute [rw] name
|
2830
|
+
# The name of the trigger.
|
2831
|
+
# @return [String]
|
2832
|
+
class Trigger < Struct.new(
|
2833
|
+
:name)
|
2834
|
+
include Aws::Structure
|
2835
|
+
end
|
2836
|
+
|
2837
|
+
# Request to update an application.
|
2838
|
+
# @note When making an API call, pass UpdateApplicationMessage
|
2839
|
+
# data as a hash:
|
2840
|
+
#
|
2841
|
+
# {
|
2842
|
+
# application_name: "ApplicationName", # required
|
2843
|
+
# description: "Description",
|
2844
|
+
# }
|
2845
|
+
# @!attribute [rw] application_name
|
2846
|
+
# The name of the application to update. If no such application is
|
2847
|
+
# found, `UpdateApplication` returns an `InvalidParameterValue` error.
|
2848
|
+
# @return [String]
|
2849
|
+
#
|
2850
|
+
# @!attribute [rw] description
|
2851
|
+
# A new description for the application.
|
2852
|
+
#
|
2853
|
+
# Default: If not specified, AWS Elastic Beanstalk does not update the
|
2854
|
+
# description.
|
2855
|
+
# @return [String]
|
2856
|
+
class UpdateApplicationMessage < Struct.new(
|
2857
|
+
:application_name,
|
2858
|
+
:description)
|
2859
|
+
include Aws::Structure
|
2860
|
+
end
|
2861
|
+
|
2862
|
+
# @note When making an API call, pass UpdateApplicationVersionMessage
|
2863
|
+
# data as a hash:
|
2864
|
+
#
|
2865
|
+
# {
|
2866
|
+
# application_name: "ApplicationName", # required
|
2867
|
+
# version_label: "VersionLabel", # required
|
2868
|
+
# description: "Description",
|
2869
|
+
# }
|
2870
|
+
# @!attribute [rw] application_name
|
2871
|
+
# The name of the application associated with this version.
|
2872
|
+
#
|
2873
|
+
# If no application is found with this name, `UpdateApplication`
|
2874
|
+
# returns an `InvalidParameterValue` error.
|
2875
|
+
# @return [String]
|
2876
|
+
#
|
2877
|
+
# @!attribute [rw] version_label
|
2878
|
+
# The name of the version to update.
|
2879
|
+
#
|
2880
|
+
# If no application version is found with this label,
|
2881
|
+
# `UpdateApplication` returns an `InvalidParameterValue` error.
|
2882
|
+
# @return [String]
|
2883
|
+
#
|
2884
|
+
# @!attribute [rw] description
|
2885
|
+
# A new description for this release.
|
2886
|
+
# @return [String]
|
2887
|
+
class UpdateApplicationVersionMessage < Struct.new(
|
2888
|
+
:application_name,
|
2889
|
+
:version_label,
|
2890
|
+
:description)
|
2891
|
+
include Aws::Structure
|
2892
|
+
end
|
2893
|
+
|
2894
|
+
# The result message containing the options for the specified solution
|
2895
|
+
# stack.
|
2896
|
+
# @note When making an API call, pass UpdateConfigurationTemplateMessage
|
2897
|
+
# data as a hash:
|
2898
|
+
#
|
2899
|
+
# {
|
2900
|
+
# application_name: "ApplicationName", # required
|
2901
|
+
# template_name: "ConfigurationTemplateName", # required
|
2902
|
+
# description: "Description",
|
2903
|
+
# option_settings: [
|
2904
|
+
# {
|
2905
|
+
# resource_name: "ResourceName",
|
2906
|
+
# namespace: "OptionNamespace",
|
2907
|
+
# option_name: "ConfigurationOptionName",
|
2908
|
+
# value: "ConfigurationOptionValue",
|
2909
|
+
# },
|
2910
|
+
# ],
|
2911
|
+
# options_to_remove: [
|
2912
|
+
# {
|
2913
|
+
# resource_name: "ResourceName",
|
2914
|
+
# namespace: "OptionNamespace",
|
2915
|
+
# option_name: "ConfigurationOptionName",
|
2916
|
+
# },
|
2917
|
+
# ],
|
2918
|
+
# }
|
2919
|
+
# @!attribute [rw] application_name
|
2920
|
+
# The name of the application associated with the configuration
|
2921
|
+
# template to update.
|
2922
|
+
#
|
2923
|
+
# If no application is found with this name,
|
2924
|
+
# `UpdateConfigurationTemplate` returns an `InvalidParameterValue`
|
2925
|
+
# error.
|
2926
|
+
# @return [String]
|
2927
|
+
#
|
2928
|
+
# @!attribute [rw] template_name
|
2929
|
+
# The name of the configuration template to update.
|
2930
|
+
#
|
2931
|
+
# If no configuration template is found with this name,
|
2932
|
+
# `UpdateConfigurationTemplate` returns an `InvalidParameterValue`
|
2933
|
+
# error.
|
2934
|
+
# @return [String]
|
2935
|
+
#
|
2936
|
+
# @!attribute [rw] description
|
2937
|
+
# A new description for the configuration.
|
2938
|
+
# @return [String]
|
2939
|
+
#
|
2940
|
+
# @!attribute [rw] option_settings
|
2941
|
+
# A list of configuration option settings to update with the new
|
2942
|
+
# specified option value.
|
2943
|
+
# @return [Array<Types::ConfigurationOptionSetting>]
|
2944
|
+
#
|
2945
|
+
# @!attribute [rw] options_to_remove
|
2946
|
+
# A list of configuration options to remove from the configuration
|
2947
|
+
# set.
|
2948
|
+
#
|
2949
|
+
# Constraint: You can remove only `UserDefined` configuration options.
|
2950
|
+
# @return [Array<Types::OptionSpecification>]
|
2951
|
+
class UpdateConfigurationTemplateMessage < Struct.new(
|
2952
|
+
:application_name,
|
2953
|
+
:template_name,
|
2954
|
+
:description,
|
2955
|
+
:option_settings,
|
2956
|
+
:options_to_remove)
|
2957
|
+
include Aws::Structure
|
2958
|
+
end
|
2959
|
+
|
2960
|
+
# Request to update an environment.
|
2961
|
+
# @note When making an API call, pass UpdateEnvironmentMessage
|
2962
|
+
# data as a hash:
|
2963
|
+
#
|
2964
|
+
# {
|
2965
|
+
# application_name: "ApplicationName",
|
2966
|
+
# environment_id: "EnvironmentId",
|
2967
|
+
# environment_name: "EnvironmentName",
|
2968
|
+
# group_name: "GroupName",
|
2969
|
+
# description: "Description",
|
2970
|
+
# tier: {
|
2971
|
+
# name: "String",
|
2972
|
+
# type: "String",
|
2973
|
+
# version: "String",
|
2974
|
+
# },
|
2975
|
+
# version_label: "VersionLabel",
|
2976
|
+
# template_name: "ConfigurationTemplateName",
|
2977
|
+
# solution_stack_name: "SolutionStackName",
|
2978
|
+
# option_settings: [
|
2979
|
+
# {
|
2980
|
+
# resource_name: "ResourceName",
|
2981
|
+
# namespace: "OptionNamespace",
|
2982
|
+
# option_name: "ConfigurationOptionName",
|
2983
|
+
# value: "ConfigurationOptionValue",
|
2984
|
+
# },
|
2985
|
+
# ],
|
2986
|
+
# options_to_remove: [
|
2987
|
+
# {
|
2988
|
+
# resource_name: "ResourceName",
|
2989
|
+
# namespace: "OptionNamespace",
|
2990
|
+
# option_name: "ConfigurationOptionName",
|
2991
|
+
# },
|
2992
|
+
# ],
|
2993
|
+
# }
|
2994
|
+
# @!attribute [rw] application_name
|
2995
|
+
# The name of the application with which the environment is
|
2996
|
+
# associated.
|
2997
|
+
# @return [String]
|
2998
|
+
#
|
2999
|
+
# @!attribute [rw] environment_id
|
3000
|
+
# The ID of the environment to update.
|
3001
|
+
#
|
3002
|
+
# If no environment with this ID exists, AWS Elastic Beanstalk returns
|
3003
|
+
# an `InvalidParameterValue` error.
|
3004
|
+
#
|
3005
|
+
# Condition: You must specify either this or an EnvironmentName, or
|
3006
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
3007
|
+
# `MissingRequiredParameter` error.
|
3008
|
+
# @return [String]
|
3009
|
+
#
|
3010
|
+
# @!attribute [rw] environment_name
|
3011
|
+
# The name of the environment to update. If no environment with this
|
3012
|
+
# name exists, AWS Elastic Beanstalk returns an
|
3013
|
+
# `InvalidParameterValue` error.
|
3014
|
+
#
|
3015
|
+
# Condition: You must specify either this or an EnvironmentId, or
|
3016
|
+
# both. If you do not specify either, AWS Elastic Beanstalk returns
|
3017
|
+
# `MissingRequiredParameter` error.
|
3018
|
+
# @return [String]
|
3019
|
+
#
|
3020
|
+
# @!attribute [rw] group_name
|
3021
|
+
# The name of the group to which the target environment belongs.
|
3022
|
+
# Specify a group name only if the environment's name is specified in
|
3023
|
+
# an environment manifest and not with the environment name or
|
3024
|
+
# environment ID parameters. See [Environment Manifest (env.yaml)][1]
|
3025
|
+
# for details.
|
3026
|
+
#
|
3027
|
+
#
|
3028
|
+
#
|
3029
|
+
# [1]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
|
3030
|
+
# @return [String]
|
3031
|
+
#
|
3032
|
+
# @!attribute [rw] description
|
3033
|
+
# If this parameter is specified, AWS Elastic Beanstalk updates the
|
3034
|
+
# description of this environment.
|
3035
|
+
# @return [String]
|
3036
|
+
#
|
3037
|
+
# @!attribute [rw] tier
|
3038
|
+
# This specifies the tier to use to update the environment.
|
3039
|
+
#
|
3040
|
+
# Condition: At this time, if you change the tier version, name, or
|
3041
|
+
# type, AWS Elastic Beanstalk returns `InvalidParameterValue` error.
|
3042
|
+
# @return [Types::EnvironmentTier]
|
3043
|
+
#
|
3044
|
+
# @!attribute [rw] version_label
|
3045
|
+
# If this parameter is specified, AWS Elastic Beanstalk deploys the
|
3046
|
+
# named application version to the environment. If no such application
|
3047
|
+
# version is found, returns an `InvalidParameterValue` error.
|
3048
|
+
# @return [String]
|
3049
|
+
#
|
3050
|
+
# @!attribute [rw] template_name
|
3051
|
+
# If this parameter is specified, AWS Elastic Beanstalk deploys this
|
3052
|
+
# configuration template to the environment. If no such configuration
|
3053
|
+
# template is found, AWS Elastic Beanstalk returns an
|
3054
|
+
# `InvalidParameterValue` error.
|
3055
|
+
# @return [String]
|
3056
|
+
#
|
3057
|
+
# @!attribute [rw] solution_stack_name
|
3058
|
+
# This specifies the platform version that the environment will run
|
3059
|
+
# after the environment is updated.
|
3060
|
+
# @return [String]
|
3061
|
+
#
|
3062
|
+
# @!attribute [rw] option_settings
|
3063
|
+
# If specified, AWS Elastic Beanstalk updates the configuration set
|
3064
|
+
# associated with the running environment and sets the specified
|
3065
|
+
# configuration options to the requested value.
|
3066
|
+
# @return [Array<Types::ConfigurationOptionSetting>]
|
3067
|
+
#
|
3068
|
+
# @!attribute [rw] options_to_remove
|
3069
|
+
# A list of custom user-defined configuration options to remove from
|
3070
|
+
# the configuration set for this environment.
|
3071
|
+
# @return [Array<Types::OptionSpecification>]
|
3072
|
+
class UpdateEnvironmentMessage < Struct.new(
|
3073
|
+
:application_name,
|
3074
|
+
:environment_id,
|
3075
|
+
:environment_name,
|
3076
|
+
:group_name,
|
3077
|
+
:description,
|
3078
|
+
:tier,
|
3079
|
+
:version_label,
|
3080
|
+
:template_name,
|
3081
|
+
:solution_stack_name,
|
3082
|
+
:option_settings,
|
3083
|
+
:options_to_remove)
|
3084
|
+
include Aws::Structure
|
3085
|
+
end
|
3086
|
+
|
3087
|
+
# A list of validation messages for a specified configuration template.
|
3088
|
+
# @note When making an API call, pass ValidateConfigurationSettingsMessage
|
3089
|
+
# data as a hash:
|
3090
|
+
#
|
3091
|
+
# {
|
3092
|
+
# application_name: "ApplicationName", # required
|
3093
|
+
# template_name: "ConfigurationTemplateName",
|
3094
|
+
# environment_name: "EnvironmentName",
|
3095
|
+
# option_settings: [ # required
|
3096
|
+
# {
|
3097
|
+
# resource_name: "ResourceName",
|
3098
|
+
# namespace: "OptionNamespace",
|
3099
|
+
# option_name: "ConfigurationOptionName",
|
3100
|
+
# value: "ConfigurationOptionValue",
|
3101
|
+
# },
|
3102
|
+
# ],
|
3103
|
+
# }
|
3104
|
+
# @!attribute [rw] application_name
|
3105
|
+
# The name of the application that the configuration template or
|
3106
|
+
# environment belongs to.
|
3107
|
+
# @return [String]
|
3108
|
+
#
|
3109
|
+
# @!attribute [rw] template_name
|
3110
|
+
# The name of the configuration template to validate the settings
|
3111
|
+
# against.
|
3112
|
+
#
|
3113
|
+
# Condition: You cannot specify both this and an environment name.
|
3114
|
+
# @return [String]
|
3115
|
+
#
|
3116
|
+
# @!attribute [rw] environment_name
|
3117
|
+
# The name of the environment to validate the settings against.
|
3118
|
+
#
|
3119
|
+
# Condition: You cannot specify both this and a configuration template
|
3120
|
+
# name.
|
3121
|
+
# @return [String]
|
3122
|
+
#
|
3123
|
+
# @!attribute [rw] option_settings
|
3124
|
+
# A list of the options and desired values to evaluate.
|
3125
|
+
# @return [Array<Types::ConfigurationOptionSetting>]
|
3126
|
+
class ValidateConfigurationSettingsMessage < Struct.new(
|
3127
|
+
:application_name,
|
3128
|
+
:template_name,
|
3129
|
+
:environment_name,
|
3130
|
+
:option_settings)
|
3131
|
+
include Aws::Structure
|
3132
|
+
end
|
3133
|
+
|
3134
|
+
# An error or warning for a desired configuration option value.
|
3135
|
+
# @!attribute [rw] message
|
3136
|
+
# A message describing the error or warning.
|
3137
|
+
# @return [String]
|
3138
|
+
#
|
3139
|
+
# @!attribute [rw] severity
|
3140
|
+
# An indication of the severity of this message:
|
3141
|
+
#
|
3142
|
+
# * `error`\: This message indicates that this is not a valid setting
|
3143
|
+
# for an option.
|
3144
|
+
#
|
3145
|
+
# * `warning`\: This message is providing information you should take
|
3146
|
+
# into account.
|
3147
|
+
# @return [String]
|
3148
|
+
#
|
3149
|
+
# @!attribute [rw] namespace
|
3150
|
+
# @return [String]
|
3151
|
+
#
|
3152
|
+
# @!attribute [rw] option_name
|
3153
|
+
# @return [String]
|
3154
|
+
class ValidationMessage < Struct.new(
|
3155
|
+
:message,
|
3156
|
+
:severity,
|
3157
|
+
:namespace,
|
3158
|
+
:option_name)
|
3159
|
+
include Aws::Structure
|
3160
|
+
end
|
3161
|
+
|
3162
|
+
end
|
3163
|
+
end
|
3164
|
+
end
|