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

Inherits:

Struct

Object
Struct
Aws::MQ::Types::DescribeBrokerResponse

show all

Includes:: Structure

Defined in:: lib/aws-sdk-mq/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#actions_required ⇒ Array<Types::ActionRequired>
#authentication_strategy ⇒ String
Optional.
#auto_minor_version_upgrade ⇒ Boolean
#broker_arn ⇒ String
#broker_id ⇒ String
#broker_instances ⇒ Array<Types::BrokerInstance>
#broker_name ⇒ String
#broker_state ⇒ String
The broker's status.
#configurations ⇒ Types::Configurations
Broker configuration information.
#created ⇒ Time
#data_replication_metadata ⇒ Types::DataReplicationMetadataOutput
The replication details of the data replication-enabled broker.
#data_replication_mode ⇒ String
Specifies whether a broker is a part of a data replication pair.
#deployment_mode ⇒ String
The broker's deployment mode.
#encryption_options ⇒ Types::EncryptionOptions
Encryption options for the broker.
#engine_type ⇒ String
The type of broker engine.
#engine_version ⇒ String
#host_instance_type ⇒ String
#ldap_server_metadata ⇒ Types::LdapServerMetadataOutput
Optional.
#logs ⇒ Types::LogsSummary
The list of information about logs currently enabled and pending to be deployed for the specified broker.
#maintenance_window_start_time ⇒ Types::WeeklyStartTime
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
#pending_authentication_strategy ⇒ String
Optional.
#pending_data_replication_metadata ⇒ Types::DataReplicationMetadataOutput
The replication details of the data replication-enabled broker.
#pending_data_replication_mode ⇒ String
Specifies whether a broker is a part of a data replication pair.
#pending_engine_version ⇒ String
#pending_host_instance_type ⇒ String
#pending_ldap_server_metadata ⇒ Types::LdapServerMetadataOutput
Optional.
#pending_security_groups ⇒ Array<String>
#pending_storage_size ⇒ Integer
The pending storage size in GB, to be applied on the next broker restart.
#publicly_accessible ⇒ Boolean
#security_groups ⇒ Array<String>
#storage_size ⇒ Integer
The broker's storage size in GB.
#storage_type ⇒ String
The broker's storage type.
#subnet_ids ⇒ Array<String>
#tags ⇒ Hash<String,String>
#users ⇒ Array<Types::UserSummary>

Instance Attribute Details

#actions_required ⇒ `Array<Types::ActionRequired>`

Returns:

(Array<Types::ActionRequired>)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_strategy ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_upgrade ⇒ `Boolean`

Returns:

(Boolean)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_arn ⇒ `String`

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_id ⇒ `String`

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_instances ⇒ `Array<Types::BrokerInstance>`

Returns:

(Array<Types::BrokerInstance>)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_name ⇒ `String`

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_state ⇒ `String`

The broker's status.

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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

#configurations ⇒ `Types::Configurations`

Broker configuration information

Returns:

(Types::Configurations)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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

#created ⇒ `Time`

Returns:

(Time)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_metadata ⇒ `Types::DataReplicationMetadataOutput`

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

Returns:

(Types::DataReplicationMetadataOutput)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_mode ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_mode ⇒ `String`

The broker's deployment mode.

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_options ⇒ `Types::EncryptionOptions`

Encryption options for the broker.

Returns:

(Types::EncryptionOptions)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_type ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_version ⇒ `String`

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_type ⇒ `String`

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_metadata ⇒ `Types::LdapServerMetadataOutput`

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

Returns:

(Types::LdapServerMetadataOutput)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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

#logs ⇒ `Types::LogsSummary`

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

Returns:

(Types::LogsSummary)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_time ⇒ `Types::WeeklyStartTime`

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

Returns:

(Types::WeeklyStartTime)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_strategy ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_metadata ⇒ `Types::DataReplicationMetadataOutput`

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

Returns:

(Types::DataReplicationMetadataOutput)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_mode ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_version ⇒ `String`

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_type ⇒ `String`

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_metadata ⇒ `Types::LdapServerMetadataOutput`

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

Returns:

(Types::LdapServerMetadataOutput)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_groups ⇒ `Array<String>`

Returns:

(Array<String>)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_storage_size ⇒ `Integer`

The pending storage size in GB, to be applied on the next broker restart.

