aws-sdk-mq 1.36.0 → 1.37.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.
@@ -44,7 +44,7 @@ module Aws::MQ
44
44
  # Types of broker engines.
45
45
  #
46
46
  # @!attribute [rw] engine_type
47
- # The type of broker engine.
47
+ # The broker's engine type.
48
48
  # @return [String]
49
49
  #
50
50
  # @!attribute [rw] engine_versions
@@ -90,7 +90,7 @@ module Aws::MQ
90
90
  # Returns information about all brokers.
91
91
  #
92
92
  # @!attribute [rw] console_url
93
- # The URL of the broker's Web Console.
93
+ # The brokers web console URL.
94
94
  # @return [String]
95
95
  #
96
96
  # @!attribute [rw] endpoints
@@ -99,7 +99,7 @@ module Aws::MQ
99
99
  #
100
100
  # @!attribute [rw] ip_address
101
101
  # The IP address of the Elastic Network Interface (ENI) attached to
102
- # the broker. Does not apply to RabbitMQ brokers
102
+ # the broker. Does not apply to RabbitMQ brokers.
103
103
  # @return [String]
104
104
  #
105
105
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/BrokerInstance AWS API Documentation
@@ -119,11 +119,11 @@ module Aws::MQ
119
119
  # @return [Array<Types::AvailabilityZone>]
120
120
  #
121
121
  # @!attribute [rw] engine_type
122
- # The type of broker engine.
122
+ # The broker's engine type.
123
123
  # @return [String]
124
124
  #
125
125
  # @!attribute [rw] host_instance_type
126
- # The type of broker instance.
126
+ # The broker's instance type.
127
127
  # @return [String]
128
128
  #
129
129
  # @!attribute [rw] storage_type
@@ -178,10 +178,10 @@ module Aws::MQ
178
178
  include Aws::Structure
179
179
  end
180
180
 
181
- # The Amazon Resource Name (ARN) of the broker.
181
+ # Returns information about all brokers.
182
182
  #
183
183
  # @!attribute [rw] broker_arn
184
- # The Amazon Resource Name (ARN) of the broker.
184
+ # The broker's Amazon Resource Name (ARN).
185
185
  # @return [String]
186
186
  #
187
187
  # @!attribute [rw] broker_id
@@ -189,14 +189,14 @@ module Aws::MQ
189
189
  # @return [String]
190
190
  #
191
191
  # @!attribute [rw] broker_name
192
- # The name of the broker. This value must be unique in your AWS
193
- # account, 1-50 characters long, must contain only letters, numbers,
194
- # dashes, and underscores, and must not contain whitespaces, brackets,
195
- # wildcard characters, or special characters.
192
+ # The broker's name. This value is unique in your AWS account, 1-50
193
+ # characters long, and containing only letters, numbers, dashes, and
194
+ # underscores, and must not contain white spaces, brackets, wildcard
195
+ # characters, or special characters.
196
196
  # @return [String]
197
197
  #
198
198
  # @!attribute [rw] broker_state
199
- # The status of the broker.
199
+ # The broker's status.
200
200
  # @return [String]
201
201
  #
202
202
  # @!attribute [rw] created
@@ -204,11 +204,11 @@ module Aws::MQ
204
204
  # @return [Time]
205
205
  #
206
206
  # @!attribute [rw] deployment_mode
207
- # Required. The deployment mode of the broker.
207
+ # The broker's deployment mode.
208
208
  # @return [String]
209
209
  #
210
210
  # @!attribute [rw] engine_type
211
- # Required. The type of broker engine.
211
+ # The type of broker engine.
212
212
  # @return [String]
213
213
  #
214
214
  # @!attribute [rw] host_instance_type
@@ -237,7 +237,8 @@ module Aws::MQ
237
237
  # @return [String]
238
238
  #
239
239
  # @!attribute [rw] authentication_strategy
240
- # The authentication strategy associated with the configuration.
240
+ # Optional. The authentication strategy associated with the
241
+ # configuration. The default is SIMPLE.
241
242
  # @return [String]
242
243
  #
243
244
  # @!attribute [rw] created
@@ -249,14 +250,17 @@ module Aws::MQ
249
250
  # @return [String]
250
251
  #
251
252
  # @!attribute [rw] engine_type
252
- # Required. The type of broker engine. Note: Currently, Amazon MQ
253
- # supports ACTIVEMQ and RABBITMQ.
253
+ # Required. The type of broker engine. Currently, Amazon MQ supports
254
+ # ACTIVEMQ and RABBITMQ.
254
255
  # @return [String]
255
256
  #
256
257
  # @!attribute [rw] engine_version
257
- # Required. The version of the broker engine. For a list of supported
258
- # engine versions, see
259
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
258
+ # Required. The broker engine's version. For a list of supported
259
+ # engine versions, see, [Supported engines][1].
260
+ #
261
+ #
262
+ #
263
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html
260
264
  # @return [String]
261
265
  #
262
266
  # @!attribute [rw] id
@@ -295,13 +299,15 @@ module Aws::MQ
295
299
  include Aws::Structure
296
300
  end
297
301
 
298
- # A list of information about the configuration. Does not apply to RabbitMQ brokers.
302
+ # A list of information about the configuration.
303
+ #
304
+ # Does not apply to RabbitMQ brokers.
299
305
  #
300
306
  # @note When making an API call, you may pass ConfigurationId
301
307
  # data as a hash:
302
308
  #
303
309
  # {
304
- # id: "__string",
310
+ # id: "__string", # required
305
311
  # revision: 1,
306
312
  # }
307
313
  #
@@ -350,7 +356,7 @@ module Aws::MQ
350
356
  # Broker configuration information
351
357
  #
352
358
  # @!attribute [rw] current
353
- # The current configuration of the broker.
359
+ # The broker's current configuration.
354
360
  # @return [Types::ConfigurationId]
355
361
  #
356
362
  # @!attribute [rw] history
@@ -358,7 +364,7 @@ module Aws::MQ
358
364
  # @return [Array<Types::ConfigurationId>]
359
365
  #
360
366
  # @!attribute [rw] pending
361
- # The pending configuration of the broker.
367
+ # The broker's pending configuration.
362
368
  # @return [Types::ConfigurationId]
363
369
  #
364
370
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/Configurations AWS API Documentation
@@ -388,25 +394,25 @@ module Aws::MQ
388
394
  include Aws::Structure
389
395
  end
390
396
 
391
- # Required. The version of the broker engine. For a list of supported
392
- # engine versions, see
393
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
397
+ # Creates a broker.
394
398
  #
395
399
  # @!attribute [rw] authentication_strategy
396
- # The authentication strategy used to secure the broker.
400
+ # Optional. The authentication strategy used to secure the broker. The
401
+ # default is SIMPLE.
397
402
  # @return [String]
398
403
  #
399
404
  # @!attribute [rw] auto_minor_version_upgrade
400
- # Required. Enables automatic upgrades to new minor versions for
401
- # brokers, as Apache releases the versions. The automatic upgrades
402
- # occur during the maintenance window of the broker or after a manual
403
- # broker reboot.
405
+ # Enables automatic upgrades to new minor versions for brokers, as new
406
+ # versions are released and supported by Amazon MQ. Automatic upgrades
407
+ # occur during the scheduled maintenance window of the broker or after
408
+ # a manual broker reboot. Set to true by default, if no value is
409
+ # specified.
404
410
  # @return [Boolean]
405
411
  #
406
412
  # @!attribute [rw] broker_name
407
- # Required. The name of the broker. This value must be unique in your
408
- # AWS account, 1-50 characters long, must contain only letters,
409
- # numbers, dashes, and underscores, and must not contain whitespaces,
413
+ # Required. The broker's name. This value must be unique in your AWS
414
+ # account, 1-50 characters long, must contain only letters, numbers,
415
+ # dashes, and underscores, and must not contain white spaces,
410
416
  # brackets, wildcard characters, or special characters.
411
417
  # @return [String]
412
418
  #
@@ -415,27 +421,37 @@ module Aws::MQ
415
421
  # @return [Types::ConfigurationId]
416
422
  #
417
423
  # @!attribute [rw] creator_request_id
