Binding
This class encapsulates and extends the ROS resource type ALIYUN::AMQP::Binding
, which is used to bind a queue or exchange to an exchange.
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
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
argument |
typing.Union[str, ros_cdk_core.IResolvable] |
Property argument: X-match 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 Target Binding Types. |
destination_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property destinationName: The Target Queue Or Exchange of the Name. |
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. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
argument
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property argument: X-match Attributes.
Valid Values: "x-match:all": Default Value, All the Message Header of Key-Value Pairs Stored in the Must Match. "x-match:any": at Least One Pair of the Message Header of Key-Value Pairs Stored in the Must Match.
binding_key
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property bindingKey: The Binding Key.
binding_type
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property bindingType: The Target Binding Types.
Valid values: EXCHANGE, QUEUE.
destination_name
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property destinationName: The Target Queue Or Exchange of the Name.
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
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition |
No description. |
add_count |
No description. |
add_dependency |
No description. |
add_resource_desc |
No description. |
apply_removal_policy |
No description. |
get_att |
No description. |
set_metadata |
No description. |
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_amqp
ros_cdk_amqp.Binding.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
Name | Type | Description |
---|---|---|
node |
ros_cdk_core.ConstructNode |
The construct tree node associated with this construct. |
ref |
str |
No description. |
stack |
ros_cdk_core.Stack |
The stack in which this resource is defined. |
resource |
ros_cdk_core.RosResource |
No description. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
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