1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeBroker`](crate::operation::describe_broker::builders::DescribeBrokerFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`broker_id(impl Into<String>)`](crate::operation::describe_broker::builders::DescribeBrokerFluentBuilder::broker_id) / [`set_broker_id(Option<String>)`](crate::operation::describe_broker::builders::DescribeBrokerFluentBuilder::set_broker_id):<br>required: **true**<br><p>The unique ID that Amazon MQ generates for the broker.</p><br>
    /// - On success, responds with [`DescribeBrokerOutput`](crate::operation::describe_broker::DescribeBrokerOutput) with field(s):
    ///   - [`actions_required(Option<Vec::<ActionRequired>>)`](crate::operation::describe_broker::DescribeBrokerOutput::actions_required): <p>Actions required for a broker.</p>
    ///   - [`authentication_strategy(Option<AuthenticationStrategy>)`](crate::operation::describe_broker::DescribeBrokerOutput::authentication_strategy): <p>The authentication strategy used to secure the broker. The default is SIMPLE.</p>
    ///   - [`auto_minor_version_upgrade(Option<bool>)`](crate::operation::describe_broker::DescribeBrokerOutput::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>
    ///   - [`broker_arn(Option<String>)`](crate::operation::describe_broker::DescribeBrokerOutput::broker_arn): <p>The broker's Amazon Resource Name (ARN).</p>
    ///   - [`broker_id(Option<String>)`](crate::operation::describe_broker::DescribeBrokerOutput::broker_id): <p>The unique ID that Amazon MQ generates for the broker.</p>
    ///   - [`broker_instances(Option<Vec::<BrokerInstance>>)`](crate::operation::describe_broker::DescribeBrokerOutput::broker_instances): <p>A list of information about allocated brokers.</p>
    ///   - [`broker_name(Option<String>)`](crate::operation::describe_broker::DescribeBrokerOutput::broker_name): <p>The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.</p>
    ///   - [`broker_state(Option<BrokerState>)`](crate::operation::describe_broker::DescribeBrokerOutput::broker_state): <p>The broker's status.</p>
    ///   - [`configurations(Option<Configurations>)`](crate::operation::describe_broker::DescribeBrokerOutput::configurations): <p>The list of all revisions for the specified configuration.</p>
    ///   - [`created(Option<DateTime>)`](crate::operation::describe_broker::DescribeBrokerOutput::created): <p>The time when the broker was created.</p>
    ///   - [`deployment_mode(Option<DeploymentMode>)`](crate::operation::describe_broker::DescribeBrokerOutput::deployment_mode): <p>The broker's deployment mode.</p>
    ///   - [`encryption_options(Option<EncryptionOptions>)`](crate::operation::describe_broker::DescribeBrokerOutput::encryption_options): <p>Encryption options for the broker.</p>
    ///   - [`engine_type(Option<EngineType>)`](crate::operation::describe_broker::DescribeBrokerOutput::engine_type): <p>The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.</p>
    ///   - [`engine_version(Option<String>)`](crate::operation::describe_broker::DescribeBrokerOutput::engine_version): <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>
    ///   - [`host_instance_type(Option<String>)`](crate::operation::describe_broker::DescribeBrokerOutput::host_instance_type): <p>The broker's instance type.</p>
    ///   - [`ldap_server_metadata(Option<LdapServerMetadataOutput>)`](crate::operation::describe_broker::DescribeBrokerOutput::ldap_server_metadata): <p>The metadata of the LDAP server used to authenticate and authorize connections to the broker.</p>
    ///   - [`logs(Option<LogsSummary>)`](crate::operation::describe_broker::DescribeBrokerOutput::logs): <p>The list of information about logs currently enabled and pending to be deployed for the specified broker.</p>
    ///   - [`maintenance_window_start_time(Option<WeeklyStartTime>)`](crate::operation::describe_broker::DescribeBrokerOutput::maintenance_window_start_time): <p>The parameters that determine the WeeklyStartTime.</p>
    ///   - [`pending_authentication_strategy(Option<AuthenticationStrategy>)`](crate::operation::describe_broker::DescribeBrokerOutput::pending_authentication_strategy): <p>The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.</p>
    ///   - [`pending_engine_version(Option<String>)`](crate::operation::describe_broker::DescribeBrokerOutput::pending_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>
    ///   - [`pending_host_instance_type(Option<String>)`](crate::operation::describe_broker::DescribeBrokerOutput::pending_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>
    ///   - [`pending_ldap_server_metadata(Option<LdapServerMetadataOutput>)`](crate::operation::describe_broker::DescribeBrokerOutput::pending_ldap_server_metadata): <p>The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.</p>
    ///   - [`pending_security_groups(Option<Vec::<String>>)`](crate::operation::describe_broker::DescribeBrokerOutput::pending_security_groups): <p>The list of pending security groups to authorize connections to brokers.</p>
    ///   - [`publicly_accessible(Option<bool>)`](crate::operation::describe_broker::DescribeBrokerOutput::publicly_accessible): <p>Enables connections from applications outside of the VPC that hosts the broker's subnets.</p>
    ///   - [`security_groups(Option<Vec::<String>>)`](crate::operation::describe_broker::DescribeBrokerOutput::security_groups): <p>The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.</p>
    ///   - [`storage_type(Option<BrokerStorageType>)`](crate::operation::describe_broker::DescribeBrokerOutput::storage_type): <p>The broker's storage type.</p>
    ///   - [`subnet_ids(Option<Vec::<String>>)`](crate::operation::describe_broker::DescribeBrokerOutput::subnet_ids): <p>The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_broker::DescribeBrokerOutput::tags): <p>The list of all tags associated with this broker.</p>
    ///   - [`users(Option<Vec::<UserSummary>>)`](crate::operation::describe_broker::DescribeBrokerOutput::users): <p>The list of all broker usernames for the specified broker.</p>
    ///   - [`data_replication_metadata(Option<DataReplicationMetadataOutput>)`](crate::operation::describe_broker::DescribeBrokerOutput::data_replication_metadata): <p>The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.</p>
    ///   - [`data_replication_mode(Option<DataReplicationMode>)`](crate::operation::describe_broker::DescribeBrokerOutput::data_replication_mode): <p>Describes whether this broker is a part of a data replication pair.</p>
    ///   - [`pending_data_replication_metadata(Option<DataReplicationMetadataOutput>)`](crate::operation::describe_broker::DescribeBrokerOutput::pending_data_replication_metadata): <p>The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.</p>
    ///   - [`pending_data_replication_mode(Option<DataReplicationMode>)`](crate::operation::describe_broker::DescribeBrokerOutput::pending_data_replication_mode): <p>Describes whether this broker will be a part of a data replication pair after reboot.</p>
    /// - On failure, responds with [`SdkError<DescribeBrokerError>`](crate::operation::describe_broker::DescribeBrokerError)
    pub fn describe_broker(&self) -> crate::operation::describe_broker::builders::DescribeBrokerFluentBuilder {
        crate::operation::describe_broker::builders::DescribeBrokerFluentBuilder::new(self.handle.clone())
    }
}