418
- # 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
424
+ # The unique ID that the requester receives for the created broker.
425
+ # Amazon MQ passes your ID with the API action. Note: We recommend
426
+ # using a Universally Unique Identifier (UUID) for the
427
+ # creatorRequestId. You may omit the creatorRequestId if your
428
+ # application doesn't require idempotency.
429
+ #
430
+ # **A suitable default value is auto-generated.** You should normally
419
431
  # not need to pass this option.
420
432
  # @return [String]
421
433
  #
422
434
  # @!attribute [rw] deployment_mode
423
- # Required. The deployment mode of the broker.
435
+ # Required. The broker's deployment mode.
424
436
  # @return [String]
425
437
  #
426
438
  # @!attribute [rw] encryption_options
427
- # Encryption options for the broker.
439
+ # Encryption options for the broker. Does not apply to RabbitMQ
440
+ # brokers.
428
441
  # @return [Types::EncryptionOptions]
429
442
  #
430
443
  # @!attribute [rw] engine_type
431
- # Required. The type of broker engine. Note: Currently, Amazon MQ
432
- # supports ACTIVEMQ and RABBITMQ.
444
+ # Required. The type of broker engine. Currently, Amazon MQ supports
445
+ # ACTIVEMQ and RABBITMQ.
433
446
  # @return [String]
434
447
  #
435
448
  # @!attribute [rw] engine_version
436
- # Required. The version of the broker engine. For a list of supported
437
- # engine versions, see
438
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
449
+ # Required. The broker engine's version. For a list of supported
450
+ # engine versions, see [Supported engines][1].
451
+ #
452
+ #
453
+ #
454
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html
439
455
  # @return [String]
440
456
  #
441
457
  # @!attribute [rw] host_instance_type
@@ -443,8 +459,9 @@ module Aws::MQ
443
459
  # @return [String]
444
460
  #
445
461
  # @!attribute [rw] ldap_server_metadata
446
- # The metadata of the LDAP server used to authenticate and authorize
447
- # connections to the broker.
462
+ # Optional. The metadata of the LDAP server used to authenticate and
463
+ # authorize connections to the broker. Does not apply to RabbitMQ
464
+ # brokers.
448
465
  # @return [Types::LdapServerMetadataInput]
449
466
  #
450
467
  # @!attribute [rw] logs
@@ -456,12 +473,13 @@ module Aws::MQ
456
473
  # @return [Types::WeeklyStartTime]
457
474
  #
458
475
  # @!attribute [rw] publicly_accessible
459
- # Required. Enables connections from applications outside of the VPC
460
- # that hosts the broker's subnets.
476
+ # Enables connections from applications outside of the VPC that hosts
477
+ # the broker's subnets. Set to false by default, if no value is
478
+ # provided.
461
479
  # @return [Boolean]
462
480
  #
463
481
  # @!attribute [rw] security_groups
464
- # The list of security groups (1 minimum, 5 maximum) that authorizes
482
+ # The list of rules (1 minimum, 125 maximum) that authorize
465
483
  # connections to brokers.
466
484
  # @return [Array<String>]
467
485
  #
@@ -471,12 +489,25 @@ module Aws::MQ
471
489
  #
472
490
  # @!attribute [rw] subnet_ids
473
491
  # The list of groups that define which subnets and IP ranges the
474
- # broker can use from different Availability Zones. A SINGLE\_INSTANCE
475
- # deployment requires one subnet (for example, the default subnet). An
476
- # ACTIVE\_STANDBY\_MULTI\_AZ deployment (ACTIVEMQ) requires two
477
- # subnets. A CLUSTER\_MULTI\_AZ deployment (RABBITMQ) has no subnet
478
- # requirements when deployed with public accessibility, deployment
479
- # without public accessibility requires at least one subnet.
492
+ # broker can use from different Availability Zones. If you specify
493
+ # more than one subnet, the subnets must be in different Availability
494
+ # Zones. Amazon MQ will not be able to create VPC endpoints for your
495
+ # broker with multiple subnets in the same Availability Zone. A
496
+ # SINGLE\_INSTANCE deployment requires one subnet (for example, the
497
+ # default subnet). An ACTIVE\_STANDBY\_MULTI\_AZ Amazon MQ for
498
+ # ActiveMQ deployment requires two subnets. A CLUSTER\_MULTI\_AZ
499
+ # Amazon MQ for RabbitMQ deployment has no subnet requirements when
500
+ # deployed with public accessibility. Deployment without public
501
+ # accessibility requires at least one subnet.
502
+ #
503
+ # If you specify subnets in a [shared VPC][1] for a RabbitMQ broker,
504
+ # the associated VPC to which the specified subnets belong must be
505
+ # owned by your AWS account. Amazon MQ will not be able to create VPC
506
+ # endpoints in VPCs that are not owned by your AWS account.
507
+ #
508
+ #
509
+ #
510
+ # [1]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html
480
511
  # @return [Array<String>]
481
512
  #
482
513
  # @!attribute [rw] tags
@@ -485,13 +516,17 @@ module Aws::MQ
485
516
  #
486
517
  # @!attribute [rw] users
487
518
  # Required. The list of broker users (persons or applications) who can
488
- # access queues and topics. For RabbitMQ brokers, one and only one
519
+ # access queues and topics. This value can contain only alphanumeric
520
+ # characters, dashes, periods, underscores, and tildes (- . \_ ~).
521
+ # This value must be 2-100 characters long.
522
+ #
523
+ # <title>Amazon MQ for RabbitMQ</title>
524
+ #
525
+ # When you create an Amazon MQ for RabbitMQ broker, one and only one
489
526
  # administrative user is accepted and created when a broker is first
490
527
  # provisioned. All subsequent broker users are created by making
491
- # RabbitMQ API calls directly to brokers or via the RabbitMQ Web
492
- # Console. This value can contain only alphanumeric characters,
493
- # dashes, periods, underscores, and tildes (- . \_ ~). This value must
494
- # be 2-100 characters long.
528
+ # RabbitMQ API calls directly to brokers or via the RabbitMQ web
529
+ # console.
495
530
  # @return [Array<Types::User>]
496
531
  #
497
532
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerInput AWS API Documentation
@@ -523,7 +558,7 @@ module Aws::MQ
523
558
  # Returns information about the created broker.
524
559
  #
525
560
  # @!attribute [rw] broker_arn
526
- # The Amazon Resource Name (ARN) of the broker.
561
+ # The broker's Amazon Resource Name (ARN).
527
562
  # @return [String]
528
563
  #
529
564
  # @!attribute [rw] broker_id
@@ -544,32 +579,32 @@ module Aws::MQ
544
579
  #
545
580
  # {
546
581
  # authentication_strategy: "SIMPLE", # accepts SIMPLE, LDAP
547
- # auto_minor_version_upgrade: false,
548
- # broker_name: "__string",
582
+ # auto_minor_version_upgrade: false, # required
583
+ # broker_name: "__string", # required
549
584
  # configuration: {
550
- # id: "__string",
585
+ # id: "__string", # required
551
586
  # revision: 1,
552
587
  # },
553
588
  # creator_request_id: "__string",
554
- # deployment_mode: "SINGLE_INSTANCE", # accepts SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, CLUSTER_MULTI_AZ
589
+ # deployment_mode: "SINGLE_INSTANCE", # required, accepts SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, CLUSTER_MULTI_AZ
555
590
  # encryption_options: {
556
591
  # kms_key_id: "__string",
557
592
  # use_aws_owned_key: false, # required
558
593
  # },
559
- # engine_type: "ACTIVEMQ", # accepts ACTIVEMQ, RABBITMQ
560
- # engine_version: "__string",
561
- # host_instance_type: "__string",
594
+ # engine_type: "ACTIVEMQ", # required, accepts ACTIVEMQ, RABBITMQ
595
+ # engine_version: "__string", # required
596
+ # host_instance_type: "__string", # required
562
597
  # ldap_server_metadata: {
563
- # hosts: ["__string"],
564
- # role_base: "__string",
598
+ # hosts: ["__string"], # required
599
+ # role_base: "__string", # required
565
600
  # role_name: "__string",
566
- # role_search_matching: "__string",
601
+ # role_search_matching: "__string", # required
567
602
  # role_search_subtree: false,
568
- # service_account_password: "__string",
569
- # service_account_username: "__string",
570
- # user_base: "__string",
603
+ # service_account_password: "__string", # required
604
+ # service_account_username: "__string", # required
605
+ # user_base: "__string", # required
571
606
  # user_role_name: "__string",
572
- # user_search_matching: "__string",
607
+ # user_search_matching: "__string", # required
573
608
  # user_search_subtree: false,
574
609
  # },
575
610
  # logs: {
@@ -577,29 +612,30 @@ module Aws::MQ
577
612
  # general: false,
578
613
  # },
579
614
  # maintenance_window_start_time: {
580
- # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
581
- # time_of_day: "__string",
615
+ # day_of_week: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
616
+ # time_of_day: "__string", # required
582
617
  # time_zone: "__string",
583
618
  # },
584
- # publicly_accessible: false,
619
+ # publicly_accessible: false, # required
585
620
  # security_groups: ["__string"],
586
621
  # storage_type: "EBS", # accepts EBS, EFS
587
622
  # subnet_ids: ["__string"],
588
623
  # tags: {
589
624
  # "__string" => "__string",
590
625
  # },
591
- # users: [
626
+ # users: [ # required
592
627
  # {
593
628
  # console_access: false,
594
629
  # groups: ["__string"],
595
- # password: "__string",
596
- # username: "__string",
630
+ # password: "__string", # required
631
+ # username: "__string", # required
597
632
  # },
598
633
  # ],
599
634
  # }
600
635
  #
601
636
  # @!attribute [rw] authentication_strategy
602
- # The authentication strategy used to secure the broker.
637
+ # Optional. The authentication strategy used to secure the broker. The
638
+ # default is SIMPLE.
603
639
  # @return [String]
604
640
  #
605
641
  # @!attribute [rw] auto_minor_version_upgrade
@@ -609,7 +645,9 @@ module Aws::MQ
609
645
  # @return [String]
610
646
  #
611
647
  # @!attribute [rw] configuration
612
- # A list of information about the configuration. Does not apply to RabbitMQ brokers.
648
+ # A list of information about the configuration.
649
+ #
650
+ # Does not apply to RabbitMQ brokers.
613
651
  # @return [Types::ConfigurationId]
614
652
  #
615
653
  # @!attribute [rw] creator_request_id
@@ -618,16 +656,17 @@ module Aws::MQ
618
656
  # @return [String]
619
657
  #
620
658
  # @!attribute [rw] deployment_mode
621
- # The deployment mode of the broker.
659
+ # The broker's deployment mode.
622
660
  # @return [String]
623
661
  #
624
662
  # @!attribute [rw] encryption_options
663
+ # Does not apply to RabbitMQ brokers.
664
+ #
625
665
  # Encryption options for the broker.
626
666
  # @return [Types::EncryptionOptions]
627
667
  #
628
668
  # @!attribute [rw] engine_type
629
- # The type of broker engine. Note: Currently, Amazon MQ supports
630
- # ActiveMQ and RabbitMQ.
669
+ # The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
631
670
  # @return [String]
632
671
  #
633
672
  # @!attribute [rw] engine_version
@@ -637,7 +676,10 @@ module Aws::MQ
637
676
  # @return [String]
638
677
  #
639
678
  # @!attribute [rw] ldap_server_metadata
640
- # The metadata of the LDAP server used to authenticate and authorize connections to the broker. Currently not supported for RabbitMQ engine type.
679
+ # Optional. The metadata of the LDAP server used to authenticate and
680
+ # authorize connections to the broker.
681
+ #
682
+ # Does not apply to RabbitMQ brokers.
641
683
  # @return [Types::LdapServerMetadataInput]
642
684
  #
643
685
  # @!attribute [rw] logs
@@ -657,7 +699,9 @@ module Aws::MQ
657
699
  # @return [Array<String>]
658
700
  #
659
701
  # @!attribute [rw] storage_type
660
- # The storage type of the broker. EFS is currently not Supported for RabbitMQ engine type.
702
+ # The broker's storage type.
703
+ #
704
+ # EFS is not supported for RabbitMQ engine type.
661
705
  # @return [String]
662
706
  #
663
707
  # @!attribute [rw] subnet_ids
@@ -715,18 +759,22 @@ module Aws::MQ
715
759
  # version).
716
760
  #
717
761
  # @!attribute [rw] authentication_strategy
718
- # The authentication strategy associated with the configuration.
762
+ # Optional. The authentication strategy associated with the
763
+ # configuration. The default is SIMPLE.
719
764
  # @return [String]
720
765
  #
721
766
  # @!attribute [rw] engine_type
722
- # Required. The type of broker engine. Note: Currently, Amazon MQ
723
- # supports ACTIVEMQ and RABBITMQ.
767
+ # Required. The type of broker engine. Currently, Amazon MQ supports
768
+ # ACTIVEMQ and RABBITMQ.
724
769
  # @return [String]
725
770
  #
726
771
  # @!attribute [rw] engine_version
727
- # Required. The version of the broker engine. For a list of supported
728
- # engine versions, see
729
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
772
+ # Required. The broker engine's version. For a list of supported
773
+ # engine versions, see [Supported engines][1].
774
+ #
775
+ #
776
+ #
777
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html
730
778
  # @return [String]
731
779
  #
732
780
  # @!attribute [rw] name
@@ -758,7 +806,8 @@ module Aws::MQ
758
806
  # @return [String]
759
807
  #
760
808
  # @!attribute [rw] authentication_strategy
761
- # The authentication strategy associated with the configuration.
809
+ # Optional. The authentication strategy associated with the
810
+ # configuration. The default is SIMPLE.
762
811
  # @return [String]
763
812
  #
764
813
  # @!attribute [rw] created
@@ -798,21 +847,21 @@ module Aws::MQ
798
847
  #
799
848
  # {
800
849
  # authentication_strategy: "SIMPLE", # accepts SIMPLE, LDAP
801
- # engine_type: "ACTIVEMQ", # accepts ACTIVEMQ, RABBITMQ
802
- # engine_version: "__string",
803
- # name: "__string",
850
+ # engine_type: "ACTIVEMQ", # required, accepts ACTIVEMQ, RABBITMQ
851
+ # engine_version: "__string", # required
852
+ # name: "__string", # required
804
853
  # tags: {
805
854
  # "__string" => "__string",
806
855
  # },
807
856
  # }
808
857
  #
809
858
  # @!attribute [rw] authentication_strategy
810
- # The authentication strategy used to secure the broker.
859
+ # Optional. The authentication strategy used to secure the broker. The
860
+ # default is SIMPLE.
811
861
  # @return [String]
812
862
  #
813
863
  # @!attribute [rw] engine_type
814
- # The type of broker engine. Note: Currently, Amazon MQ supports
815
- # ActiveMQ and RabbitMQ.
864
+ # The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
816
865
  # @return [String]
817
866
  #
818
867
  # @!attribute [rw] engine_version
@@ -840,7 +889,8 @@ module Aws::MQ
840
889
  # @return [String]
841
890
  #
842
891
  # @!attribute [rw] authentication_strategy
843
- # The authentication strategy used to secure the broker.
892
+ # Optional. The authentication strategy used to secure the broker. The
893
+ # default is SIMPLE.
844
894
  # @return [String]
845
895
  #
846
896
  # @!attribute [rw] created
@@ -910,7 +960,7 @@ module Aws::MQ
910
960
  # @!attribute [rw] password
911
961
  # Required. The password of the user. This value must be at least 12
912
962
  # characters long, must contain at least 4 unique characters, and must
913
- # not contain commas.
963
+ # not contain commas, colons, or equal signs (,:=).
914
964
  # @return [String]
915
965
  #
916
966
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateUserInput AWS API Documentation
@@ -930,7 +980,7 @@ module Aws::MQ
930
980
  # broker_id: "__string", # required
931
981
  # console_access: false,
932
982
  # groups: ["__string"],
933
- # password: "__string",
983
+ # password: "__string", # required
934
984
  # username: "__string", # required
935
985
  # }
936
986
  #
@@ -1162,23 +1212,22 @@ module Aws::MQ
1162
1212
  include Aws::Structure
1163
1213
  end
1164
1214
 
1165
- # The version of the broker engine. For a list of supported engine
1166
- # versions, see
1167
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
1215
+ # Returns information about the specified broker.
1168
1216
  #
1169
1217
  # @!attribute [rw] authentication_strategy
1170
- # The authentication strategy used to secure the broker.
1218
+ # The authentication strategy used to secure the broker. The default
1219
+ # is SIMPLE.
1171
1220
  # @return [String]
1172
1221
  #
