Struct aws_sdk_mq::client::fluent_builders::CreateBroker
source · [−]pub struct CreateBroker { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateBroker
.
Creates a broker. Note: This API is asynchronous.
To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.
ec2:CreateNetworkInterface
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
ec2:CreateNetworkInterfacePermission
This permission is required to attach the ENI to the broker instance.
ec2:DeleteNetworkInterface
ec2:DeleteNetworkInterfacePermission
ec2:DetachNetworkInterface
ec2:DescribeInternetGateways
ec2:DescribeNetworkInterfaces
ec2:DescribeNetworkInterfacePermissions
ec2:DescribeRouteTables
ec2:DescribeSecurityGroups
ec2:DescribeSubnets
ec2:DescribeVpcs
For more information, see Create an IAM User and Get Your AWS Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
Implementations
sourceimpl CreateBroker
impl CreateBroker
sourcepub async fn send(
self
) -> Result<CreateBrokerOutput, SdkError<CreateBrokerError>>
pub async fn send(
self
) -> Result<CreateBrokerOutput, SdkError<CreateBrokerError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn authentication_strategy(self, input: AuthenticationStrategy) -> Self
pub fn authentication_strategy(self, input: AuthenticationStrategy) -> Self
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
sourcepub fn set_authentication_strategy(
self,
input: Option<AuthenticationStrategy>
) -> Self
pub fn set_authentication_strategy(
self,
input: Option<AuthenticationStrategy>
) -> Self
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
sourcepub fn auto_minor_version_upgrade(self, input: bool) -> Self
pub fn auto_minor_version_upgrade(self, input: bool) -> Self
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 set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self
pub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self
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, input: impl Into<String>) -> Self
pub fn broker_name(self, input: impl Into<String>) -> Self
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 set_broker_name(self, input: Option<String>) -> Self
pub fn set_broker_name(self, input: Option<String>) -> Self
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, input: ConfigurationId) -> Self
pub fn configuration(self, input: ConfigurationId) -> Self
A list of information about the configuration.
sourcepub fn set_configuration(self, input: Option<ConfigurationId>) -> Self
pub fn set_configuration(self, input: Option<ConfigurationId>) -> Self
A list of information about the configuration.
sourcepub fn creator_request_id(self, input: impl Into<String>) -> Self
pub fn creator_request_id(self, input: impl Into<String>) -> Self
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 set_creator_request_id(self, input: Option<String>) -> Self
pub fn set_creator_request_id(self, input: Option<String>) -> Self
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, input: DeploymentMode) -> Self
pub fn deployment_mode(self, input: DeploymentMode) -> Self
Required. The broker's deployment mode.
sourcepub fn set_deployment_mode(self, input: Option<DeploymentMode>) -> Self
pub fn set_deployment_mode(self, input: Option<DeploymentMode>) -> Self
Required. The broker's deployment mode.
sourcepub fn encryption_options(self, input: EncryptionOptions) -> Self
pub fn encryption_options(self, input: EncryptionOptions) -> Self
Encryption options for the broker. Does not apply to RabbitMQ brokers.
sourcepub fn set_encryption_options(self, input: Option<EncryptionOptions>) -> Self
pub fn set_encryption_options(self, input: Option<EncryptionOptions>) -> Self
Encryption options for the broker. Does not apply to RabbitMQ brokers.
sourcepub fn engine_type(self, input: EngineType) -> Self
pub fn engine_type(self, input: EngineType) -> Self
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
sourcepub fn set_engine_type(self, input: Option<EngineType>) -> Self
pub fn set_engine_type(self, input: Option<EngineType>) -> Self
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
sourcepub fn engine_version(self, input: impl Into<String>) -> Self
pub fn engine_version(self, input: impl Into<String>) -> Self
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
sourcepub fn set_engine_version(self, input: Option<String>) -> Self
pub fn set_engine_version(self, input: Option<String>) -> Self
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
sourcepub fn host_instance_type(self, input: impl Into<String>) -> Self
pub fn host_instance_type(self, input: impl Into<String>) -> Self
Required. The broker's instance type.
sourcepub fn set_host_instance_type(self, input: Option<String>) -> Self
pub fn set_host_instance_type(self, input: Option<String>) -> Self
Required. The broker's instance type.
sourcepub fn ldap_server_metadata(self, input: LdapServerMetadataInput) -> Self
pub fn ldap_server_metadata(self, input: LdapServerMetadataInput) -> Self
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
sourcepub fn set_ldap_server_metadata(
self,
input: Option<LdapServerMetadataInput>
) -> Self
pub fn set_ldap_server_metadata(
self,
input: Option<LdapServerMetadataInput>
) -> Self
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
sourcepub fn set_logs(self, input: Option<Logs>) -> Self
pub fn set_logs(self, input: Option<Logs>) -> Self
Enables Amazon CloudWatch logging for brokers.
sourcepub fn maintenance_window_start_time(self, input: WeeklyStartTime) -> Self
pub fn maintenance_window_start_time(self, input: WeeklyStartTime) -> Self
The parameters that determine the WeeklyStartTime.
sourcepub fn set_maintenance_window_start_time(
self,
input: Option<WeeklyStartTime>
) -> Self
pub fn set_maintenance_window_start_time(
self,
input: Option<WeeklyStartTime>
) -> Self
The parameters that determine the WeeklyStartTime.
sourcepub fn publicly_accessible(self, input: bool) -> Self
pub fn publicly_accessible(self, input: bool) -> Self
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 set_publicly_accessible(self, input: Option<bool>) -> Self
pub fn set_publicly_accessible(self, input: Option<bool>) -> Self
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, input: impl Into<String>) -> Self
pub fn security_groups(self, input: impl Into<String>) -> Self
Appends an item to SecurityGroups
.
To override the contents of this collection use set_security_groups
.
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
sourcepub fn set_security_groups(self, input: Option<Vec<String>>) -> Self
pub fn set_security_groups(self, input: Option<Vec<String>>) -> Self
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
sourcepub fn storage_type(self, input: BrokerStorageType) -> Self
pub fn storage_type(self, input: BrokerStorageType) -> Self
The broker's storage type.
sourcepub fn set_storage_type(self, input: Option<BrokerStorageType>) -> Self
pub fn set_storage_type(self, input: Option<BrokerStorageType>) -> Self
The broker's storage type.
sourcepub fn subnet_ids(self, input: impl Into<String>) -> Self
pub fn subnet_ids(self, input: impl Into<String>) -> Self
Appends an item to SubnetIds
.
To override the contents of this collection use set_subnet_ids
.
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.
sourcepub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
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.
Adds a key-value pair to Tags
.
To override the contents of this collection use set_tags
.
Create tags when creating the broker.
Create tags when creating the broker.
sourcepub fn users(self, input: User) -> Self
pub fn users(self, input: User) -> Self
Appends an item to Users
.
To override the contents of this collection use set_users
.
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.
sourcepub fn set_users(self, input: Option<Vec<User>>) -> Self
pub fn set_users(self, input: Option<Vec<User>>) -> Self
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 CreateBroker
impl Clone for CreateBroker
sourcefn clone(&self) -> CreateBroker
fn clone(&self) -> CreateBroker
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
Auto Trait Implementations
impl !RefUnwindSafe for CreateBroker
impl Send for CreateBroker
impl Sync for CreateBroker
impl Unpin for CreateBroker
impl !UnwindSafe for CreateBroker
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