Class: Aws::MQ::Types::DescribeBrokerResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actions_requiredArray<Types::ActionRequired>

Returns:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#authentication_strategyString

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

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#auto_minor_version_upgradeBoolean

Returns:

  • (Boolean)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#broker_arnString

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#broker_idString

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#broker_instancesArray<Types::BrokerInstance>

Returns:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#broker_nameString

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#broker_stateString

The broker's status.

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#configurationsTypes::Configurations

Broker configuration information



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#createdTime

Returns:

  • (Time)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#data_replication_metadataTypes::DataReplicationMetadataOutput

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



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#data_replication_modeString

Specifies whether a broker is a part of a data replication pair.

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#deployment_modeString

The broker's deployment mode.

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#encryption_optionsTypes::EncryptionOptions

Encryption options for the broker.



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#engine_typeString

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#engine_versionString

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#host_instance_typeString

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#ldap_server_metadataTypes::LdapServerMetadataOutput

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



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

class DescribeBrokerResponse < Struct.new(
  :actions_required,
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :pending_authentication_strategy,
  :pending_engine_version,
  :pending_host_instance_type,
  :pending_ldap_server_metadata,
  :pending_security_groups,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :tags,
  :users,
  :data_replication_metadata,
  :data_replication_mode,
  :pending_data_replication_metadata,
  :pending_data_replication_mode)
  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:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#maintenance_window_start_timeTypes::WeeklyStartTime

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#pending_authentication_strategyString

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

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#pending_data_replication_metadataTypes::DataReplicationMetadataOutput

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



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#pending_data_replication_modeString

Specifies whether a broker is a part of a data replication pair.

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#pending_engine_versionString

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#pending_host_instance_typeString

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#pending_ldap_server_metadataTypes::LdapServerMetadataOutput

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



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#pending_security_groupsArray<String>

Returns:

  • (Array<String>)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#publicly_accessibleBoolean

Returns:

  • (Boolean)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#security_groupsArray<String>

Returns:

  • (Array<String>)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#storage_typeString

The broker's storage type.

EFS is not supported for RabbitMQ engine type.

Returns:

  • (String)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#subnet_idsArray<String>

Returns:

  • (Array<String>)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#tagsHash<String,String>

Returns:

  • (Hash<String,String>)


1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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

#usersArray<Types::UserSummary>

Returns:



1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 1510

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