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

Inherits:

Struct

Object
Struct
Aws::MQ::Types::DescribeBrokerOutput

show all

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

Overview

Returns information about the specified broker.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#actions_required ⇒ Array<Types::ActionRequired>
Actions required for a broker.
#authentication_strategy ⇒ String
The authentication strategy used to secure the broker.
#auto_minor_version_upgrade ⇒ Boolean
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
#broker_arn ⇒ String
The broker's Amazon Resource Name (ARN).
#broker_id ⇒ String
The unique ID that Amazon MQ generates for the broker.
#broker_instances ⇒ Array<Types::BrokerInstance>
A list of information about allocated brokers.
#broker_name ⇒ String
The broker's name.
#broker_state ⇒ String
The broker's status.
#configurations ⇒ Types::Configurations
The list of all revisions for the specified configuration.
#created ⇒ Time
The time when the broker was created.
#data_replication_metadata ⇒ Types::DataReplicationMetadataOutput
The replication details of the data replication-enabled broker.
#data_replication_mode ⇒ String
Describes whether this 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
The broker engine's version.
#host_instance_type ⇒ String
The broker's instance type.
#ldap_server_metadata ⇒ Types::LdapServerMetadataOutput
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
#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 parameters that determine the WeeklyStartTime.
#pending_authentication_strategy ⇒ String
The authentication strategy that will be applied when the broker is rebooted.
#pending_data_replication_metadata ⇒ Types::DataReplicationMetadataOutput
The pending replication details of the data replication-enabled broker.
#pending_data_replication_mode ⇒ String
Describes whether this broker will be a part of a data replication pair after reboot.
#pending_engine_version ⇒ String
The broker engine version to upgrade to.
#pending_host_instance_type ⇒ String
The broker's host instance type to upgrade to.
#pending_ldap_server_metadata ⇒ Types::LdapServerMetadataOutput
The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
#pending_security_groups ⇒ Array<String>
The list of pending security groups to authorize connections to brokers.
#publicly_accessible ⇒ Boolean
Enables connections from applications outside of the VPC that hosts the broker's subnets.
#security_groups ⇒ Array<String>
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
#storage_type ⇒ String
The broker's storage type.
#subnet_ids ⇒ Array<String>
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
#tags ⇒ Hash<String,String>
The list of all tags associated with this broker.
#users ⇒ Array<Types::UserSummary>
The list of all broker usernames for the specified broker.

Instance Attribute Details

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

Actions required for a broker.

Returns:

(Array<Types::ActionRequired>)

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

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_strategy ⇒ `String`

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

Returns:

(String)

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

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_upgrade ⇒ `Boolean`

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

Returns:

(Boolean)

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

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_arn ⇒ `String`

The broker's Amazon Resource Name (ARN).

Returns:

(String)

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

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_id ⇒ `String`

The unique ID that Amazon MQ generates for the broker.

Returns:

(String)

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

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_instances ⇒ `Array<Types::BrokerInstance>`

A list of information about allocated brokers.

Returns:

(Array<Types::BrokerInstance>)

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

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_name ⇒ `String`

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)

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

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_state ⇒ `String`

The broker's status.

Returns:

(String)

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

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

#configurations ⇒ `Types::Configurations`

The list of all revisions for the specified configuration.

Returns:

(Types::Configurations)

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

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

#created ⇒ `Time`

The time when the broker was created.

Returns:

(Time)

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

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_metadata ⇒ `Types::DataReplicationMetadataOutput`

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

Returns:

(Types::DataReplicationMetadataOutput)

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

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_mode ⇒ `String`

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

Returns:

(String)

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

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_mode ⇒ `String`

The broker's deployment mode.

Returns:

(String)

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

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_options ⇒ `Types::EncryptionOptions`

Encryption options for the broker.

Returns:

(Types::EncryptionOptions)

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

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_type ⇒ `String`

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

Returns:

(String)

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

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_version ⇒ `String`

The broker engine's version. For a list of supported engine versions, see Supported engines.

Returns:

(String)

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

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_type ⇒ `String`

The broker's instance type.

Returns:

(String)

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

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_metadata ⇒ `Types::LdapServerMetadataOutput`

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

Returns:

(Types::LdapServerMetadataOutput)

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

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

#logs ⇒ `Types::LogsSummary`

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

Returns:

(Types::LogsSummary)

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

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_time ⇒ `Types::WeeklyStartTime`

The parameters that determine the WeeklyStartTime.

Returns:

(Types::WeeklyStartTime)

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

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_strategy ⇒ `String`

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

Returns:

(String)

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

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_metadata ⇒ `Types::DataReplicationMetadataOutput`

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

Returns:

(Types::DataReplicationMetadataOutput)

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

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_mode ⇒ `String`

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

Returns:

(String)

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

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_version ⇒ `String`

The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

Returns:

(String)

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

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_type ⇒ `String`

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

Returns:

(String)

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

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_metadata ⇒ `Types::LdapServerMetadataOutput`

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

Returns:

(Types::LdapServerMetadataOutput)

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

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_groups ⇒ `Array<String>`

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

Returns:

(Array<String>)

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

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_accessible ⇒ `Boolean`

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

Returns:

(Boolean)

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

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_groups ⇒ `Array<String>`

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

Returns:

(Array<String>)

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

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_type ⇒ `String`

The broker's storage type.

Returns:

(String)

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

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_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

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

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

#tags ⇒ `Hash<String,String>`

The list of all tags associated with this broker.

Returns:

(Hash<String,String>)

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

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

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

The list of all broker usernames for the specified broker.

Returns:

(Array<Types::UserSummary>)

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

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

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

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>

#publicly_accessible ⇒ Boolean

#security_groups ⇒ Array<String>

#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>`

#publicly_accessible ⇒ `Boolean`

#security_groups ⇒ `Array<String>`

#storage_type ⇒ `String`

#subnet_ids ⇒ `Array<String>`

#tags ⇒ `Hash<String,String>`

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