Class: Aws::MQ::Types::DescribeBrokerOutput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-mq/types.rb

Overview

Returns information about the specified broker.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actions_requiredArray<Types::ActionRequired>

Actions required for a broker.

Returns:



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_strategyString

The authentication strategy used to secure the broker. The default is SIMPLE.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Returns:

  • (Boolean)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#broker_arnString

The broker’s Amazon Resource Name (ARN).

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#broker_idString

The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#broker_instancesArray<Types::BrokerInstance>

A list of information about allocated brokers.

Returns:



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#broker_nameString

The broker’s name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#broker_stateString

The broker’s status.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#configurationsTypes::Configurations

The list of all revisions for the specified configuration.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#createdTime

The time when the broker was created.

Returns:

  • (Time)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#data_replication_metadataTypes::DataReplicationMetadataOutput

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#data_replication_modeString

Describes whether this broker is a part of a data replication pair.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_modeString

The broker’s deployment mode.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_optionsTypes::EncryptionOptions

Encryption options for the broker.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#engine_typeString

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The broker engine version. For more information, see the [ActiveMQ version management] and the [RabbitMQ version management] sections in the Amazon MQ Developer Guide.

[1]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html [2]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#host_instance_typeString

The broker’s instance type.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#ldap_server_metadataTypes::LdapServerMetadataOutput

The metadata of the LDAP server used to authenticate and authorize connections to the broker.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#logsTypes::LogsSummary

The list of information about logs currently enabled and pending to be deployed for the specified broker.

Returns:



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_window_start_timeTypes::WeeklyStartTime

The parameters that determine the WeeklyStartTime.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#pending_authentication_strategyString

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#pending_data_replication_metadataTypes::DataReplicationMetadataOutput

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#pending_data_replication_modeString

Describes whether this broker will be a part of a data replication pair after reboot.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#pending_engine_versionString

The broker engine version to upgrade to. For more information, see the [ActiveMQ version management] and the [RabbitMQ version management] sections in the Amazon MQ Developer Guide.

[1]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html [2]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#pending_host_instance_typeString

The broker’s host instance type to upgrade to. For a list of supported instance types, see [Broker instance types].

[1]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#pending_ldap_server_metadataTypes::LdapServerMetadataOutput

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#pending_security_groupsArray<String>

The list of pending security groups to authorize connections to brokers.

Returns:

  • (Array<String>)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

Enables connections from applications outside of the VPC that hosts the broker’s subnets.

Returns:

  • (Boolean)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#security_groupsArray<String>

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

Returns:

  • (Array<String>)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#storage_typeString

The broker’s storage type.

Returns:

  • (String)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idsArray<String>

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

Returns:

  • (Array<String>)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The list of all tags associated with this broker.

Returns:

  • (Hash<String,String>)


1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#usersArray<Types::UserSummary>

The list of all broker usernames for the specified broker.

Returns:



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/aws-sdk-mq/types.rb', line 1349

class DescribeBrokerOutput < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :data_replication_metadata,
  :data_replication_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_data_replication_metadata,
  :pending_data_replication_mode,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users)
  SENSITIVE = []
  include Aws::Structure
end