Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.19.0 published on Friday, Mar 18, 2022 by Pulumi

Binding

Provides a RabbitMQ (AMQP) Binding resource to bind tha exchange with another exchange or queue.

NOTE: Available in v1.135.0+.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleVirtualHost = new AliCloud.Amqp.VirtualHost("exampleVirtualHost", new AliCloud.Amqp.VirtualHostArgs
        {
            InstanceId = "amqp-abc12345",
            VirtualHostName = "my-VirtualHost",
        });
        var exampleExchange = new AliCloud.Amqp.Exchange("exampleExchange", new AliCloud.Amqp.ExchangeArgs
        {
            AutoDeleteState = false,
            ExchangeName = "my-Exchange",
            ExchangeType = "HEADERS",
            InstanceId = exampleVirtualHost.InstanceId,
            Internal = false,
            VirtualHostName = exampleVirtualHost.VirtualHostName,
        });
        var exampleQueue = new AliCloud.Amqp.Queue("exampleQueue", new AliCloud.Amqp.QueueArgs
        {
            InstanceId = exampleVirtualHost.InstanceId,
            QueueName = "my-Queue",
            VirtualHostName = exampleVirtualHost.VirtualHostName,
        });
        var exampleBinding = new AliCloud.Amqp.Binding("exampleBinding", new AliCloud.Amqp.BindingArgs
        {
            Argument = "x-match:all",
            BindingKey = exampleQueue.QueueName,
            BindingType = "QUEUE",
            DestinationName = "binding-queue",
            InstanceId = exampleExchange.InstanceId,
            SourceExchange = exampleExchange.ExchangeName,
            VirtualHostName = exampleExchange.VirtualHostName,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/amqp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleVirtualHost, err := amqp.NewVirtualHost(ctx, "exampleVirtualHost", &amqp.VirtualHostArgs{
			InstanceId:      pulumi.String("amqp-abc12345"),
			VirtualHostName: pulumi.String("my-VirtualHost"),
		})
		if err != nil {
			return err
		}
		exampleExchange, err := amqp.NewExchange(ctx, "exampleExchange", &amqp.ExchangeArgs{
			AutoDeleteState: pulumi.Bool(false),
			ExchangeName:    pulumi.String("my-Exchange"),
			ExchangeType:    pulumi.String("HEADERS"),
			InstanceId:      exampleVirtualHost.InstanceId,
			Internal:        pulumi.Bool(false),
			VirtualHostName: exampleVirtualHost.VirtualHostName,
		})
		if err != nil {
			return err
		}
		exampleQueue, err := amqp.NewQueue(ctx, "exampleQueue", &amqp.QueueArgs{
			InstanceId:      exampleVirtualHost.InstanceId,
			QueueName:       pulumi.String("my-Queue"),
			VirtualHostName: exampleVirtualHost.VirtualHostName,
		})
		if err != nil {
			return err
		}
		_, err = amqp.NewBinding(ctx, "exampleBinding", &amqp.BindingArgs{
			Argument:        pulumi.String("x-match:all"),
			BindingKey:      exampleQueue.QueueName,
			BindingType:     pulumi.String("QUEUE"),
			DestinationName: pulumi.String("binding-queue"),
			InstanceId:      exampleExchange.InstanceId,
			SourceExchange:  exampleExchange.ExchangeName,
			VirtualHostName: exampleExchange.VirtualHostName,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

example_virtual_host = alicloud.amqp.VirtualHost("exampleVirtualHost",
    instance_id="amqp-abc12345",
    virtual_host_name="my-VirtualHost")
example_exchange = alicloud.amqp.Exchange("exampleExchange",
    auto_delete_state=False,
    exchange_name="my-Exchange",
    exchange_type="HEADERS",
    instance_id=example_virtual_host.instance_id,
    internal=False,
    virtual_host_name=example_virtual_host.virtual_host_name)
example_queue = alicloud.amqp.Queue("exampleQueue",
    instance_id=example_virtual_host.instance_id,
    queue_name="my-Queue",
    virtual_host_name=example_virtual_host.virtual_host_name)
example_binding = alicloud.amqp.Binding("exampleBinding",
    argument="x-match:all",
    binding_key=example_queue.queue_name,
    binding_type="QUEUE",
    destination_name="binding-queue",
    instance_id=example_exchange.instance_id,
    source_exchange=example_exchange.exchange_name,
    virtual_host_name=example_exchange.virtual_host_name)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const exampleVirtualHost = new alicloud.amqp.VirtualHost("exampleVirtualHost", {
    instanceId: "amqp-abc12345",
    virtualHostName: "my-VirtualHost",
});
const exampleExchange = new alicloud.amqp.Exchange("exampleExchange", {
    autoDeleteState: false,
    exchangeName: "my-Exchange",
    exchangeType: "HEADERS",
    instanceId: exampleVirtualHost.instanceId,
    internal: false,
    virtualHostName: exampleVirtualHost.virtualHostName,
});
const exampleQueue = new alicloud.amqp.Queue("exampleQueue", {
    instanceId: exampleVirtualHost.instanceId,
    queueName: "my-Queue",
    virtualHostName: exampleVirtualHost.virtualHostName,
});
const exampleBinding = new alicloud.amqp.Binding("exampleBinding", {
    argument: "x-match:all",
    bindingKey: exampleQueue.queueName,
    bindingType: "QUEUE",
    destinationName: "binding-queue",
    instanceId: exampleExchange.instanceId,
    sourceExchange: exampleExchange.exchangeName,
    virtualHostName: exampleExchange.virtualHostName,
});

Coming soon!

Create a Binding Resource

new Binding(name: string, args: BindingArgs, opts?: CustomResourceOptions);
@overload
def Binding(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            argument: Optional[str] = None,
            binding_key: Optional[str] = None,
            binding_type: Optional[str] = None,
            destination_name: Optional[str] = None,
            instance_id: Optional[str] = None,
            source_exchange: Optional[str] = None,
            virtual_host_name: Optional[str] = None)
@overload
def Binding(resource_name: str,
            args: BindingArgs,
            opts: Optional[ResourceOptions] = None)
func NewBinding(ctx *Context, name string, args BindingArgs, opts ...ResourceOption) (*Binding, error)
public Binding(string name, BindingArgs args, CustomResourceOptions? opts = null)
public Binding(String name, BindingArgs args)
public Binding(String name, BindingArgs args, CustomResourceOptions options)
type: alicloud:amqp:Binding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args BindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args BindingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args BindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args BindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args BindingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Binding Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Binding resource accepts the following input properties:

BindingKey string

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
BindingType string

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

DestinationName string

The Target Queue Or Exchange of the Name.

InstanceId string

Instance Id.

SourceExchange string

The Source Exchange Name.

VirtualHostName string

Virtualhost Name.

Argument string

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.
BindingKey string

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
BindingType string

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

DestinationName string

The Target Queue Or Exchange of the Name.

InstanceId string

Instance Id.

SourceExchange string

The Source Exchange Name.

VirtualHostName string

Virtualhost Name.

Argument string

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.
bindingKey String

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
bindingType String

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

destinationName String

The Target Queue Or Exchange of the Name.

instanceId String

Instance Id.

sourceExchange String

The Source Exchange Name.

virtualHostName String

Virtualhost Name.

argument String

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.
bindingKey string

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
bindingType string

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

destinationName string

The Target Queue Or Exchange of the Name.

instanceId string

Instance Id.

sourceExchange string

The Source Exchange Name.

virtualHostName string

Virtualhost Name.

argument string

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 str

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
binding_type str

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

destination_name str

The Target Queue Or Exchange of the Name.

instance_id str

Instance Id.

source_exchange str

The Source Exchange Name.

virtual_host_name str

Virtualhost Name.

argument str

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.
bindingKey String

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
bindingType String

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

destinationName String

The Target Queue Or Exchange of the Name.

instanceId String

Instance Id.

sourceExchange String

The Source Exchange Name.

virtualHostName String

Virtualhost Name.

argument String

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Binding resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing Binding Resource

Get an existing Binding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BindingState, opts?: CustomResourceOptions): Binding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        argument: Optional[str] = None,
        binding_key: Optional[str] = None,
        binding_type: Optional[str] = None,
        destination_name: Optional[str] = None,
        instance_id: Optional[str] = None,
        source_exchange: Optional[str] = None,
        virtual_host_name: Optional[str] = None) -> Binding
func GetBinding(ctx *Context, name string, id IDInput, state *BindingState, opts ...ResourceOption) (*Binding, error)
public static Binding Get(string name, Input<string> id, BindingState? state, CustomResourceOptions? opts = null)
public static Binding get(String name, Output<String> id, BindingState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Argument string

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.
BindingKey string

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
BindingType string

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

DestinationName string

The Target Queue Or Exchange of the Name.

InstanceId string

Instance Id.

SourceExchange string

The Source Exchange Name.

VirtualHostName string

Virtualhost Name.

Argument string

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.
BindingKey string

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
BindingType string

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

DestinationName string

The Target Queue Or Exchange of the Name.

InstanceId string

Instance Id.

SourceExchange string

The Source Exchange Name.

VirtualHostName string

Virtualhost Name.

argument String

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.
bindingKey String

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
bindingType String

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

destinationName String

The Target Queue Or Exchange of the Name.

instanceId String

Instance Id.

sourceExchange String

The Source Exchange Name.

virtualHostName String

Virtualhost Name.

argument string

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.
bindingKey string

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
bindingType string

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

destinationName string

The Target Queue Or Exchange of the Name.

instanceId string

Instance Id.

sourceExchange string

The Source Exchange Name.

virtualHostName string

Virtualhost Name.

argument str

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 str

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
binding_type str

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

destination_name str

The Target Queue Or Exchange of the Name.

instance_id str

Instance Id.

source_exchange str

The Source Exchange Name.

virtual_host_name str

Virtualhost Name.

argument String

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.
bindingKey String

The Binding Key.

  • For a non-topic source exchange: The binding key can contain only letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). The binding key must be 1 to 255 characters in length.
  • For a topic source exchange: The binding key can contain letters, digits, hyphens (-), underscores (_), periods (.), and at signs (@). If the binding key contains a number sign (#), the binding key must start with a number sign (#) followed by a period (.) or end with a number sign (#) that follows a period (.). The binding key must be 1 to 255 characters in length.
bindingType String

The Target Binding Types. Valid values: EXCHANGE, QUEUE.

destinationName String

The Target Queue Or Exchange of the Name.

instanceId String

Instance Id.

sourceExchange String

The Source Exchange Name.

virtualHostName String

Virtualhost Name.

Import

RabbitMQ (AMQP) Binding can be imported using the id, e.g.

 $ pulumi import alicloud:amqp/binding:Binding example <instance_id>:<virtual_host_name>:<source_exchange>:<destination_name>

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.