1173
1222
  # @!attribute [rw] auto_minor_version_upgrade
1174
- # Required. Enables automatic upgrades to new minor versions for
1175
- # brokers, as Apache releases the versions. The automatic upgrades
1176
- # occur during the maintenance window of the broker or after a manual
1177
- # broker reboot.
1223
+ # Enables automatic upgrades to new minor versions for brokers, as new
1224
+ # versions are released and supported by Amazon MQ. Automatic upgrades
1225
+ # occur during the scheduled maintenance window of the broker or after
1226
+ # a manual broker reboot.
1178
1227
  # @return [Boolean]
1179
1228
  #
1180
1229
  # @!attribute [rw] broker_arn
1181
- # The Amazon Resource Name (ARN) of the broker.
1230
+ # The broker's Amazon Resource Name (ARN).
1182
1231
  # @return [String]
1183
1232
  #
1184
1233
  # @!attribute [rw] broker_id
@@ -1190,14 +1239,14 @@ module Aws::MQ
1190
1239
  # @return [Array<Types::BrokerInstance>]
1191
1240
  #
1192
1241
  # @!attribute [rw] broker_name
1193
- # The name of the broker. This value must be unique in your AWS
1194
- # account, 1-50 characters long, must contain only letters, numbers,
1195
- # dashes, and underscores, and must not contain whitespaces, brackets,
1242
+ # The broker's name. This value must be unique in your AWS account,
1243
+ # 1-50 characters long, must contain only letters, numbers, dashes,
1244
+ # and underscores, and must not contain white spaces, brackets,
1196
1245
  # wildcard characters, or special characters.
1197
1246
  # @return [String]
1198
1247
  #
1199
1248
  # @!attribute [rw] broker_state
1200
- # The status of the broker.
1249
+ # The broker's status.
1201
1250
  # @return [String]
1202
1251
  #
1203
1252
  # @!attribute [rw] configurations
@@ -1209,22 +1258,26 @@ module Aws::MQ
1209
1258
  # @return [Time]
1210
1259
  #
1211
1260
  # @!attribute [rw] deployment_mode
1212
- # Required. The deployment mode of the broker.
1261
+ # The broker's deployment mode.
1213
1262
  # @return [String]
1214
1263
  #
1215
1264
  # @!attribute [rw] encryption_options
1216
- # Encryption options for the broker.
1265
+ # Encryption options for the broker. Does not apply to RabbitMQ
1266
+ # brokers.
1217
1267
  # @return [Types::EncryptionOptions]
1218
1268
  #
1219
1269
  # @!attribute [rw] engine_type
1220
- # Required. The type of broker engine. Note: Currently, Amazon MQ
1221
- # supports ACTIVEMQ and RABBITMQ.
1270
+ # The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ
1271
+ # and RABBITMQ.
1222
1272
  # @return [String]
1223
1273
  #
1224
1274
  # @!attribute [rw] engine_version
1225
- # The version of the broker engine. For a list of supported engine
1226
- # versions, see
1227
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
1275
+ # The broker engine's version. For a list of supported engine
1276
+ # versions, see [Supported engines][1].
1277
+ #
1278
+ #
1279
+ #
1280
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html
1228
1281
  # @return [String]
1229
1282
  #
1230
1283
  # @!attribute [rw] host_instance_type
@@ -1247,24 +1300,30 @@ module Aws::MQ
1247
1300
  #
1248
1301
  # @!attribute [rw] pending_authentication_strategy
1249
1302
  # The authentication strategy that will be applied when the broker is
1250
- # rebooted.
1303
+ # rebooted. The default is SIMPLE.
1251
1304
  # @return [String]
1252
1305
  #
1253
1306
  # @!attribute [rw] pending_engine_version
1254
- # The version of the broker engine to upgrade to. For a list of
1255
- # supported engine versions, see
1256
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
1307
+ # The broker engine version to upgrade to. For a list of supported
1308
+ # engine versions, see [Supported engines][1].
1309
+ #
1310
+ #
1311
+ #
1312
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html
1257
1313
  # @return [String]
1258
1314
  #
1259
1315
  # @!attribute [rw] pending_host_instance_type
1260
- # The host instance type of the broker to upgrade to. For a list of
1261
- # supported instance types, see
1262
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
1316
+ # The broker's host instance type to upgrade to. For a list of
1317
+ # supported instance types, see [Broker instance types][1].
1318
+ #
1319
+ #
1320
+ #
1321
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types
1263
1322
  # @return [String]
1264
1323
  #
1265
1324
  # @!attribute [rw] pending_ldap_server_metadata
1266
1325
  # The metadata of the LDAP server that will be used to authenticate
1267
- # and authorize connections to the broker once it is rebooted.
1326
+ # and authorize connections to the broker after it is rebooted.
1268
1327
  # @return [Types::LdapServerMetadataOutput]
1269
1328
  #
1270
1329
  # @!attribute [rw] pending_security_groups
@@ -1273,12 +1332,12 @@ module Aws::MQ
1273
1332
  # @return [Array<String>]
1274
1333
  #
1275
1334
  # @!attribute [rw] publicly_accessible
1276
- # Required. Enables connections from applications outside of the VPC
1277
- # that hosts the broker's subnets.
1335
+ # Enables connections from applications outside of the VPC that hosts
1336
+ # the broker's subnets.
1278
1337
  # @return [Boolean]
1279
1338
  #
1280
1339
  # @!attribute [rw] security_groups
1281
- # The list of security groups (1 minimum, 5 maximum) that authorizes
1340
+ # The list of rules (1 minimum, 125 maximum) that authorize
1282
1341
  # connections to brokers.
1283
1342
  # @return [Array<String>]
1284
1343
  #
@@ -1288,12 +1347,7 @@ module Aws::MQ
1288
1347
  #
1289
1348
  # @!attribute [rw] subnet_ids
1290
1349
  # The list of groups that define which subnets and IP ranges the
1291
- # broker can use from different Availability Zones. A SINGLE\_INSTANCE
1292
- # deployment requires one subnet (for example, the default subnet). An
1293
- # ACTIVE\_STANDBY\_MULTI\_AZ deployment (ACTIVEMQ) requires two
1294
- # subnets. A CLUSTER\_MULTI\_AZ deployment (RABBITMQ) has no subnet
1295
- # requirements when deployed with public accessibility, deployment
1296
- # without public accessibility requires at least one subnet.
1350
+ # broker can use from different Availability Zones.
1297
1351
  # @return [Array<String>]
1298
1352
  #
1299
1353
  # @!attribute [rw] tags
@@ -1358,7 +1412,8 @@ module Aws::MQ
1358
1412
  end
1359
1413
 
1360
1414
  # @!attribute [rw] authentication_strategy
1361
- # The authentication strategy used to secure the broker.
1415
+ # Optional. The authentication strategy used to secure the broker. The
1416
+ # default is SIMPLE.
1362
1417
  # @return [String]
1363
1418
  #
1364
1419
  # @!attribute [rw] auto_minor_version_upgrade
@@ -1377,7 +1432,7 @@ module Aws::MQ
1377
1432
  # @return [String]
1378
1433
  #
1379
1434
  # @!attribute [rw] broker_state
1380
- # The status of the broker.
1435
+ # The broker's status.
1381
1436
  # @return [String]
1382
1437
  #
1383
1438
  # @!attribute [rw] configurations
@@ -1388,16 +1443,17 @@ module Aws::MQ
1388
1443
  # @return [Time]
1389
1444
  #
1390
1445
  # @!attribute [rw] deployment_mode
1391
- # The deployment mode of the broker.
1446
+ # The broker's deployment mode.
1392
1447
  # @return [String]
1393
1448
  #
1394
1449
  # @!attribute [rw] encryption_options
1450
+ # Does not apply to RabbitMQ brokers.
1451
+ #
1395
1452
  # Encryption options for the broker.
1396
1453
  # @return [Types::EncryptionOptions]
1397
1454
  #
1398
1455
  # @!attribute [rw] engine_type
1399
- # The type of broker engine. Note: Currently, Amazon MQ supports
1400
- # ActiveMQ and RabbitMQ.
1456
+ # The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
1401
1457
  # @return [String]
1402
1458
  #
1403
1459
  # @!attribute [rw] engine_version
@@ -1407,8 +1463,8 @@ module Aws::MQ
1407
1463
  # @return [String]
1408
1464
  #
