Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. Plugin
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp

cloudamqp.Plugin

Explore with Pulumi AI

CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp

Import

cloudamqp_plugin can be imported using the name argument of the resource together with CloudAMQP

instance identifier (CSV separated). To retrieve list of available community plugins, use

[CloudAMQP API list plugins].

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

hcl

import {

to = cloudamqp_plugin.<resource_name>

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

}

Or use Terraform CLI:

$ pulumi import cloudamqp:index/plugin:Plugin <resource_name> <plugin_name>,<instance_id>`
Copy

Create Plugin Resource

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

Constructor syntax

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

@overload
def Plugin(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           enabled: Optional[bool] = None,
           instance_id: Optional[int] = None,
           name: Optional[str] = None,
           sleep: Optional[int] = None,
           timeout: Optional[int] = None)
func NewPlugin(ctx *Context, name string, args PluginArgs, opts ...ResourceOption) (*Plugin, error)
public Plugin(string name, PluginArgs args, CustomResourceOptions? opts = null)
public Plugin(String name, PluginArgs args)
public Plugin(String name, PluginArgs args, CustomResourceOptions options)

type: cloudamqp:Plugin
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. PluginArgs
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. PluginArgs
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. PluginArgs
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. PluginArgs
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. PluginArgs
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 pluginResource = new CloudAmqp.Plugin("pluginResource", new()
{
    Enabled = false,
    InstanceId = 0,
    Name = "string",
    Sleep = 0,
    Timeout = 0,
});
Copy
example, err := cloudamqp.NewPlugin(ctx, "pluginResource", &cloudamqp.PluginArgs{
	Enabled:    pulumi.Bool(false),
	InstanceId: pulumi.Int(0),
	Name:       pulumi.String("string"),
	Sleep:      pulumi.Int(0),
	Timeout:    pulumi.Int(0),
})
Copy
var pluginResource = new Plugin("pluginResource", PluginArgs.builder()
    .enabled(false)
    .instanceId(0)
    .name("string")
    .sleep(0)
    .timeout(0)
    .build());
Copy
plugin_resource = cloudamqp.Plugin("pluginResource",
    enabled=False,
    instance_id=0,
    name="string",
    sleep=0,
    timeout=0)
Copy
const pluginResource = new cloudamqp.Plugin("pluginResource", {
    enabled: false,
    instanceId: 0,
    name: "string",
    sleep: 0,
    timeout: 0,
});
Copy
type: cloudamqp:Plugin
properties:
    enabled: false
    instanceId: 0
    name: string
    sleep: 0
    timeout: 0
Copy

Plugin 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 Plugin resource accepts the following input properties:

Enabled This property is required. bool
Enable or disable the plugins.
InstanceId
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
Name string
The name of the Rabbit MQ plugin.
Sleep int

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

Timeout int

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Enabled This property is required. bool
Enable or disable the plugins.
InstanceId
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
Name string
The name of the Rabbit MQ plugin.
Sleep int

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

Timeout int

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

enabled This property is required. Boolean
Enable or disable the plugins.
instanceId
This property is required.
Changes to this property will trigger replacement.
Integer
The CloudAMQP instance ID.
name String
The name of the Rabbit MQ plugin.
sleep Integer

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout Integer

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

enabled This property is required. boolean
Enable or disable the plugins.
instanceId
This property is required.
Changes to this property will trigger replacement.
number
The CloudAMQP instance ID.
name string
The name of the Rabbit MQ plugin.
sleep number

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout number

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

enabled This property is required. bool
Enable or disable the plugins.
instance_id
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance ID.
name str
The name of the Rabbit MQ plugin.
sleep int

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout int

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

enabled This property is required. Boolean
Enable or disable the plugins.
instanceId
This property is required.
Changes to this property will trigger replacement.
Number
The CloudAMQP instance ID.
name String
The name of the Rabbit MQ plugin.
sleep Number

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout Number

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Outputs

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

Description string
The description of the plugin.
Id string
The provider-assigned unique ID for this managed resource.
Version string
The version of the plugin.
Description string
The description of the plugin.
Id string
The provider-assigned unique ID for this managed resource.
Version string
The version of the plugin.
description String
The description of the plugin.
id String
The provider-assigned unique ID for this managed resource.
version String
The version of the plugin.
description string
The description of the plugin.
id string
The provider-assigned unique ID for this managed resource.
version string
The version of the plugin.
description str
The description of the plugin.
id str
The provider-assigned unique ID for this managed resource.
version str
The version of the plugin.
description String
The description of the plugin.
id String
The provider-assigned unique ID for this managed resource.
version String
The version of the plugin.

Look up Existing Plugin Resource

Get an existing Plugin 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?: PluginState, opts?: CustomResourceOptions): Plugin
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        instance_id: Optional[int] = None,
        name: Optional[str] = None,
        sleep: Optional[int] = None,
        timeout: Optional[int] = None,
        version: Optional[str] = None) -> Plugin
func GetPlugin(ctx *Context, name string, id IDInput, state *PluginState, opts ...ResourceOption) (*Plugin, error)
public static Plugin Get(string name, Input<string> id, PluginState? state, CustomResourceOptions? opts = null)
public static Plugin get(String name, Output<String> id, PluginState state, CustomResourceOptions options)
resources:  _:    type: cloudamqp:Plugin    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:
Description string
The description of the plugin.
Enabled bool
Enable or disable the plugins.
InstanceId Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
Name string
The name of the Rabbit MQ plugin.
Sleep int

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

Timeout int

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Version string
The version of the plugin.
Description string
The description of the plugin.
Enabled bool
Enable or disable the plugins.
InstanceId Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
Name string
The name of the Rabbit MQ plugin.
Sleep int

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

Timeout int

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Version string
The version of the plugin.
description String
The description of the plugin.
enabled Boolean
Enable or disable the plugins.
instanceId Changes to this property will trigger replacement. Integer
The CloudAMQP instance ID.
name String
The name of the Rabbit MQ plugin.
sleep Integer

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout Integer

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

version String
The version of the plugin.
description string
The description of the plugin.
enabled boolean
Enable or disable the plugins.
instanceId Changes to this property will trigger replacement. number
The CloudAMQP instance ID.
name string
The name of the Rabbit MQ plugin.
sleep number

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout number

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

version string
The version of the plugin.
description str
The description of the plugin.
enabled bool
Enable or disable the plugins.
instance_id Changes to this property will trigger replacement. int
The CloudAMQP instance ID.
name str
The name of the Rabbit MQ plugin.
sleep int

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout int

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

version str
The version of the plugin.
description String
The description of the plugin.
enabled Boolean
Enable or disable the plugins.
instanceId Changes to this property will trigger replacement. Number
The CloudAMQP instance ID.
name String
The name of the Rabbit MQ plugin.
sleep Number

Configurable sleep time (seconds) for retries when requesting information about plugins. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout Number

Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds.

Note: Available from [v1.29.0]

version String
The version of the plugin.

Package Details

Repository
CloudAMQP pulumi/pulumi-cloudamqp
License
Apache-2.0
Notes
This Pulumi package is based on the cloudamqp Terraform Provider.
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-cloudamqp