Skip to content

ExchangeProps

Properties for defining a Exchange.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-amqp-exchange

Initializer

import { ExchangeProps } from '@alicloud/ros-cdk-amqp'
const exchangeProps: ExchangeProps = { ... }

Properties

Name Type Description
autoDeleteState boolean | @alicloud/ros-cdk-core.IResolvable Property autoDeleteState: Specifies whether the Auto Delete attribute is configured.
exchangeName string | @alicloud/ros-cdk-core.IResolvable Property exchangeName: The name of the exchange.
exchangeType string | @alicloud/ros-cdk-core.IResolvable Property exchangeType: The type of the exchange.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: InstanceId.
internal boolean | @alicloud/ros-cdk-core.IResolvable Property internal: Specifies whether an exchange is an internal exchange.
virtualHost string | @alicloud/ros-cdk-core.IResolvable Property virtualHost: The name of the virtual host.
alternateExchange string | @alicloud/ros-cdk-core.IResolvable Property alternateExchange: The alternate exchange.
xDelayedType string | @alicloud/ros-cdk-core.IResolvable Property xDelayedType: Exchanges of the x-delay-Message type allow you to customize the Header property of the message, and the x-delay specifies the amount of time in milliseconds for the message to be delivered.

autoDeleteStateRequired

public readonly autoDeleteState: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoDeleteState: Specifies whether the Auto Delete attribute is configured.

Valid values: true: The Auto Delete attribute is configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted.


exchangeNameRequired

public readonly exchangeName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property exchangeName: The name of the exchange.


exchangeTypeRequired

public readonly exchangeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property exchangeType: The type of the exchange.

Valid values: FANOUT: An exchange of this type routes all the received messages to all the queues bound to this exchange. You can use a fanout exchange to broadcast messages. DIRECT: An exchange of this type routes a message to the queue whose binding key is exactly the same as the routing key of the message. TOPIC: This type is similar to the direct exchange type. An exchange of this type routes a message to one or more queues based on the fuzzy match or multi-condition match result between the routing key of the message and the binding keys of the current exchange. HEADERS: Headers Exchange uses the Headers property instead of Routing Key for routing matching. When binding Headers Exchange and Queue, set the key-value pair of the binding property; when sending a message to the Headers Exchange, set the message's Headers property key-value pair and use the message Headers The message is routed to the bound Queue by comparing the attribute key-value pair and the bound attribute key-value pair.


instanceIdRequired

public readonly instanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceId: InstanceId.


internalRequired

public readonly internal: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property internal: Specifies whether an exchange is an internal exchange.

Valid values: false: The exchange is not an internal exchange. true: The exchange is an internal exchange.


virtualHostRequired

public readonly virtualHost: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property virtualHost: The name of the virtual host.


alternateExchangeOptional

public readonly alternateExchange: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property alternateExchange: The alternate exchange.

An alternate exchange is configured for an existing exchange. It is used to receive messages that fail to be routed to queues from the existing exchange.


xDelayedTypeOptional

public readonly xDelayedType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property xDelayedType: Exchanges of the x-delay-Message type allow you to customize the Header property of the message, and the x-delay specifies the amount of time in milliseconds for the message to be delivered.

The routing rules for this class of exchanges depend on the Exchange type specified in the x-delay-type parameter, which specifies the actual Exchange type to which the delayed message will eventually be delivered. Valid values: - DIRECT: Delivers deferred messages to a specified queue bound to an Exchange of type DIRECT. - TOPIC: Delivers deferred messages to the queue bound to the Exchange type TOPIC. - FANOUT: Delivers deferred messages to a queue bound to an Exchange of type FANOUT. - HEADERS: Deferred messages are delivered to the queue bound to the Exchange HEADERS type. - X-JMS-TOPIC: Delivers deferred messages to the queue bound to X-JMS-TOPIC.