1409
1465
  # @!attribute [rw] ldap_server_metadata
1410
- # The metadata of the LDAP server used to authenticate and authorize
1411
- # connections to the broker.
1466
+ # Optional. The metadata of the LDAP server used to authenticate and
1467
+ # authorize connections to the broker.
1412
1468
  # @return [Types::LdapServerMetadataOutput]
1413
1469
  #
1414
1470
  # @!attribute [rw] logs
@@ -1422,7 +1478,8 @@ module Aws::MQ
1422
1478
  # @return [Types::WeeklyStartTime]
1423
1479
  #
1424
1480
  # @!attribute [rw] pending_authentication_strategy
1425
- # The authentication strategy used to secure the broker.
1481
+ # Optional. The authentication strategy used to secure the broker. The
1482
+ # default is SIMPLE.
1426
1483
  # @return [String]
1427
1484
  #
1428
1485
  # @!attribute [rw] pending_engine_version
@@ -1432,8 +1489,8 @@ module Aws::MQ
1432
1489
  # @return [String]
1433
1490
  #
1434
1491
  # @!attribute [rw] pending_ldap_server_metadata
1435
- # The metadata of the LDAP server used to authenticate and authorize
1436
- # connections to the broker.
1492
+ # Optional. The metadata of the LDAP server used to authenticate and
1493
+ # authorize connections to the broker.
1437
1494
  # @return [Types::LdapServerMetadataOutput]
1438
1495
  #
1439
1496
  # @!attribute [rw] pending_security_groups
@@ -1446,7 +1503,9 @@ module Aws::MQ
1446
1503
  # @return [Array<String>]
1447
1504
  #
1448
1505
  # @!attribute [rw] storage_type
1449
- # The storage type of the broker. EFS is currently not Supported for RabbitMQ engine type.
1506
+ # The broker's storage type.
1507
+ #
1508
+ # EFS is not supported for RabbitMQ engine type.
1450
1509
  # @return [String]
1451
1510
  #
1452
1511
  # @!attribute [rw] subnet_ids
@@ -1515,7 +1574,8 @@ module Aws::MQ
1515
1574
  # @return [String]
1516
1575
  #
1517
1576
  # @!attribute [rw] authentication_strategy
1518
- # The authentication strategy used to secure the broker.
1577
+ # Optional. The authentication strategy used to secure the broker. The
1578
+ # default is SIMPLE.
1519
1579
  # @return [String]
1520
1580
  #
1521
1581
  # @!attribute [rw] created
@@ -1525,8 +1585,7 @@ module Aws::MQ
1525
1585
  # @return [String]
1526
1586
  #
1527
1587
  # @!attribute [rw] engine_type
1528
- # The type of broker engine. Note: Currently, Amazon MQ supports
1529
- # ActiveMQ and RabbitMQ.
1588
+ # The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
1530
1589
  # @return [String]
1531
1590
  #
1532
1591
  # @!attribute [rw] engine_version
@@ -1731,6 +1790,8 @@ module Aws::MQ
1731
1790
  include Aws::Structure
1732
1791
  end
1733
1792
 
1793
+ # Does not apply to RabbitMQ brokers.
1794
+ #
1734
1795
  # Encryption options for the broker.
1735
1796
  #
1736
1797
  # @note When making an API call, you may pass EncryptionOptions
@@ -1742,15 +1803,15 @@ module Aws::MQ
1742
1803
  # }
1743
1804
  #
1744
1805
  # @!attribute [rw] kms_key_id
1745
- # The symmetric customer master key (CMK) to use for the AWS Key
1746
- # Management Service (KMS). This key is used to encrypt your data at
1747
- # rest. If not provided, Amazon MQ will use a default CMK to encrypt
1748
- # your data.
1806
+ # The customer master key (CMK) to use for the AWS Key Management
1807
+ # Service (KMS). This key is used to encrypt your data at rest. If not
1808
+ # provided, Amazon MQ will use a default CMK to encrypt your data.
1749
1809
  # @return [String]
1750
1810
  #
1751
1811
  # @!attribute [rw] use_aws_owned_key
1752
1812
  # Enables the use of an AWS owned CMK using AWS Key Management Service
1753
- # (KMS).
1813
+ # (KMS). Set to true by default, if no value is provided, for example,
1814
+ # for RabbitMQ brokers.
1754
1815
  # @return [Boolean]
1755
1816
  #
1756
1817
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/EncryptionOptions AWS API Documentation
@@ -1829,32 +1890,37 @@ module Aws::MQ
1829
1890
  include Aws::Structure
1830
1891
  end
1831
1892
 
1832
- # The metadata of the LDAP server used to authenticate and authorize connections to the broker. Currently not supported for RabbitMQ engine type.
1893
+ # Optional. The metadata of the LDAP server used to authenticate and
1894
+ # authorize connections to the broker.
1895
+ #
1896
+ # Does not apply to RabbitMQ brokers.
1833
1897
  #
1834
1898
  # @note When making an API call, you may pass LdapServerMetadataInput
1835
1899
  # data as a hash:
1836
1900
  #
1837
1901
  # {
1838
- # hosts: ["__string"],
1839
- # role_base: "__string",
1902
+ # hosts: ["__string"], # required
1903
+ # role_base: "__string", # required
1840
1904
  # role_name: "__string",
1841
- # role_search_matching: "__string",
1905
+ # role_search_matching: "__string", # required
1842
1906
  # role_search_subtree: false,
1843
- # service_account_password: "__string",
1844
- # service_account_username: "__string",
1845
- # user_base: "__string",
1907
+ # service_account_password: "__string", # required
1908
+ # service_account_username: "__string", # required
1909
+ # user_base: "__string", # required
1846
1910
  # user_role_name: "__string",
1847
- # user_search_matching: "__string",
1911
+ # user_search_matching: "__string", # required
1848
1912
  # user_search_subtree: false,
1849
1913
  # }
1850
1914
  #
1851
1915
  # @!attribute [rw] hosts
1852
- # Fully qualified domain name of the LDAP server. Optional failover
1853
- # server.
1916
+ # Specifies the location of the LDAP server such as AWS Directory
1917
+ # Service for Microsoft Active Directory . Optional failover server.
1854
1918
  # @return [Array<String>]
1855
1919
  #
1856
1920
  # @!attribute [rw] role_base
1857
- # Fully qualified name of the directory to search for a user’s groups.
1921
+ # The distinguished name of the node in the directory information tree
1922
+ # (DIT) to search for roles or groups. For example, ou=group, ou=corp,
1923
+ # dc=corp, dc=example, dc=com.
1858
1924
  # @return [String]
1859
1925
  #
1860
1926
  # @!attribute [rw] role_name
@@ -1863,25 +1929,41 @@ module Aws::MQ
1863
1929
  # @return [String]
1864
1930
  #
1865
1931
  # @!attribute [rw] role_search_matching
1866
- # The search criteria for groups.
1932
+ # The LDAP search filter used to find roles within the roleBase. The
1933
+ # distinguished name of the user matched by userSearchMatching is
1934
+ # substituted into the \\\{0\\} placeholder in the search filter. The
1935
+ # client's username is substituted into the \\\{1\\} placeholder. For
1936
+ # example, if you set this option to (member=uid=\\\{1\\})for the user
1937
+ # janedoe, the search filter becomes (member=uid=janedoe) after string
1938
+ # substitution. It matches all role entries that have a member
1939
+ # attribute equal to uid=janedoe under the subtree selected by the
1940
+ # roleBase.
1867
1941
  # @return [String]
1868
1942
  #
1869
1943
  # @!attribute [rw] role_search_subtree
1870
1944
  # The directory search scope for the role. If set to true, scope is to
1871
- # search the entire sub-tree.
1945
+ # search the entire subtree.
1872
1946
  # @return [Boolean]
1873
1947
  #
1874
1948
  # @!attribute [rw] service_account_password
1875
- # Service account password.
1949
+ # Service account password. A service account is an account in your
1950
+ # LDAP server that has access to initiate a connection. For example,
1951
+ # cn=admin,dc=corp, dc=example, dc=com.
1876
1952
  # @return [String]
1877
1953
  #
1878
1954
  # @!attribute [rw] service_account_username
1879
- # Service account username.
1955
+ # Service account username. A service account is an account in your
1956
+ # LDAP server that has access to initiate a connection. For example,
1957
+ # cn=admin,dc=corp, dc=example, dc=com.
1880
1958
  # @return [String]
