You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgradeBoolean

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)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#broker_arnString

The Amazon Resource Name (ARN) of the broker.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#broker_idString

The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#broker_instancesArray<Types::BrokerInstance>

A list of information about allocated brokers.

Returns:



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#broker_nameString

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)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#broker_stateString

The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#configurationsTypes::Configurations

The list of all revisions for the specified configuration.



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#deployment_modeString

Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#engine_typeString

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

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#engine_versionString

The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#host_instance_typeString

The broker's instance type. Possible values: mq.t2.micro, mq.m4.large

Returns:

  • (String)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#maintenance_window_start_timeTypes::WeeklyStartTime

The parameters that determine the WeeklyStartTime.



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#publicly_accessibleBoolean

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

Returns:

  • (Boolean)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#security_groupsArray<String>

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

Returns:

  • (Array<String>)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#subnet_idsArray<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>)


763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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

#usersArray<Types::UserSummary>

The list of all ActiveMQ usernames for the specified broker.

Returns:



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 763

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