Class: Aws::MQ::Types::UpdateBrokerInput

Inherits:

Struct

• Object
• Struct
• Aws::MQ::Types::UpdateBrokerInput

Includes:

Structure

Defined in:

lib/aws-sdk-mq/types.rb

Overview

Updates the broker using the specified properties.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authentication_strategy ⇒ String

  Optional.

• #auto_minor_version_upgrade ⇒ Boolean

  Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ.

• #configuration ⇒ Types::ConfigurationId

  A list of information about the configuration.

• #data_replication_mode ⇒ String

  Defines whether this broker is a part of a data replication pair.

• #engine_version ⇒ String

  The broker engine version.

• #host_instance_type ⇒ String

  The broker’s host instance type to upgrade to.

• #ldap_server_metadata ⇒ Types::LdapServerMetadataInput

  Optional.

• #logs ⇒ Types::Logs

  Enables Amazon CloudWatch logging for brokers.

• #maintenance_window_start_time ⇒ Types::WeeklyStartTime

  The parameters that determine the WeeklyStartTime.

• #security_groups ⇒ Array<String>

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

Instance Attribute Details

#authentication_strategy ⇒ String

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ Boolean

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

<note markdown=“1”>Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

</note>

Returns:

• (Boolean)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::ConfigurationId

A list of information about the configuration.

Returns:

• (Types::ConfigurationId)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#data_replication_mode ⇒ String

Defines whether this broker is a part of a data replication pair.

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The broker engine version. For more information, see the [ActiveMQ version management] and the [RabbitMQ version management] sections in the Amazon MQ Developer Guide.

<note markdown=“1”>When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

</note>

[1]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html [2]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#host_instance_type ⇒ String

The broker’s host instance type to upgrade to. For a list of supported instance types, see [Broker instance types].

[1]: docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types

Returns:

• (String)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#ldap_server_metadata ⇒ Types::LdapServerMetadataInput

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Returns:

• (Types::LdapServerMetadataInput)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#logs ⇒ Types::Logs

Enables Amazon CloudWatch logging for brokers.

Returns:

• (Types::Logs)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_window_start_time ⇒ Types::WeeklyStartTime

The parameters that determine the WeeklyStartTime.

Returns:

• (Types::WeeklyStartTime)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end

#security_groups ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-mq/types.rb', line 2647

class UpdateBrokerInput < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :configuration,
  :data_replication_mode,
  :engine_version,
  :host_instance_type,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :security_groups)
  SENSITIVE = []
  include Aws::Structure
end