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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_strategy ⇒ String

The authentication strategy used to secure the broker.

Possible values:

  • SIMPLE
  • LDAP

Returns:

  • (String) —

    The authentication strategy used to secure the broker.

#auto_minor_version_upgrade ⇒ Boolean

Returns:

  • (Boolean)

#broker_arn ⇒ String

Returns:

  • (String)

#broker_id ⇒ String

Returns:

  • (String)

#broker_instances ⇒ Array<Types::BrokerInstance>

Returns:

#broker_name ⇒ String

Returns:

  • (String)

#broker_state ⇒ String

The status of the broker.

Possible values:

  • CREATION_IN_PROGRESS
  • CREATION_FAILED
  • DELETION_IN_PROGRESS
  • RUNNING
  • REBOOT_IN_PROGRESS

Returns:

  • (String) —

    The status of the broker.

#configurations ⇒ Types::Configurations

Broker configuration information

Returns:

#created ⇒ Time

Returns:

  • (Time)

#deployment_mode ⇒ String

The deployment mode of the broker.

Possible values:

  • SINGLE_INSTANCE
  • ACTIVE_STANDBY_MULTI_AZ
  • CLUSTER_MULTI_AZ

Returns:

  • (String) —

    The deployment mode of the broker.

#encryption_options ⇒ Types::EncryptionOptions

Encryption options for the broker.

Returns:

#engine_type ⇒ String

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

Possible values:

  • ACTIVEMQ
  • RABBITMQ

Returns:

  • (String) —

    The type of broker engine.

#engine_version ⇒ String

Returns:

  • (String)

#host_instance_type ⇒ String

Returns:

  • (String)

#ldap_server_metadata ⇒ Types::LdapServerMetadataOutput

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

Returns:

#logs ⇒ Types::LogsSummary

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

Returns:

  • (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 scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

Returns:

  • (Types::WeeklyStartTime) —

    The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

#pending_authentication_strategy ⇒ String

The authentication strategy used to secure the broker.

Possible values:

  • SIMPLE
  • LDAP

Returns:

  • (String) —

    The authentication strategy used to secure the broker.

#pending_engine_version ⇒ String

Returns:

  • (String)

#pending_host_instance_type ⇒ String

Returns:

  • (String)

#pending_ldap_server_metadata ⇒ Types::LdapServerMetadataOutput

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

Returns:

#pending_security_groups ⇒ Array<String>

Returns:

  • (Array<String>)

#publicly_accessible ⇒ Boolean

Returns:

  • (Boolean)

#security_groups ⇒ Array<String>

Returns:

  • (Array<String>)

#storage_type ⇒ String

The storage type of the broker. EFS is currently not Supported for RabbitMQ engine type.

Possible values:

  • EBS
  • EFS

Returns:

  • (String) —

    The storage type of the broker.

#subnet_ids ⇒ Array<String>

Returns:

  • (Array<String>)

#tags ⇒ Hash<String,String>

Returns:

  • (Hash<String,String>)

#users ⇒ Array<Types::UserSummary>

Returns: