Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. Plugin
CloudAMQP v3.20.2 published on Tuesday, Oct 29, 2024 by Pulumi
pulumi/pulumi-cloudamqp

cloudamqp.Plugin

Explore with Pulumi AI

cloudamqp logo
CloudAMQP v3.20.2 published on Tuesday, Oct 29, 2024 by Pulumi
pulumi/pulumi-cloudamqp

    Import

    cloudamqp_plugin can be imported using the name argument of the resource together with CloudAMQP instance identifier. The name and identifier are CSV separated, see example below.

    $ pulumi import cloudamqp:index/plugin:Plugin rabbitmq_management rabbitmq_management,<instance_id>`

    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 string
    The unique name of the resource.
    args PluginArgs
    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 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 string
    The unique name of the resource.
    args PluginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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,
});

    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),
})

    var pluginResource = new Plugin("pluginResource", PluginArgs.builder()
    .enabled(false)
    .instanceId(0)
    .name("string")
    .sleep(0)
    .timeout(0)
    .build());

    plugin_resource = cloudamqp.Plugin("pluginResource",
    enabled=False,
    instance_id=0,
    name="string",
    sleep=0,
    timeout=0)

    const pluginResource = new cloudamqp.Plugin("pluginResource", {
    enabled: false,
    instanceId: 0,
    name: "string",
    sleep: 0,
    timeout: 0,
});

    type: cloudamqp:Plugin
properties:
    enabled: false
    instanceId: 0
    name: string
    sleep: 0
    timeout: 0

    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 bool
    Enable or disable the plugins.
    InstanceId 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. Available from v1.29.0
    Timeout int
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. Available from v1.29.0
    Enabled bool
    Enable or disable the plugins.
    InstanceId 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. Available from v1.29.0
    Timeout int
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. Available from v1.29.0
    enabled Boolean
    Enable or disable the plugins.
    instanceId 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. Available from v1.29.0
    timeout Integer
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. Available from v1.29.0
    enabled boolean
    Enable or disable the plugins.
    instanceId 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. Available from v1.29.0
    timeout number
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. Available from v1.29.0
    enabled bool
    Enable or disable the plugins.
    instance_id 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. Available from v1.29.0
    timeout int
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. Available from v1.29.0
    enabled Boolean
    Enable or disable the plugins.
    instanceId 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. Available from v1.29.0
    timeout Number
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. 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)
    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:
    Description string
    The description of the plugin.
    Enabled bool
    Enable or disable the plugins.
    InstanceId 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. Available from v1.29.0
    Timeout int
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. 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 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. Available from v1.29.0
    Timeout int
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. 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 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. Available from v1.29.0
    timeout Integer
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. 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 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. Available from v1.29.0
    timeout number
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. 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 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. Available from v1.29.0
    timeout int
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. 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 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. Available from v1.29.0
    timeout Number
    Configurable timeout time (seconds) for retries when requesting information about plugins. Default set to 1800 seconds. 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 logo
    CloudAMQP v3.20.2 published on Tuesday, Oct 29, 2024 by Pulumi
    pulumi/pulumi-cloudamqp