aws-sdk-mq 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-mq.rb +47 -0
- data/lib/aws-sdk-mq/client.rb +889 -0
- data/lib/aws-sdk-mq/client_api.rb +699 -0
- data/lib/aws-sdk-mq/customizations.rb +0 -0
- data/lib/aws-sdk-mq/errors.rb +14 -0
- data/lib/aws-sdk-mq/resource.rb +23 -0
- data/lib/aws-sdk-mq/types.rb +1825 -0
- metadata +82 -0
File without changes
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MQ
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MQ
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,1825 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MQ
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# Returns information about all brokers.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] console_url
|
14
|
+
# The URL of the broker's ActiveMQ Web Console.
|
15
|
+
# @return [String]
|
16
|
+
#
|
17
|
+
# @!attribute [rw] endpoints
|
18
|
+
# The broker's wire-level protocol endpoints.
|
19
|
+
# @return [Array<String>]
|
20
|
+
#
|
21
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/BrokerInstance AWS API Documentation
|
22
|
+
#
|
23
|
+
class BrokerInstance < Struct.new(
|
24
|
+
:console_url,
|
25
|
+
:endpoints)
|
26
|
+
include Aws::Structure
|
27
|
+
end
|
28
|
+
|
29
|
+
# The Amazon Resource Name (ARN) of the broker.
|
30
|
+
#
|
31
|
+
# @!attribute [rw] broker_arn
|
32
|
+
# The Amazon Resource Name (ARN) of the broker.
|
33
|
+
# @return [String]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] broker_id
|
36
|
+
# The unique ID that Amazon MQ generates for the broker.
|
37
|
+
# @return [String]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] broker_name
|
40
|
+
# The name of the broker. This value must be unique in your AWS
|
41
|
+
# account, 1-50 characters long, must contain only letters, numbers,
|
42
|
+
# dashes, and underscores, and must not contain whitespaces, brackets,
|
43
|
+
# wildcard characters, or special characters.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @!attribute [rw] broker_state
|
47
|
+
# The status of the broker. Possible values: CREATION\_IN\_PROGRESS,
|
48
|
+
# CREATION\_FAILED, DELETION\_IN\_PROGRESS, RUNNING,
|
49
|
+
# REBOOT\_IN\_PROGRESS
|
50
|
+
# @return [String]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] deployment_mode
|
53
|
+
# Required. The deployment mode of the broker. Possible values:
|
54
|
+
# SINGLE\_INSTANCE, ACTIVE\_STANDBY\_MULTI\_AZ SINGLE\_INSTANCE
|
55
|
+
# creates a single-instance broker in a single Availability Zone.
|
56
|
+
# ACTIVE\_STANDBY\_MULTI\_AZ creates an active/standby broker for high
|
57
|
+
# availability.
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] host_instance_type
|
61
|
+
# The broker's instance type. Possible values: mq.t2.micro,
|
62
|
+
# mq.m4.large
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/BrokerSummary AWS API Documentation
|
66
|
+
#
|
67
|
+
class BrokerSummary < Struct.new(
|
68
|
+
:broker_arn,
|
69
|
+
:broker_id,
|
70
|
+
:broker_name,
|
71
|
+
:broker_state,
|
72
|
+
:deployment_mode,
|
73
|
+
:host_instance_type)
|
74
|
+
include Aws::Structure
|
75
|
+
end
|
76
|
+
|
77
|
+
# Returns information about all configurations.
|
78
|
+
#
|
79
|
+
# @!attribute [rw] arn
|
80
|
+
# Required. The ARN of the configuration.
|
81
|
+
# @return [String]
|
82
|
+
#
|
83
|
+
# @!attribute [rw] description
|
84
|
+
# Required. The description of the configuration.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] engine_type
|
88
|
+
# Required. The type of broker engine. Note: Currently, Amazon MQ
|
89
|
+
# supports only ACTIVEMQ.
|
90
|
+
# @return [String]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] engine_version
|
93
|
+
# Required. The version of the broker engine.
|
94
|
+
# @return [String]
|
95
|
+
#
|
96
|
+
# @!attribute [rw] id
|
97
|
+
# Required. The unique ID that Amazon MQ generates for the
|
98
|
+
# configuration.
|
99
|
+
# @return [String]
|
100
|
+
#
|
101
|
+
# @!attribute [rw] latest_revision
|
102
|
+
# Required. The latest revision of the configuration.
|
103
|
+
# @return [Types::ConfigurationRevision]
|
104
|
+
#
|
105
|
+
# @!attribute [rw] name
|
106
|
+
# Required. The name of the configuration. This value can contain only
|
107
|
+
# alphanumeric characters, dashes, periods, underscores, and tildes (-
|
108
|
+
# . \_ ~). This value must be 1-150 characters long.
|
109
|
+
# @return [String]
|
110
|
+
#
|
111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/Configuration AWS API Documentation
|
112
|
+
#
|
113
|
+
class Configuration < Struct.new(
|
114
|
+
:arn,
|
115
|
+
:description,
|
116
|
+
:engine_type,
|
117
|
+
:engine_version,
|
118
|
+
:id,
|
119
|
+
:latest_revision,
|
120
|
+
:name)
|
121
|
+
include Aws::Structure
|
122
|
+
end
|
123
|
+
|
124
|
+
# A list of information about the configuration.
|
125
|
+
#
|
126
|
+
# @note When making an API call, you may pass ConfigurationId
|
127
|
+
# data as a hash:
|
128
|
+
#
|
129
|
+
# {
|
130
|
+
# id: "__string",
|
131
|
+
# revision: 1,
|
132
|
+
# }
|
133
|
+
#
|
134
|
+
# @!attribute [rw] id
|
135
|
+
# Required. The unique ID that Amazon MQ generates for the
|
136
|
+
# configuration.
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @!attribute [rw] revision
|
140
|
+
# The Universally Unique Identifier (UUID) of the request.
|
141
|
+
# @return [Integer]
|
142
|
+
#
|
143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ConfigurationId AWS API Documentation
|
144
|
+
#
|
145
|
+
class ConfigurationId < Struct.new(
|
146
|
+
:id,
|
147
|
+
:revision)
|
148
|
+
include Aws::Structure
|
149
|
+
end
|
150
|
+
|
151
|
+
# Returns information about the specified configuration revision.
|
152
|
+
#
|
153
|
+
# @!attribute [rw] description
|
154
|
+
# The description of the configuration revision.
|
155
|
+
# @return [String]
|
156
|
+
#
|
157
|
+
# @!attribute [rw] revision
|
158
|
+
# Required. The revision of the configuration.
|
159
|
+
# @return [Integer]
|
160
|
+
#
|
161
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ConfigurationRevision AWS API Documentation
|
162
|
+
#
|
163
|
+
class ConfigurationRevision < Struct.new(
|
164
|
+
:description,
|
165
|
+
:revision)
|
166
|
+
include Aws::Structure
|
167
|
+
end
|
168
|
+
|
169
|
+
# Broker configuration information
|
170
|
+
#
|
171
|
+
# @!attribute [rw] current
|
172
|
+
# The current configuration of the broker.
|
173
|
+
# @return [Types::ConfigurationId]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] history
|
176
|
+
# The history of configurations applied to the broker.
|
177
|
+
# @return [Array<Types::ConfigurationId>]
|
178
|
+
#
|
179
|
+
# @!attribute [rw] pending
|
180
|
+
# The pending configuration of the broker.
|
181
|
+
# @return [Types::ConfigurationId]
|
182
|
+
#
|
183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/Configurations AWS API Documentation
|
184
|
+
#
|
185
|
+
class Configurations < Struct.new(
|
186
|
+
:current,
|
187
|
+
:history,
|
188
|
+
:pending)
|
189
|
+
include Aws::Structure
|
190
|
+
end
|
191
|
+
|
192
|
+
# Required. The time period during which Amazon MQ applies pending
|
193
|
+
# updates or patches to the broker.
|
194
|
+
#
|
195
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
196
|
+
# Required. Enables automatic upgrades to new minor versions for
|
197
|
+
# brokers, as Apache releases the versions. The automatic upgrades
|
198
|
+
# occur during the maintenance window of the broker or after a manual
|
199
|
+
# broker reboot.
|
200
|
+
# @return [Boolean]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] broker_name
|
203
|
+
# Required. The name of the broker. This value must be unique in your
|
204
|
+
# AWS account, 1-50 characters long, must contain only letters,
|
205
|
+
# numbers, dashes, and underscores, and must not contain whitespaces,
|
206
|
+
# brackets, wildcard characters, or special characters.
|
207
|
+
# @return [String]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] configuration
|
210
|
+
# A list of information about the configuration.
|
211
|
+
# @return [Types::ConfigurationId]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] creator_request_id
|
214
|
+
# The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.**A suitable default value is auto-generated.** You should normally
|
215
|
+
# not need to pass this option.
|
216
|
+
# @return [String]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] deployment_mode
|
219
|
+
# Required. The deployment mode of the broker. Possible values:
|
220
|
+
# SINGLE\_INSTANCE, ACTIVE\_STANDBY\_MULTI\_AZ SINGLE\_INSTANCE
|
221
|
+
# creates a single-instance broker in a single Availability Zone.
|
222
|
+
# ACTIVE\_STANDBY\_MULTI\_AZ creates an active/standby broker for high
|
223
|
+
# availability.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] engine_type
|
227
|
+
# Required. The type of broker engine. Note: Currently, Amazon MQ
|
228
|
+
# supports only ACTIVEMQ.
|
229
|
+
# @return [String]
|
230
|
+
#
|
231
|
+
# @!attribute [rw] engine_version
|
232
|
+
# Required. The version of the broker engine. Note: Currently, Amazon
|
233
|
+
# MQ supports only 5.15.0.
|
234
|
+
# @return [String]
|
235
|
+
#
|
236
|
+
# @!attribute [rw] host_instance_type
|
237
|
+
# Required. The broker's instance type. Possible values: mq.t2.micro,
|
238
|
+
# mq.m4.large
|
239
|
+
# @return [String]
|
240
|
+
#
|
241
|
+
# @!attribute [rw] maintenance_window_start_time
|
242
|
+
# The parameters that determine the WeeklyStartTime.
|
243
|
+
# @return [Types::WeeklyStartTime]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] publicly_accessible
|
246
|
+
# Required. Enables connections from applications outside of the VPC
|
247
|
+
# that hosts the broker's subnets.
|
248
|
+
# @return [Boolean]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] security_groups
|
251
|
+
# Required. The list of rules (1 minimum, 125 maximum) that authorize
|
252
|
+
# connections to brokers.
|
253
|
+
# @return [Array<String>]
|
254
|
+
#
|
255
|
+
# @!attribute [rw] subnet_ids
|
256
|
+
# Required. The list of groups (2 maximum) that define which subnets
|
257
|
+
# and IP ranges the broker can use from different Availability Zones.
|
258
|
+
# A SINGLE\_INSTANCE deployment requires one subnet (for example, the
|
259
|
+
# default subnet). An ACTIVE\_STANDBY\_MULTI\_AZ deployment requires
|
260
|
+
# two subnets.
|
261
|
+
# @return [Array<String>]
|
262
|
+
#
|
263
|
+
# @!attribute [rw] users
|
264
|
+
# Required. The list of ActiveMQ users (persons or applications) who
|
265
|
+
# can access queues and topics. This value can contain only
|
266
|
+
# alphanumeric characters, dashes, periods, underscores, and tildes (-
|
267
|
+
# . \_ ~). This value must be 2-100 characters long.
|
268
|
+
# @return [Array<Types::User>]
|
269
|
+
#
|
270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerInput AWS API Documentation
|
271
|
+
#
|
272
|
+
class CreateBrokerInput < Struct.new(
|
273
|
+
:auto_minor_version_upgrade,
|
274
|
+
:broker_name,
|
275
|
+
:configuration,
|
276
|
+
:creator_request_id,
|
277
|
+
:deployment_mode,
|
278
|
+
:engine_type,
|
279
|
+
:engine_version,
|
280
|
+
:host_instance_type,
|
281
|
+
:maintenance_window_start_time,
|
282
|
+
:publicly_accessible,
|
283
|
+
:security_groups,
|
284
|
+
:subnet_ids,
|
285
|
+
:users)
|
286
|
+
include Aws::Structure
|
287
|
+
end
|
288
|
+
|
289
|
+
# Returns information about the created broker.
|
290
|
+
#
|
291
|
+
# @!attribute [rw] broker_arn
|
292
|
+
# The Amazon Resource Name (ARN) of the broker.
|
293
|
+
# @return [String]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] broker_id
|
296
|
+
# The unique ID that Amazon MQ generates for the broker.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerOutput AWS API Documentation
|
300
|
+
#
|
301
|
+
class CreateBrokerOutput < Struct.new(
|
302
|
+
:broker_arn,
|
303
|
+
:broker_id)
|
304
|
+
include Aws::Structure
|
305
|
+
end
|
306
|
+
|
307
|
+
# @note When making an API call, you may pass CreateBrokerRequest
|
308
|
+
# data as a hash:
|
309
|
+
#
|
310
|
+
# {
|
311
|
+
# auto_minor_version_upgrade: false,
|
312
|
+
# broker_name: "__string",
|
313
|
+
# configuration: {
|
314
|
+
# id: "__string",
|
315
|
+
# revision: 1,
|
316
|
+
# },
|
317
|
+
# creator_request_id: "__string",
|
318
|
+
# deployment_mode: "SINGLE_INSTANCE", # accepts SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
|
319
|
+
# engine_type: "ACTIVEMQ", # accepts ACTIVEMQ
|
320
|
+
# engine_version: "__string",
|
321
|
+
# host_instance_type: "__string",
|
322
|
+
# maintenance_window_start_time: {
|
323
|
+
# day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
|
324
|
+
# time_of_day: "__string",
|
325
|
+
# time_zone: "__string",
|
326
|
+
# },
|
327
|
+
# publicly_accessible: false,
|
328
|
+
# security_groups: ["__string"],
|
329
|
+
# subnet_ids: ["__string"],
|
330
|
+
# users: [
|
331
|
+
# {
|
332
|
+
# console_access: false,
|
333
|
+
# groups: ["__string"],
|
334
|
+
# password: "__string",
|
335
|
+
# username: "__string",
|
336
|
+
# },
|
337
|
+
# ],
|
338
|
+
# }
|
339
|
+
#
|
340
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
341
|
+
# @return [Boolean]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] broker_name
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] configuration
|
347
|
+
# A list of information about the configuration.
|
348
|
+
# @return [Types::ConfigurationId]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] creator_request_id
|
351
|
+
# **A suitable default value is auto-generated.** You should normally
|
352
|
+
# not need to pass this option.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @!attribute [rw] deployment_mode
|
356
|
+
# The deployment mode of the broker. Possible values:
|
357
|
+
# SINGLE\_INSTANCE, ACTIVE\_STANDBY\_MULTI\_AZ SINGLE\_INSTANCE
|
358
|
+
# creates a single-instance broker in a single Availability Zone.
|
359
|
+
# ACTIVE\_STANDBY\_MULTI\_AZ creates an active/standby broker for high
|
360
|
+
# availability.
|
361
|
+
# @return [String]
|
362
|
+
#
|
363
|
+
# @!attribute [rw] engine_type
|
364
|
+
# The type of broker engine. Note: Currently, Amazon MQ supports only
|
365
|
+
# ActiveMQ.
|
366
|
+
# @return [String]
|
367
|
+
#
|
368
|
+
# @!attribute [rw] engine_version
|
369
|
+
# @return [String]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] host_instance_type
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] maintenance_window_start_time
|
375
|
+
# The scheduled time period relative to UTC during which Amazon MQ
|
376
|
+
# begins to apply pending updates or patches to the broker.
|
377
|
+
# @return [Types::WeeklyStartTime]
|
378
|
+
#
|
379
|
+
# @!attribute [rw] publicly_accessible
|
380
|
+
# @return [Boolean]
|
381
|
+
#
|
382
|
+
# @!attribute [rw] security_groups
|
383
|
+
# @return [Array<String>]
|
384
|
+
#
|
385
|
+
# @!attribute [rw] subnet_ids
|
386
|
+
# @return [Array<String>]
|
387
|
+
#
|
388
|
+
# @!attribute [rw] users
|
389
|
+
# @return [Array<Types::User>]
|
390
|
+
#
|
391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerRequest AWS API Documentation
|
392
|
+
#
|
393
|
+
class CreateBrokerRequest < Struct.new(
|
394
|
+
:auto_minor_version_upgrade,
|
395
|
+
:broker_name,
|
396
|
+
:configuration,
|
397
|
+
:creator_request_id,
|
398
|
+
:deployment_mode,
|
399
|
+
:engine_type,
|
400
|
+
:engine_version,
|
401
|
+
:host_instance_type,
|
402
|
+
:maintenance_window_start_time,
|
403
|
+
:publicly_accessible,
|
404
|
+
:security_groups,
|
405
|
+
:subnet_ids,
|
406
|
+
:users)
|
407
|
+
include Aws::Structure
|
408
|
+
end
|
409
|
+
|
410
|
+
# @!attribute [rw] broker_arn
|
411
|
+
# @return [String]
|
412
|
+
#
|
413
|
+
# @!attribute [rw] broker_id
|
414
|
+
# @return [String]
|
415
|
+
#
|
416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerResponse AWS API Documentation
|
417
|
+
#
|
418
|
+
class CreateBrokerResponse < Struct.new(
|
419
|
+
:broker_arn,
|
420
|
+
:broker_id)
|
421
|
+
include Aws::Structure
|
422
|
+
end
|
423
|
+
|
424
|
+
# Creates a new configuration for the specified configuration name.
|
425
|
+
# Amazon MQ uses the default configuration (the engine type and
|
426
|
+
# version). Note: If the configuration name already exists, Amazon MQ
|
427
|
+
# doesn't create a configuration.
|
428
|
+
#
|
429
|
+
# @!attribute [rw] engine_type
|
430
|
+
# Required. The type of broker engine. Note: Currently, Amazon MQ
|
431
|
+
# supports only ACTIVEMQ.
|
432
|
+
# @return [String]
|
433
|
+
#
|
434
|
+
# @!attribute [rw] engine_version
|
435
|
+
# Required. The version of the broker engine. Note: Currently, Amazon
|
436
|
+
# MQ supports only 5.15.0.
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] name
|
440
|
+
# Required. The name of the configuration. This value can contain only
|
441
|
+
# alphanumeric characters, dashes, periods, underscores, and tildes (-
|
442
|
+
# . \_ ~). This value must be 1-150 characters long.
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfigurationInput AWS API Documentation
|
446
|
+
#
|
447
|
+
class CreateConfigurationInput < Struct.new(
|
448
|
+
:engine_type,
|
449
|
+
:engine_version,
|
450
|
+
:name)
|
451
|
+
include Aws::Structure
|
452
|
+
end
|
453
|
+
|
454
|
+
# Returns information about the created configuration.
|
455
|
+
#
|
456
|
+
# @!attribute [rw] arn
|
457
|
+
# Required. The Amazon Resource Name (ARN) of the configuration.
|
458
|
+
# @return [String]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] id
|
461
|
+
# Required. The unique ID that Amazon MQ generates for the
|
462
|
+
# configuration.
|
463
|
+
# @return [String]
|
464
|
+
#
|
465
|
+
# @!attribute [rw] latest_revision
|
466
|
+
# The latest revision of the configuration.
|
467
|
+
# @return [Types::ConfigurationRevision]
|
468
|
+
#
|
469
|
+
# @!attribute [rw] name
|
470
|
+
# Required. The name of the configuration. This value can contain only
|
471
|
+
# alphanumeric characters, dashes, periods, underscores, and tildes (-
|
472
|
+
# . \_ ~). This value must be 1-150 characters long.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfigurationOutput AWS API Documentation
|
476
|
+
#
|
477
|
+
class CreateConfigurationOutput < Struct.new(
|
478
|
+
:arn,
|
479
|
+
:id,
|
480
|
+
:latest_revision,
|
481
|
+
:name)
|
482
|
+
include Aws::Structure
|
483
|
+
end
|
484
|
+
|
485
|
+
# @note When making an API call, you may pass CreateConfigurationRequest
|
486
|
+
# data as a hash:
|
487
|
+
#
|
488
|
+
# {
|
489
|
+
# engine_type: "ACTIVEMQ", # accepts ACTIVEMQ
|
490
|
+
# engine_version: "__string",
|
491
|
+
# name: "__string",
|
492
|
+
# }
|
493
|
+
#
|
494
|
+
# @!attribute [rw] engine_type
|
495
|
+
# The type of broker engine. Note: Currently, Amazon MQ supports only
|
496
|
+
# ActiveMQ.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] engine_version
|
500
|
+
# @return [String]
|
501
|
+
#
|
502
|
+
# @!attribute [rw] name
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfigurationRequest AWS API Documentation
|
506
|
+
#
|
507
|
+
class CreateConfigurationRequest < Struct.new(
|
508
|
+
:engine_type,
|
509
|
+
:engine_version,
|
510
|
+
:name)
|
511
|
+
include Aws::Structure
|
512
|
+
end
|
513
|
+
|
514
|
+
# @!attribute [rw] arn
|
515
|
+
# @return [String]
|
516
|
+
#
|
517
|
+
# @!attribute [rw] id
|
518
|
+
# @return [String]
|
519
|
+
#
|
520
|
+
# @!attribute [rw] latest_revision
|
521
|
+
# Returns information about the specified configuration revision.
|
522
|
+
# @return [Types::ConfigurationRevision]
|
523
|
+
#
|
524
|
+
# @!attribute [rw] name
|
525
|
+
# @return [String]
|
526
|
+
#
|
527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateConfigurationResponse AWS API Documentation
|
528
|
+
#
|
529
|
+
class CreateConfigurationResponse < Struct.new(
|
530
|
+
:arn,
|
531
|
+
:id,
|
532
|
+
:latest_revision,
|
533
|
+
:name)
|
534
|
+
include Aws::Structure
|
535
|
+
end
|
536
|
+
|
537
|
+
# Creates a new ActiveMQ user.
|
538
|
+
#
|
539
|
+
# @!attribute [rw] console_access
|
540
|
+
# Enables access to the the ActiveMQ Web Console for the ActiveMQ
|
541
|
+
# user.
|
542
|
+
# @return [Boolean]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] groups
|
545
|
+
# The list of groups (20 maximum) to which the ActiveMQ user belongs.
|
546
|
+
# This value can contain only alphanumeric characters, dashes,
|
547
|
+
# periods, underscores, and tildes (- . \_ ~). This value must be
|
548
|
+
# 2-100 characters long.
|
549
|
+
# @return [Array<String>]
|
550
|
+
#
|
551
|
+
# @!attribute [rw] password
|
552
|
+
# Required. The password of the user. This value must be at least 12
|
553
|
+
# characters long, must contain at least 4 unique characters, and must
|
554
|
+
# not contain commas.
|
555
|
+
# @return [String]
|
556
|
+
#
|
557
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUserInput AWS API Documentation
|
558
|
+
#
|
559
|
+
class CreateUserInput < Struct.new(
|
560
|
+
:console_access,
|
561
|
+
:groups,
|
562
|
+
:password)
|
563
|
+
include Aws::Structure
|
564
|
+
end
|
565
|
+
|
566
|
+
# @note When making an API call, you may pass CreateUserRequest
|
567
|
+
# data as a hash:
|
568
|
+
#
|
569
|
+
# {
|
570
|
+
# broker_id: "__string", # required
|
571
|
+
# console_access: false,
|
572
|
+
# groups: ["__string"],
|
573
|
+
# password: "__string",
|
574
|
+
# username: "__string", # required
|
575
|
+
# }
|
576
|
+
#
|
577
|
+
# @!attribute [rw] broker_id
|
578
|
+
# @return [String]
|
579
|
+
#
|
580
|
+
# @!attribute [rw] console_access
|
581
|
+
# @return [Boolean]
|
582
|
+
#
|
583
|
+
# @!attribute [rw] groups
|
584
|
+
# @return [Array<String>]
|
585
|
+
#
|
586
|
+
# @!attribute [rw] password
|
587
|
+
# @return [String]
|
588
|
+
#
|
589
|
+
# @!attribute [rw] username
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUserRequest AWS API Documentation
|
593
|
+
#
|
594
|
+
class CreateUserRequest < Struct.new(
|
595
|
+
:broker_id,
|
596
|
+
:console_access,
|
597
|
+
:groups,
|
598
|
+
:password,
|
599
|
+
:username)
|
600
|
+
include Aws::Structure
|
601
|
+
end
|
602
|
+
|
603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUserResponse AWS API Documentation
|
604
|
+
#
|
605
|
+
class CreateUserResponse < Aws::EmptyStructure; end
|
606
|
+
|
607
|
+
# Returns information about the deleted broker.
|
608
|
+
#
|
609
|
+
# @!attribute [rw] broker_id
|
610
|
+
# The unique ID that Amazon MQ generates for the broker.
|
611
|
+
# @return [String]
|
612
|
+
#
|
613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBrokerOutput AWS API Documentation
|
614
|
+
#
|
615
|
+
class DeleteBrokerOutput < Struct.new(
|
616
|
+
:broker_id)
|
617
|
+
include Aws::Structure
|
618
|
+
end
|
619
|
+
|
620
|
+
# @note When making an API call, you may pass DeleteBrokerRequest
|
621
|
+
# data as a hash:
|
622
|
+
#
|
623
|
+
# {
|
624
|
+
# broker_id: "__string", # required
|
625
|
+
# }
|
626
|
+
#
|
627
|
+
# @!attribute [rw] broker_id
|
628
|
+
# @return [String]
|
629
|
+
#
|
630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBrokerRequest AWS API Documentation
|
631
|
+
#
|
632
|
+
class DeleteBrokerRequest < Struct.new(
|
633
|
+
:broker_id)
|
634
|
+
include Aws::Structure
|
635
|
+
end
|
636
|
+
|
637
|
+
# @!attribute [rw] broker_id
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteBrokerResponse AWS API Documentation
|
641
|
+
#
|
642
|
+
class DeleteBrokerResponse < Struct.new(
|
643
|
+
:broker_id)
|
644
|
+
include Aws::Structure
|
645
|
+
end
|
646
|
+
|
647
|
+
# @note When making an API call, you may pass DeleteUserRequest
|
648
|
+
# data as a hash:
|
649
|
+
#
|
650
|
+
# {
|
651
|
+
# broker_id: "__string", # required
|
652
|
+
# username: "__string", # required
|
653
|
+
# }
|
654
|
+
#
|
655
|
+
# @!attribute [rw] broker_id
|
656
|
+
# @return [String]
|
657
|
+
#
|
658
|
+
# @!attribute [rw] username
|
659
|
+
# @return [String]
|
660
|
+
#
|
661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteUserRequest AWS API Documentation
|
662
|
+
#
|
663
|
+
class DeleteUserRequest < Struct.new(
|
664
|
+
:broker_id,
|
665
|
+
:username)
|
666
|
+
include Aws::Structure
|
667
|
+
end
|
668
|
+
|
669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DeleteUserResponse AWS API Documentation
|
670
|
+
#
|
671
|
+
class DeleteUserResponse < Aws::EmptyStructure; end
|
672
|
+
|
673
|
+
# The version of the broker engine. Note: Currently, Amazon MQ supports
|
674
|
+
# only 5.15.0.
|
675
|
+
#
|
676
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
677
|
+
# Required. Enables automatic upgrades to new minor versions for
|
678
|
+
# brokers, as Apache releases the versions. The automatic upgrades
|
679
|
+
# occur during the maintenance window of the broker or after a manual
|
680
|
+
# broker reboot.
|
681
|
+
# @return [Boolean]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] broker_arn
|
684
|
+
# The Amazon Resource Name (ARN) of the broker.
|
685
|
+
# @return [String]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] broker_id
|
688
|
+
# The unique ID that Amazon MQ generates for the broker.
|
689
|
+
# @return [String]
|
690
|
+
#
|
691
|
+
# @!attribute [rw] broker_instances
|
692
|
+
# A list of information about allocated brokers.
|
693
|
+
# @return [Array<Types::BrokerInstance>]
|
694
|
+
#
|
695
|
+
# @!attribute [rw] broker_name
|
696
|
+
# The name of the broker. This value must be unique in your AWS
|
697
|
+
# account, 1-50 characters long, must contain only letters, numbers,
|
698
|
+
# dashes, and underscores, and must not contain whitespaces, brackets,
|
699
|
+
# wildcard characters, or special characters.
|
700
|
+
# @return [String]
|
701
|
+
#
|
702
|
+
# @!attribute [rw] broker_state
|
703
|
+
# The status of the broker. Possible values: CREATION\_IN\_PROGRESS,
|
704
|
+
# CREATION\_FAILED, DELETION\_IN\_PROGRESS, RUNNING,
|
705
|
+
# REBOOT\_IN\_PROGRESS
|
706
|
+
# @return [String]
|
707
|
+
#
|
708
|
+
# @!attribute [rw] configurations
|
709
|
+
# The list of all revisions for the specified configuration.
|
710
|
+
# @return [Types::Configurations]
|
711
|
+
#
|
712
|
+
# @!attribute [rw] deployment_mode
|
713
|
+
# Required. The deployment mode of the broker. Possible values:
|
714
|
+
# SINGLE\_INSTANCE, ACTIVE\_STANDBY\_MULTI\_AZ SINGLE\_INSTANCE
|
715
|
+
# creates a single-instance broker in a single Availability Zone.
|
716
|
+
# ACTIVE\_STANDBY\_MULTI\_AZ creates an active/standby broker for high
|
717
|
+
# availability.
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] engine_type
|
721
|
+
# Required. The type of broker engine. Note: Currently, Amazon MQ
|
722
|
+
# supports only ACTIVEMQ.
|
723
|
+
# @return [String]
|
724
|
+
#
|
725
|
+
# @!attribute [rw] engine_version
|
726
|
+
# The version of the broker engine. Note: Currently, Amazon MQ
|
727
|
+
# supports only 5.15.0.
|
728
|
+
# @return [String]
|
729
|
+
#
|
730
|
+
# @!attribute [rw] host_instance_type
|
731
|
+
# The broker's instance type. Possible values: mq.t2.micro,
|
732
|
+
# mq.m4.large
|
733
|
+
# @return [String]
|
734
|
+
#
|
735
|
+
# @!attribute [rw] maintenance_window_start_time
|
736
|
+
# The parameters that determine the WeeklyStartTime.
|
737
|
+
# @return [Types::WeeklyStartTime]
|
738
|
+
#
|
739
|
+
# @!attribute [rw] publicly_accessible
|
740
|
+
# Required. Enables connections from applications outside of the VPC
|
741
|
+
# that hosts the broker's subnets.
|
742
|
+
# @return [Boolean]
|
743
|
+
#
|
744
|
+
# @!attribute [rw] security_groups
|
745
|
+
# Required. The list of rules (1 minimum, 125 maximum) that authorize
|
746
|
+
# connections to brokers.
|
747
|
+
# @return [Array<String>]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] subnet_ids
|
750
|
+
# The list of groups (2 maximum) that define which subnets and IP
|
751
|
+
# ranges the broker can use from different Availability Zones. A
|
752
|
+
# SINGLE\_INSTANCE deployment requires one subnet (for example, the
|
753
|
+
# default subnet). An ACTIVE\_STANDBY\_MULTI\_AZ deployment requires
|
754
|
+
# two subnets.
|
755
|
+
# @return [Array<String>]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] users
|
758
|
+
# The list of all ActiveMQ usernames for the specified broker.
|
759
|
+
# @return [Array<Types::UserSummary>]
|
760
|
+
#
|
761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBrokerOutput AWS API Documentation
|
762
|
+
#
|
763
|
+
class DescribeBrokerOutput < Struct.new(
|
764
|
+
:auto_minor_version_upgrade,
|
765
|
+
:broker_arn,
|
766
|
+
:broker_id,
|
767
|
+
:broker_instances,
|
768
|
+
:broker_name,
|
769
|
+
:broker_state,
|
770
|
+
:configurations,
|
771
|
+
:deployment_mode,
|
772
|
+
:engine_type,
|
773
|
+
:engine_version,
|
774
|
+
:host_instance_type,
|
775
|
+
:maintenance_window_start_time,
|
776
|
+
:publicly_accessible,
|
777
|
+
:security_groups,
|
778
|
+
:subnet_ids,
|
779
|
+
:users)
|
780
|
+
include Aws::Structure
|
781
|
+
end
|
782
|
+
|
783
|
+
# @note When making an API call, you may pass DescribeBrokerRequest
|
784
|
+
# data as a hash:
|
785
|
+
#
|
786
|
+
# {
|
787
|
+
# broker_id: "__string", # required
|
788
|
+
# }
|
789
|
+
#
|
790
|
+
# @!attribute [rw] broker_id
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBrokerRequest AWS API Documentation
|
794
|
+
#
|
795
|
+
class DescribeBrokerRequest < Struct.new(
|
796
|
+
:broker_id)
|
797
|
+
include Aws::Structure
|
798
|
+
end
|
799
|
+
|
800
|
+
# @!attribute [rw] auto_minor_version_upgrade
|
801
|
+
# @return [Boolean]
|
802
|
+
#
|
803
|
+
# @!attribute [rw] broker_arn
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @!attribute [rw] broker_id
|
807
|
+
# @return [String]
|
808
|
+
#
|
809
|
+
# @!attribute [rw] broker_instances
|
810
|
+
# @return [Array<Types::BrokerInstance>]
|
811
|
+
#
|
812
|
+
# @!attribute [rw] broker_name
|
813
|
+
# @return [String]
|
814
|
+
#
|
815
|
+
# @!attribute [rw] broker_state
|
816
|
+
# The status of the broker. Possible values: CREATION\_IN\_PROGRESS,
|
817
|
+
# CREATION\_FAILED, DELETION\_IN\_PROGRESS, RUNNING,
|
818
|
+
# REBOOT\_IN\_PROGRESS
|
819
|
+
# @return [String]
|
820
|
+
#
|
821
|
+
# @!attribute [rw] configurations
|
822
|
+
# Broker configuration information
|
823
|
+
# @return [Types::Configurations]
|
824
|
+
#
|
825
|
+
# @!attribute [rw] deployment_mode
|
826
|
+
# The deployment mode of the broker. Possible values:
|
827
|
+
# SINGLE\_INSTANCE, ACTIVE\_STANDBY\_MULTI\_AZ SINGLE\_INSTANCE
|
828
|
+
# creates a single-instance broker in a single Availability Zone.
|
829
|
+
# ACTIVE\_STANDBY\_MULTI\_AZ creates an active/standby broker for high
|
830
|
+
# availability.
|
831
|
+
# @return [String]
|
832
|
+
#
|
833
|
+
# @!attribute [rw] engine_type
|
834
|
+
# The type of broker engine. Note: Currently, Amazon MQ supports only
|
835
|
+
# ActiveMQ.
|
836
|
+
# @return [String]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] engine_version
|
839
|
+
# @return [String]
|
840
|
+
#
|
841
|
+
# @!attribute [rw] host_instance_type
|
842
|
+
# @return [String]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] maintenance_window_start_time
|
845
|
+
# The scheduled time period relative to UTC during which Amazon MQ
|
846
|
+
# begins to apply pending updates or patches to the broker.
|
847
|
+
# @return [Types::WeeklyStartTime]
|
848
|
+
#
|
849
|
+
# @!attribute [rw] publicly_accessible
|
850
|
+
# @return [Boolean]
|
851
|
+
#
|
852
|
+
# @!attribute [rw] security_groups
|
853
|
+
# @return [Array<String>]
|
854
|
+
#
|
855
|
+
# @!attribute [rw] subnet_ids
|
856
|
+
# @return [Array<String>]
|
857
|
+
#
|
858
|
+
# @!attribute [rw] users
|
859
|
+
# @return [Array<Types::UserSummary>]
|
860
|
+
#
|
861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBrokerResponse AWS API Documentation
|
862
|
+
#
|
863
|
+
class DescribeBrokerResponse < Struct.new(
|
864
|
+
:auto_minor_version_upgrade,
|
865
|
+
:broker_arn,
|
866
|
+
:broker_id,
|
867
|
+
:broker_instances,
|
868
|
+
:broker_name,
|
869
|
+
:broker_state,
|
870
|
+
:configurations,
|
871
|
+
:deployment_mode,
|
872
|
+
:engine_type,
|
873
|
+
:engine_version,
|
874
|
+
:host_instance_type,
|
875
|
+
:maintenance_window_start_time,
|
876
|
+
:publicly_accessible,
|
877
|
+
:security_groups,
|
878
|
+
:subnet_ids,
|
879
|
+
:users)
|
880
|
+
include Aws::Structure
|
881
|
+
end
|
882
|
+
|
883
|
+
# @note When making an API call, you may pass DescribeConfigurationRequest
|
884
|
+
# data as a hash:
|
885
|
+
#
|
886
|
+
# {
|
887
|
+
# configuration_id: "__string", # required
|
888
|
+
# }
|
889
|
+
#
|
890
|
+
# @!attribute [rw] configuration_id
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRequest AWS API Documentation
|
894
|
+
#
|
895
|
+
class DescribeConfigurationRequest < Struct.new(
|
896
|
+
:configuration_id)
|
897
|
+
include Aws::Structure
|
898
|
+
end
|
899
|
+
|
900
|
+
# @!attribute [rw] arn
|
901
|
+
# @return [String]
|
902
|
+
#
|
903
|
+
# @!attribute [rw] description
|
904
|
+
# @return [String]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] engine_type
|
907
|
+
# The type of broker engine. Note: Currently, Amazon MQ supports only
|
908
|
+
# ActiveMQ.
|
909
|
+
# @return [String]
|
910
|
+
#
|
911
|
+
# @!attribute [rw] engine_version
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @!attribute [rw] id
|
915
|
+
# @return [String]
|
916
|
+
#
|
917
|
+
# @!attribute [rw] latest_revision
|
918
|
+
# Returns information about the specified configuration revision.
|
919
|
+
# @return [Types::ConfigurationRevision]
|
920
|
+
#
|
921
|
+
# @!attribute [rw] name
|
922
|
+
# @return [String]
|
923
|
+
#
|
924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationResponse AWS API Documentation
|
925
|
+
#
|
926
|
+
class DescribeConfigurationResponse < Struct.new(
|
927
|
+
:arn,
|
928
|
+
:description,
|
929
|
+
:engine_type,
|
930
|
+
:engine_version,
|
931
|
+
:id,
|
932
|
+
:latest_revision,
|
933
|
+
:name)
|
934
|
+
include Aws::Structure
|
935
|
+
end
|
936
|
+
|
937
|
+
# Returns the specified configuration revision for the specified
|
938
|
+
# configuration.
|
939
|
+
#
|
940
|
+
# @!attribute [rw] configuration_id
|
941
|
+
# Required. The unique ID that Amazon MQ generates for the
|
942
|
+
# configuration.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] data
|
946
|
+
# Required. The base64-encoded XML configuration.
|
947
|
+
# @return [String]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] description
|
950
|
+
# The description of the configuration.
|
951
|
+
# @return [String]
|
952
|
+
#
|
953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevisionOutput AWS API Documentation
|
954
|
+
#
|
955
|
+
class DescribeConfigurationRevisionOutput < Struct.new(
|
956
|
+
:configuration_id,
|
957
|
+
:data,
|
958
|
+
:description)
|
959
|
+
include Aws::Structure
|
960
|
+
end
|
961
|
+
|
962
|
+
# @note When making an API call, you may pass DescribeConfigurationRevisionRequest
|
963
|
+
# data as a hash:
|
964
|
+
#
|
965
|
+
# {
|
966
|
+
# configuration_id: "__string", # required
|
967
|
+
# configuration_revision: "__string", # required
|
968
|
+
# }
|
969
|
+
#
|
970
|
+
# @!attribute [rw] configuration_id
|
971
|
+
# @return [String]
|
972
|
+
#
|
973
|
+
# @!attribute [rw] configuration_revision
|
974
|
+
# @return [String]
|
975
|
+
#
|
976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevisionRequest AWS API Documentation
|
977
|
+
#
|
978
|
+
class DescribeConfigurationRevisionRequest < Struct.new(
|
979
|
+
:configuration_id,
|
980
|
+
:configuration_revision)
|
981
|
+
include Aws::Structure
|
982
|
+
end
|
983
|
+
|
984
|
+
# @!attribute [rw] configuration_id
|
985
|
+
# @return [String]
|
986
|
+
#
|
987
|
+
# @!attribute [rw] data
|
988
|
+
# @return [String]
|
989
|
+
#
|
990
|
+
# @!attribute [rw] description
|
991
|
+
# @return [String]
|
992
|
+
#
|
993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeConfigurationRevisionResponse AWS API Documentation
|
994
|
+
#
|
995
|
+
class DescribeConfigurationRevisionResponse < Struct.new(
|
996
|
+
:configuration_id,
|
997
|
+
:data,
|
998
|
+
:description)
|
999
|
+
include Aws::Structure
|
1000
|
+
end
|
1001
|
+
|
1002
|
+
# Returns information about an ActiveMQ user.
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] broker_id
|
1005
|
+
# Required. The unique ID that Amazon MQ generates for the broker.
|
1006
|
+
# @return [String]
|
1007
|
+
#
|
1008
|
+
# @!attribute [rw] console_access
|
1009
|
+
# Enables access to the the ActiveMQ Web Console for the ActiveMQ
|
1010
|
+
# user.
|
1011
|
+
# @return [Boolean]
|
1012
|
+
#
|
1013
|
+
# @!attribute [rw] groups
|
1014
|
+
# The list of groups (20 maximum) to which the ActiveMQ user belongs.
|
1015
|
+
# This value can contain only alphanumeric characters, dashes,
|
1016
|
+
# periods, underscores, and tildes (- . \_ ~). This value must be
|
1017
|
+
# 2-100 characters long.
|
1018
|
+
# @return [Array<String>]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] pending
|
1021
|
+
# The status of the changes pending for the ActiveMQ user.
|
1022
|
+
# @return [Types::UserPendingChanges]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] username
|
1025
|
+
# Required. The username of the ActiveMQ user. This value can contain
|
1026
|
+
# only alphanumeric characters, dashes, periods, underscores, and
|
1027
|
+
# tildes (- . \_ ~). This value must be 2-100 characters long.
|
1028
|
+
# @return [String]
|
1029
|
+
#
|
1030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUserOutput AWS API Documentation
|
1031
|
+
#
|
1032
|
+
class DescribeUserOutput < Struct.new(
|
1033
|
+
:broker_id,
|
1034
|
+
:console_access,
|
1035
|
+
:groups,
|
1036
|
+
:pending,
|
1037
|
+
:username)
|
1038
|
+
include Aws::Structure
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# @note When making an API call, you may pass DescribeUserRequest
|
1042
|
+
# data as a hash:
|
1043
|
+
#
|
1044
|
+
# {
|
1045
|
+
# broker_id: "__string", # required
|
1046
|
+
# username: "__string", # required
|
1047
|
+
# }
|
1048
|
+
#
|
1049
|
+
# @!attribute [rw] broker_id
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] username
|
1053
|
+
# @return [String]
|
1054
|
+
#
|
1055
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUserRequest AWS API Documentation
|
1056
|
+
#
|
1057
|
+
class DescribeUserRequest < Struct.new(
|
1058
|
+
:broker_id,
|
1059
|
+
:username)
|
1060
|
+
include Aws::Structure
|
1061
|
+
end
|
1062
|
+
|
1063
|
+
# @!attribute [rw] broker_id
|
1064
|
+
# @return [String]
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] console_access
|
1067
|
+
# @return [Boolean]
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] groups
|
1070
|
+
# @return [Array<String>]
|
1071
|
+
#
|
1072
|
+
# @!attribute [rw] pending
|
1073
|
+
# Returns information about the status of the changes pending for the
|
1074
|
+
# ActiveMQ user.
|
1075
|
+
# @return [Types::UserPendingChanges]
|
1076
|
+
#
|
1077
|
+
# @!attribute [rw] username
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
1080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUserResponse AWS API Documentation
|
1081
|
+
#
|
1082
|
+
class DescribeUserResponse < Struct.new(
|
1083
|
+
:broker_id,
|
1084
|
+
:console_access,
|
1085
|
+
:groups,
|
1086
|
+
:pending,
|
1087
|
+
:username)
|
1088
|
+
include Aws::Structure
|
1089
|
+
end
|
1090
|
+
|
1091
|
+
# Returns information about an error.
|
1092
|
+
#
|
1093
|
+
# @!attribute [rw] error_attribute
|
1094
|
+
# The error attribute.
|
1095
|
+
# @return [String]
|
1096
|
+
#
|
1097
|
+
# @!attribute [rw] message
|
1098
|
+
# The error message.
|
1099
|
+
# @return [String]
|
1100
|
+
#
|
1101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/Error AWS API Documentation
|
1102
|
+
#
|
1103
|
+
class Error < Struct.new(
|
1104
|
+
:error_attribute,
|
1105
|
+
:message)
|
1106
|
+
include Aws::Structure
|
1107
|
+
end
|
1108
|
+
|
1109
|
+
# A list of information about all brokers.
|
1110
|
+
#
|
1111
|
+
# @!attribute [rw] broker_summaries
|
1112
|
+
# A list of information about all brokers.
|
1113
|
+
# @return [Array<Types::BrokerSummary>]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] next_token
|
1116
|
+
# The token that specifies the next page of results Amazon MQ should
|
1117
|
+
# return. To request the first page, leave nextToken empty.
|
1118
|
+
# @return [String]
|
1119
|
+
#
|
1120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokersOutput AWS API Documentation
|
1121
|
+
#
|
1122
|
+
class ListBrokersOutput < Struct.new(
|
1123
|
+
:broker_summaries,
|
1124
|
+
:next_token)
|
1125
|
+
include Aws::Structure
|
1126
|
+
end
|
1127
|
+
|
1128
|
+
# @note When making an API call, you may pass ListBrokersRequest
|
1129
|
+
# data as a hash:
|
1130
|
+
#
|
1131
|
+
# {
|
1132
|
+
# max_results: 1,
|
1133
|
+
# next_token: "__string",
|
1134
|
+
# }
|
1135
|
+
#
|
1136
|
+
# @!attribute [rw] max_results
|
1137
|
+
# @return [Integer]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] next_token
|
1140
|
+
# @return [String]
|
1141
|
+
#
|
1142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokersRequest AWS API Documentation
|
1143
|
+
#
|
1144
|
+
class ListBrokersRequest < Struct.new(
|
1145
|
+
:max_results,
|
1146
|
+
:next_token)
|
1147
|
+
include Aws::Structure
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# @!attribute [rw] broker_summaries
|
1151
|
+
# @return [Array<Types::BrokerSummary>]
|
1152
|
+
#
|
1153
|
+
# @!attribute [rw] next_token
|
1154
|
+
# @return [String]
|
1155
|
+
#
|
1156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListBrokersResponse AWS API Documentation
|
1157
|
+
#
|
1158
|
+
class ListBrokersResponse < Struct.new(
|
1159
|
+
:broker_summaries,
|
1160
|
+
:next_token)
|
1161
|
+
include Aws::Structure
|
1162
|
+
end
|
1163
|
+
|
1164
|
+
# Returns a list of all revisions for the specified configuration.
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] configuration_id
|
1167
|
+
# The unique ID that Amazon MQ generates for the configuration.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] max_results
|
1171
|
+
# The maximum number of configuration revisions that can be returned
|
1172
|
+
# per page (20 by default). This value must be an integer from 5 to
|
1173
|
+
# 100.
|
1174
|
+
# @return [Integer]
|
1175
|
+
#
|
1176
|
+
# @!attribute [rw] next_token
|
1177
|
+
# The token that specifies the next page of results Amazon MQ should
|
1178
|
+
# return. To request the first page, leave nextToken empty.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] revisions
|
1182
|
+
# The list of all revisions for the specified configuration.
|
1183
|
+
# @return [Array<Types::ConfigurationRevision>]
|
1184
|
+
#
|
1185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisionsOutput AWS API Documentation
|
1186
|
+
#
|
1187
|
+
class ListConfigurationRevisionsOutput < Struct.new(
|
1188
|
+
:configuration_id,
|
1189
|
+
:max_results,
|
1190
|
+
:next_token,
|
1191
|
+
:revisions)
|
1192
|
+
include Aws::Structure
|
1193
|
+
end
|
1194
|
+
|
1195
|
+
# @note When making an API call, you may pass ListConfigurationRevisionsRequest
|
1196
|
+
# data as a hash:
|
1197
|
+
#
|
1198
|
+
# {
|
1199
|
+
# configuration_id: "__string", # required
|
1200
|
+
# max_results: 1,
|
1201
|
+
# next_token: "__string",
|
1202
|
+
# }
|
1203
|
+
#
|
1204
|
+
# @!attribute [rw] configuration_id
|
1205
|
+
# @return [String]
|
1206
|
+
#
|
1207
|
+
# @!attribute [rw] max_results
|
1208
|
+
# @return [Integer]
|
1209
|
+
#
|
1210
|
+
# @!attribute [rw] next_token
|
1211
|
+
# @return [String]
|
1212
|
+
#
|
1213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisionsRequest AWS API Documentation
|
1214
|
+
#
|
1215
|
+
class ListConfigurationRevisionsRequest < Struct.new(
|
1216
|
+
:configuration_id,
|
1217
|
+
:max_results,
|
1218
|
+
:next_token)
|
1219
|
+
include Aws::Structure
|
1220
|
+
end
|
1221
|
+
|
1222
|
+
# @!attribute [rw] configuration_id
|
1223
|
+
# @return [String]
|
1224
|
+
#
|
1225
|
+
# @!attribute [rw] max_results
|
1226
|
+
# @return [Integer]
|
1227
|
+
#
|
1228
|
+
# @!attribute [rw] next_token
|
1229
|
+
# @return [String]
|
1230
|
+
#
|
1231
|
+
# @!attribute [rw] revisions
|
1232
|
+
# @return [Array<Types::ConfigurationRevision>]
|
1233
|
+
#
|
1234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationRevisionsResponse AWS API Documentation
|
1235
|
+
#
|
1236
|
+
class ListConfigurationRevisionsResponse < Struct.new(
|
1237
|
+
:configuration_id,
|
1238
|
+
:max_results,
|
1239
|
+
:next_token,
|
1240
|
+
:revisions)
|
1241
|
+
include Aws::Structure
|
1242
|
+
end
|
1243
|
+
|
1244
|
+
# Returns a list of all configurations.
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] configurations
|
1247
|
+
# The list of all revisions for the specified configuration.
|
1248
|
+
# @return [Array<Types::Configuration>]
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] max_results
|
1251
|
+
# The maximum number of configurations that Amazon MQ can return per
|
1252
|
+
# page (20 by default). This value must be an integer from 5 to 100.
|
1253
|
+
# @return [Integer]
|
1254
|
+
#
|
1255
|
+
# @!attribute [rw] next_token
|
1256
|
+
# The token that specifies the next page of results Amazon MQ should
|
1257
|
+
# return. To request the first page, leave nextToken empty.
|
1258
|
+
# @return [String]
|
1259
|
+
#
|
1260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationsOutput AWS API Documentation
|
1261
|
+
#
|
1262
|
+
class ListConfigurationsOutput < Struct.new(
|
1263
|
+
:configurations,
|
1264
|
+
:max_results,
|
1265
|
+
:next_token)
|
1266
|
+
include Aws::Structure
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# @note When making an API call, you may pass ListConfigurationsRequest
|
1270
|
+
# data as a hash:
|
1271
|
+
#
|
1272
|
+
# {
|
1273
|
+
# max_results: 1,
|
1274
|
+
# next_token: "__string",
|
1275
|
+
# }
|
1276
|
+
#
|
1277
|
+
# @!attribute [rw] max_results
|
1278
|
+
# @return [Integer]
|
1279
|
+
#
|
1280
|
+
# @!attribute [rw] next_token
|
1281
|
+
# @return [String]
|
1282
|
+
#
|
1283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationsRequest AWS API Documentation
|
1284
|
+
#
|
1285
|
+
class ListConfigurationsRequest < Struct.new(
|
1286
|
+
:max_results,
|
1287
|
+
:next_token)
|
1288
|
+
include Aws::Structure
|
1289
|
+
end
|
1290
|
+
|
1291
|
+
# @!attribute [rw] configurations
|
1292
|
+
# @return [Array<Types::Configuration>]
|
1293
|
+
#
|
1294
|
+
# @!attribute [rw] max_results
|
1295
|
+
# @return [Integer]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] next_token
|
1298
|
+
# @return [String]
|
1299
|
+
#
|
1300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListConfigurationsResponse AWS API Documentation
|
1301
|
+
#
|
1302
|
+
class ListConfigurationsResponse < Struct.new(
|
1303
|
+
:configurations,
|
1304
|
+
:max_results,
|
1305
|
+
:next_token)
|
1306
|
+
include Aws::Structure
|
1307
|
+
end
|
1308
|
+
|
1309
|
+
# Returns a list of all ActiveMQ users.
|
1310
|
+
#
|
1311
|
+
# @!attribute [rw] broker_id
|
1312
|
+
# Required. The unique ID that Amazon MQ generates for the broker.
|
1313
|
+
# @return [String]
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] max_results
|
1316
|
+
# Required. The maximum number of ActiveMQ users that can be returned
|
1317
|
+
# per page (20 by default). This value must be an integer from 5 to
|
1318
|
+
# 100.
|
1319
|
+
# @return [Integer]
|
1320
|
+
#
|
1321
|
+
# @!attribute [rw] next_token
|
1322
|
+
# The token that specifies the next page of results Amazon MQ should
|
1323
|
+
# return. To request the first page, leave nextToken empty.
|
1324
|
+
# @return [String]
|
1325
|
+
#
|
1326
|
+
# @!attribute [rw] users
|
1327
|
+
# Required. The list of all ActiveMQ usernames for the specified
|
1328
|
+
# broker.
|
1329
|
+
# @return [Array<Types::UserSummary>]
|
1330
|
+
#
|
1331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsersOutput AWS API Documentation
|
1332
|
+
#
|
1333
|
+
class ListUsersOutput < Struct.new(
|
1334
|
+
:broker_id,
|
1335
|
+
:max_results,
|
1336
|
+
:next_token,
|
1337
|
+
:users)
|
1338
|
+
include Aws::Structure
|
1339
|
+
end
|
1340
|
+
|
1341
|
+
# @note When making an API call, you may pass ListUsersRequest
|
1342
|
+
# data as a hash:
|
1343
|
+
#
|
1344
|
+
# {
|
1345
|
+
# broker_id: "__string", # required
|
1346
|
+
# max_results: 1,
|
1347
|
+
# next_token: "__string",
|
1348
|
+
# }
|
1349
|
+
#
|
1350
|
+
# @!attribute [rw] broker_id
|
1351
|
+
# @return [String]
|
1352
|
+
#
|
1353
|
+
# @!attribute [rw] max_results
|
1354
|
+
# @return [Integer]
|
1355
|
+
#
|
1356
|
+
# @!attribute [rw] next_token
|
1357
|
+
# @return [String]
|
1358
|
+
#
|
1359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsersRequest AWS API Documentation
|
1360
|
+
#
|
1361
|
+
class ListUsersRequest < Struct.new(
|
1362
|
+
:broker_id,
|
1363
|
+
:max_results,
|
1364
|
+
:next_token)
|
1365
|
+
include Aws::Structure
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
# @!attribute [rw] broker_id
|
1369
|
+
# @return [String]
|
1370
|
+
#
|
1371
|
+
# @!attribute [rw] max_results
|
1372
|
+
# @return [Integer]
|
1373
|
+
#
|
1374
|
+
# @!attribute [rw] next_token
|
1375
|
+
# @return [String]
|
1376
|
+
#
|
1377
|
+
# @!attribute [rw] users
|
1378
|
+
# @return [Array<Types::UserSummary>]
|
1379
|
+
#
|
1380
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsersResponse AWS API Documentation
|
1381
|
+
#
|
1382
|
+
class ListUsersResponse < Struct.new(
|
1383
|
+
:broker_id,
|
1384
|
+
:max_results,
|
1385
|
+
:next_token,
|
1386
|
+
:users)
|
1387
|
+
include Aws::Structure
|
1388
|
+
end
|
1389
|
+
|
1390
|
+
# @note When making an API call, you may pass RebootBrokerRequest
|
1391
|
+
# data as a hash:
|
1392
|
+
#
|
1393
|
+
# {
|
1394
|
+
# broker_id: "__string", # required
|
1395
|
+
# }
|
1396
|
+
#
|
1397
|
+
# @!attribute [rw] broker_id
|
1398
|
+
# @return [String]
|
1399
|
+
#
|
1400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/RebootBrokerRequest AWS API Documentation
|
1401
|
+
#
|
1402
|
+
class RebootBrokerRequest < Struct.new(
|
1403
|
+
:broker_id)
|
1404
|
+
include Aws::Structure
|
1405
|
+
end
|
1406
|
+
|
1407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/RebootBrokerResponse AWS API Documentation
|
1408
|
+
#
|
1409
|
+
class RebootBrokerResponse < Aws::EmptyStructure; end
|
1410
|
+
|
1411
|
+
# Returns information about the XML element or attribute that was
|
1412
|
+
# sanitized in the configuration.
|
1413
|
+
#
|
1414
|
+
# @!attribute [rw] attribute_name
|
1415
|
+
# The name of the XML attribute that has been sanitized.
|
1416
|
+
# @return [String]
|
1417
|
+
#
|
1418
|
+
# @!attribute [rw] element_name
|
1419
|
+
# The name of the XML element that has been sanitized.
|
1420
|
+
# @return [String]
|
1421
|
+
#
|
1422
|
+
# @!attribute [rw] reason
|
1423
|
+
# Required. The reason for which the XML elements or attributes were
|
1424
|
+
# sanitized. Possible values: DISALLOWED\_ELEMENT\_REMOVED,
|
1425
|
+
# DISALLOWED\_ATTRIBUTE\_REMOVED, INVALID\_ATTRIBUTE\_VALUE\_REMOVED
|
1426
|
+
# DISALLOWED\_ELEMENT\_REMOVED shows that the provided element isn't
|
1427
|
+
# allowed and has been removed. DISALLOWED\_ATTRIBUTE\_REMOVED shows
|
1428
|
+
# that the provided attribute isn't allowed and has been removed.
|
1429
|
+
# INVALID\_ATTRIBUTE\_VALUE\_REMOVED shows that the provided value for
|
1430
|
+
# the attribute isn't allowed and has been removed.
|
1431
|
+
# @return [String]
|
1432
|
+
#
|
1433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/SanitizationWarning AWS API Documentation
|
1434
|
+
#
|
1435
|
+
class SanitizationWarning < Struct.new(
|
1436
|
+
:attribute_name,
|
1437
|
+
:element_name,
|
1438
|
+
:reason)
|
1439
|
+
include Aws::Structure
|
1440
|
+
end
|
1441
|
+
|
1442
|
+
# Updates the broker using the specified properties.
|
1443
|
+
#
|
1444
|
+
# @!attribute [rw] configuration
|
1445
|
+
# A list of information about the configuration.
|
1446
|
+
# @return [Types::ConfigurationId]
|
1447
|
+
#
|
1448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBrokerInput AWS API Documentation
|
1449
|
+
#
|
1450
|
+
class UpdateBrokerInput < Struct.new(
|
1451
|
+
:configuration)
|
1452
|
+
include Aws::Structure
|
1453
|
+
end
|
1454
|
+
|
1455
|
+
# Returns information about the updated broker.
|
1456
|
+
#
|
1457
|
+
# @!attribute [rw] broker_id
|
1458
|
+
# Required. The unique ID that Amazon MQ generates for the broker.
|
1459
|
+
# @return [String]
|
1460
|
+
#
|
1461
|
+
# @!attribute [rw] configuration
|
1462
|
+
# The ID of the updated configuration.
|
1463
|
+
# @return [Types::ConfigurationId]
|
1464
|
+
#
|
1465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBrokerOutput AWS API Documentation
|
1466
|
+
#
|
1467
|
+
class UpdateBrokerOutput < Struct.new(
|
1468
|
+
:broker_id,
|
1469
|
+
:configuration)
|
1470
|
+
include Aws::Structure
|
1471
|
+
end
|
1472
|
+
|
1473
|
+
# @note When making an API call, you may pass UpdateBrokerRequest
|
1474
|
+
# data as a hash:
|
1475
|
+
#
|
1476
|
+
# {
|
1477
|
+
# broker_id: "__string", # required
|
1478
|
+
# configuration: {
|
1479
|
+
# id: "__string",
|
1480
|
+
# revision: 1,
|
1481
|
+
# },
|
1482
|
+
# }
|
1483
|
+
#
|
1484
|
+
# @!attribute [rw] broker_id
|
1485
|
+
# @return [String]
|
1486
|
+
#
|
1487
|
+
# @!attribute [rw] configuration
|
1488
|
+
# A list of information about the configuration.
|
1489
|
+
# @return [Types::ConfigurationId]
|
1490
|
+
#
|
1491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBrokerRequest AWS API Documentation
|
1492
|
+
#
|
1493
|
+
class UpdateBrokerRequest < Struct.new(
|
1494
|
+
:broker_id,
|
1495
|
+
:configuration)
|
1496
|
+
include Aws::Structure
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# @!attribute [rw] broker_id
|
1500
|
+
# @return [String]
|
1501
|
+
#
|
1502
|
+
# @!attribute [rw] configuration
|
1503
|
+
# A list of information about the configuration.
|
1504
|
+
# @return [Types::ConfigurationId]
|
1505
|
+
#
|
1506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBrokerResponse AWS API Documentation
|
1507
|
+
#
|
1508
|
+
class UpdateBrokerResponse < Struct.new(
|
1509
|
+
:broker_id,
|
1510
|
+
:configuration)
|
1511
|
+
include Aws::Structure
|
1512
|
+
end
|
1513
|
+
|
1514
|
+
# Updates the specified configuration.
|
1515
|
+
#
|
1516
|
+
# @!attribute [rw] data
|
1517
|
+
# Required. The base64-encoded XML configuration.
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1520
|
+
# @!attribute [rw] description
|
1521
|
+
# The description of the configuration.
|
1522
|
+
# @return [String]
|
1523
|
+
#
|
1524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfigurationInput AWS API Documentation
|
1525
|
+
#
|
1526
|
+
class UpdateConfigurationInput < Struct.new(
|
1527
|
+
:data,
|
1528
|
+
:description)
|
1529
|
+
include Aws::Structure
|
1530
|
+
end
|
1531
|
+
|
1532
|
+
# Returns information about the updated configuration.
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] arn
|
1535
|
+
# Required. The Amazon Resource Name (ARN) of the configuration.
|
1536
|
+
# @return [String]
|
1537
|
+
#
|
1538
|
+
# @!attribute [rw] id
|
1539
|
+
# Required. The unique ID that Amazon MQ generates for the
|
1540
|
+
# configuration.
|
1541
|
+
# @return [String]
|
1542
|
+
#
|
1543
|
+
# @!attribute [rw] latest_revision
|
1544
|
+
# The latest revision of the configuration.
|
1545
|
+
# @return [Types::ConfigurationRevision]
|
1546
|
+
#
|
1547
|
+
# @!attribute [rw] name
|
1548
|
+
# Required. The name of the configuration. This value can contain only
|
1549
|
+
# alphanumeric characters, dashes, periods, underscores, and tildes (-
|
1550
|
+
# . \_ ~). This value must be 1-150 characters long.
|
1551
|
+
# @return [String]
|
1552
|
+
#
|
1553
|
+
# @!attribute [rw] warnings
|
1554
|
+
# The list of the first 20 warnings about the configuration XML
|
1555
|
+
# elements or attributes that were sanitized.
|
1556
|
+
# @return [Array<Types::SanitizationWarning>]
|
1557
|
+
#
|
1558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfigurationOutput AWS API Documentation
|
1559
|
+
#
|
1560
|
+
class UpdateConfigurationOutput < Struct.new(
|
1561
|
+
:arn,
|
1562
|
+
:id,
|
1563
|
+
:latest_revision,
|
1564
|
+
:name,
|
1565
|
+
:warnings)
|
1566
|
+
include Aws::Structure
|
1567
|
+
end
|
1568
|
+
|
1569
|
+
# @note When making an API call, you may pass UpdateConfigurationRequest
|
1570
|
+
# data as a hash:
|
1571
|
+
#
|
1572
|
+
# {
|
1573
|
+
# configuration_id: "__string", # required
|
1574
|
+
# data: "__string",
|
1575
|
+
# description: "__string",
|
1576
|
+
# }
|
1577
|
+
#
|
1578
|
+
# @!attribute [rw] configuration_id
|
1579
|
+
# @return [String]
|
1580
|
+
#
|
1581
|
+
# @!attribute [rw] data
|
1582
|
+
# @return [String]
|
1583
|
+
#
|
1584
|
+
# @!attribute [rw] description
|
1585
|
+
# @return [String]
|
1586
|
+
#
|
1587
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfigurationRequest AWS API Documentation
|
1588
|
+
#
|
1589
|
+
class UpdateConfigurationRequest < Struct.new(
|
1590
|
+
:configuration_id,
|
1591
|
+
:data,
|
1592
|
+
:description)
|
1593
|
+
include Aws::Structure
|
1594
|
+
end
|
1595
|
+
|
1596
|
+
# @!attribute [rw] arn
|
1597
|
+
# @return [String]
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] id
|
1600
|
+
# @return [String]
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] latest_revision
|
1603
|
+
# Returns information about the specified configuration revision.
|
1604
|
+
# @return [Types::ConfigurationRevision]
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] name
|
1607
|
+
# @return [String]
|
1608
|
+
#
|
1609
|
+
# @!attribute [rw] warnings
|
1610
|
+
# @return [Array<Types::SanitizationWarning>]
|
1611
|
+
#
|
1612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfigurationResponse AWS API Documentation
|
1613
|
+
#
|
1614
|
+
class UpdateConfigurationResponse < Struct.new(
|
1615
|
+
:arn,
|
1616
|
+
:id,
|
1617
|
+
:latest_revision,
|
1618
|
+
:name,
|
1619
|
+
:warnings)
|
1620
|
+
include Aws::Structure
|
1621
|
+
end
|
1622
|
+
|
1623
|
+
# Updates the information for an ActiveMQ user.
|
1624
|
+
#
|
1625
|
+
# @!attribute [rw] console_access
|
1626
|
+
# Enables access to the the ActiveMQ Web Console for the ActiveMQ
|
1627
|
+
# user.
|
1628
|
+
# @return [Boolean]
|
1629
|
+
#
|
1630
|
+
# @!attribute [rw] groups
|
1631
|
+
# The list of groups (20 maximum) to which the ActiveMQ user belongs.
|
1632
|
+
# This value can contain only alphanumeric characters, dashes,
|
1633
|
+
# periods, underscores, and tildes (- . \_ ~). This value must be
|
1634
|
+
# 2-100 characters long.
|
1635
|
+
# @return [Array<String>]
|
1636
|
+
#
|
1637
|
+
# @!attribute [rw] password
|
1638
|
+
# The password of the user. This value must be at least 12 characters
|
1639
|
+
# long, must contain at least 4 unique characters, and must not
|
1640
|
+
# contain commas.
|
1641
|
+
# @return [String]
|
1642
|
+
#
|
1643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUserInput AWS API Documentation
|
1644
|
+
#
|
1645
|
+
class UpdateUserInput < Struct.new(
|
1646
|
+
:console_access,
|
1647
|
+
:groups,
|
1648
|
+
:password)
|
1649
|
+
include Aws::Structure
|
1650
|
+
end
|
1651
|
+
|
1652
|
+
# @note When making an API call, you may pass UpdateUserRequest
|
1653
|
+
# data as a hash:
|
1654
|
+
#
|
1655
|
+
# {
|
1656
|
+
# broker_id: "__string", # required
|
1657
|
+
# console_access: false,
|
1658
|
+
# groups: ["__string"],
|
1659
|
+
# password: "__string",
|
1660
|
+
# username: "__string", # required
|
1661
|
+
# }
|
1662
|
+
#
|
1663
|
+
# @!attribute [rw] broker_id
|
1664
|
+
# @return [String]
|
1665
|
+
#
|
1666
|
+
# @!attribute [rw] console_access
|
1667
|
+
# @return [Boolean]
|
1668
|
+
#
|
1669
|
+
# @!attribute [rw] groups
|
1670
|
+
# @return [Array<String>]
|
1671
|
+
#
|
1672
|
+
# @!attribute [rw] password
|
1673
|
+
# @return [String]
|
1674
|
+
#
|
1675
|
+
# @!attribute [rw] username
|
1676
|
+
# @return [String]
|
1677
|
+
#
|
1678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUserRequest AWS API Documentation
|
1679
|
+
#
|
1680
|
+
class UpdateUserRequest < Struct.new(
|
1681
|
+
:broker_id,
|
1682
|
+
:console_access,
|
1683
|
+
:groups,
|
1684
|
+
:password,
|
1685
|
+
:username)
|
1686
|
+
include Aws::Structure
|
1687
|
+
end
|
1688
|
+
|
1689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUserResponse AWS API Documentation
|
1690
|
+
#
|
1691
|
+
class UpdateUserResponse < Aws::EmptyStructure; end
|
1692
|
+
|
1693
|
+
# An ActiveMQ user associated with the broker.
|
1694
|
+
#
|
1695
|
+
# @note When making an API call, you may pass User
|
1696
|
+
# data as a hash:
|
1697
|
+
#
|
1698
|
+
# {
|
1699
|
+
# console_access: false,
|
1700
|
+
# groups: ["__string"],
|
1701
|
+
# password: "__string",
|
1702
|
+
# username: "__string",
|
1703
|
+
# }
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] console_access
|
1706
|
+
# Enables access to the the ActiveMQ Web Console for the ActiveMQ
|
1707
|
+
# user.
|
1708
|
+
# @return [Boolean]
|
1709
|
+
#
|
1710
|
+
# @!attribute [rw] groups
|
1711
|
+
# The list of groups (20 maximum) to which the ActiveMQ user belongs.
|
1712
|
+
# This value can contain only alphanumeric characters, dashes,
|
1713
|
+
# periods, underscores, and tildes (- . \_ ~). This value must be
|
1714
|
+
# 2-100 characters long.
|
1715
|
+
# @return [Array<String>]
|
1716
|
+
#
|
1717
|
+
# @!attribute [rw] password
|
1718
|
+
# Required. The password of the ActiveMQ user. This value must be at
|
1719
|
+
# least 12 characters long, must contain at least 4 unique characters,
|
1720
|
+
# and must not contain commas.
|
1721
|
+
# @return [String]
|
1722
|
+
#
|
1723
|
+
# @!attribute [rw] username
|
1724
|
+
# Required. The username of the ActiveMQ user. This value can contain
|
1725
|
+
# only alphanumeric characters, dashes, periods, underscores, and
|
1726
|
+
# tildes (- . \_ ~). This value must be 2-100 characters long.
|
1727
|
+
# @return [String]
|
1728
|
+
#
|
1729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/User AWS API Documentation
|
1730
|
+
#
|
1731
|
+
class User < Struct.new(
|
1732
|
+
:console_access,
|
1733
|
+
:groups,
|
1734
|
+
:password,
|
1735
|
+
:username)
|
1736
|
+
include Aws::Structure
|
1737
|
+
end
|
1738
|
+
|
1739
|
+
# Returns information about the status of the changes pending for the
|
1740
|
+
# ActiveMQ user.
|
1741
|
+
#
|
1742
|
+
# @!attribute [rw] console_access
|
1743
|
+
# Enables access to the the ActiveMQ Web Console for the ActiveMQ
|
1744
|
+
# user.
|
1745
|
+
# @return [Boolean]
|
1746
|
+
#
|
1747
|
+
# @!attribute [rw] groups
|
1748
|
+
# The list of groups (20 maximum) to which the ActiveMQ user belongs.
|
1749
|
+
# This value can contain only alphanumeric characters, dashes,
|
1750
|
+
# periods, underscores, and tildes (- . \_ ~). This value must be
|
1751
|
+
# 2-100 characters long.
|
1752
|
+
# @return [Array<String>]
|
1753
|
+
#
|
1754
|
+
# @!attribute [rw] pending_change
|
1755
|
+
# Required. The type of change pending for the ActiveMQ user. Possible
|
1756
|
+
# values: CREATE, UPDATE, DELETE
|
1757
|
+
# @return [String]
|
1758
|
+
#
|
1759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UserPendingChanges AWS API Documentation
|
1760
|
+
#
|
1761
|
+
class UserPendingChanges < Struct.new(
|
1762
|
+
:console_access,
|
1763
|
+
:groups,
|
1764
|
+
:pending_change)
|
1765
|
+
include Aws::Structure
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# Returns a list of all ActiveMQ users.
|
1769
|
+
#
|
1770
|
+
# @!attribute [rw] pending_change
|
1771
|
+
# The type of change pending for the ActiveMQ user. Possible values:
|
1772
|
+
# CREATE, UPDATE, DELETE
|
1773
|
+
# @return [String]
|
1774
|
+
#
|
1775
|
+
# @!attribute [rw] username
|
1776
|
+
# Required. The username of the ActiveMQ user. This value can contain
|
1777
|
+
# only alphanumeric characters, dashes, periods, underscores, and
|
1778
|
+
# tildes (- . \_ ~). This value must be 2-100 characters long.
|
1779
|
+
# @return [String]
|
1780
|
+
#
|
1781
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UserSummary AWS API Documentation
|
1782
|
+
#
|
1783
|
+
class UserSummary < Struct.new(
|
1784
|
+
:pending_change,
|
1785
|
+
:username)
|
1786
|
+
include Aws::Structure
|
1787
|
+
end
|
1788
|
+
|
1789
|
+
# The scheduled time period relative to UTC during which Amazon MQ
|
1790
|
+
# begins to apply pending updates or patches to the broker.
|
1791
|
+
#
|
1792
|
+
# @note When making an API call, you may pass WeeklyStartTime
|
1793
|
+
# data as a hash:
|
1794
|
+
#
|
1795
|
+
# {
|
1796
|
+
# day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
|
1797
|
+
# time_of_day: "__string",
|
1798
|
+
# time_zone: "__string",
|
1799
|
+
# }
|
1800
|
+
#
|
1801
|
+
# @!attribute [rw] day_of_week
|
1802
|
+
# Required. The day of the week. Possible values: MONDAY, TUESDAY,
|
1803
|
+
# WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
|
1804
|
+
# @return [String]
|
1805
|
+
#
|
1806
|
+
# @!attribute [rw] time_of_day
|
1807
|
+
# Required. The time, in 24-hour format.
|
1808
|
+
# @return [String]
|
1809
|
+
#
|
1810
|
+
# @!attribute [rw] time_zone
|
1811
|
+
# The time zone, UTC by default, in either the Country/City format, or
|
1812
|
+
# the UTC offset format.
|
1813
|
+
# @return [String]
|
1814
|
+
#
|
1815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/WeeklyStartTime AWS API Documentation
|
1816
|
+
#
|
1817
|
+
class WeeklyStartTime < Struct.new(
|
1818
|
+
:day_of_week,
|
1819
|
+
:time_of_day,
|
1820
|
+
:time_zone)
|
1821
|
+
include Aws::Structure
|
1822
|
+
end
|
1823
|
+
|
1824
|
+
end
|
1825
|
+
end
|