class Aws::MQ::Types::CreateBrokerInput
Creates a broker.
@!attribute [rw] authentication_strategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE. @return [String]
@!attribute [rw] auto_minor_version_upgrade
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. @return [Boolean]
@!attribute [rw] broker_name
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. @return [String]
@!attribute [rw] configuration
A list of information about the configuration. @return [Types::ConfigurationId]
@!attribute [rw] creator_request_id
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. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] deployment_mode
Required. The broker's deployment mode. @return [String]
@!attribute [rw] encryption_options
Encryption options for the broker. Does not apply to RabbitMQ brokers. @return [Types::EncryptionOptions]
@!attribute [rw] engine_type
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ. @return [String]
@!attribute [rw] engine_version
Required. The broker engine's version. For a list of supported engine versions, see [Supported engines][1]. [1]: https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker-engine.html @return [String]
@!attribute [rw] host_instance_type
Required. The broker's instance type. @return [String]
@!attribute [rw] ldap_server_metadata
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers. @return [Types::LdapServerMetadataInput]
@!attribute [rw] logs
Enables Amazon CloudWatch logging for brokers. @return [Types::Logs]
@!attribute [rw] maintenance_window_start_time
The parameters that determine the WeeklyStartTime. @return [Types::WeeklyStartTime]
@!attribute [rw] publicly_accessible
Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided. @return [Boolean]
@!attribute [rw] security_groups
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers. @return [Array<String>]
@!attribute [rw] storage_type
The broker's storage type. @return [String]
@!attribute [rw] 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][1] 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. [1]: https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html @return [Array<String>]
@!attribute [rw] tags
Create tags when creating the broker. @return [Hash<String,String>]
@!attribute [rw] 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. <title>Amazon MQ for RabbitMQ</title> 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. @return [Array<Types::User>]
@see docs.aws.amazon.com/goto/WebAPI/mq-2017-11-27/CreateBrokerInput AWS API Documentation
Constants
- SENSITIVE