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

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

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

Overview

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

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

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) —

    Required.

#broker_arn ⇒ String

The Amazon Resource Name (ARN) of the broker.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the broker.

#broker_id ⇒ String

The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String) —

    The unique ID that Amazon MQ generates for the broker.

#broker_instances ⇒ Array<Types::BrokerInstance>

A list of information about allocated brokers.

Returns:

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

    The name of the broker.

#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

The list of all revisions for the specified configuration.

Returns:

#created ⇒ Time

The time when the broker was created.

Returns:

  • (Time) —

    The time when the broker was created.

#deployment_mode ⇒ String

Required. The deployment mode of the broker.

Possible values:

  • SINGLE_INSTANCE
  • ACTIVE_STANDBY_MULTI_AZ
  • CLUSTER_MULTI_AZ

Returns:

  • (String) —

    Required.

#encryption_options ⇒ Types::EncryptionOptions

Encryption options for the broker.

Returns:

#engine_type ⇒ String

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

Possible values:

  • ACTIVEMQ
  • RABBITMQ

Returns:

  • (String) —

    Required.

#engine_version ⇒ String

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

Returns:

  • (String) —

    The version of the broker engine.

#host_instance_type ⇒ String

The broker\'s instance type.

Returns:

  • (String) —

    The broker\'s instance type.

#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 parameters that determine the WeeklyStartTime.

Returns:

#pending_authentication_strategy ⇒ String

The authentication strategy that will be applied when the broker is rebooted.

Possible values:

  • SIMPLE
  • LDAP

Returns:

  • (String) —

    The authentication strategy that will be applied when the broker is rebooted.

#pending_engine_version ⇒ String

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

Returns:

  • (String) —

    The version of the broker engine to upgrade to.

#pending_host_instance_type ⇒ String

The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types

Returns:

  • (String) —

    The host instance type of the broker to upgrade to.

#pending_ldap_server_metadata ⇒ Types::LdapServerMetadataOutput

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.

Returns:

  • (Types::LdapServerMetadataOutput) —

    The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.

#pending_security_groups ⇒ Array<String>

The list of pending security groups to authorize connections to brokers.

Returns:

  • (Array<String>) —

    The list of pending security groups to authorize connections to brokers.

#publicly_accessible ⇒ Boolean

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

Returns:

  • (Boolean) —

    Required.

#security_groups ⇒ Array<String>

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

Returns:

  • (Array<String>) —

    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

#storage_type ⇒ String

The broker\'s storage type.

Possible values:

  • EBS
  • EFS

Returns:

  • (String) —

    The broker\'s storage type.

#subnet_ids ⇒ Array<String>

The list of groups 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 (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) has no subnet requirements when deployed with public accessibility, deployment without public accessibility requires at least one subnet.

Returns:

  • (Array<String>) —

    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

#tags ⇒ Hash<String,String>

The list of all tags associated with this broker.

Returns:

  • (Hash<String,String>) —

    The list of all tags associated with this broker.

#users ⇒ Array<Types::UserSummary>

The list of all broker usernames for the specified broker.

Returns:

  • (Array<Types::UserSummary>) —

    The list of all broker usernames for the specified broker.