create_broker ¶

def create_broker(
    self,
    *,
    config_overrides: Optional[mqClientConfig] = None,
    authentication_strategy: Optional[
        "capo_mq.types.authentication_strategy.AuthenticationStrategy"
    ] = None,
    auto_minor_version_upgrade: Optional[
        "capo_mq.types.__boolean.__boolean"
    ] = None,
    broker_name: Optional["capo_mq.types.__string.__string"] = None,
    configuration: Optional[
        "capo_mq.types.configuration_id.ConfigurationId"
    ] = None,
    creator_request_id: Optional["capo_mq.types.__string.__string"] = None,
    deployment_mode: Optional[
        "capo_mq.types.deployment_mode.DeploymentMode"
    ] = None,
    encryption_options: Optional[
        "capo_mq.types.encryption_options.EncryptionOptions"
    ] = None,
    engine_type: Optional["capo_mq.types.engine_type.EngineType"] = None,
    engine_version: Optional["capo_mq.types.__string.__string"] = None,
    host_instance_type: Optional["capo_mq.types.__string.__string"] = None,
    ldap_server_metadata: Optional[
        "capo_mq.types.ldap_server_metadata_input.LdapServerMetadataInput"
    ] = None,
    logs: Optional["capo_mq.types.logs.Logs"] = None,
    maintenance_window_start_time: Optional[
        "capo_mq.types.weekly_start_time.WeeklyStartTime"
    ] = None,
    publicly_accessible: Optional["capo_mq.types.__boolean.__boolean"] = None,
    security_groups: Optional[
        "capo_mq.types.__list_of__string.__listOf__string"
    ] = None,
    storage_size: Optional["capo_mq.types.__integer.__integer"] = None,
    storage_type: Optional[
        "capo_mq.types.broker_storage_type.BrokerStorageType"
    ] = None,
    subnet_ids: Optional["capo_mq.types.__list_of__string.__listOf__string"] = None,
    tags: Optional["capo_mq.types.__map_of__string.__mapOf__string"] = None,
    users: Optional["capo_mq.types.__list_of_user.__listOfUser"] = None,
    data_replication_mode: Optional[
        "capo_mq.types.data_replication_mode.DataReplicationMode"
    ] = None,
    data_replication_primary_broker_arn: Optional[
        "capo_mq.types.__string.__string"
    ] = None,
) -> "capo_mq.types.create_broker_response.CreateBrokerResponse":
    """<p>Creates a broker. Note: This API is asynchronous.</p> <p>To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.</p> <ul><li><p>ec2:CreateNetworkInterface</p> <p>This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.</p></li> <li><p>ec2:CreateNetworkInterfacePermission</p> <p>This permission is required to attach the ENI to the broker instance.</p></li> <li><p>ec2:DeleteNetworkInterface</p></li> <li><p>ec2:DeleteNetworkInterfacePermission</p></li> <li><p>ec2:DetachNetworkInterface</p></li> <li><p>ec2:DescribeInternetGateways</p></li> <li><p>ec2:DescribeNetworkInterfaces</p></li> <li><p>ec2:DescribeNetworkInterfacePermissions</p></li> <li><p>ec2:DescribeRouteTables</p></li> <li><p>ec2:DescribeSecurityGroups</p></li> <li><p>ec2:DescribeSubnets</p></li> <li><p>ec2:DescribeVpcs</p></li></ul> <p>For more information, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/amazon-mq-setting-up.html#create-iam-user">Create an IAM User and Get Your Amazon Web Services Credentials</a> and <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/connecting-to-amazon-mq.html#never-modify-delete-elastic-network-interface">Never Modify or Delete the Amazon MQ Elastic Network Interface</a> in the <i>Amazon MQ Developer Guide</i>.</p>

    Args:
        authentication_strategy: <p>Optional. The authentication strategy used to secure the broker. The default is SIMPLE.</p>
        auto_minor_version_upgrade: <p>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.</p> <note><p>Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.</p></note>
        broker_name: <p>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.</p> <important><p>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.</p></important>
        configuration: <p>A list of information about the configuration.</p>
        creator_request_id: <p>The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.</p> <note><p>We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.</p></note>
        deployment_mode: <p>Required. The broker's deployment mode.</p>
        encryption_options: <p>Encryption options for the broker.</p>
        engine_type: <p>Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.</p>
        engine_version: <p>The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p>
        host_instance_type: <p>Required. The broker's instance type.</p>
        ldap_server_metadata: <p>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.</p>
        logs: <p>Enables Amazon CloudWatch logging for brokers.</p>
        maintenance_window_start_time: <p>The parameters that determine the WeeklyStartTime.</p>
        publicly_accessible: <p>Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.</p>
        security_groups: <p>The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.</p>
        storage_size: <p>The broker's storage size in GB.</p>
        storage_type: <p>The broker's storage type.</p>
        subnet_ids: <p>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.</p> <important><p>If you specify subnets in a <a href="https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html">shared VPC</a> 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.</p></important>
        tags: <p>Create tags when creating the broker.</p>
        users: <p>The list of broker users (persons or applications) who can access queues and topics. For Amazon MQ for RabbitMQ brokers, an administrative user is required if using simple authentication and authorization. For brokers using OAuth2, this user is optional. When provided, 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.</p>
        data_replication_mode: <p>Defines whether this broker is a part of a data replication pair.</p>
        data_replication_primary_broker_arn: <p>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.</p>

    Raises:
        capo_mq.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_mq.errors.conflict_exception.ConflictException: <p>Returns information about an error.</p>
        capo_mq.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_mq.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_mq.errors.unauthorized_exception.UnauthorizedException: <p>Returns information about an error.</p>
        capo_mq.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mq.types.create_broker_request.CreateBrokerRequest]",
    ) -> OperationResponse[
        "capo_mq.types.create_broker_response.CreateBrokerResponse"
    ]:
        import capo_mq._operations.mq.create_broker

        output, http_response = capo_mq._operations.mq.create_broker.create_broker(
            req.options, req.input
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateBroker")
    )
    input_: capo_mq.types.create_broker_request.CreateBrokerRequest = {}
    if authentication_strategy is not None:
        input_["authentication_strategy"] = authentication_strategy
    if auto_minor_version_upgrade is not None:
        input_["auto_minor_version_upgrade"] = auto_minor_version_upgrade
    if broker_name is not None:
        input_["broker_name"] = broker_name
    if configuration is not None:
        input_["configuration"] = configuration
    if creator_request_id is None:
        creator_request_id = str(uuid.uuid4())
    input_["creator_request_id"] = creator_request_id
    if deployment_mode is not None:
        input_["deployment_mode"] = deployment_mode
    if encryption_options is not None:
        input_["encryption_options"] = encryption_options
    if engine_type is not None:
        input_["engine_type"] = engine_type
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if host_instance_type is not None:
        input_["host_instance_type"] = host_instance_type
    if ldap_server_metadata is not None:
        input_["ldap_server_metadata"] = ldap_server_metadata
    if logs is not None:
        input_["logs"] = logs
    if maintenance_window_start_time is not None:
        input_["maintenance_window_start_time"] = maintenance_window_start_time
    if publicly_accessible is not None:
        input_["publicly_accessible"] = publicly_accessible
    if security_groups is not None:
        input_["security_groups"] = security_groups
    if storage_size is not None:
        input_["storage_size"] = storage_size
    if storage_type is not None:
        input_["storage_type"] = storage_type
    if subnet_ids is not None:
        input_["subnet_ids"] = subnet_ids
    if tags is not None:
        input_["tags"] = tags
    if users is not None:
        input_["users"] = users
    if data_replication_mode is not None:
        input_["data_replication_mode"] = data_replication_mode
    if data_replication_primary_broker_arn is not None:
        input_["data_replication_primary_broker_arn"] = (
            data_replication_primary_broker_arn
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output