Skip to content

BindingProps

Properties for defining a Binding.

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

Initializer

import ros_cdk_amqp
ros_cdk_amqp.BindingProps(
  argument: typing.Union[str, IResolvable],
  binding_key: typing.Union[str, IResolvable],
  binding_type: typing.Union[str, IResolvable],
  destination_name: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  source_exchange: typing.Union[str, IResolvable],
  virtual_host: typing.Union[str, IResolvable]
)

Properties

Name Type Description
argument typing.Union[str, ros_cdk_core.IResolvable] Property argument: The key-value pairs for the message header attributes.
binding_key typing.Union[str, ros_cdk_core.IResolvable] Property bindingKey: The binding key.
binding_type typing.Union[str, ros_cdk_core.IResolvable] Property bindingType: The type of the destination object.
destination_name typing.Union[str, ros_cdk_core.IResolvable] Property destinationName: The name of the binding destination.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: InstanceId.
source_exchange typing.Union[str, ros_cdk_core.IResolvable] Property sourceExchange: The Source Exchange Name.
virtual_host typing.Union[str, ros_cdk_core.IResolvable] Property virtualHost: The name of the virtual host.

argumentRequired

argument: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

binding_keyRequired

binding_key: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

binding_typeRequired

binding_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property bindingType: The type of the destination object.

Valid values:

  • 0: Queue
  • 1: Exchange

destination_nameRequired

destination_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


instance_idRequired

instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: InstanceId.


source_exchangeRequired

source_exchange: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property sourceExchange: The Source Exchange Name.


virtual_hostRequired

virtual_host: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property virtualHost: The name of the virtual host.