1881
1959
  #
1882
1960
  # @!attribute [rw] user_base
1883
- # Fully qualified name of the directory where you want to search for
1884
- # users.
1961
+ # Select a particular subtree of the directory information tree (DIT)
1962
+ # to search for user entries. The subtree is specified by a DN, which
1963
+ # specifies the base node of the subtree. For example, by setting this
1964
+ # option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search
1965
+ # for user entries is restricted to the subtree beneath ou=Users,
1966
+ # ou=corp, dc=corp, dc=example, dc=com.
1885
1967
  # @return [String]
1886
1968
  #
1887
1969
  # @!attribute [rw] user_role_name
@@ -1890,12 +1972,18 @@ module Aws::MQ
1890
1972
  # @return [String]
1891
1973
  #
1892
1974
  # @!attribute [rw] user_search_matching
1893
- # The search criteria for users.
1975
+ # The LDAP search filter used to find users within the userBase. The
1976
+ # client's username is substituted into the \\\{0\\} placeholder in
1977
+ # the search filter. For example, if this option is set to
1978
+ # (uid=\\\{0\\}) and the received username is janedoe, the search
1979
+ # filter becomes (uid=janedoe) after string substitution. It will
1980
+ # result in matching an entry like uid=janedoe, ou=Users,ou=corp,
1981
+ # dc=corp, dc=example, dc=com.
1894
1982
  # @return [String]
1895
1983
  #
1896
1984
  # @!attribute [rw] user_search_subtree
1897
1985
  # The directory search scope for the user. If set to true, scope is to
1898
- # search the entire sub-tree.
1986
+ # search the entire subtree.
1899
1987
  # @return [Boolean]
1900
1988
  #
1901
1989
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/LdapServerMetadataInput AWS API Documentation
@@ -1916,16 +2004,18 @@ module Aws::MQ
1916
2004
  include Aws::Structure
1917
2005
  end
1918
2006
 
1919
- # The metadata of the LDAP server used to authenticate and authorize
1920
- # connections to the broker.
2007
+ # Optional. The metadata of the LDAP server used to authenticate and
2008
+ # authorize connections to the broker.
1921
2009
  #
1922
2010
  # @!attribute [rw] hosts
1923
- # Fully qualified domain name of the LDAP server. Optional failover
1924
- # server.
2011
+ # Specifies the location of the LDAP server such as AWS Directory
2012
+ # Service for Microsoft Active Directory . Optional failover server.
1925
2013
  # @return [Array<String>]
1926
2014
  #
1927
2015
  # @!attribute [rw] role_base
1928
- # Fully qualified name of the directory to search for a user’s groups.
2016
+ # The distinguished name of the node in the directory information tree
2017
+ # (DIT) to search for roles or groups. For example, ou=group, ou=corp,
2018
+ # dc=corp, dc=example, dc=com.
1929
2019
  # @return [String]
1930
2020
  #
1931
2021
  # @!attribute [rw] role_name
@@ -1934,21 +2024,35 @@ module Aws::MQ
1934
2024
  # @return [String]
1935
2025
  #
1936
2026
  # @!attribute [rw] role_search_matching
1937
- # The search criteria for groups.
2027
+ # The LDAP search filter used to find roles within the roleBase. The
2028
+ # distinguished name of the user matched by userSearchMatching is
2029
+ # substituted into the \\\{0\\} placeholder in the search filter. The
2030
+ # client's username is substituted into the \\\{1\\} placeholder. For
2031
+ # example, if you set this option to (member=uid=\\\{1\\})for the user
2032
+ # janedoe, the search filter becomes (member=uid=janedoe) after string
2033
+ # substitution. It matches all role entries that have a member
2034
+ # attribute equal to uid=janedoe under the subtree selected by the
2035
+ # roleBase.
1938
2036
  # @return [String]
1939
2037
  #
1940
2038
  # @!attribute [rw] role_search_subtree
1941
2039
  # The directory search scope for the role. If set to true, scope is to
1942
- # search the entire sub-tree.
2040
+ # search the entire subtree.
1943
2041
  # @return [Boolean]
1944
2042
  #
1945
2043
  # @!attribute [rw] service_account_username
1946
- # Service account username.
2044
+ # Service account username. A service account is an account in your
2045
+ # LDAP server that has access to initiate a connection. For example,
2046
+ # cn=admin,dc=corp, dc=example, dc=com.
1947
2047
  # @return [String]
1948
2048
  #
1949
2049
  # @!attribute [rw] user_base
1950
- # Fully qualified name of the directory where you want to search for
1951
- # users.
2050
+ # Select a particular subtree of the directory information tree (DIT)
2051
+ # to search for user entries. The subtree is specified by a DN, which
2052
+ # specifies the base node of the subtree. For example, by setting this
2053
+ # option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search
2054
+ # for user entries is restricted to the subtree beneath ou=Users,
2055
+ # ou=corp, dc=corp, dc=example, dc=com.
1952
2056
  # @return [String]
1953
2057
  #
1954
2058
  # @!attribute [rw] user_role_name
@@ -1957,12 +2061,18 @@ module Aws::MQ
1957
2061
  # @return [String]
1958
2062
  #
1959
2063
  # @!attribute [rw] user_search_matching
1960
- # The search criteria for users.
2064
+ # The LDAP search filter used to find users within the userBase. The
2065
+ # client's username is substituted into the \\\{0\\} placeholder in
2066
+ # the search filter. For example, if this option is set to
2067
+ # (uid=\\\{0\\}) and the received username is janedoe, the search
2068
+ # filter becomes (uid=janedoe) after string substitution. It will
2069
+ # result in matching an entry like uid=janedoe, ou=Users,ou=corp,
2070
+ # dc=corp, dc=example, dc=com.
1961
2071
  # @return [String]
1962
2072
  #
1963
2073
  # @!attribute [rw] user_search_subtree
1964
2074
  # The directory search scope for the user. If set to true, scope is to
1965
- # search the entire sub-tree.
2075
+ # search the entire subtree.
1966
2076
  # @return [Boolean]
1967
2077
  #
1968
2078
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/LdapServerMetadataOutput AWS API Documentation
@@ -1982,8 +2092,6 @@ module Aws::MQ
1982
2092
  include Aws::Structure
1983
2093
  end
1984
2094
 
1985
- # A list of information about all brokers.
1986
- #
1987
2095
  # @!attribute [rw] broker_summaries
1988
2096
  # A list of information about all brokers.
1989
2097
  # @return [Array<Types::BrokerSummary>]
@@ -2239,7 +2347,7 @@ module Aws::MQ
2239
2347
  #
2240
2348
  # @!attribute [rw] users
2241
2349
  # Required. The list of all ActiveMQ usernames for the specified
2242
- # broker.
2350
+ # broker. Does not apply to RabbitMQ brokers.
2243
2351
  # @return [Array<Types::UserSummary>]
2244
2352
  #
2245
2353
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/ListUsersOutput AWS API Documentation
@@ -2493,14 +2601,15 @@ module Aws::MQ
2493
2601
  # Updates the broker using the specified properties.
2494
2602
  #
2495
2603
  # @!attribute [rw] authentication_strategy
2496
- # The authentication strategy used to secure the broker.
2604
+ # Optional. The authentication strategy used to secure the broker. The
2605
+ # default is SIMPLE.
2497
2606
  # @return [String]
2498
2607
  #
2499
2608
  # @!attribute [rw] auto_minor_version_upgrade
2500
- # Enables automatic upgrades to new minor versions for brokers, as
2501
- # Apache releases the versions. The automatic upgrades occur during
2502
- # the maintenance window of the broker or after a manual broker
2503
- # reboot.
2609
+ # Enables automatic upgrades to new minor versions for brokers, as new
2610
+ # versions are released and supported by Amazon MQ. Automatic upgrades
2611
+ # occur during the scheduled maintenance window of the broker or after
2612
+ # a manual broker reboot.
2504
2613
  # @return [Boolean]
2505
2614
  #
2506
2615
  # @!attribute [rw] configuration
@@ -2508,26 +2617,37 @@ module Aws::MQ
2508
2617
  # @return [Types::ConfigurationId]
2509
2618
  #
2510
2619
  # @!attribute [rw] engine_version
