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

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

Overview

The version of the broker engine. For a list of supported engine versions, see docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

Returns:

  • (Boolean) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#broker_arn ⇒ String

The Amazon Resource Name (ARN) of the broker.

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#broker_id ⇒ String

The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#broker_instances ⇒ Array<Types::BrokerInstance>

A list of information about allocated brokers.

Returns:



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#broker_name ⇒ String

The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#broker_state ⇒ String

The status of the broker.

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#configurations ⇒ Types::Configurations

The list of all revisions for the specified configuration.

Returns:



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#created ⇒ Time

The time when the broker was created.

Returns:

  • (Time) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#deployment_mode ⇒ String

Required. The deployment mode of the broker.

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#engine_type ⇒ String

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#engine_version ⇒ String

The version of the broker engine. For a list of supported engine versions, see docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#host_instance_type ⇒ String

The broker’s instance type.

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  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:



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#maintenance_window_start_time ⇒ Types::WeeklyStartTime

The parameters that determine the WeeklyStartTime.

Returns:



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#pending_engine_version ⇒ String

The version of the broker engine to upgrade to. For a list of supported engine versions, see docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

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

Returns:

  • (Boolean) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#security_groups ⇒ Array<String>

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

Returns:

  • (Array<String>) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.

Returns:

  • (Array<String>) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The list of all tags associated with this broker.

Returns:

  • (Hash<String,String>) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end

#users ⇒ Array<Types::UserSummary>

The list of all ActiveMQ usernames for the specified broker.

Returns:



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
 
# File 'lib/aws-sdk-mq/types.rb', line 884

class DescribeBrokerOutput < Struct.new(
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_id,
  :broker_instances,
  :broker_name,
  :broker_state,
  :configurations,
  :created,
  :deployment_mode,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :logs,
  :maintenance_window_start_time,
  :pending_engine_version,
  :publicly_accessible,
  :security_groups,
  :subnet_ids,
  :tags,
  :users)
  include Aws::Structure
end