---
schema_version: "1"
id: f974c7956d0fe261a3d2f34cb8ff585760aef51e9b4e42e7d2b4025f0cb08d72
title: Anypoint MQ Connector Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/anypoint-mq-connector/3.x/anypoint-mq-connector-reference.md
canonical_url: https://docs.mulesoft.com/anypoint-mq-connector/3.x/anypoint-mq-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: c65a48a0914dd4d0910fd59fc822d5f4d21e0e0e811d7db20801683f3def1511
description: MuleSoft Documentation Site
release: 3.x
latest: false
---
---
product: Anypoint MQ Connector
version: 3.x
---

# Anypoint MQ Connector Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Support Version: Select

Anypoint MQ Connector Version 3.x

Anypoint MQ is a multi-tenant, cloud messaging service that enables customers to perform advanced
asynchronous messaging among their applications.

## Configurations

---

### Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Specifies the name for this configuration. Connectors refer to the configuration by using this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#config_connection">Connection</a></p></div></div></td><td><p>Specifies the connection types to provide to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for purging. The platform purges expired instances as needed to free resources.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Connection

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>URL</p></td><td><div><div><p>String</p></div></div></td><td><p>The region URL for the queue from the <strong>Anypoint Platform &gt; MQ</strong> console</p></td><td><p>https://mq-us-east-1.anypoint.mulesoft.com/api/v1</p></td><td></td></tr><tr><td><p>Client App ID</p></td><td><div><div><p>String</p></div></div></td><td><p>The Client App ID from <strong>Anypoint Platform &gt; MQ &gt; Client Apps</strong></p></td><td></td><td><p>x</p></td></tr><tr><td><p>Client Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>The Client Secret field from <strong>Anypoint Platform &gt; MQ &gt; Client Apps</strong></p></td><td></td><td><p>x</p></td></tr><tr><td><p>TLS Context</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Destination host for proxy requests</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Destination port for proxy requests</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username to authenticate against the proxy</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password to authenticate against the proxy</p></td><td></td><td></td></tr><tr><td><p>Send Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Size of the buffer (in bytes) used when sending data, set on the socket itself</p></td><td></td><td></td></tr><tr><td><p>Receive Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Size of the buffer (in bytes) used when receiving data</p></td><td></td><td></td></tr><tr><td><p>Client Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>SO_TIMEOUT value on sockets. Indicates the amount of time (in milliseconds) that the socket waits in a blocking operation before failing. A value of 0 (the default) indicates an indefinite wait.</p></td><td></td><td></td></tr><tr><td><p>Send TCP With No Delay</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If set, transmitted data is not grouped but sent immediately. Defaults to true.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Linger</p></td><td><div><div><p>Number</p></div></div></td><td><p>SO_LINGER value, which determines how long (in milliseconds) the socket takes to close so that any remaining data is transmitted correctly</p></td><td></td><td></td></tr><tr><td><p>Keep Alive</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>SO_KEEPALIVE behavior on open sockets, which automatically checks open socket connections that are unused for long periods, and closes them if the connection becomes unavailable. This is a property on the socket itself and is used by a server socket to control whether connections to the server are kept alive before they are recycled.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of milliseconds to wait until an outbound connection to a remote server is successfully created, before failing with a timeout. Defaults to 30 seconds.</p></td><td><p>30000</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the deployment connectivity test to each connector fails.</p></td><td></td><td></td></tr></tbody></table>

## Operations