2511
- # The version of the broker engine. For a list of supported engine
2512
- # versions, see
2513
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
2620
+ # The broker engine version. For a list of supported engine versions,
2621
+ # see [Supported engines][1].
2622
+ #
2623
+ #
2624
+ #
2625
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html
2514
2626
  # @return [String]
2515
2627
  #
2516
2628
  # @!attribute [rw] host_instance_type
2517
- # The host instance type of the broker to upgrade to. For a list of
2518
- # supported instance types, see
2519
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
2629
+ # The broker's host instance type to upgrade to. For a list of
2630
+ # supported instance types, see [Broker instance types][1].
2631
+ #
2632
+ #
2633
+ #
2634
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types
2520
2635
  # @return [String]
2521
2636
  #
2522
2637
  # @!attribute [rw] ldap_server_metadata
2523
- # The metadata of the LDAP server used to authenticate and authorize
2524
- # connections to the broker.
2638
+ # Optional. The metadata of the LDAP server used to authenticate and
2639
+ # authorize connections to the broker. Does not apply to RabbitMQ
2640
+ # brokers.
2525
2641
  # @return [Types::LdapServerMetadataInput]
2526
2642
  #
2527
2643
  # @!attribute [rw] logs
2528
2644
  # Enables Amazon CloudWatch logging for brokers.
2529
2645
  # @return [Types::Logs]
2530
2646
  #
2647
+ # @!attribute [rw] maintenance_window_start_time
2648
+ # The parameters that determine the WeeklyStartTime.
2649
+ # @return [Types::WeeklyStartTime]
2650
+ #
2531
2651
  # @!attribute [rw] security_groups
2532
2652
  # The list of security groups (1 minimum, 5 maximum) that authorizes
2533
2653
  # connections to brokers.
@@ -2543,6 +2663,7 @@ module Aws::MQ
2543
2663
  :host_instance_type,
2544
2664
  :ldap_server_metadata,
2545
2665
  :logs,
2666
+ :maintenance_window_start_time,
2546
2667
  :security_groups)
2547
2668
  SENSITIVE = []
2548
2669
  include Aws::Structure
@@ -2551,12 +2672,14 @@ module Aws::MQ
2551
2672
  # Returns information about the updated broker.
2552
2673
  #
2553
2674
  # @!attribute [rw] authentication_strategy
2554
- # The authentication strategy used to secure the broker.
2675
+ # Optional. The authentication strategy used to secure the broker. The
2676
+ # default is SIMPLE.
2555
2677
  # @return [String]
2556
2678
  #
2557
2679
  # @!attribute [rw] auto_minor_version_upgrade
2558
- # The new value of automatic upgrades to new minor version for
2559
- # brokers.
2680
+ # The new boolean value that specifies whether broker engines
2681
+ # automatically upgrade to new minor versions as new versions are
2682
+ # released and supported by Amazon MQ.
2560
2683
  # @return [Boolean]
2561
2684
  #
2562
2685
  # @!attribute [rw] broker_id
@@ -2568,20 +2691,27 @@ module Aws::MQ
2568
2691
  # @return [Types::ConfigurationId]
2569
2692
  #
2570
2693
  # @!attribute [rw] engine_version
2571
- # The version of the broker engine to upgrade to. For a list of
2572
- # supported engine versions, see
2573
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
2694
+ # The broker engine version to upgrade to. For a list of supported
2695
+ # engine versions, see [Supported engines][1].
2696
+ #
2697
+ #
2698
+ #
2699
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html
2574
2700
  # @return [String]
2575
2701
  #
2576
2702
  # @!attribute [rw] host_instance_type
2577
- # The host instance type of the broker to upgrade to. For a list of
2578
- # supported instance types, see
2579
- # https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
2703
+ # The broker's host instance type to upgrade to. For a list of
2704
+ # supported instance types, see [Broker instance types][1].
2705
+ #
2706
+ #
2707
+ #
2708
+ # [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types
2580
2709
  # @return [String]
2581
2710
  #
2582
2711
  # @!attribute [rw] ldap_server_metadata
2583
- # The metadata of the LDAP server used to authenticate and authorize
2584
- # connections to the broker.
2712
+ # Optional. The metadata of the LDAP server used to authenticate and
2713
+ # authorize connections to the broker. Does not apply to RabbitMQ
2714
+ # brokers.
2585
2715
  # @return [Types::LdapServerMetadataOutput]
2586
2716
  #
2587
2717
  # @!attribute [rw] logs
@@ -2589,6 +2719,10 @@ module Aws::MQ
2589
2719
  # broker.
2590
2720
  # @return [Types::Logs]
2591
2721
  #
2722
+ # @!attribute [rw] maintenance_window_start_time
2723
+ # The parameters that determine the WeeklyStartTime.
2724
+ # @return [Types::WeeklyStartTime]
2725
+ #
2592
2726
  # @!attribute [rw] security_groups
2593
2727
  # The list of security groups (1 minimum, 5 maximum) that authorizes
2594
2728
  # connections to brokers.
@@ -2605,6 +2739,7 @@ module Aws::MQ
2605
2739
  :host_instance_type,
2606
2740
  :ldap_server_metadata,
2607
2741
  :logs,
2742
+ :maintenance_window_start_time,
2608
2743
  :security_groups)
2609
2744
  SENSITIVE = []
2610
2745
  include Aws::Structure
@@ -2618,33 +2753,39 @@ module Aws::MQ
2618
2753
  # auto_minor_version_upgrade: false,
2619
2754
  # broker_id: "__string", # required
2620
2755
  # configuration: {
2621
- # id: "__string",
2756
+ # id: "__string", # required
2622
2757
  # revision: 1,
2623
2758
  # },
2624
2759
  # engine_version: "__string",
2625
2760
  # host_instance_type: "__string",
2626
2761
  # ldap_server_metadata: {
2627
- # hosts: ["__string"],
2628
- # role_base: "__string",
2762
+ # hosts: ["__string"], # required
2763
+ # role_base: "__string", # required
2629
2764
  # role_name: "__string",
2630
- # role_search_matching: "__string",
2765
+ # role_search_matching: "__string", # required
2631
2766
  # role_search_subtree: false,
2632
- # service_account_password: "__string",
2633
- # service_account_username: "__string",
2634
- # user_base: "__string",
2767
+ # service_account_password: "__string", # required
2768
+ # service_account_username: "__string", # required
2769
+ # user_base: "__string", # required
2635
2770
  # user_role_name: "__string",
2636
- # user_search_matching: "__string",
2771
+ # user_search_matching: "__string", # required
2637
2772
  # user_search_subtree: false,
2638
2773
  # },
2639
2774
  # logs: {
2640
2775
  # audit: false,
2641
2776
  # general: false,
2642
2777
  # },
2778
+ # maintenance_window_start_time: {
2779
+ # day_of_week: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
2780
+ # time_of_day: "__string", # required
2781
+ # time_zone: "__string",
2782
+ # },
2643
2783
  # security_groups: ["__string"],
2644
2784
  # }
2645
2785
  #
2646
2786
  # @!attribute [rw] authentication_strategy
2647
- # The authentication strategy used to secure the broker.
2787
+ # Optional. The authentication strategy used to secure the broker. The
2788
+ # default is SIMPLE.
2648
2789
  # @return [String]
2649
2790
  #
2650
2791
  # @!attribute [rw] auto_minor_version_upgrade
@@ -2654,7 +2795,9 @@ module Aws::MQ
2654
2795
  # @return [String]
2655
2796
  #
2656
2797
  # @!attribute [rw] configuration
2657
- # A list of information about the configuration. Does not apply to RabbitMQ brokers.
2798
+ # A list of information about the configuration.
2799
+ #
2800
+ # Does not apply to RabbitMQ brokers.
2658
2801
  # @return [Types::ConfigurationId]
2659
2802
  #
2660
2803
  # @!attribute [rw] engine_version
@@ -2664,7 +2807,10 @@ module Aws::MQ
2664
2807
  # @return [String]
2665
2808
  #
2666
2809
  # @!attribute [rw] ldap_server_metadata
2667
- # The metadata of the LDAP server used to authenticate and authorize connections to the broker. Currently not supported for RabbitMQ engine type.
2810
+ # Optional. The metadata of the LDAP server used to authenticate and
2811
+ # authorize connections to the broker.
2812
+ #
2813
+ # Does not apply to RabbitMQ brokers.
2668
2814
  # @return [Types::LdapServerMetadataInput]
