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

Class: Aws::MQ::Types::BrokerSummary

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

Overview

The Amazon Resource Name (ARN) of the broker.

Instance Attribute Summary collapse

Instance Attribute Details

#broker_arnString

The Amazon Resource Name (ARN) of the broker.

Returns:

  • (String)


67
68
69
70
71
72
73
74
75
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 67

class BrokerSummary < Struct.new(
  :broker_arn,
  :broker_id,
  :broker_name,
  :broker_state,
  :deployment_mode,
  :host_instance_type)
  include Aws::Structure
end

#broker_idString

The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String)


67
68
69
70
71
72
73
74
75
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 67

class BrokerSummary < Struct.new(
  :broker_arn,
  :broker_id,
  :broker_name,
  :broker_state,
  :deployment_mode,
  :host_instance_type)
  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)


67
68
69
70
71
72
73
74
75
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 67

class BrokerSummary < Struct.new(
  :broker_arn,
  :broker_id,
  :broker_name,
  :broker_state,
  :deployment_mode,
  :host_instance_type)
  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)


67
68
69
70
71
72
73
74
75
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 67

class BrokerSummary < Struct.new(
  :broker_arn,
  :broker_id,
  :broker_name,
  :broker_state,
  :deployment_mode,
  :host_instance_type)
  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)


67
68
69
70
71
72
73
74
75
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 67

class BrokerSummary < Struct.new(
  :broker_arn,
  :broker_id,
  :broker_name,
  :broker_state,
  :deployment_mode,
  :host_instance_type)
  include Aws::Structure
end

#host_instance_typeString

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

Returns:

  • (String)


67
68
69
70
71
72
73
74
75
# File 'gems/aws-sdk-mq/lib/aws-sdk-mq/types.rb', line 67

class BrokerSummary < Struct.new(
  :broker_arn,
  :broker_id,
  :broker_name,
  :broker_state,
  :deployment_mode,
  :host_instance_type)
  include Aws::Structure
end