Skip to content

BindingProps

Properties for defining a Binding.

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

Initializer

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

Properties

Name Type Description
argument string | @alicloud/ros-cdk-core.IResolvable Property argument: The key-value pairs for the message header attributes.
bindingKey string | @alicloud/ros-cdk-core.IResolvable Property bindingKey: The binding key.
bindingType string | @alicloud/ros-cdk-core.IResolvable Property bindingType: The type of the destination object.
destinationName string | @alicloud/ros-cdk-core.IResolvable Property destinationName: The name of the binding destination.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: InstanceId.
sourceExchange string | @alicloud/ros-cdk-core.IResolvable Property sourceExchange: The Source Exchange Name.
virtualHost string | @alicloud/ros-cdk-core.IResolvable Property virtualHost: The name of the virtual host.

argumentRequired

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

Property argument: The key-value pairs for the message header attributes.

The message header attributes consist of one or more key-value pairs. The x-match attribute is required. Other attributes are custom. The x-match attribute supports the following values: - all: This is the default value. All key-value pairs in the message header must match. - any: At least one key-value pair in the message header must match. Separate attributes with semicolons (;) and separate keys from values with colons (:). Example: x-match:all;type:report;format:pdf This parameter is valid only for headers exchanges. For other types of exchanges, this parameter is ignored.


bindingKeyRequired

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

Property bindingKey: The binding key.

If the source exchange is not a topic exchange: - It can contain letters, digits, hyphens (-), underscores (), periods (.), forward slashes (\/), and at signs (@). - The length must be 1 to 255 characters. - If the source exchange is a topic exchange: - It can contain letters, digits, hyphens (-), underscores (), asterisks (*), periods (.), number signs (#), forward slashes (\/), and at signs (@). - The key cannot start or end with a period (.). If the key starts with a number sign (#) or an asterisk (*), a period (.) must immediately follow. If the key ends with a number sign (#) or an asterisk (*), a period (.) must immediately precede it. If a number sign (#) or an asterisk (*) is in the middle of the key, it must have a period (.) on both sides. - The length must be 1 to 255 characters.


bindingTypeRequired

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

Property bindingType: The type of the destination object.

Valid values: - 0: Queue - 1: Exchange


destinationNameRequired

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

Property destinationName: The name of the binding destination.

The destination must be created in the console. It must belong to the same vhost as SourceExchange. The VirtualHost parameter specifies the vhost.


instanceIdRequired

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

Property instanceId: InstanceId.


sourceExchangeRequired

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

Property sourceExchange: The Source Exchange Name.


virtualHostRequired

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

Property virtualHost: The name of the virtual host.