aws-sdk-mq 1.51.0 → 1.52.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-mq/client.rb +88 -13
- data/lib/aws-sdk-mq/client_api.rb +70 -9
- data/lib/aws-sdk-mq/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-mq/endpoints.rb +14 -0
- data/lib/aws-sdk-mq/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-mq/types.rb +352 -107
- data/lib/aws-sdk-mq.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-mq/types.rb
CHANGED
@@ -10,25 +10,15 @@
|
|
10
10
|
module Aws::MQ
|
11
11
|
module Types
|
12
12
|
|
13
|
-
#
|
14
|
-
# CRITICAL\_ACTION\_REQUIRED state.
|
13
|
+
# Action required for a broker.
|
15
14
|
#
|
16
15
|
# @!attribute [rw] action_required_code
|
17
|
-
# The code you can use to
|
18
|
-
#
|
19
|
-
# choosing the link for your code from the list of action required
|
20
|
-
# codes in [Amazon MQ action required codes][1]. Each code references
|
21
|
-
# a topic with detailed information, instructions, and recommendations
|
22
|
-
# for how to resolve the issue and prevent future occurrences.
|
23
|
-
#
|
24
|
-
#
|
25
|
-
#
|
26
|
-
# [1]: https://docs.aws.amazon.com//latest/developer-guide/troubleshooting-action-required-codes.html
|
16
|
+
# The code you can use to find instructions on the action required to
|
17
|
+
# resolve your broker issue.
|
27
18
|
# @return [String]
|
28
19
|
#
|
29
20
|
# @!attribute [rw] action_required_info
|
30
|
-
# Information about the action required to resolve your broker issue
|
31
|
-
# when the broker is in a CRITICAL\_ACTION\_REQUIRED state.
|
21
|
+
# Information about the action required to resolve your broker issue.
|
32
22
|
# @return [String]
|
33
23
|
#
|
34
24
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ActionRequired AWS API Documentation
|
@@ -219,10 +209,10 @@ module Aws::MQ
|
|
219
209
|
# @return [String]
|
220
210
|
#
|
221
211
|
# @!attribute [rw] broker_name
|
222
|
-
# The broker's name. This value is unique in your
|
223
|
-
# characters long, and containing only letters, numbers,
|
224
|
-
# underscores, and must not contain white spaces,
|
225
|
-
# characters, or special characters.
|
212
|
+
# The broker's name. This value is unique in your Amazon Web Services
|
213
|
+
# account, 1-50 characters long, and containing only letters, numbers,
|
214
|
+
# dashes, and underscores, and must not contain white spaces,
|
215
|
+
# brackets, wildcard characters, or special characters.
|
226
216
|
# @return [String]
|
227
217
|
#
|
228
218
|
# @!attribute [rw] broker_state
|
@@ -331,8 +321,6 @@ module Aws::MQ
|
|
331
321
|
|
332
322
|
# A list of information about the configuration.
|
333
323
|
#
|
334
|
-
# Does not apply to RabbitMQ brokers.
|
335
|
-
#
|
336
324
|
# @!attribute [rw] id
|
337
325
|
# Required. The unique ID that Amazon MQ generates for the
|
338
326
|
# configuration.
|
@@ -432,10 +420,16 @@ module Aws::MQ
|
|
432
420
|
# @return [Boolean]
|
433
421
|
#
|
434
422
|
# @!attribute [rw] broker_name
|
435
|
-
# Required. The broker's name. This value must be unique in your
|
436
|
-
# account, 1-50 characters long, must contain only
|
437
|
-
# dashes, and underscores, and must not contain
|
438
|
-
# brackets, wildcard characters, or special characters.
|
423
|
+
# Required. The broker's name. This value must be unique in your
|
424
|
+
# Amazon Web Services account, 1-50 characters long, must contain only
|
425
|
+
# letters, numbers, dashes, and underscores, and must not contain
|
426
|
+
# white spaces, brackets, wildcard characters, or special characters.
|
427
|
+
#
|
428
|
+
# Do not add personally identifiable information (PII) or other
|
429
|
+
# confidential or sensitive information in broker names. Broker names
|
430
|
+
# are accessible to other Amazon Web Services services, including
|
431
|
+
# CloudWatch Logs. Broker names are not intended to be used for
|
432
|
+
# private or sensitive data.
|
439
433
|
# @return [String]
|
440
434
|
#
|
441
435
|
# @!attribute [rw] configuration
|
@@ -444,11 +438,14 @@ module Aws::MQ
|
|
444
438
|
#
|
445
439
|
# @!attribute [rw] creator_request_id
|
446
440
|
# The unique ID that the requester receives for the created broker.
|
447
|
-
# Amazon MQ passes your ID with the API action.
|
448
|
-
#
|
441
|
+
# Amazon MQ passes your ID with the API action.
|
442
|
+
#
|
443
|
+
# <note markdown="1">We recommend using a Universally Unique Identifier (UUID) for the
|
449
444
|
# creatorRequestId. You may omit the creatorRequestId if your
|
450
445
|
# application doesn't require idempotency.
|
451
446
|
#
|
447
|
+
# </note>
|
448
|
+
#
|
452
449
|
# **A suitable default value is auto-generated.** You should normally
|
453
450
|
# not need to pass this option.
|
454
451
|
# @return [String]
|
@@ -457,9 +454,19 @@ module Aws::MQ
|
|
457
454
|
# Required. The broker's deployment mode.
|
458
455
|
# @return [String]
|
459
456
|
#
|
457
|
+
# @!attribute [rw] data_replication_mode
|
458
|
+
# Defines whether this broker is a part of a data replication pair.
|
459
|
+
# @return [String]
|
460
|
+
#
|
461
|
+
# @!attribute [rw] data_replication_primary_broker_arn
|
462
|
+
# The Amazon Resource Name (ARN) of the primary broker that is used to
|
463
|
+
# replicate data from in a data replication pair, and is applied to
|
464
|
+
# the replica broker. Must be set when dataReplicationMode is set to
|
465
|
+
# CRDR.
|
466
|
+
# @return [String]
|
467
|
+
#
|
460
468
|
# @!attribute [rw] encryption_options
|
461
|
-
# Encryption options for the broker.
|
462
|
-
# brokers.
|
469
|
+
# Encryption options for the broker.
|
463
470
|
# @return [Types::EncryptionOptions]
|
464
471
|
#
|
465
472
|
# @!attribute [rw] engine_type
|
@@ -524,8 +531,9 @@ module Aws::MQ
|
|
524
531
|
#
|
525
532
|
# If you specify subnets in a [shared VPC][1] for a RabbitMQ broker,
|
526
533
|
# the associated VPC to which the specified subnets belong must be
|
527
|
-
# owned by your
|
528
|
-
# endpoints in VPCs that are not owned by your
|
534
|
+
# owned by your Amazon Web Services account. Amazon MQ will not be
|
535
|
+
# able to create VPC endpoints in VPCs that are not owned by your
|
536
|
+
# Amazon Web Services account.
|
529
537
|
#
|
530
538
|
#
|
531
539
|
#
|
@@ -537,16 +545,10 @@ module Aws::MQ
|
|
537
545
|
# @return [Hash<String,String>]
|
538
546
|
#
|
539
547
|
# @!attribute [rw] users
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
# <title>Amazon MQ for RabbitMQ</title>
|
546
|
-
#
|
547
|
-
# When you create an Amazon MQ for RabbitMQ broker, one and only one
|
548
|
-
# administrative user is accepted and created when a broker is first
|
549
|
-
# provisioned. All subsequent broker users are created by making
|
548
|
+
# The list of broker users (persons or applications) who can access
|
549
|
+
# queues and topics. For Amazon MQ for RabbitMQ brokers, one and only
|
550
|
+
# one administrative user is accepted and created when a broker is
|
551
|
+
# first provisioned. All subsequent broker users are created by making
|
550
552
|
# RabbitMQ API calls directly to brokers or via the RabbitMQ web
|
551
553
|
# console.
|
552
554
|
# @return [Array<Types::User>]
|
@@ -560,6 +562,8 @@ module Aws::MQ
|
|
560
562
|
:configuration,
|
561
563
|
:creator_request_id,
|
562
564
|
:deployment_mode,
|
565
|
+
:data_replication_mode,
|
566
|
+
:data_replication_primary_broker_arn,
|
563
567
|
:encryption_options,
|
564
568
|
:engine_type,
|
565
569
|
:engine_version,
|
@@ -609,8 +613,6 @@ module Aws::MQ
|
|
609
613
|
#
|
610
614
|
# @!attribute [rw] configuration
|
611
615
|
# A list of information about the configuration.
|
612
|
-
#
|
613
|
-
# Does not apply to RabbitMQ brokers.
|
614
616
|
# @return [Types::ConfigurationId]
|
615
617
|
#
|
616
618
|
# @!attribute [rw] creator_request_id
|
@@ -623,8 +625,6 @@ module Aws::MQ
|
|
623
625
|
# @return [String]
|
624
626
|
#
|
625
627
|
# @!attribute [rw] encryption_options
|
626
|
-
# Does not apply to RabbitMQ brokers.
|
627
|
-
#
|
628
628
|
# Encryption options for the broker.
|
629
629
|
# @return [Types::EncryptionOptions]
|
630
630
|
#
|
@@ -676,6 +676,13 @@ module Aws::MQ
|
|
676
676
|
# @!attribute [rw] users
|
677
677
|
# @return [Array<Types::User>]
|
678
678
|
#
|
679
|
+
# @!attribute [rw] data_replication_mode
|
680
|
+
# Specifies whether a broker is a part of a data replication pair.
|
681
|
+
# @return [String]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] data_replication_primary_broker_arn
|
684
|
+
# @return [String]
|
685
|
+
#
|
679
686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerRequest AWS API Documentation
|
680
687
|
#
|
681
688
|
class CreateBrokerRequest < Struct.new(
|
@@ -697,7 +704,9 @@ module Aws::MQ
|
|
697
704
|
:storage_type,
|
698
705
|
:subnet_ids,
|
699
706
|
:tags,
|
700
|
-
:users
|
707
|
+
:users,
|
708
|
+
:data_replication_mode,
|
709
|
+
:data_replication_primary_broker_arn)
|
701
710
|
SENSITIVE = []
|
702
711
|
include Aws::Structure
|
703
712
|
end
|
@@ -903,12 +912,17 @@ module Aws::MQ
|
|
903
912
|
# not contain commas, colons, or equal signs (,:=).
|
904
913
|
# @return [String]
|
905
914
|
#
|
915
|
+
# @!attribute [rw] replication_user
|
916
|
+
# Defines if this user is intended for CRDR replication purposes.
|
917
|
+
# @return [Boolean]
|
918
|
+
#
|
906
919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUserInput AWS API Documentation
|
907
920
|
#
|
908
921
|
class CreateUserInput < Struct.new(
|
909
922
|
:console_access,
|
910
923
|
:groups,
|
911
|
-
:password
|
924
|
+
:password,
|
925
|
+
:replication_user)
|
912
926
|
SENSITIVE = []
|
913
927
|
include Aws::Structure
|
914
928
|
end
|
@@ -928,6 +942,9 @@ module Aws::MQ
|
|
928
942
|
# @!attribute [rw] username
|
929
943
|
# @return [String]
|
930
944
|
#
|
945
|
+
# @!attribute [rw] replication_user
|
946
|
+
# @return [Boolean]
|
947
|
+
#
|
931
948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUserRequest AWS API Documentation
|
932
949
|
#
|
933
950
|
class CreateUserRequest < Struct.new(
|
@@ -935,7 +952,8 @@ module Aws::MQ
|
|
935
952
|
:console_access,
|
936
953
|
:groups,
|
937
954
|
:password,
|
938
|
-
:username
|
955
|
+
:username,
|
956
|
+
:replication_user)
|
939
957
|
SENSITIVE = []
|
940
958
|
include Aws::Structure
|
941
959
|
end
|
@@ -944,6 +962,49 @@ module Aws::MQ
|
|
944
962
|
#
|
945
963
|
class CreateUserResponse < Aws::EmptyStructure; end
|
946
964
|
|
965
|
+
# Specifies a broker in a data replication pair.
|
966
|
+
#
|
967
|
+
# @!attribute [rw] broker_id
|
968
|
+
# Required. The unique broker id generated by Amazon MQ.
|
969
|
+
# @return [String]
|
970
|
+
#
|
971
|
+
# @!attribute [rw] region
|
972
|
+
# Required. The region of the broker.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DataReplicationCounterpart AWS API Documentation
|
976
|
+
#
|
977
|
+
class DataReplicationCounterpart < Struct.new(
|
978
|
+
:broker_id,
|
979
|
+
:region)
|
980
|
+
SENSITIVE = []
|
981
|
+
include Aws::Structure
|
982
|
+
end
|
983
|
+
|
984
|
+
# The replication details of the data replication-enabled broker. Only
|
985
|
+
# returned if dataReplicationMode or pendingDataReplicationMode is set
|
986
|
+
# to CRDR.
|
987
|
+
#
|
988
|
+
# @!attribute [rw] data_replication_counterpart
|
989
|
+
# Describes the replica/primary broker. Only returned if this broker
|
990
|
+
# is currently set as a primary or replica in the broker's
|
991
|
+
# dataReplicationRole property.
|
992
|
+
# @return [Types::DataReplicationCounterpart]
|
993
|
+
#
|
994
|
+
# @!attribute [rw] data_replication_role
|
995
|
+
# Defines the role of this broker in a data replication pair. When a
|
996
|
+
# replica broker is promoted to primary, this role is interchanged.
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DataReplicationMetadataOutput AWS API Documentation
|
1000
|
+
#
|
1001
|
+
class DataReplicationMetadataOutput < Struct.new(
|
1002
|
+
:data_replication_counterpart,
|
1003
|
+
:data_replication_role)
|
1004
|
+
SENSITIVE = []
|
1005
|
+
include Aws::Structure
|
1006
|
+
end
|
1007
|
+
|
947
1008
|
# Returns information about the deleted broker.
|
948
1009
|
#
|
949
1010
|
# @!attribute [rw] broker_id
|
@@ -1101,7 +1162,7 @@ module Aws::MQ
|
|
1101
1162
|
# Returns information about the specified broker.
|
1102
1163
|
#
|
1103
1164
|
# @!attribute [rw] actions_required
|
1104
|
-
#
|
1165
|
+
# Actions required for a broker.
|
1105
1166
|
# @return [Array<Types::ActionRequired>]
|
1106
1167
|
#
|
1107
1168
|
# @!attribute [rw] authentication_strategy
|
@@ -1129,10 +1190,10 @@ module Aws::MQ
|
|
1129
1190
|
# @return [Array<Types::BrokerInstance>]
|
1130
1191
|
#
|
1131
1192
|
# @!attribute [rw] broker_name
|
1132
|
-
# The broker's name. This value must be unique in your
|
1133
|
-
# 1-50 characters long, must contain only
|
1134
|
-
# and underscores, and must not contain
|
1135
|
-
# wildcard characters, or special characters.
|
1193
|
+
# The broker's name. This value must be unique in your Amazon Web
|
1194
|
+
# Services account account, 1-50 characters long, must contain only
|
1195
|
+
# letters, numbers, dashes, and underscores, and must not contain
|
1196
|
+
# white spaces, brackets, wildcard characters, or special characters.
|
1136
1197
|
# @return [String]
|
1137
1198
|
#
|
1138
1199
|
# @!attribute [rw] broker_state
|
@@ -1151,9 +1212,17 @@ module Aws::MQ
|
|
1151
1212
|
# The broker's deployment mode.
|
1152
1213
|
# @return [String]
|
1153
1214
|
#
|
1215
|
+
# @!attribute [rw] data_replication_metadata
|
1216
|
+
# The replication details of the data replication-enabled broker. Only
|
1217
|
+
# returned if dataReplicationMode is set to CRDR.
|
1218
|
+
# @return [Types::DataReplicationMetadataOutput]
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] data_replication_mode
|
1221
|
+
# Describes whether this broker is a part of a data replication pair.
|
1222
|
+
# @return [String]
|
1223
|
+
#
|
1154
1224
|
# @!attribute [rw] encryption_options
|
1155
|
-
# Encryption options for the broker.
|
1156
|
-
# brokers.
|
1225
|
+
# Encryption options for the broker.
|
1157
1226
|
# @return [Types::EncryptionOptions]
|
1158
1227
|
#
|
1159
1228
|
# @!attribute [rw] engine_type
|
@@ -1193,6 +1262,16 @@ module Aws::MQ
|
|
1193
1262
|
# rebooted. The default is SIMPLE.
|
1194
1263
|
# @return [String]
|
1195
1264
|
#
|
1265
|
+
# @!attribute [rw] pending_data_replication_metadata
|
1266
|
+
# The pending replication details of the data replication-enabled
|
1267
|
+
# broker. Only returned if pendingDataReplicationMode is set to CRDR.
|
1268
|
+
# @return [Types::DataReplicationMetadataOutput]
|
1269
|
+
#
|
1270
|
+
# @!attribute [rw] pending_data_replication_mode
|
1271
|
+
# Describes whether this broker will be a part of a data replication
|
1272
|
+
# pair after reboot.
|
1273
|
+
# @return [String]
|
1274
|
+
#
|
1196
1275
|
# @!attribute [rw] pending_engine_version
|
1197
1276
|
# The broker engine version to upgrade to. For a list of supported
|
1198
1277
|
# engine versions, see [Supported engines][1].
|
@@ -1262,6 +1341,8 @@ module Aws::MQ
|
|
1262
1341
|
:configurations,
|
1263
1342
|
:created,
|
1264
1343
|
:deployment_mode,
|
1344
|
+
:data_replication_metadata,
|
1345
|
+
:data_replication_mode,
|
1265
1346
|
:encryption_options,
|
1266
1347
|
:engine_type,
|
1267
1348
|
:engine_version,
|
@@ -1270,6 +1351,8 @@ module Aws::MQ
|
|
1270
1351
|
:logs,
|
1271
1352
|
:maintenance_window_start_time,
|
1272
1353
|
:pending_authentication_strategy,
|
1354
|
+
:pending_data_replication_metadata,
|
1355
|
+
:pending_data_replication_mode,
|
1273
1356
|
:pending_engine_version,
|
1274
1357
|
:pending_host_instance_type,
|
1275
1358
|
:pending_ldap_server_metadata,
|
@@ -1334,8 +1417,6 @@ module Aws::MQ
|
|
1334
1417
|
# @return [String]
|
1335
1418
|
#
|
1336
1419
|
# @!attribute [rw] encryption_options
|
1337
|
-
# Does not apply to RabbitMQ brokers.
|
1338
|
-
#
|
1339
1420
|
# Encryption options for the broker.
|
1340
1421
|
# @return [Types::EncryptionOptions]
|
1341
1422
|
#
|
@@ -1404,6 +1485,26 @@ module Aws::MQ
|
|
1404
1485
|
# @!attribute [rw] users
|
1405
1486
|
# @return [Array<Types::UserSummary>]
|
1406
1487
|
#
|
1488
|
+
# @!attribute [rw] data_replication_metadata
|
1489
|
+
# The replication details of the data replication-enabled broker. Only
|
1490
|
+
# returned if dataReplicationMode or pendingDataReplicationMode is set
|
1491
|
+
# to CRDR.
|
1492
|
+
# @return [Types::DataReplicationMetadataOutput]
|
1493
|
+
#
|
1494
|
+
# @!attribute [rw] data_replication_mode
|
1495
|
+
# Specifies whether a broker is a part of a data replication pair.
|
1496
|
+
# @return [String]
|
1497
|
+
#
|
1498
|
+
# @!attribute [rw] pending_data_replication_metadata
|
1499
|
+
# The replication details of the data replication-enabled broker. Only
|
1500
|
+
# returned if dataReplicationMode or pendingDataReplicationMode is set
|
1501
|
+
# to CRDR.
|
1502
|
+
# @return [Types::DataReplicationMetadataOutput]
|
1503
|
+
#
|
1504
|
+
# @!attribute [rw] pending_data_replication_mode
|
1505
|
+
# Specifies whether a broker is a part of a data replication pair.
|
1506
|
+
# @return [String]
|
1507
|
+
#
|
1407
1508
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeBrokerResponse AWS API Documentation
|
1408
1509
|
#
|
1409
1510
|
class DescribeBrokerResponse < Struct.new(
|
@@ -1435,7 +1536,11 @@ module Aws::MQ
|
|
1435
1536
|
:storage_type,
|
1436
1537
|
:subnet_ids,
|
1437
1538
|
:tags,
|
1438
|
-
:users
|
1539
|
+
:users,
|
1540
|
+
:data_replication_metadata,
|
1541
|
+
:data_replication_mode,
|
1542
|
+
:pending_data_replication_metadata,
|
1543
|
+
:pending_data_replication_mode)
|
1439
1544
|
SENSITIVE = []
|
1440
1545
|
include Aws::Structure
|
1441
1546
|
end
|
@@ -1515,7 +1620,8 @@ module Aws::MQ
|
|
1515
1620
|
# @return [Time]
|
1516
1621
|
#
|
1517
1622
|
# @!attribute [rw] data
|
1518
|
-
#
|
1623
|
+
# Amazon MQ for ActiveMQ: the base64-encoded XML configuration. Amazon
|
1624
|
+
# MQ for RabbitMQ: base64-encoded Cuttlefish.
|
1519
1625
|
# @return [String]
|
1520
1626
|
#
|
1521
1627
|
# @!attribute [rw] description
|
@@ -1593,6 +1699,10 @@ module Aws::MQ
|
|
1593
1699
|
# The status of the changes pending for the ActiveMQ user.
|
1594
1700
|
# @return [Types::UserPendingChanges]
|
1595
1701
|
#
|
1702
|
+
# @!attribute [rw] replication_user
|
1703
|
+
# Describes whether the user is intended for data replication
|
1704
|
+
# @return [Boolean]
|
1705
|
+
#
|
1596
1706
|
# @!attribute [rw] username
|
1597
1707
|
# Required. The username of the ActiveMQ user. This value can contain
|
1598
1708
|
# only alphanumeric characters, dashes, periods, underscores, and
|
@@ -1606,6 +1716,7 @@ module Aws::MQ
|
|
1606
1716
|
:console_access,
|
1607
1717
|
:groups,
|
1608
1718
|
:pending,
|
1719
|
+
:replication_user,
|
1609
1720
|
:username)
|
1610
1721
|
SENSITIVE = []
|
1611
1722
|
include Aws::Structure
|
@@ -1643,6 +1754,9 @@ module Aws::MQ
|
|
1643
1754
|
# @!attribute [rw] username
|
1644
1755
|
# @return [String]
|
1645
1756
|
#
|
1757
|
+
# @!attribute [rw] replication_user
|
1758
|
+
# @return [Boolean]
|
1759
|
+
#
|
1646
1760
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/DescribeUserResponse AWS API Documentation
|
1647
1761
|
#
|
1648
1762
|
class DescribeUserResponse < Struct.new(
|
@@ -1650,25 +1764,24 @@ module Aws::MQ
|
|
1650
1764
|
:console_access,
|
1651
1765
|
:groups,
|
1652
1766
|
:pending,
|
1653
|
-
:username
|
1767
|
+
:username,
|
1768
|
+
:replication_user)
|
1654
1769
|
SENSITIVE = []
|
1655
1770
|
include Aws::Structure
|
1656
1771
|
end
|
1657
1772
|
|
1658
|
-
# Does not apply to RabbitMQ brokers.
|
1659
|
-
#
|
1660
1773
|
# Encryption options for the broker.
|
1661
1774
|
#
|
1662
1775
|
# @!attribute [rw] kms_key_id
|
1663
|
-
# The customer master key (CMK) to use for the
|
1664
|
-
#
|
1665
|
-
#
|
1776
|
+
# The customer master key (CMK) to use for the A KMS (KMS). This key
|
1777
|
+
# is used to encrypt your data at rest. If not provided, Amazon MQ
|
1778
|
+
# will use a default CMK to encrypt your data.
|
1666
1779
|
# @return [String]
|
1667
1780
|
#
|
1668
1781
|
# @!attribute [rw] use_aws_owned_key
|
1669
|
-
# Enables the use of an
|
1670
|
-
#
|
1671
|
-
#
|
1782
|
+
# Enables the use of an Amazon Web Services owned CMK using KMS (KMS).
|
1783
|
+
# Set to true by default, if no value is provided, for example, for
|
1784
|
+
# RabbitMQ brokers.
|
1672
1785
|
# @return [Boolean]
|
1673
1786
|
#
|
1674
1787
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/EncryptionOptions AWS API Documentation
|
@@ -1753,8 +1866,8 @@ module Aws::MQ
|
|
1753
1866
|
# Does not apply to RabbitMQ brokers.
|
1754
1867
|
#
|
1755
1868
|
# @!attribute [rw] hosts
|
1756
|
-
# Specifies the location of the LDAP server such as
|
1757
|
-
#
|
1869
|
+
# Specifies the location of the LDAP server such as Directory Service
|
1870
|
+
# for Microsoft Active Directory. Optional failover server.
|
1758
1871
|
# @return [Array<String>]
|
1759
1872
|
#
|
1760
1873
|
# @!attribute [rw] role_base
|
@@ -1848,8 +1961,8 @@ module Aws::MQ
|
|
1848
1961
|
# authorize connections to the broker.
|
1849
1962
|
#
|
1850
1963
|
# @!attribute [rw] hosts
|
1851
|
-
# Specifies the location of the LDAP server such as
|
1852
|
-
#
|
1964
|
+
# Specifies the location of the LDAP server such as Directory Service
|
1965
|
+
# for Microsoft Active Directory. Optional failover server.
|
1853
1966
|
# @return [Array<String>]
|
1854
1967
|
#
|
1855
1968
|
# @!attribute [rw] role_base
|
@@ -1932,6 +2045,8 @@ module Aws::MQ
|
|
1932
2045
|
include Aws::Structure
|
1933
2046
|
end
|
1934
2047
|
|
2048
|
+
# A list of information about all brokers.
|
2049
|
+
#
|
1935
2050
|
# @!attribute [rw] broker_summaries
|
1936
2051
|
# A list of information about all brokers.
|
1937
2052
|
# @return [Array<Types::BrokerSummary>]
|
@@ -2310,6 +2425,62 @@ module Aws::MQ
|
|
2310
2425
|
include Aws::Structure
|
2311
2426
|
end
|
2312
2427
|
|
2428
|
+
# Creates a Promote request with the properties specified.
|
2429
|
+
#
|
2430
|
+
# @!attribute [rw] mode
|
2431
|
+
# The Promote mode requested. Note: Valid values for the parameter are
|
2432
|
+
# SWITCHOVER, FAILOVER.
|
2433
|
+
# @return [String]
|
2434
|
+
#
|
2435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/PromoteInput AWS API Documentation
|
2436
|
+
#
|
2437
|
+
class PromoteInput < Struct.new(
|
2438
|
+
:mode)
|
2439
|
+
SENSITIVE = []
|
2440
|
+
include Aws::Structure
|
2441
|
+
end
|
2442
|
+
|
2443
|
+
# Returns information about the updated broker.
|
2444
|
+
#
|
2445
|
+
# @!attribute [rw] broker_id
|
2446
|
+
# The unique ID that Amazon MQ generates for the broker.
|
2447
|
+
# @return [String]
|
2448
|
+
#
|
2449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/PromoteOutput AWS API Documentation
|
2450
|
+
#
|
2451
|
+
class PromoteOutput < Struct.new(
|
2452
|
+
:broker_id)
|
2453
|
+
SENSITIVE = []
|
2454
|
+
include Aws::Structure
|
2455
|
+
end
|
2456
|
+
|
2457
|
+
# @!attribute [rw] broker_id
|
2458
|
+
# @return [String]
|
2459
|
+
#
|
2460
|
+
# @!attribute [rw] mode
|
2461
|
+
# The Promote mode requested.
|
2462
|
+
# @return [String]
|
2463
|
+
#
|
2464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/PromoteRequest AWS API Documentation
|
2465
|
+
#
|
2466
|
+
class PromoteRequest < Struct.new(
|
2467
|
+
:broker_id,
|
2468
|
+
:mode)
|
2469
|
+
SENSITIVE = []
|
2470
|
+
include Aws::Structure
|
2471
|
+
end
|
2472
|
+
|
2473
|
+
# @!attribute [rw] broker_id
|
2474
|
+
# @return [String]
|
2475
|
+
#
|
2476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/PromoteResponse AWS API Documentation
|
2477
|
+
#
|
2478
|
+
class PromoteResponse < Struct.new(
|
2479
|
+
:broker_id)
|
2480
|
+
SENSITIVE = []
|
2481
|
+
include Aws::Structure
|
2482
|
+
end
|
2483
|
+
|
2313
2484
|
# @!attribute [rw] broker_id
|
2314
2485
|
# @return [String]
|
2315
2486
|
#
|
@@ -2325,19 +2496,19 @@ module Aws::MQ
|
|
2325
2496
|
#
|
2326
2497
|
class RebootBrokerResponse < Aws::EmptyStructure; end
|
2327
2498
|
|
2328
|
-
# Returns information about the
|
2329
|
-
# sanitized in the configuration.
|
2499
|
+
# Returns information about the configuration element or attribute that
|
2500
|
+
# was sanitized in the configuration.
|
2330
2501
|
#
|
2331
2502
|
# @!attribute [rw] attribute_name
|
2332
|
-
# The name of the
|
2503
|
+
# The name of the configuration attribute that has been sanitized.
|
2333
2504
|
# @return [String]
|
2334
2505
|
#
|
2335
2506
|
# @!attribute [rw] element_name
|
2336
|
-
# The name of the
|
2507
|
+
# The name of the configuration element that has been sanitized.
|
2337
2508
|
# @return [String]
|
2338
2509
|
#
|
2339
2510
|
# @!attribute [rw] reason
|
2340
|
-
#
|
2511
|
+
# The reason for which the configuration elements or attributes were
|
2341
2512
|
# sanitized.
|
2342
2513
|
# @return [String]
|
2343
2514
|
#
|
@@ -2400,6 +2571,10 @@ module Aws::MQ
|
|
2400
2571
|
# A list of information about the configuration.
|
2401
2572
|
# @return [Types::ConfigurationId]
|
2402
2573
|
#
|
2574
|
+
# @!attribute [rw] data_replication_mode
|
2575
|
+
# Defines whether this broker is a part of a data replication pair.
|
2576
|
+
# @return [String]
|
2577
|
+
#
|
2403
2578
|
# @!attribute [rw] engine_version
|
2404
2579
|
# The broker engine version. For a list of supported engine versions,
|
2405
2580
|
# see [Supported engines][1].
|
@@ -2443,6 +2618,7 @@ module Aws::MQ
|
|
2443
2618
|
:authentication_strategy,
|
2444
2619
|
:auto_minor_version_upgrade,
|
2445
2620
|
:configuration,
|
2621
|
+
:data_replication_mode,
|
2446
2622
|
:engine_version,
|
2447
2623
|
:host_instance_type,
|
2448
2624
|
:ldap_server_metadata,
|
@@ -2474,6 +2650,15 @@ module Aws::MQ
|
|
2474
2650
|
# The ID of the updated configuration.
|
2475
2651
|
# @return [Types::ConfigurationId]
|
2476
2652
|
#
|
2653
|
+
# @!attribute [rw] data_replication_metadata
|
2654
|
+
# The replication details of the data replication-enabled broker. Only
|
2655
|
+
# returned if dataReplicationMode is set to CRDR.
|
2656
|
+
# @return [Types::DataReplicationMetadataOutput]
|
2657
|
+
#
|
2658
|
+
# @!attribute [rw] data_replication_mode
|
2659
|
+
# Describes whether this broker is a part of a data replication pair.
|
2660
|
+
# @return [String]
|
2661
|
+
#
|
2477
2662
|
# @!attribute [rw] engine_version
|
2478
2663
|
# The broker engine version to upgrade to. For a list of supported
|
2479
2664
|
# engine versions, see [Supported engines][1].
|
@@ -2507,6 +2692,16 @@ module Aws::MQ
|
|
2507
2692
|
# The parameters that determine the WeeklyStartTime.
|
2508
2693
|
# @return [Types::WeeklyStartTime]
|
2509
2694
|
#
|
2695
|
+
# @!attribute [rw] pending_data_replication_metadata
|
2696
|
+
# The pending replication details of the data replication-enabled
|
2697
|
+
# broker. Only returned if pendingDataReplicationMode is set to CRDR.
|
2698
|
+
# @return [Types::DataReplicationMetadataOutput]
|
2699
|
+
#
|
2700
|
+
# @!attribute [rw] pending_data_replication_mode
|
2701
|
+
# Describes whether this broker will be a part of a data replication
|
2702
|
+
# pair after reboot.
|
2703
|
+
# @return [String]
|
2704
|
+
#
|
2510
2705
|
# @!attribute [rw] security_groups
|
2511
2706
|
# The list of security groups (1 minimum, 5 maximum) that authorizes
|
2512
2707
|
# connections to brokers.
|
@@ -2519,11 +2714,15 @@ module Aws::MQ
|
|
2519
2714
|
:auto_minor_version_upgrade,
|
2520
2715
|
:broker_id,
|
2521
2716
|
:configuration,
|
2717
|
+
:data_replication_metadata,
|
2718
|
+
:data_replication_mode,
|
2522
2719
|
:engine_version,
|
2523
2720
|
:host_instance_type,
|
2524
2721
|
:ldap_server_metadata,
|
2525
2722
|
:logs,
|
2526
2723
|
:maintenance_window_start_time,
|
2724
|
+
:pending_data_replication_metadata,
|
2725
|
+
:pending_data_replication_mode,
|
2527
2726
|
:security_groups)
|
2528
2727
|
SENSITIVE = []
|
2529
2728
|
include Aws::Structure
|
@@ -2542,8 +2741,6 @@ module Aws::MQ
|
|
2542
2741
|
#
|
2543
2742
|
# @!attribute [rw] configuration
|
2544
2743
|
# A list of information about the configuration.
|
2545
|
-
#
|
2546
|
-
# Does not apply to RabbitMQ brokers.
|
2547
2744
|
# @return [Types::ConfigurationId]
|
2548
2745
|
#
|
2549
2746
|
# @!attribute [rw] engine_version
|
@@ -2572,6 +2769,10 @@ module Aws::MQ
|
|
2572
2769
|
# @!attribute [rw] security_groups
|
2573
2770
|
# @return [Array<String>]
|
2574
2771
|
#
|
2772
|
+
# @!attribute [rw] data_replication_mode
|
2773
|
+
# Specifies whether a broker is a part of a data replication pair.
|
2774
|
+
# @return [String]
|
2775
|
+
#
|
2575
2776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBrokerRequest AWS API Documentation
|
2576
2777
|
#
|
2577
2778
|
class UpdateBrokerRequest < Struct.new(
|
@@ -2584,7 +2785,8 @@ module Aws::MQ
|
|
2584
2785
|
:ldap_server_metadata,
|
2585
2786
|
:logs,
|
2586
2787
|
:maintenance_window_start_time,
|
2587
|
-
:security_groups
|
2788
|
+
:security_groups,
|
2789
|
+
:data_replication_mode)
|
2588
2790
|
SENSITIVE = []
|
2589
2791
|
include Aws::Structure
|
2590
2792
|
end
|
@@ -2602,8 +2804,6 @@ module Aws::MQ
|
|
2602
2804
|
#
|
2603
2805
|
# @!attribute [rw] configuration
|
2604
2806
|
# A list of information about the configuration.
|
2605
|
-
#
|
2606
|
-
# Does not apply to RabbitMQ brokers.
|
2607
2807
|
# @return [Types::ConfigurationId]
|
2608
2808
|
#
|
2609
2809
|
# @!attribute [rw] engine_version
|
@@ -2630,6 +2830,26 @@ module Aws::MQ
|
|
2630
2830
|
# @!attribute [rw] security_groups
|
2631
2831
|
# @return [Array<String>]
|
2632
2832
|
#
|
2833
|
+
# @!attribute [rw] data_replication_metadata
|
2834
|
+
# The replication details of the data replication-enabled broker. Only
|
2835
|
+
# returned if dataReplicationMode or pendingDataReplicationMode is set
|
2836
|
+
# to CRDR.
|
2837
|
+
# @return [Types::DataReplicationMetadataOutput]
|
2838
|
+
#
|
2839
|
+
# @!attribute [rw] data_replication_mode
|
2840
|
+
# Specifies whether a broker is a part of a data replication pair.
|
2841
|
+
# @return [String]
|
2842
|
+
#
|
2843
|
+
# @!attribute [rw] pending_data_replication_metadata
|
2844
|
+
# The replication details of the data replication-enabled broker. Only
|
2845
|
+
# returned if dataReplicationMode or pendingDataReplicationMode is set
|
2846
|
+
# to CRDR.
|
2847
|
+
# @return [Types::DataReplicationMetadataOutput]
|
2848
|
+
#
|
2849
|
+
# @!attribute [rw] pending_data_replication_mode
|
2850
|
+
# Specifies whether a broker is a part of a data replication pair.
|
2851
|
+
# @return [String]
|
2852
|
+
#
|
2633
2853
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateBrokerResponse AWS API Documentation
|
2634
2854
|
#
|
2635
2855
|
class UpdateBrokerResponse < Struct.new(
|
@@ -2642,7 +2862,11 @@ module Aws::MQ
|
|
2642
2862
|
:ldap_server_metadata,
|
2643
2863
|
:logs,
|
2644
2864
|
:maintenance_window_start_time,
|
2645
|
-
:security_groups
|
2865
|
+
:security_groups,
|
2866
|
+
:data_replication_metadata,
|
2867
|
+
:data_replication_mode,
|
2868
|
+
:pending_data_replication_metadata,
|
2869
|
+
:pending_data_replication_mode)
|
2646
2870
|
SENSITIVE = []
|
2647
2871
|
include Aws::Structure
|
2648
2872
|
end
|
@@ -2650,7 +2874,8 @@ module Aws::MQ
|
|
2650
2874
|
# Updates the specified configuration.
|
2651
2875
|
#
|
2652
2876
|
# @!attribute [rw] data
|
2653
|
-
#
|
2877
|
+
# Amazon MQ for Active MQ: The base64-encoded XML configuration.
|
2878
|
+
# Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.
|
2654
2879
|
# @return [String]
|
2655
2880
|
#
|
2656
2881
|
# @!attribute [rw] description
|
@@ -2669,7 +2894,7 @@ module Aws::MQ
|
|
2669
2894
|
# Returns information about the updated configuration.
|
2670
2895
|
#
|
2671
2896
|
# @!attribute [rw] arn
|
2672
|
-
#
|
2897
|
+
# The Amazon Resource Name (ARN) of the configuration.
|
2673
2898
|
# @return [String]
|
2674
2899
|
#
|
2675
2900
|
# @!attribute [rw] created
|
@@ -2677,8 +2902,7 @@ module Aws::MQ
|
|
2677
2902
|
# @return [Time]
|
2678
2903
|
#
|
2679
2904
|
# @!attribute [rw] id
|
2680
|
-
#
|
2681
|
-
# configuration.
|
2905
|
+
# The unique ID that Amazon MQ generates for the configuration.
|
2682
2906
|
# @return [String]
|
2683
2907
|
#
|
2684
2908
|
# @!attribute [rw] latest_revision
|
@@ -2686,14 +2910,14 @@ module Aws::MQ
|
|
2686
2910
|
# @return [Types::ConfigurationRevision]
|
2687
2911
|
#
|
2688
2912
|
# @!attribute [rw] name
|
2689
|
-
#
|
2913
|
+
# The name of the configuration. This value can contain only
|
2690
2914
|
# alphanumeric characters, dashes, periods, underscores, and tildes (-
|
2691
2915
|
# . \_ ~). This value must be 1-150 characters long.
|
2692
2916
|
# @return [String]
|
2693
2917
|
#
|
2694
2918
|
# @!attribute [rw] warnings
|
2695
|
-
# The list of the first 20 warnings about the configuration
|
2696
|
-
#
|
2919
|
+
# The list of the first 20 warnings about the configuration elements
|
2920
|
+
# or attributes that were sanitized.
|
2697
2921
|
# @return [Array<Types::SanitizationWarning>]
|
2698
2922
|
#
|
2699
2923
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateConfigurationOutput AWS API Documentation
|
@@ -2780,12 +3004,17 @@ module Aws::MQ
|
|
2780
3004
|
# contain commas, colons, or equal signs (,:=).
|
2781
3005
|
# @return [String]
|
2782
3006
|
#
|
3007
|
+
# @!attribute [rw] replication_user
|
3008
|
+
# Defines whether the user is intended for data replication.
|
3009
|
+
# @return [Boolean]
|
3010
|
+
#
|
2783
3011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUserInput AWS API Documentation
|
2784
3012
|
#
|
2785
3013
|
class UpdateUserInput < Struct.new(
|
2786
3014
|
:console_access,
|
2787
3015
|
:groups,
|
2788
|
-
:password
|
3016
|
+
:password,
|
3017
|
+
:replication_user)
|
2789
3018
|
SENSITIVE = []
|
2790
3019
|
include Aws::Structure
|
2791
3020
|
end
|
@@ -2805,6 +3034,9 @@ module Aws::MQ
|
|
2805
3034
|
# @!attribute [rw] username
|
2806
3035
|
# @return [String]
|
2807
3036
|
#
|
3037
|
+
# @!attribute [rw] replication_user
|
3038
|
+
# @return [Boolean]
|
3039
|
+
#
|
2808
3040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUserRequest AWS API Documentation
|
2809
3041
|
#
|
2810
3042
|
class UpdateUserRequest < Struct.new(
|
@@ -2812,7 +3044,8 @@ module Aws::MQ
|
|
2812
3044
|
:console_access,
|
2813
3045
|
:groups,
|
2814
3046
|
:password,
|
2815
|
-
:username
|
3047
|
+
:username,
|
3048
|
+
:replication_user)
|
2816
3049
|
SENSITIVE = []
|
2817
3050
|
include Aws::Structure
|
2818
3051
|
end
|
@@ -2821,11 +3054,11 @@ module Aws::MQ
|
|
2821
3054
|
#
|
2822
3055
|
class UpdateUserResponse < Aws::EmptyStructure; end
|
2823
3056
|
|
2824
|
-
# A user associated with the broker. For RabbitMQ brokers,
|
2825
|
-
# one administrative user is accepted and created when a
|
2826
|
-
# provisioned. All subsequent broker users are created
|
2827
|
-
# RabbitMQ API calls directly to brokers or via the RabbitMQ
|
2828
|
-
# console.
|
3057
|
+
# A user associated with the broker. For Amazon MQ for RabbitMQ brokers,
|
3058
|
+
# one and only one administrative user is accepted and created when a
|
3059
|
+
# broker is first provisioned. All subsequent broker users are created
|
3060
|
+
# by making RabbitMQ API calls directly to brokers or via the RabbitMQ
|
3061
|
+
# web console.
|
2829
3062
|
#
|
2830
3063
|
# @!attribute [rw] console_access
|
2831
3064
|
# Enables access to the ActiveMQ Web Console for the ActiveMQ user.
|
@@ -2846,28 +3079,40 @@ module Aws::MQ
|
|
2846
3079
|
# @return [String]
|
2847
3080
|
#
|
2848
3081
|
# @!attribute [rw] username
|
2849
|
-
#
|
3082
|
+
# The username of the broker user. The following restrictions apply to
|
3083
|
+
# broker usernames:
|
2850
3084
|
#
|
2851
|
-
#
|
2852
|
-
#
|
2853
|
-
#
|
2854
|
-
#
|
3085
|
+
# * For Amazon MQ for ActiveMQ brokers, this value can contain only
|
3086
|
+
# alphanumeric characters, dashes, periods, underscores, and tildes
|
3087
|
+
# (- . \_ ~). This value must be 2-100 characters long.
|
3088
|
+
#
|
3089
|
+
# * para>For Amazon MQ for RabbitMQ brokers, this value can contain
|
3090
|
+
# only alphanumeric characters, dashes, periods, underscores (- .
|
3091
|
+
# \_). This value must not contain a tilde (~) character. Amazon MQ
|
3092
|
+
# prohibts using guest as a valid usename. This value must be 2-100
|
3093
|
+
# characters long.
|
2855
3094
|
#
|
2856
|
-
#
|
2857
|
-
# characters, dashes, periods, underscores (- . \_). This value must
|
2858
|
-
# not contain a tilde (~) character. Amazon MQ prohibts using guest as
|
2859
|
-
# a valid usename. This value must be 2-100 characters long.
|
3095
|
+
# </para>
|
2860
3096
|
#
|
2861
|
-
#
|
3097
|
+
# Do not add personally identifiable information (PII) or other
|
3098
|
+
# confidential or sensitive information in broker usernames. Broker
|
3099
|
+
# usernames are accessible to other Amazon Web Services services,
|
3100
|
+
# including CloudWatch Logs. Broker usernames are not intended to be
|
3101
|
+
# used for private or sensitive data.
|
2862
3102
|
# @return [String]
|
2863
3103
|
#
|
3104
|
+
# @!attribute [rw] replication_user
|
3105
|
+
# Defines if this user is intended for CRDR replication purposes.
|
3106
|
+
# @return [Boolean]
|
3107
|
+
#
|
2864
3108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/User AWS API Documentation
|
2865
3109
|
#
|
2866
3110
|
class User < Struct.new(
|
2867
3111
|
:console_access,
|
2868
3112
|
:groups,
|
2869
3113
|
:password,
|
2870
|
-
:username
|
3114
|
+
:username,
|
3115
|
+
:replication_user)
|
2871
3116
|
SENSITIVE = []
|
2872
3117
|
include Aws::Structure
|
2873
3118
|
end
|