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

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)

    Required.

#broker_arnString

The Amazon Resource Name (ARN) of the broker.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the broker.

#broker_idString

The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String)

    The unique ID that Amazon MQ generates for the broker.

#broker_instancesArray<Types::BrokerInstance>

A list of information about allocated brokers.

Returns:

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

    The name of the broker.

#broker_stateString

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.

#configurationsTypes::Configurations

The list of all revisions for the specified configuration.

Returns:

#createdTime

The time when the broker was created.

Returns:

  • (Time)

    The time when the broker was created.

#deployment_modeString

Required. The deployment mode of the broker.

Possible values:

  • SINGLE_INSTANCE
  • ACTIVE_STANDBY_MULTI_AZ

Returns:

  • (String)

    Required.

#encryption_optionsTypes::EncryptionOptions

Encryption options for the broker.

Returns:

#engine_typeString

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

Possible values:

  • ACTIVEMQ

Returns:

  • (String)

    Required.

#engine_versionString

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_typeString

The broker\'s instance type.

Returns:

  • (String)

    The broker\'s instance type.

#logsTypes::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_timeTypes::WeeklyStartTime

The parameters that determine the WeeklyStartTime.

Returns:

#pending_engine_versionString

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_security_groupsArray<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_accessibleBoolean

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

Returns:

  • (Boolean)

    Required.

#security_groupsArray<String>

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

Returns:

  • (Array<String>)

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

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

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

#tagsHash<String,String>

The list of all tags associated with this broker.

Returns:

  • (Hash<String,String>)

    The list of all tags associated with this broker.

#usersArray<Types::UserSummary>

The list of all ActiveMQ usernames for the specified broker.

Returns:

  • (Array<Types::UserSummary>)

    The list of all ActiveMQ usernames for the specified broker.