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

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

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

Overview

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

Returns:

  • (Boolean) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_arn ⇒ String

Returns:

  • (String) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_id ⇒ String

Returns:

  • (String) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

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

Returns:



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_name ⇒ String

Returns:

  • (String) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_state ⇒ String

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

Returns:

  • (String) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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

#configurations ⇒ Types::Configurations

Broker configuration information

Returns:



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_mode ⇒ String

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) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_type ⇒ String

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

Returns:

  • (String) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_version ⇒ String

Returns:

  • (String) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_type ⇒ String

Returns:

  • (String) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_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:



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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_accessible ⇒ Boolean

Returns:

  • (Boolean) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

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

Returns:

  • (Array<String>) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

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

Returns:

  • (Array<String>) 


863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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

#users ⇒ Array<Types::UserSummary>

Returns:



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 863

class DescribeBrokerResponse < 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