1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. Webhook
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi

cloudamqp.Webhook

Explore with Pulumi AI

Import

cloudamqp_webhook can be imported using the resource identifier together with CloudAMQP instance

identifier (CSV separated). To retrieve the resource identifier, use [CloudAMQP API list webhooks].

From Terraform v1.5.0, the import block can be used to import this resource:

hcl

import {

to = cloudamqp_webhook.webhook_queue

id = format(",%s", cloudamqp_instance.instance.id)

}

Or use Terraform CLI:

$ pulumi import cloudamqp:index/webhook:Webhook webhook_queue <id>,<instance_id>`
Copy

Create Webhook Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Webhook(name: string, args: WebhookArgs, opts?: CustomResourceOptions);
@overload
def Webhook(resource_name: str,
            args: WebhookArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            concurrency: Optional[int] = None,
            instance_id: Optional[int] = None,
            queue: Optional[str] = None,
            vhost: Optional[str] = None,
            webhook_uri: Optional[str] = None,
            sleep: Optional[int] = None,
            timeout: Optional[int] = None)
func NewWebhook(ctx *Context, name string, args WebhookArgs, opts ...ResourceOption) (*Webhook, error)
public Webhook(string name, WebhookArgs args, CustomResourceOptions? opts = null)
public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)
type: cloudamqp:Webhook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var webhookResource = new CloudAmqp.Webhook("webhookResource", new()
{
    Concurrency = 0,
    InstanceId = 0,
    Queue = "string",
    Vhost = "string",
    WebhookUri = "string",
    Sleep = 0,
    Timeout = 0,
});
Copy
example, err := cloudamqp.NewWebhook(ctx, "webhookResource", &cloudamqp.WebhookArgs{
	Concurrency: pulumi.Int(0),
	InstanceId:  pulumi.Int(0),
	Queue:       pulumi.String("string"),
	Vhost:       pulumi.String("string"),
	WebhookUri:  pulumi.String("string"),
	Sleep:       pulumi.Int(0),
	Timeout:     pulumi.Int(0),
})
Copy
var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()
    .concurrency(0)
    .instanceId(0)
    .queue("string")
    .vhost("string")
    .webhookUri("string")
    .sleep(0)
    .timeout(0)
    .build());
Copy
webhook_resource = cloudamqp.Webhook("webhookResource",
    concurrency=0,
    instance_id=0,
    queue="string",
    vhost="string",
    webhook_uri="string",
    sleep=0,
    timeout=0)
Copy
const webhookResource = new cloudamqp.Webhook("webhookResource", {
    concurrency: 0,
    instanceId: 0,
    queue: "string",
    vhost: "string",
    webhookUri: "string",
    sleep: 0,
    timeout: 0,
});
Copy
type: cloudamqp:Webhook
properties:
    concurrency: 0
    instanceId: 0
    queue: string
    sleep: 0
    timeout: 0
    vhost: string
    webhookUri: string
Copy

Webhook Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Webhook resource accepts the following input properties:

Concurrency This property is required. int
Max simultaneous requests to the endpoint.
InstanceId
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
Queue This property is required. string
A (durable) queue on your RabbitMQ instance.
Vhost This property is required. string
The vhost the queue resides in.
WebhookUri This property is required. string
A POST request will be made for each message in the queue to this endpoint.
Sleep int
Configurable sleep time in seconds between retries for webhook
Timeout int
Configurable timeout time in seconds for webhook
Concurrency This property is required. int
Max simultaneous requests to the endpoint.
InstanceId
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
Queue This property is required. string
A (durable) queue on your RabbitMQ instance.
Vhost This property is required. string
The vhost the queue resides in.
WebhookUri This property is required. string
A POST request will be made for each message in the queue to this endpoint.
Sleep int
Configurable sleep time in seconds between retries for webhook
Timeout int
Configurable timeout time in seconds for webhook
concurrency This property is required. Integer
Max simultaneous requests to the endpoint.
instanceId
This property is required.
Changes to this property will trigger replacement.
Integer
The CloudAMQP instance ID.
queue This property is required. String
A (durable) queue on your RabbitMQ instance.
vhost This property is required. String
The vhost the queue resides in.
webhookUri This property is required. String
A POST request will be made for each message in the queue to this endpoint.
sleep Integer
Configurable sleep time in seconds between retries for webhook
timeout Integer
Configurable timeout time in seconds for webhook
concurrency This property is required. number
Max simultaneous requests to the endpoint.
instanceId
This property is required.
Changes to this property will trigger replacement.
number
The CloudAMQP instance ID.
queue This property is required. string
A (durable) queue on your RabbitMQ instance.
vhost This property is required. string
The vhost the queue resides in.
webhookUri This property is required. string
A POST request will be made for each message in the queue to this endpoint.
sleep number
Configurable sleep time in seconds between retries for webhook
timeout number
Configurable timeout time in seconds for webhook
concurrency This property is required. int
Max simultaneous requests to the endpoint.
instance_id
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
queue This property is required. str
A (durable) queue on your RabbitMQ instance.
vhost This property is required. str
The vhost the queue resides in.
webhook_uri This property is required. str
A POST request will be made for each message in the queue to this endpoint.
sleep int
Configurable sleep time in seconds between retries for webhook
timeout int
Configurable timeout time in seconds for webhook
concurrency This property is required. Number
Max simultaneous requests to the endpoint.
instanceId
This property is required.
Changes to this property will trigger replacement.
Number
The CloudAMQP instance ID.
queue This property is required. String
A (durable) queue on your RabbitMQ instance.
vhost This property is required. String
The vhost the queue resides in.
webhookUri This property is required. String
A POST request will be made for each message in the queue to this endpoint.
sleep Number
Configurable sleep time in seconds between retries for webhook
timeout Number
Configurable timeout time in seconds for webhook

Outputs

All input properties are implicitly available as output properties. Additionally, the Webhook 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 Existing Webhook Resource

Get an existing Webhook 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?: WebhookState, opts?: CustomResourceOptions): Webhook
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        concurrency: Optional[int] = None,
        instance_id: Optional[int] = None,
        queue: Optional[str] = None,
        sleep: Optional[int] = None,
        timeout: Optional[int] = None,
        vhost: Optional[str] = None,
        webhook_uri: Optional[str] = None) -> Webhook
func GetWebhook(ctx *Context, name string, id IDInput, state *WebhookState, opts ...ResourceOption) (*Webhook, error)
public static Webhook Get(string name, Input<string> id, WebhookState? state, CustomResourceOptions? opts = null)
public static Webhook get(String name, Output<String> id, WebhookState state, CustomResourceOptions options)
resources:  _:    type: cloudamqp:Webhook    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Concurrency int
Max simultaneous requests to the endpoint.
InstanceId Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
Queue string
A (durable) queue on your RabbitMQ instance.
Sleep int
Configurable sleep time in seconds between retries for webhook
Timeout int
Configurable timeout time in seconds for webhook
Vhost string
The vhost the queue resides in.
WebhookUri string
A POST request will be made for each message in the queue to this endpoint.
Concurrency int
Max simultaneous requests to the endpoint.
InstanceId Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
Queue string
A (durable) queue on your RabbitMQ instance.
Sleep int
Configurable sleep time in seconds between retries for webhook
Timeout int
Configurable timeout time in seconds for webhook
Vhost string
The vhost the queue resides in.
WebhookUri string
A POST request will be made for each message in the queue to this endpoint.
concurrency Integer
Max simultaneous requests to the endpoint.
instanceId Changes to this property will trigger replacement. Integer
The CloudAMQP instance ID.
queue String
A (durable) queue on your RabbitMQ instance.
sleep Integer
Configurable sleep time in seconds between retries for webhook
timeout Integer
Configurable timeout time in seconds for webhook
vhost String
The vhost the queue resides in.
webhookUri String
A POST request will be made for each message in the queue to this endpoint.
concurrency number
Max simultaneous requests to the endpoint.
instanceId Changes to this property will trigger replacement. number
The CloudAMQP instance ID.
queue string
A (durable) queue on your RabbitMQ instance.
sleep number
Configurable sleep time in seconds between retries for webhook
timeout number
Configurable timeout time in seconds for webhook
vhost string
The vhost the queue resides in.
webhookUri string
A POST request will be made for each message in the queue to this endpoint.
concurrency int
Max simultaneous requests to the endpoint.
instance_id Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
queue str
A (durable) queue on your RabbitMQ instance.
sleep int
Configurable sleep time in seconds between retries for webhook
timeout int
Configurable timeout time in seconds for webhook
vhost str
The vhost the queue resides in.
webhook_uri str
A POST request will be made for each message in the queue to this endpoint.
concurrency Number
Max simultaneous requests to the endpoint.
instanceId Changes to this property will trigger replacement. Number
The CloudAMQP instance ID.
queue String
A (durable) queue on your RabbitMQ instance.
sleep Number
Configurable sleep time in seconds between retries for webhook
timeout Number
Configurable timeout time in seconds for webhook
vhost String
The vhost the queue resides in.
webhookUri String
A POST request will be made for each message in the queue to this endpoint.

Package Details

Repository
CloudAMQP pulumi/pulumi-cloudamqp
License
Apache-2.0
Notes
This Pulumi package is based on the cloudamqp Terraform Provider.