Returns:

(Integer)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_accessible ⇒ `Boolean`

Returns:

(Boolean)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_groups ⇒ `Array<String>`

Returns:

(Array<String>)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_size ⇒ `Integer`

The broker's storage size in GB.

Returns:

(Integer)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_type ⇒ `String`

The broker's storage type.

EFS is not supported for RabbitMQ engine type.

Returns:

(String)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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_ids ⇒ `Array<String>`

Returns:

(Array<String>)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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

#tags ⇒ `Hash<String,String>`

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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

#users ⇒ `Array<Types::UserSummary>`

Returns:

(Array<Types::UserSummary>)

# File 'lib/aws-sdk-mq/types.rb', line 1603

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,
  :pending_storage_size,
  :publicly_accessible,
  :security_groups,
  :storage_size,
  :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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#actions_required ⇒ Array<Types::ActionRequired>

#authentication_strategy ⇒ String

#auto_minor_version_upgrade ⇒ Boolean

#broker_arn ⇒ String

#broker_id ⇒ String

#broker_instances ⇒ Array<Types::BrokerInstance>

#broker_name ⇒ String

#broker_state ⇒ String

#configurations ⇒ Types::Configurations

#created ⇒ Time

#data_replication_metadata ⇒ Types::DataReplicationMetadataOutput

#data_replication_mode ⇒ String

#deployment_mode ⇒ String

#encryption_options ⇒ Types::EncryptionOptions

#engine_type ⇒ String

#engine_version ⇒ String

#host_instance_type ⇒ String

#ldap_server_metadata ⇒ Types::LdapServerMetadataOutput

#logs ⇒ Types::LogsSummary

#maintenance_window_start_time ⇒ Types::WeeklyStartTime

#pending_authentication_strategy ⇒ String

#pending_data_replication_metadata ⇒ Types::DataReplicationMetadataOutput

#pending_data_replication_mode ⇒ String

#pending_engine_version ⇒ String

#pending_host_instance_type ⇒ String

#pending_ldap_server_metadata ⇒ Types::LdapServerMetadataOutput

#pending_security_groups ⇒ Array<String>

#pending_storage_size ⇒ Integer

#publicly_accessible ⇒ Boolean

#security_groups ⇒ Array<String>

#storage_size ⇒ Integer

#storage_type ⇒ String

#subnet_ids ⇒ Array<String>

#tags ⇒ Hash<String,String>

#users ⇒ Array<Types::UserSummary>

#actions_required ⇒ `Array<Types::ActionRequired>`

#authentication_strategy ⇒ `String`

#auto_minor_version_upgrade ⇒ `Boolean`

#broker_arn ⇒ `String`

#broker_id ⇒ `String`

#broker_instances ⇒ `Array<Types::BrokerInstance>`

#broker_name ⇒ `String`

#broker_state ⇒ `String`

#configurations ⇒ `Types::Configurations`

#created ⇒ `Time`

#data_replication_metadata ⇒ `Types::DataReplicationMetadataOutput`

#data_replication_mode ⇒ `String`

#deployment_mode ⇒ `String`

#encryption_options ⇒ `Types::EncryptionOptions`

#engine_type ⇒ `String`

#engine_version ⇒ `String`

#host_instance_type ⇒ `String`

#ldap_server_metadata ⇒ `Types::LdapServerMetadataOutput`

#logs ⇒ `Types::LogsSummary`

#maintenance_window_start_time ⇒ `Types::WeeklyStartTime`

#pending_authentication_strategy ⇒ `String`

#pending_data_replication_metadata ⇒ `Types::DataReplicationMetadataOutput`

#pending_data_replication_mode ⇒ `String`

#pending_engine_version ⇒ `String`

#pending_host_instance_type ⇒ `String`

#pending_ldap_server_metadata ⇒ `Types::LdapServerMetadataOutput`

#pending_security_groups ⇒ `Array<String>`

#pending_storage_size ⇒ `Integer`

#publicly_accessible ⇒ `Boolean`

#security_groups ⇒ `Array<String>`

#storage_size ⇒ `Integer`

#storage_type ⇒ `String`

#subnet_ids ⇒ `Array<String>`

#tags ⇒ `Hash<String,String>`

#users ⇒ `Array<Types::UserSummary>`