aws_sdk_mq/client/
update_broker.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateBroker`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`authentication_strategy(AuthenticationStrategy)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::authentication_strategy) / [`set_authentication_strategy(Option<AuthenticationStrategy>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_authentication_strategy):<br>required: **false**<br><p>Optional. The authentication strategy used to secure the broker. The default is SIMPLE.</p><br>
7    ///   - [`auto_minor_version_upgrade(bool)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::auto_minor_version_upgrade) / [`set_auto_minor_version_upgrade(Option<bool>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_auto_minor_version_upgrade):<br>required: **false**<br><p>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.</p><note>  <p>Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.</p> </note><br>
8    ///   - [`broker_id(impl Into<String>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::broker_id) / [`set_broker_id(Option<String>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_broker_id):<br>required: **true**<br><p>The unique ID that Amazon MQ generates for the broker.</p><br>
9    ///   - [`configuration(ConfigurationId)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::configuration) / [`set_configuration(Option<ConfigurationId>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_configuration):<br>required: **false**<br><p>A list of information about the configuration.</p><br>
10    ///   - [`engine_version(impl Into<String>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::engine_version) / [`set_engine_version(Option<String>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_engine_version):<br>required: **false**<br><p>The broker engine version. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p><note>  <p>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.</p> </note><br>
11    ///   - [`host_instance_type(impl Into<String>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::host_instance_type) / [`set_host_instance_type(Option<String>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_host_instance_type):<br>required: **false**<br><p>The broker's host instance type to upgrade to. For a list of supported instance types, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types">Broker instance types</a>.</p><br>
12    ///   - [`ldap_server_metadata(LdapServerMetadataInput)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::ldap_server_metadata) / [`set_ldap_server_metadata(Option<LdapServerMetadataInput>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_ldap_server_metadata):<br>required: **false**<br><p>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.</p><br>
13    ///   - [`logs(Logs)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::logs) / [`set_logs(Option<Logs>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_logs):<br>required: **false**<br><p>Enables Amazon CloudWatch logging for brokers.</p><br>
14    ///   - [`maintenance_window_start_time(WeeklyStartTime)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::maintenance_window_start_time) / [`set_maintenance_window_start_time(Option<WeeklyStartTime>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_maintenance_window_start_time):<br>required: **false**<br><p>The parameters that determine the WeeklyStartTime.</p><br>
15    ///   - [`security_groups(impl Into<String>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::security_groups) / [`set_security_groups(Option<Vec::<String>>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_security_groups):<br>required: **false**<br><p>The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.</p><br>
16    ///   - [`data_replication_mode(DataReplicationMode)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::data_replication_mode) / [`set_data_replication_mode(Option<DataReplicationMode>)`](crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::set_data_replication_mode):<br>required: **false**<br><p>Defines whether this broker is a part of a data replication pair.</p><br>
17    /// - On success, responds with [`UpdateBrokerOutput`](crate::operation::update_broker::UpdateBrokerOutput) with field(s):
18    ///   - [`authentication_strategy(Option<AuthenticationStrategy>)`](crate::operation::update_broker::UpdateBrokerOutput::authentication_strategy): <p>Optional. The authentication strategy used to secure the broker. The default is SIMPLE.</p>
19    ///   - [`auto_minor_version_upgrade(Option<bool>)`](crate::operation::update_broker::UpdateBrokerOutput::auto_minor_version_upgrade): <p>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.</p>
20    ///   - [`broker_id(Option<String>)`](crate::operation::update_broker::UpdateBrokerOutput::broker_id): <p>Required. The unique ID that Amazon MQ generates for the broker.</p>
21    ///   - [`configuration(Option<ConfigurationId>)`](crate::operation::update_broker::UpdateBrokerOutput::configuration): <p>The ID of the updated configuration.</p>
22    ///   - [`engine_version(Option<String>)`](crate::operation::update_broker::UpdateBrokerOutput::engine_version): <p>The broker engine version to upgrade to. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
23    ///   - [`host_instance_type(Option<String>)`](crate::operation::update_broker::UpdateBrokerOutput::host_instance_type): <p>The broker's host instance type to upgrade to. For a list of supported instance types, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types">Broker instance types</a>.</p>
24    ///   - [`ldap_server_metadata(Option<LdapServerMetadataOutput>)`](crate::operation::update_broker::UpdateBrokerOutput::ldap_server_metadata): <p>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.</p>
25    ///   - [`logs(Option<Logs>)`](crate::operation::update_broker::UpdateBrokerOutput::logs): <p>The list of information about logs to be enabled for the specified broker.</p>
26    ///   - [`maintenance_window_start_time(Option<WeeklyStartTime>)`](crate::operation::update_broker::UpdateBrokerOutput::maintenance_window_start_time): <p>The parameters that determine the WeeklyStartTime.</p>
27    ///   - [`security_groups(Option<Vec::<String>>)`](crate::operation::update_broker::UpdateBrokerOutput::security_groups): <p>The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.</p>
28    ///   - [`data_replication_metadata(Option<DataReplicationMetadataOutput>)`](crate::operation::update_broker::UpdateBrokerOutput::data_replication_metadata): <p>The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.</p>
29    ///   - [`data_replication_mode(Option<DataReplicationMode>)`](crate::operation::update_broker::UpdateBrokerOutput::data_replication_mode): <p>Describes whether this broker is a part of a data replication pair.</p>
30    ///   - [`pending_data_replication_metadata(Option<DataReplicationMetadataOutput>)`](crate::operation::update_broker::UpdateBrokerOutput::pending_data_replication_metadata): <p>The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.</p>
31    ///   - [`pending_data_replication_mode(Option<DataReplicationMode>)`](crate::operation::update_broker::UpdateBrokerOutput::pending_data_replication_mode): <p>Describes whether this broker will be a part of a data replication pair after reboot.</p>
32    /// - On failure, responds with [`SdkError<UpdateBrokerError>`](crate::operation::update_broker::UpdateBrokerError)
33    pub fn update_broker(&self) -> crate::operation::update_broker::builders::UpdateBrokerFluentBuilder {
34        crate::operation::update_broker::builders::UpdateBrokerFluentBuilder::new(self.handle.clone())
35    }
36}
aws_sdk_mq/client/update_broker.rs

aws_sdk_mq/client/
update_broker.rs
