Skip to content

Binding

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

Initializers

import com.aliyun.ros.cdk.amqp.Binding;
Binding.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .argument(java.lang.String)
    .argument(IResolvable)
    .bindingKey(java.lang.String)
    .bindingKey(IResolvable)
    .bindingType(java.lang.String)
    .bindingType(IResolvable)
    .destinationName(java.lang.String)
    .destinationName(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .sourceExchange(java.lang.String)
    .sourceExchange(IResolvable)
    .virtualHost(java.lang.String)
    .virtualHost(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
argument java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property argument: The key-value pairs for the message header attributes.
bindingKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bindingKey: The binding key.
bindingType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bindingType: The type of the destination object.
destinationName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property destinationName: The name of the binding destination.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: InstanceId.
sourceExchange java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceExchange: The Source Exchange Name.
virtualHost java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property virtualHost: The name of the virtual host.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

argumentRequired

  • Type: java.lang.String OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property bindingType: The type of the destination object.

Valid values:

  • 0: Queue
  • 1: Exchange

destinationNameRequired

  • Type: java.lang.String OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceId: InstanceId.


sourceExchangeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceExchange: The Source Exchange Name.


virtualHostRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property virtualHost: The name of the virtual host.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.amqp.Binding;
Binding.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
props BindingProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

propsRequired

public BindingProps getProps();