Struct aws_sdk_mq::input::CreateBrokerInput

#[non_exhaustive]
pub struct CreateBrokerInput {

    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>>,
}

Creates a broker using the specified properties.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

tags: Option<HashMap<String, String>>

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

impl CreateBrokerInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<CreateBroker, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateBroker>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateBrokerInput

impl CreateBrokerInput

pub fn authentication_strategy(&self) -> Option<&AuthenticationStrategy>

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

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.

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.

pub fn configuration(&self) -> Option<&ConfigurationId>

A list of information about the configuration.

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.

pub fn deployment_mode(&self) -> Option<&DeploymentMode>

Required. The broker's deployment mode.

pub fn encryption_options(&self) -> Option<&EncryptionOptions>

Encryption options for the broker. Does not apply to RabbitMQ brokers.

pub fn engine_type(&self) -> Option<&EngineType>

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

pub fn engine_version(&self) -> Option<&str>

Required. The broker engine's version. For a list of supported engine versions, see Supported engines.

pub fn host_instance_type(&self) -> Option<&str>

Required. The broker's instance type.

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.

pub fn logs(&self) -> Option<&Logs>

Enables Amazon CloudWatch logging for brokers.

pub fn maintenance_window_start_time(&self) -> Option<&WeeklyStartTime>

The parameters that determine the WeeklyStartTime.

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.

pub fn security_groups(&self) -> Option<&[String]>

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

pub fn storage_type(&self) -> Option<&BrokerStorageType>

The broker's storage type.

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.

pub fn tags(&self) -> Option<&HashMap<String, String>>

Create tags when creating the broker.

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

impl Clone for CreateBrokerInput

fn clone(&self) -> CreateBrokerInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateBrokerInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CreateBrokerInput> for CreateBrokerInput

fn eq(&self, other: &CreateBrokerInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateBrokerInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateBrokerInput