Binding

• Implements: IBinding

This class encapsulates and extends the ROS resource type ALIYUN::AMQP::Binding.

Initializers

import ros_cdk_amqp
ros_cdk_amqp.Binding(
  scope: Construct,
  id: str,
  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],
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

argument^Required

• 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_key^Required

• 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_type^Required

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

Property bindingType: The type of the destination object.

Valid values:

• 0: Queue
• 1: Exchange

destination_name^Required

• 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_id^Required

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

Property instanceId: InstanceId.

source_exchange^Required

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

Property sourceExchange: The Source Exchange Name.

virtual_host^Required

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

Property virtualHost: The name of the virtual host.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_amqp
ros_cdk_amqp.Binding.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

props^Required

props: BindingProps

• Type: BindingProps