1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. Plugin
CloudAMQP v3.20.0 published on Thursday, Sep 5, 2024 by Pulumi

cloudamqp.Plugin

Explore with Pulumi AI

cloudamqp logo
CloudAMQP v3.20.0 published on Thursday, Sep 5, 2024 by Pulumi

    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

    The Plugin resource accepts the following input properties:

    Enabled bool
    If the plugin is enabled
    InstanceId int
    Instance identifier
    Name string
    The name of the plugin
    Sleep int
    Configurable sleep time in seconds between retries for plugins
    Timeout int
    Configurable timeout time in seconds for plugins
    Enabled bool
    If the plugin is enabled
    InstanceId int
    Instance identifier
    Name string
    The name of the plugin
    Sleep int
    Configurable sleep time in seconds between retries for plugins
    Timeout int
    Configurable timeout time in seconds for plugins
    enabled Boolean
    If the plugin is enabled
    instanceId Integer
    Instance identifier
    name String
    The name of the plugin
    sleep Integer
    Configurable sleep time in seconds between retries for plugins
    timeout Integer
    Configurable timeout time in seconds for plugins
    enabled boolean
    If the plugin is enabled
    instanceId number
    Instance identifier
    name string
    The name of the plugin
    sleep number
    Configurable sleep time in seconds between retries for plugins
    timeout number
    Configurable timeout time in seconds for plugins
    enabled bool
    If the plugin is enabled
    instance_id int
    Instance identifier
    name str
    The name of the plugin
    sleep int
    Configurable sleep time in seconds between retries for plugins
    timeout int
    Configurable timeout time in seconds for plugins
    enabled Boolean
    If the plugin is enabled
    instanceId Number
    Instance identifier
    name String
    The name of the plugin
    sleep Number
    Configurable sleep time in seconds between retries for plugins
    timeout Number
    Configurable timeout time in seconds for plugins

    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
    If the plugin is enabled
    InstanceId int
    Instance identifier
    Name string
    The name of the plugin
    Sleep int
    Configurable sleep time in seconds between retries for plugins
    Timeout int
    Configurable timeout time in seconds for plugins
    Version string
    The version of the plugin.
    Description string
    The description of the plugin.
    Enabled bool
    If the plugin is enabled
    InstanceId int
    Instance identifier
    Name string
    The name of the plugin
    Sleep int
    Configurable sleep time in seconds between retries for plugins
    Timeout int
    Configurable timeout time in seconds for plugins
    Version string
    The version of the plugin.
    description String
    The description of the plugin.
    enabled Boolean
    If the plugin is enabled
    instanceId Integer
    Instance identifier
    name String
    The name of the plugin
    sleep Integer
    Configurable sleep time in seconds between retries for plugins
    timeout Integer
    Configurable timeout time in seconds for plugins
    version String
    The version of the plugin.
    description string
    The description of the plugin.
    enabled boolean
    If the plugin is enabled
    instanceId number
    Instance identifier
    name string
    The name of the plugin
    sleep number
    Configurable sleep time in seconds between retries for plugins
    timeout number
    Configurable timeout time in seconds for plugins
    version string
    The version of the plugin.
    description str
    The description of the plugin.
    enabled bool
    If the plugin is enabled
    instance_id int
    Instance identifier
    name str
    The name of the plugin
    sleep int
    Configurable sleep time in seconds between retries for plugins
    timeout int
    Configurable timeout time in seconds for plugins
    version str
    The version of the plugin.
    description String
    The description of the plugin.
    enabled Boolean
    If the plugin is enabled
    instanceId Number
    Instance identifier
    name String
    The name of the plugin
    sleep Number
    Configurable sleep time in seconds between retries for plugins
    timeout Number
    Configurable timeout time in seconds for plugins
    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.0 published on Thursday, Sep 5, 2024 by Pulumi