- [Ack](#ack)

- [Consume](#consume)

- [Nack](#nack)

- [Publish](#publish)

### Associated Sources

- [Subscriber](#subscriber)

### Ack

`<anypoint-mq:ack>`

Executes an acknowledgment indicating that the message is consumed correctly and deletes the message
from In Flight status.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Ack Token</p></td><td><div><div><p>String</p></div></div></td><td><p>Acknowledgment token used to perform manual ACK and NACK operations, in MANUAL mode only</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors</p><p>Anypoint MQ Connector doesn’t support this parameter. For more information, see <a href="https://docs.mulesoft.com/mq/mq-faq#can-i-use-a-retry-strategy-with-the-anypoint-mq-connector">Can I use a retry strategy with the Anypoint MQ connector?</a></p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Config](#config)

#### Throws

- ANYPOINT-MQ:ACKING

- ANYPOINT-MQ:CONNECTIVITY

- ANYPOINT-MQ:DESTINATION\_NOT\_FOUND

- ANYPOINT-MQ:RETRY\_EXHAUSTED

### Consume

`<anypoint-mq:consume>`

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Queue</p></td><td><div><div><p>String</p></div></div></td><td><p>Queue or Exchange name from which to fetch a message</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Acknowledgment Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>IMMEDIATE</p></li><li><p>MANUAL</p></li></ul></div></div></td><td><p>Acknowledgment mode to use for the messages retrieved</p></td><td><p>IMMEDIATE</p></td><td></td></tr><tr><td><p>Acknowledgment Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Duration that a message is held by a consumer waiting for an acknowledgment or not acknowledgment. After that duration elapses, the message is again available to any consumer.</p></td><td><p>0</p></td><td></td></tr><tr><td><p>Acknowledgment Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit to use in the acknowledgmentTimeout configuration</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Polling Time</p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Time to wait for a message to be ready for consumption (0-20000).</p></div><div><ul><li><p>If this value is greater than 0 and no message arrives, the connector throws a <code>ANYPOINT-MQ:TIMEOUT</code> exception.</p></li><li><p>If this value is 0 and no message arrives, the connector returns <code>NULL</code> and doesn’t throw the <code>ANYPOINT-MQ:TIMEOUT</code> exception.</p></li></ul></div></div></td><td><p>10000</p></td><td></td></tr><tr><td><p>Polling Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit to use in the pollingTime configuration</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the operation output</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the operation output</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Use repeatable streams</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of a variable to store the operation’s output</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors</p><p>Anypoint MQ Connector doesn’t support this parameter. For more information, see <a href="https://docs.mulesoft.com/mq/mq-faq#can-i-use-a-retry-strategy-with-the-anypoint-mq-connector">Can I use a retry strategy with the Anypoint MQ connector?</a></p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#AnypointMQMessageAttributes">Anypoint MQ Message Attributes</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Config](#config)

#### Throws

- ANYPOINT-MQ:ACKING

- ANYPOINT-MQ:CONSUMING

- ANYPOINT-MQ:CONNECTIVITY

- ANYPOINT-MQ:TIMEOUT

- ANYPOINT-MQ:DESTINATION\_NOT\_FOUND

- ANYPOINT-MQ:RETRY\_EXHAUSTED

### Nack

`<anypoint-mq:nack>`

Executes a not acknowledgment and changes the status of the message from In Flight to In Queue for
subscriber consumption

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Ack Token</p></td><td><div><div><p>String</p></div></div></td><td><p>Acknowledgment token used to perform manual ACK and NACK operations, in MANUAL mode only</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors</p><p>Anypoint MQ Connector doesn’t support this parameter. For more information, see <a href="https://docs.mulesoft.com/mq/mq-faq#can-i-use-a-retry-strategy-with-the-anypoint-mq-connector">Can I use a retry strategy with the Anypoint MQ connector?</a></p></td><td></td><td></td></tr></tbody></table>

#### For Configurations

- [Config](#config)

#### Throws

- ANYPOINT-MQ:NACKING

- ANYPOINT-MQ:CONNECTIVITY

- ANYPOINT-MQ:DESTINATION\_NOT\_FOUND

- ANYPOINT-MQ:RETRY\_EXHAUSTED

### Publish

`<anypoint-mq:publish>`

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Destination</p></td><td><div><div><p>String</p></div></div></td><td><p>Queue or Exchange name from which to fetch a message</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the operation output</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>The encoding of the operation output</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Use repeatable streams</p></td><td></td><td></td></tr><tr><td><p>Body</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Body of the outgoing message, sent as a string as part of a JSON message. Any content that is published must be capable of being serialized to and deserialized from string format. Sending Objects that don’t have a proper string serialization causes the message to be unreadable on the receiving end.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>User Properties</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom user properties set to the message</p></td><td></td><td></td></tr><tr><td><p>Message Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Valid custom user ID for the outgoing message. If not specified, the broker creates one.</p></td><td></td><td></td></tr><tr><td><p>Message Group Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the message group to which the published message belongs. Specify only for FIFO queues.</p><p>Message group IDs can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (! " # $ % &amp; ' ( ) * + , - . / : ; &lt; = &gt; ? @ [ ] \ ^ _ ` { } | ~).</p></td><td></td><td></td></tr><tr><td><p>Delivery Delay</p></td><td><div><div><p>Number</p></div></div></td><td><p>Time to postpone delivery of the message before consumption: between 0 and 15 minutes.</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Delivery Delay Unit</p></td><td><div><div><p>Enumeration</p></div></div></td><td><div><div><p>Time unit to use in the <code>Delivery Delay</code> parameter:</p></div><div><ul><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li></ul></div></div></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Send Content-Type</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Set to true if the body type should be sent as an Anypoint MQ Message property</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of a variable to store the operation output</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression to evaluate against the operation output. The expression outcome is stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors</p><p>Anypoint MQ Connector doesn’t support this parameter. For more information, see <a href="https://docs.mulesoft.com/mq/mq-faq#can-i-use-a-retry-strategy-with-the-anypoint-mq-connector">Can I use a retry strategy with the Anypoint MQ connector?</a></p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#AnypointMQMessagePublishAttributes">Anypoint MQ Message Publish Attributes</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Config](#config)

#### Throws

- ANYPOINT-MQ:PUBLISHING

- ANYPOINT-MQ:CONNECTIVITY

- ANYPOINT-MQ:ILLEGAL\_BODY

- ANYPOINT-MQ:DESTINATION\_NOT\_FOUND

- ANYPOINT-MQ:RETRY\_EXHAUSTED

## Sources

### Subscriber

`<anypoint-mq:subscriber>`

Anypoint MQ Subscriber Message Source retrieves messages from the given destination name.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Queue</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the queue from which messages are retrieved</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Subscriber Type</p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#polling">Polling</a></p></li><li><p><a href="#prefetch">Prefetch</a></p></li></ul></div></div></td><td><p>Strategy to use when subscribing to messages from the service</p></td><td></td><td></td></tr><tr><td><p>Acknowledgment Mode</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>IMMEDIATE</p></li><li><p>AUTO</p></li><li><p>MANUAL</p></li></ul></div></div></td><td><p>Acknowledgment mode to use for the messages retrieved</p></td><td><p>AUTO</p></td><td></td></tr><tr><td><p>Acknowledgment Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Duration that a message is held by a broker waiting for an acknowledgment or not acknowledgment before being made available to any subscriber. Specifies the default <code>acknowledgmentTimeout</code> value for all Subscriber sources, unless it is overridden. The maximum value of this parameter is 12 hours.</p></td><td><p>If <code>acknowledgementTimeout</code> is not set (the default), the connector uses the TTL value of at least two minutes.</p></td><td></td></tr><tr><td><p>Acknowledgment Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Time unit to use in the acknowledgmentTimeout configuration</p></td><td><p>MILLISECONDS</p></td><td></td></tr><tr><td><p>Circuit Breaker</p></td><td><div><div><p><a href="#circuitBreaker">Circuit Breaker</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the operation output</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the operation output</p></td><td></td><td></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Use repeatable streams</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Message redelivery policy</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors</p><p>Anypoint MQ Connector doesn’t support this parameter. For more information, see <a href="https://docs.mulesoft.com/mq/mq-faq#can-i-use-a-retry-strategy-with-the-anypoint-mq-connector">Can I use a retry strategy with the Anypoint MQ connector?</a></p></td><td></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#AnypointMQMessageAttributes">Anypoint MQ Message Attributes</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Config](#config)

## Types

### Tls

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Enabled Protocols</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of protocols enabled for this context</p></td><td></td><td></td></tr><tr><td><p>Enabled Cipher Suites</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of cipher suites enabled for this context</p></td><td></td><td></td></tr><tr><td><p>Trust Store</p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Key Store</p></td><td><div><div><p><a href="#KeyStore">Key Store</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Revocation Check</p></td><td><div><div><ul><li><p><a href="#standard-revocation-check">Standard Revocation Check</a></p></li><li><p><a href="#custom-ocsp-responder">Custom OCSP Responder</a></p></li><li><p><a href="#crl-file">CRL File</a></p></li></ul></div></div></td><td></td><td></td><td></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Location of the trust store, resolved relative to the current classpath and file system, if possible</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to protect the trust store</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Type of store used</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>Algorithm used by the trust store</p></td><td></td><td></td></tr><tr><td><p>Insecure</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.</p></td><td></td><td></td></tr></tbody></table>

### Key Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Location of the key store, resolved relative to the current classpath and file system, if possible</p></td><td></td><td></td></tr><tr><td><p>Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Type of store used</p></td><td></td><td></td></tr><tr><td><p>Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>When the key store contains many private keys, indicates the alias of the key that is used. If not defined, the first key in the file is used by default.</p></td><td></td><td></td></tr><tr><td><p>Key Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to protect the private key</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password used to protect the key store</p></td><td></td><td></td></tr><tr><td><p>Algorithm</p></td><td><div><div><p>String</p></div></div></td><td><p>Algorithm used by the key store</p></td><td></td><td></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Only End Entities</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Verifies only the last element in the certificate chain</p></td><td></td><td></td></tr><tr><td><p>Prefer Crls</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Uses CRL-signing certificates before using OCSP-signing certificate</p></td><td></td><td></td></tr><tr><td><p>No Fallback</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Doesn’t use the secondary checking method (the one not selected for Prefer Crls)</p></td><td></td><td></td></tr><tr><td><p>Soft Fail</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Avoids verification failure when the revocation server cannot be reached or is busy</p></td><td></td><td></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL of the OCSP responder</p></td><td></td><td></td></tr><tr><td><p>Cert Alias</p></td><td><div><div><p>String</p></div></div></td><td><p>Alias of the signing certificate for the OCSP response, if present. The signing certificate must be in the trust store.</p></td><td></td><td></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path to the CRL file</p></td><td></td><td></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the deployment connectivity test to each connector fails.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Reconnection strategy to use</p><p>Anypoint MQ Connector doesn’t support this parameter. For more information, see <a href="https://docs.mulesoft.com/mq/mq-faq#can-i-use-a-retry-strategy-with-the-anypoint-mq-connector">Can I use a retry strategy with the Anypoint MQ connector?</a></p></td><td></td><td></td></tr></tbody></table>

### Reconnect

> [!NOTE] Anypoint MQ Connector doesn’t support this parameter. For more information, see
> [Can I use a retry strategy with the Anypoint MQ connector?](https://docs.mulesoft.com/mq/mq-faq#can-i-use-a-retry-strategy-with-the-anypoint-mq-connector)

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often to reconnect, in milliseconds</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>How many reconnection attempts to make</p></td><td></td><td></td></tr><tr><td><p>blocking</p></td><td><p>Boolean</p></td><td><p>If false, the reconnection strategy runs in a separate, non-blocking thread</p></td><td><p>true</p></td><td></td></tr></tbody></table>

### Reconnect Forever

> [!NOTE] Anypoint MQ Connector doesn’t support this parameter. For more information, see
> [Can I use a retry strategy with the Anypoint MQ connector?](https://docs.mulesoft.com/mq/mq-faq#can-i-use-a-retry-strategy-with-the-anypoint-mq-connector)

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>How often to reconnect, in milliseconds</p></td><td></td><td></td></tr><tr><td><p>blocking</p></td><td><p>Boolean</p></td><td><p>If false, the reconnection strategy runs in a separate, non-blocking thread</p></td><td><p>true</p></td><td></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration</p></td><td></td><td></td></tr><tr><td><p>Time Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the maxIdleTime attribute</p></td><td></td><td></td></tr></tbody></table>

### Anypoint MQ Message Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Destination</p></td><td><div><div><p>String</p></div></div></td><td><p>Message destination</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Message headers</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Properties</p></td><td><div><div><p>Object</p></div></div></td><td><p>Message properties</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the message</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Delivery Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of times the message was delivered</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Content Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Content type of the message body</p></td><td></td><td></td></tr><tr><td><p>Ack Token</p></td><td><div><div><p>String</p></div></div></td><td><p>Acknowledgment token used to perform manual ACK and NACK operations, in MANUAL mode only</p></td><td></td><td></td></tr></tbody></table>

### Circuit Breaker

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>On Error Types</p></td><td><div><div><p>String</p></div></div></td><td><p>Error types that equal failure of the circuit when they occur during flow execution. By default, all errors result in failure.</p></td><td></td><td></td></tr><tr><td><p>Errors Threshold</p></td><td><div><div><p>Number</p></div></div></td><td><p>Of the errors considered by the circuit, how many must occur for the circuit to be opened.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Trip Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>How long the circuit remains open after <code>errorsThreshold</code> is reached</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Trip Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>The time unit bound to the tripTimeout value</p></td><td><p>MILLISECONDS</p></td><td></td></tr></tbody></table>

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The amount of memory allocated to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>How much buffer size can expand. If set to 0 (zero) or less, STREAM_MAXIMUM_SIZE_EXCEEDED is raised when the buffer is full.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum amount of memory to use before STREAM_MAXIMUM_SIZE_EXCEEDED is raised. If set to 0 (zero) or less, memory is unlimited.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>Unit in which all these attributes are expressed</p></td><td></td><td></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum amount of memory that the stream can hold locally before content is buffered to disk</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>Unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

### Redelivery Policy

For information on the redelivery policy, see
[Configure a Redelivery Policy](https://docs.mulesoft.com/mule-runtime/latest/redelivery-policy).

### Anypoint MQ Message Publish Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Message Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the message that was published</p></td><td></td><td><p>x</p></td></tr></tbody></table>

### Prefetch

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max Local Messages</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of messages to prefetch from the service and keep locally before dispatching to the flow</p><p>NOTE: Due to a known issue, using <code>prefetch</code> mode with <code>maxConcurrency="1"</code> set on the <code>flow</code> element might result in message-processing latency.</p><p>When using <code>prefetch</code> mode, set <code>maxLocalMessages</code> to a value greater than <code>1</code> to avoid message-processing latency issues. When <code>maxLocalMessages</code> is set to <code>1</code>, latency can occur when the connector prefetches the message but the app doesn’t consume it, and the message returns to the queue for reprocessing.</p></td><td><p>30</p></td><td></td></tr></tbody></table>

### Polling

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Fetch size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of messages (1-10) to fetch on each polling execution</p><p>An error occurs if you configure a value greater than 10.</p></td><td><p>10</p></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><div><div><p>Scheduling strategy for triggering the message fetch from the service</p></div><div><ul><li><p><a href="#fixed-frequency">Fixed Frequency</a></p></li><li><p><a href="#cron">Cron</a></p></li></ul></div></div></td><td></td><td><p>x</p></td></tr></tbody></table>

### Fixed Frequency

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Frequency</p></td><td><div><div><p>Number</p></div></div></td><td><p>Polling frequency</p></td><td><div><div><p>1000ms</p></div><div><p>(1 second)</p></div></div></td><td></td></tr><tr><td><p>Start delay</p></td><td><div><div><p>Number</p></div></div></td><td><p>The amount of time for the scheduler to wait before starting</p></td><td><p>10</p></td><td></td></tr><tr><td><p>Time unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>DAYS</p></li><li><p>HOURS</p></li><li><p>MINUTES</p></li><li><p>SECONDS</p></li><li><p>MILLISECONDS</p></li></ul></div></div></td><td><p>Time unit to use in the <code>startDelay</code> configuration</p></td><td><p>MILLISECONDS</p></td><td></td></tr></tbody></table>

### Cron

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Expression</p></td><td><div><div><p>Cron expression</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Time Zone</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the time zone in which the expression is based</p></td><td></td><td></td></tr></tbody></table>

## See Also

- [Fixed Frequency](https://docs.mulesoft.com/mule-runtime/latest/scheduler-concept#fixed-frequency)

- [Cron Expressions](https://docs.mulesoft.com/mule-runtime/latest/scheduler-concept#cron-expressions)