Class: Aws::MQ::Types::UpdateBrokerOutput

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

Overview

Returns information about the updated broker.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_strategyString

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

Returns:

  • (String)


2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#auto_minor_version_upgradeBoolean

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.

Returns:

  • (Boolean)


2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#broker_idString

Required. The unique ID that Amazon MQ generates for the broker.

Returns:

  • (String)


2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#configurationTypes::ConfigurationId

The ID of the updated configuration.



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#data_replication_metadataTypes::DataReplicationMetadataOutput

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#data_replication_modeString

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

Returns:

  • (String)


2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#engine_versionString

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

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


2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#host_instance_typeString

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)


2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#ldap_server_metadataTypes::LdapServerMetadataOutput

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



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#logsTypes::Logs

The list of information about logs to be enabled for the specified broker.

Returns:



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#maintenance_window_start_timeTypes::WeeklyStartTime

The parameters that determine the WeeklyStartTime.



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#pending_data_replication_metadataTypes::DataReplicationMetadataOutput

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#pending_data_replication_modeString

Describes whether this broker will be a part of a data replication pair after reboot.

Returns:

  • (String)


2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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

#security_groupsArray<String>

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

Returns:

  • (Array<String>)


2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
# File 'lib/aws-sdk-mq/types.rb', line 2745

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