#[non_exhaustive]pub struct DescribeBrokerOutput {Show 33 fields
pub actions_required: Option<Vec<ActionRequired>>,
pub authentication_strategy: Option<AuthenticationStrategy>,
pub auto_minor_version_upgrade: Option<bool>,
pub broker_arn: Option<String>,
pub broker_id: Option<String>,
pub broker_instances: Option<Vec<BrokerInstance>>,
pub broker_name: Option<String>,
pub broker_state: Option<BrokerState>,
pub configurations: Option<Configurations>,
pub created: Option<DateTime>,
pub deployment_mode: Option<DeploymentMode>,
pub encryption_options: Option<EncryptionOptions>,
pub engine_type: Option<EngineType>,
pub engine_version: Option<String>,
pub host_instance_type: Option<String>,
pub ldap_server_metadata: Option<LdapServerMetadataOutput>,
pub logs: Option<LogsSummary>,
pub maintenance_window_start_time: Option<WeeklyStartTime>,
pub pending_authentication_strategy: Option<AuthenticationStrategy>,
pub pending_engine_version: Option<String>,
pub pending_host_instance_type: Option<String>,
pub pending_ldap_server_metadata: Option<LdapServerMetadataOutput>,
pub pending_security_groups: Option<Vec<String>>,
pub publicly_accessible: Option<bool>,
pub security_groups: Option<Vec<String>>,
pub storage_type: Option<BrokerStorageType>,
pub subnet_ids: Option<Vec<String>>,
pub tags: Option<HashMap<String, String>>,
pub users: Option<Vec<UserSummary>>,
pub data_replication_metadata: Option<DataReplicationMetadataOutput>,
pub data_replication_mode: Option<DataReplicationMode>,
pub pending_data_replication_metadata: Option<DataReplicationMetadataOutput>,
pub pending_data_replication_mode: Option<DataReplicationMode>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.actions_required: Option<Vec<ActionRequired>>
Actions required for a broker.
authentication_strategy: Option<AuthenticationStrategy>
The authentication strategy used to secure the broker. The default is SIMPLE.
auto_minor_version_upgrade: Option<bool>
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.
broker_arn: Option<String>
The broker's Amazon Resource Name (ARN).
broker_id: Option<String>
The unique ID that Amazon MQ generates for the broker.
broker_instances: Option<Vec<BrokerInstance>>
A list of information about allocated brokers.
broker_name: Option<String>
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.
broker_state: Option<BrokerState>
The broker's status.
configurations: Option<Configurations>
The list of all revisions for the specified configuration.
created: Option<DateTime>
The time when the broker was created.
deployment_mode: Option<DeploymentMode>
The broker's deployment mode.
encryption_options: Option<EncryptionOptions>
Encryption options for the broker.
engine_type: Option<EngineType>
The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
engine_version: Option<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.
host_instance_type: Option<String>
The broker's instance type.
ldap_server_metadata: Option<LdapServerMetadataOutput>
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
logs: Option<LogsSummary>
The list of information about logs currently enabled and pending to be deployed for the specified broker.
maintenance_window_start_time: Option<WeeklyStartTime>
The parameters that determine the WeeklyStartTime.
pending_authentication_strategy: Option<AuthenticationStrategy>
The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
pending_engine_version: Option<String>
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.
pending_host_instance_type: Option<String>
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
pending_ldap_server_metadata: Option<LdapServerMetadataOutput>
The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
pending_security_groups: Option<Vec<String>>
The list of pending security groups to authorize connections to brokers.
publicly_accessible: Option<bool>
Enables connections from applications outside of the VPC that hosts the broker's subnets.
security_groups: Option<Vec<String>>
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
storage_type: Option<BrokerStorageType>
The broker's storage type.
subnet_ids: Option<Vec<String>>
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
The list of all tags associated with this broker.
users: Option<Vec<UserSummary>>
The list of all broker usernames for the specified broker.
data_replication_metadata: Option<DataReplicationMetadataOutput>
The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.
data_replication_mode: Option<DataReplicationMode>
Describes whether this broker is a part of a data replication pair.
pending_data_replication_metadata: Option<DataReplicationMetadataOutput>
The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.
pending_data_replication_mode: Option<DataReplicationMode>
Describes whether this broker will be a part of a data replication pair after reboot.
Implementations§
Source§impl DescribeBrokerOutput
impl DescribeBrokerOutput
Sourcepub fn actions_required(&self) -> &[ActionRequired]
pub fn actions_required(&self) -> &[ActionRequired]
Actions required for a broker.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .actions_required.is_none()
.
Sourcepub fn authentication_strategy(&self) -> Option<&AuthenticationStrategy>
pub fn authentication_strategy(&self) -> Option<&AuthenticationStrategy>
The authentication strategy used to secure the broker. The default is SIMPLE.
Sourcepub fn auto_minor_version_upgrade(&self) -> Option<bool>
pub fn auto_minor_version_upgrade(&self) -> Option<bool>
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.
Sourcepub fn broker_arn(&self) -> Option<&str>
pub fn broker_arn(&self) -> Option<&str>
The broker's Amazon Resource Name (ARN).
Sourcepub fn broker_instances(&self) -> &[BrokerInstance]
pub fn broker_instances(&self) -> &[BrokerInstance]
A list of information about allocated brokers.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .broker_instances.is_none()
.
Sourcepub fn broker_name(&self) -> Option<&str>
pub fn broker_name(&self) -> Option<&str>
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.
Sourcepub fn broker_state(&self) -> Option<&BrokerState>
pub fn broker_state(&self) -> Option<&BrokerState>
The broker's status.
Sourcepub fn configurations(&self) -> Option<&Configurations>
pub fn configurations(&self) -> Option<&Configurations>
The list of all revisions for the specified configuration.
Sourcepub fn deployment_mode(&self) -> Option<&DeploymentMode>
pub fn deployment_mode(&self) -> Option<&DeploymentMode>
The broker's deployment mode.
Sourcepub fn encryption_options(&self) -> Option<&EncryptionOptions>
pub fn encryption_options(&self) -> Option<&EncryptionOptions>
Encryption options for the broker.
Sourcepub fn engine_type(&self) -> Option<&EngineType>
pub fn engine_type(&self) -> Option<&EngineType>
The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
Sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
Sourcepub fn host_instance_type(&self) -> Option<&str>
pub fn host_instance_type(&self) -> Option<&str>
The broker's instance type.
Sourcepub fn ldap_server_metadata(&self) -> Option<&LdapServerMetadataOutput>
pub fn ldap_server_metadata(&self) -> Option<&LdapServerMetadataOutput>
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Sourcepub fn logs(&self) -> Option<&LogsSummary>
pub fn logs(&self) -> Option<&LogsSummary>
The list of information about logs currently enabled and pending to be deployed for the specified broker.
Sourcepub fn maintenance_window_start_time(&self) -> Option<&WeeklyStartTime>
pub fn maintenance_window_start_time(&self) -> Option<&WeeklyStartTime>
The parameters that determine the WeeklyStartTime.
Sourcepub fn pending_authentication_strategy(&self) -> Option<&AuthenticationStrategy>
pub fn pending_authentication_strategy(&self) -> Option<&AuthenticationStrategy>
The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
Sourcepub fn pending_engine_version(&self) -> Option<&str>
pub fn pending_engine_version(&self) -> Option<&str>
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.
Sourcepub fn pending_host_instance_type(&self) -> Option<&str>
pub fn pending_host_instance_type(&self) -> Option<&str>
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
Sourcepub fn pending_ldap_server_metadata(&self) -> Option<&LdapServerMetadataOutput>
pub fn pending_ldap_server_metadata(&self) -> Option<&LdapServerMetadataOutput>
The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
Sourcepub fn pending_security_groups(&self) -> &[String]
pub fn pending_security_groups(&self) -> &[String]
The list of pending security groups to authorize connections to brokers.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .pending_security_groups.is_none()
.
Sourcepub fn publicly_accessible(&self) -> Option<bool>
pub fn publicly_accessible(&self) -> Option<bool>
Enables connections from applications outside of the VPC that hosts the broker's subnets.
Sourcepub fn security_groups(&self) -> &[String]
pub fn security_groups(&self) -> &[String]
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .security_groups.is_none()
.
Sourcepub fn storage_type(&self) -> Option<&BrokerStorageType>
pub fn storage_type(&self) -> Option<&BrokerStorageType>
The broker's storage type.
Sourcepub fn subnet_ids(&self) -> &[String]
pub fn subnet_ids(&self) -> &[String]
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subnet_ids.is_none()
.
The list of all tags associated with this broker.
Sourcepub fn users(&self) -> &[UserSummary]
pub fn users(&self) -> &[UserSummary]
The list of all broker usernames for the specified broker.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .users.is_none()
.
Sourcepub fn data_replication_metadata(
&self,
) -> Option<&DataReplicationMetadataOutput>
pub fn data_replication_metadata( &self, ) -> Option<&DataReplicationMetadataOutput>
The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.
Sourcepub fn data_replication_mode(&self) -> Option<&DataReplicationMode>
pub fn data_replication_mode(&self) -> Option<&DataReplicationMode>
Describes whether this broker is a part of a data replication pair.
Sourcepub fn pending_data_replication_metadata(
&self,
) -> Option<&DataReplicationMetadataOutput>
pub fn pending_data_replication_metadata( &self, ) -> Option<&DataReplicationMetadataOutput>
The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.
Sourcepub fn pending_data_replication_mode(&self) -> Option<&DataReplicationMode>
pub fn pending_data_replication_mode(&self) -> Option<&DataReplicationMode>
Describes whether this broker will be a part of a data replication pair after reboot.
Source§impl DescribeBrokerOutput
impl DescribeBrokerOutput
Sourcepub fn builder() -> DescribeBrokerOutputBuilder
pub fn builder() -> DescribeBrokerOutputBuilder
Creates a new builder-style object to manufacture DescribeBrokerOutput
.
Trait Implementations§
Source§impl Clone for DescribeBrokerOutput
impl Clone for DescribeBrokerOutput
Source§fn clone(&self) -> DescribeBrokerOutput
fn clone(&self) -> DescribeBrokerOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DescribeBrokerOutput
impl Debug for DescribeBrokerOutput
Source§impl PartialEq for DescribeBrokerOutput
impl PartialEq for DescribeBrokerOutput
Source§impl RequestId for DescribeBrokerOutput
impl RequestId for DescribeBrokerOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for DescribeBrokerOutput
Auto Trait Implementations§
impl Freeze for DescribeBrokerOutput
impl RefUnwindSafe for DescribeBrokerOutput
impl Send for DescribeBrokerOutput
impl Sync for DescribeBrokerOutput
impl Unpin for DescribeBrokerOutput
impl UnwindSafe for DescribeBrokerOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);