Struct aws_sdk_mq::input::CreateBrokerInput
source · [−]#[non_exhaustive]pub struct CreateBrokerInput {Show 19 fields
pub authentication_strategy: Option<AuthenticationStrategy>,
pub auto_minor_version_upgrade: 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: 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>>,
}
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: bool
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.
broker_name: Option<String>
Required. The broker's name. This value must be unique in your AWS 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.
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. Note: 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. Does not apply to RabbitMQ brokers.
engine_type: Option<EngineType>
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
engine_version: Option<String>
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
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: 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 AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
Create tags when creating the broker.
users: Option<Vec<User>>
Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
When you create an Amazon MQ for RabbitMQ broker, 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.
Implementations
sourceimpl CreateBrokerInput
impl CreateBrokerInput
sourcepub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateBroker, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
self,
_config: &Config
) -> Result<Operation<CreateBroker, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateBroker
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateBrokerInput
sourceimpl 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) -> bool
pub fn auto_minor_version_upgrade(&self) -> bool
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.
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 AWS 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 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. Note: 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. Does not apply to RabbitMQ brokers.
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>
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
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) -> bool
pub fn publicly_accessible(&self) -> 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) -> Option<&[String]>
pub fn security_groups(&self) -> Option<&[String]>
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
sourcepub fn storage_type(&self) -> Option<&BrokerStorageType>
pub fn storage_type(&self) -> Option<&BrokerStorageType>
The broker's storage type.
sourcepub fn subnet_ids(&self) -> Option<&[String]>
pub fn subnet_ids(&self) -> Option<&[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 AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
Create tags when creating the broker.
sourcepub fn users(&self) -> Option<&[User]>
pub fn users(&self) -> Option<&[User]>
Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
When you create an Amazon MQ for RabbitMQ broker, 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.
Trait Implementations
sourceimpl Clone for CreateBrokerInput
impl Clone for CreateBrokerInput
sourcefn clone(&self) -> CreateBrokerInput
fn clone(&self) -> CreateBrokerInput
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CreateBrokerInput
impl Debug for CreateBrokerInput
sourceimpl PartialEq<CreateBrokerInput> for CreateBrokerInput
impl PartialEq<CreateBrokerInput> for CreateBrokerInput
sourcefn eq(&self, other: &CreateBrokerInput) -> bool
fn eq(&self, other: &CreateBrokerInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateBrokerInput) -> bool
fn ne(&self, other: &CreateBrokerInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateBrokerInput
Auto Trait Implementations
impl RefUnwindSafe for CreateBrokerInput
impl Send for CreateBrokerInput
impl Sync for CreateBrokerInput
impl Unpin for CreateBrokerInput
impl UnwindSafe for CreateBrokerInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more