#[non_exhaustive]pub struct CreateBrokerInput {Show 21 fields
pub authentication_strategy: Option<AuthenticationStrategy>,
pub auto_minor_version_upgrade: Option<bool>,
pub broker_name: Option<String>,
pub configuration: Option<ConfigurationId>,
pub creator_request_id: Option<String>,
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<LdapServerMetadataInput>,
pub logs: Option<Logs>,
pub maintenance_window_start_time: Option<WeeklyStartTime>,
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<User>>,
pub data_replication_mode: Option<DataReplicationMode>,
pub data_replication_primary_broker_arn: Option<String>,
}Expand description
Creates a broker using the specified properties.
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.authentication_strategy: Option<AuthenticationStrategy>Optional. 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. Set to true by default, if no value is specified.
Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.
broker_name: Option<String>Required. The broker's name. This value must be unique in your Amazon Web Services 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.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.
configuration: Option<ConfigurationId>A list of information about the configuration.
creator_request_id: Option<String>The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.
We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
deployment_mode: Option<DeploymentMode>Required. The broker's deployment mode.
encryption_options: Option<EncryptionOptions>Encryption options for the broker.
engine_type: Option<EngineType>Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
engine_version: Option<String>The broker engine version. Defaults to the latest available version for the specified broker engine type. 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>Required. The broker's instance type.
ldap_server_metadata: Option<LdapServerMetadataInput>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
logs: Option<Logs>Enables Amazon CloudWatch logging for brokers.
maintenance_window_start_time: Option<WeeklyStartTime>The parameters that determine the WeeklyStartTime.
publicly_accessible: Option<bool>Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.
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. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
Create tags when creating the broker.
users: Option<Vec<User>>The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
data_replication_mode: Option<DataReplicationMode>Defines whether this broker is a part of a data replication pair.
data_replication_primary_broker_arn: Option<String>The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.
Implementations§
Source§impl CreateBrokerInput
impl CreateBrokerInput
Sourcepub fn authentication_strategy(&self) -> Option<&AuthenticationStrategy>
pub fn authentication_strategy(&self) -> Option<&AuthenticationStrategy>
Optional. 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. Set to true by default, if no value is specified.
Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.
Sourcepub fn broker_name(&self) -> Option<&str>
pub fn broker_name(&self) -> Option<&str>
Required. The broker's name. This value must be unique in your Amazon Web Services 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.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.
Sourcepub fn configuration(&self) -> Option<&ConfigurationId>
pub fn configuration(&self) -> Option<&ConfigurationId>
A list of information about the configuration.
Sourcepub fn creator_request_id(&self) -> Option<&str>
pub fn creator_request_id(&self) -> Option<&str>
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.
We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
Sourcepub fn deployment_mode(&self) -> Option<&DeploymentMode>
pub fn deployment_mode(&self) -> Option<&DeploymentMode>
Required. 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>
Required. 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. Defaults to the latest available version for the specified broker engine type. 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>
Required. The broker's instance type.
Sourcepub fn ldap_server_metadata(&self) -> Option<&LdapServerMetadataInput>
pub fn ldap_server_metadata(&self) -> Option<&LdapServerMetadataInput>
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
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 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. Set to false by default, if no value is provided.
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 you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.
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().
Create tags when creating the broker.
Sourcepub fn users(&self) -> &[User]
pub fn users(&self) -> &[User]
The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
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_mode(&self) -> Option<&DataReplicationMode>
pub fn data_replication_mode(&self) -> Option<&DataReplicationMode>
Defines whether this broker is a part of a data replication pair.
Sourcepub fn data_replication_primary_broker_arn(&self) -> Option<&str>
pub fn data_replication_primary_broker_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.
Source§impl CreateBrokerInput
impl CreateBrokerInput
Sourcepub fn builder() -> CreateBrokerInputBuilder
pub fn builder() -> CreateBrokerInputBuilder
Creates a new builder-style object to manufacture CreateBrokerInput.
Trait Implementations§
Source§impl Clone for CreateBrokerInput
impl Clone for CreateBrokerInput
Source§fn clone(&self) -> CreateBrokerInput
fn clone(&self) -> CreateBrokerInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CreateBrokerInput
impl Debug for CreateBrokerInput
Source§impl PartialEq for CreateBrokerInput
impl PartialEq for CreateBrokerInput
impl StructuralPartialEq for CreateBrokerInput
Auto Trait Implementations§
impl Freeze for CreateBrokerInput
impl RefUnwindSafe for CreateBrokerInput
impl Send for CreateBrokerInput
impl Sync for CreateBrokerInput
impl Unpin for CreateBrokerInput
impl UnwindSafe for CreateBrokerInput
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);