2669
2815
  #
2670
2816
  # @!attribute [rw] logs
@@ -2672,6 +2818,11 @@ module Aws::MQ
2672
2818
  # broker.
2673
2819
  # @return [Types::Logs]
2674
2820
  #
2821
+ # @!attribute [rw] maintenance_window_start_time
2822
+ # The scheduled time period relative to UTC during which Amazon MQ
2823
+ # begins to apply pending updates or patches to the broker.
2824
+ # @return [Types::WeeklyStartTime]
2825
+ #
2675
2826
  # @!attribute [rw] security_groups
2676
2827
  # @return [Array<String>]
2677
2828
  #
@@ -2686,13 +2837,15 @@ module Aws::MQ
2686
2837
  :host_instance_type,
2687
2838
  :ldap_server_metadata,
2688
2839
  :logs,
2840
+ :maintenance_window_start_time,
2689
2841
  :security_groups)
2690
2842
  SENSITIVE = []
2691
2843
  include Aws::Structure
2692
2844
  end
2693
2845
 
2694
2846
  # @!attribute [rw] authentication_strategy
2695
- # The authentication strategy used to secure the broker.
2847
+ # Optional. The authentication strategy used to secure the broker. The
2848
+ # default is SIMPLE.
2696
2849
  # @return [String]
2697
2850
  #
2698
2851
  # @!attribute [rw] auto_minor_version_upgrade
@@ -2702,7 +2855,9 @@ module Aws::MQ
2702
2855
  # @return [String]
2703
2856
  #
2704
2857
  # @!attribute [rw] configuration
2705
- # A list of information about the configuration. Does not apply to RabbitMQ brokers.
2858
+ # A list of information about the configuration.
2859
+ #
2860
+ # Does not apply to RabbitMQ brokers.
2706
2861
  # @return [Types::ConfigurationId]
2707
2862
  #
2708
2863
  # @!attribute [rw] engine_version
@@ -2712,8 +2867,8 @@ module Aws::MQ
2712
2867
  # @return [String]
2713
2868
  #
2714
2869
  # @!attribute [rw] ldap_server_metadata
2715
- # The metadata of the LDAP server used to authenticate and authorize
2716
- # connections to the broker.
2870
+ # Optional. The metadata of the LDAP server used to authenticate and
2871
+ # authorize connections to the broker.
2717
2872
  # @return [Types::LdapServerMetadataOutput]
2718
2873
  #
2719
2874
  # @!attribute [rw] logs
@@ -2721,6 +2876,11 @@ module Aws::MQ
2721
2876
  # broker.
2722
2877
  # @return [Types::Logs]
2723
2878
  #
2879
+ # @!attribute [rw] maintenance_window_start_time
2880
+ # The scheduled time period relative to UTC during which Amazon MQ
2881
+ # begins to apply pending updates or patches to the broker.
2882
+ # @return [Types::WeeklyStartTime]
2883
+ #
2724
2884
  # @!attribute [rw] security_groups
2725
2885
  # @return [Array<String>]
2726
2886
  #
@@ -2735,6 +2895,7 @@ module Aws::MQ
2735
2895
  :host_instance_type,
2736
2896
  :ldap_server_metadata,
2737
2897
  :logs,
2898
+ :maintenance_window_start_time,
2738
2899
  :security_groups)
2739
2900
  SENSITIVE = []
2740
2901
  include Aws::Structure
@@ -2807,7 +2968,7 @@ module Aws::MQ
2807
2968
  #
2808
2969
  # {
2809
2970
  # configuration_id: "__string", # required
2810
- # data: "__string",
2971
+ # data: "__string", # required
2811
2972
  # description: "__string",
2812
2973
  # }
2813
2974
  #
@@ -2879,7 +3040,7 @@ module Aws::MQ
2879
3040
  # @!attribute [rw] password
2880
3041
  # The password of the user. This value must be at least 12 characters
2881
3042
  # long, must contain at least 4 unique characters, and must not
2882
- # contain commas.
3043
+ # contain commas, colons, or equal signs (,:=).
2883
3044
  # @return [String]
2884
3045
  #
2885
3046
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/UpdateUserInput AWS API Documentation
@@ -2934,7 +3095,11 @@ module Aws::MQ
2934
3095
  #
2935
3096
  class UpdateUserResponse < Aws::EmptyStructure; end
2936
3097
 
2937
- # A user associated with the broker.
3098
+ # A user associated with the broker. For RabbitMQ brokers, one and only
3099
+ # one administrative user is accepted and created when a broker is first
3100
+ # provisioned. All subsequent broker users are created by making
3101
+ # RabbitMQ API calls directly to brokers or via the RabbitMQ web
3102
+ # console.
2938
3103
  #
2939
3104
  # @note When making an API call, you may pass User
2940
3105
  # data as a hash:
@@ -2942,32 +3107,42 @@ module Aws::MQ
2942
3107
  # {
2943
3108
  # console_access: false,
2944
3109
  # groups: ["__string"],
2945
- # password: "__string",
2946
- # username: "__string",
3110
+ # password: "__string", # required
3111
+ # username: "__string", # required
2947
3112
  # }
2948
3113
  #
2949
3114
  # @!attribute [rw] console_access
2950
- # Enables access to the ActiveMQ Web Console for the ActiveMQ user
2951
- # (Does not apply to RabbitMQ brokers).
3115
+ # Enables access to the ActiveMQ Web Console for the ActiveMQ user.
3116
+ # Does not apply to RabbitMQ brokers.
2952
3117
  # @return [Boolean]
2953
3118
  #
2954
3119
  # @!attribute [rw] groups
2955
3120
  # The list of groups (20 maximum) to which the ActiveMQ user belongs.
2956
3121
  # This value can contain only alphanumeric characters, dashes,
2957
3122
  # periods, underscores, and tildes (- . \_ ~). This value must be
2958
- # 2-100 characters long.
3123
+ # 2-100 characters long. Does not apply to RabbitMQ brokers.
2959
3124
  # @return [Array<String>]
2960
3125
  #
2961
3126
  # @!attribute [rw] password
2962
- # Required. The password of the broker user. This value must be at
2963
- # least 12 characters long, must contain at least 4 unique characters,
2964
- # and must not contain commas.
3127
+ # Required. The password of the user. This value must be at least 12
3128
+ # characters long, must contain at least 4 unique characters, and must
3129
+ # not contain commas, colons, or equal signs (,:=).
2965
3130
  # @return [String]
2966
3131
  #
2967
3132
  # @!attribute [rw] username
2968
- # Required. The username of the broker user. This value can contain
3133
+ # important><title>Amazon MQ for ActiveMQ</title>
3134
+ #
3135
+ # <para markdown="1">For ActiveMQ brokers, this value can contain
2969
3136
  # only alphanumeric characters, dashes, periods, underscores, and
2970
- # tildes (- . \_ ~). This value must be 2-100 characters long.
3137
+ # tildes (- . \_ ~). This value must be 2-100 characters
3138
+ # long.</p>/important> <title>Amazon MQ for RabbitMQ</title>
3139
+ #
3140
+ # For RabbitMQ brokers, this value can contain only alphanumeric
3141
+ # characters, dashes, periods, underscores (- . \_). This value must
3142
+ # not contain a tilde (~) character. Amazon MQ prohibts using guest as
3143
+ # a valid usename. This value must be 2-100 characters long.
3144
+ #
3145
+ # </para>
2971
3146
  # @return [String]
2972
3147
  #
2973
3148
  # @see http://docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/User AWS API Documentation
@@ -3010,7 +3185,8 @@ module Aws::MQ
3010
3185
  include Aws::Structure
3011
3186
  end
3012
3187
 
3013
- # Returns a list of all broker users.
3188
+ # Returns a list of all broker users. Does not apply to RabbitMQ
3189
+ # brokers.
3014
3190
  #
3015
3191
  # @!attribute [rw] pending_change
3016
3192
  # The type of change pending for the broker user.
@@ -3038,8 +3214,8 @@ module Aws::MQ
3038
3214
  # data as a hash:
3039
3215
  #
3040
3216
  # {
3041
- # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
3042
- # time_of_day: "__string",
3217
+ # day_of_week: "MONDAY", # required, accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
3218
+ # time_of_day: "__string", # required
3043
3219
  # time_zone: "__string",
3044
3220
  # }
3045
3221
  #