Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Plugin

Manages the lifecycle of a Docker plugin.

Schema

Required

  • name (String) Docker Plugin name

Optional

  • alias (String) Docker Plugin alias
  • enable_timeout (Number) HTTP client timeout to enable the plugin
  • enabled (Boolean) If true the plugin is enabled. Defaults to true
  • env (Set of String) The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
  • force_destroy (Boolean) If true, then the plugin is destroyed forcibly
  • force_disable (Boolean) If true, then the plugin is disabled forcibly
  • grant_all_permissions (Boolean) If true, grant all permissions necessary to run the plugin
  • grant_permissions (Block Set) Grant specific permissions only (see below for nested schema)
  • id (String) The ID of this resource.

Read-Only

  • plugin_reference (String) Docker Plugin Reference

Nested Schema for grant_permissions

Required:

  • name (String) The name of the permission
  • value (Set of String) The value of the permission

Example Usage

using Pulumi;
using Docker = Pulumi.Docker;

class MyStack : Stack
{
    public MyStack()
    {
        var sample_volume_plugin = new Docker.Plugin("sample-volume-plugin", new Docker.PluginArgs
        {
            Alias = "sample-volume-plugin",
            EnableTimeout = 60,
            Enabled = false,
            Envs = 
            {
                "DEBUG=1",
            },
            ForceDestroy = true,
            ForceDisable = true,
            GrantAllPermissions = true,
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docker.NewPlugin(ctx, "sample_volume_plugin", &docker.PluginArgs{
			Alias:         pulumi.String("sample-volume-plugin"),
			EnableTimeout: pulumi.Int(60),
			Enabled:       pulumi.Bool(false),
			Envs: pulumi.StringArray{
				pulumi.String("DEBUG=1"),
			},
			ForceDestroy:        pulumi.Bool(true),
			ForceDisable:        pulumi.Bool(true),
			GrantAllPermissions: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_docker as docker

sample_volume_plugin = docker.Plugin("sample-volume-plugin",
    alias="sample-volume-plugin",
    enable_timeout=60,
    enabled=False,
    envs=["DEBUG=1"],
    force_destroy=True,
    force_disable=True,
    grant_all_permissions=True)
import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const sample_volume_plugin = new docker.Plugin("sample-volume-plugin", {
    alias: "sample-volume-plugin",
    enableTimeout: 60,
    enabled: false,
    envs: ["DEBUG=1"],
    forceDestroy: true,
    forceDisable: true,
    grantAllPermissions: true,
});

Create a Plugin Resource

new Plugin(name: string, args?: PluginArgs, opts?: CustomResourceOptions);
@overload
def Plugin(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           alias: Optional[str] = None,
           enable_timeout: Optional[int] = None,
           enabled: Optional[bool] = None,
           envs: Optional[Sequence[str]] = None,
           force_destroy: Optional[bool] = None,
           force_disable: Optional[bool] = None,
           grant_all_permissions: Optional[bool] = None,
           grant_permissions: Optional[Sequence[PluginGrantPermissionArgs]] = None,
           name: Optional[str] = None)
@overload
def Plugin(resource_name: str,
           args: Optional[PluginArgs] = None,
           opts: Optional[ResourceOptions] = None)
func NewPlugin(ctx *Context, name string, args *PluginArgs, opts ...ResourceOption) (*Plugin, error)
public Plugin(string name, PluginArgs? args = null, CustomResourceOptions? opts = null)
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.

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:

Alias string
Docker Plugin alias
EnableTimeout int
HTTP client timeout to enable the plugin
Enabled bool
If true the plugin is enabled. Defaults to true
Envs List<string>
The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
ForceDestroy bool
If true, then the plugin is destroyed forcibly
ForceDisable bool
If true, then the plugin is disabled forcibly
GrantAllPermissions bool
If true, grant all permissions necessary to run the plugin
GrantPermissions List<PluginGrantPermissionArgs>
Grant specific permissions only
Name string
Docker Plugin name
Alias string
Docker Plugin alias
EnableTimeout int
HTTP client timeout to enable the plugin
Enabled bool
If true the plugin is enabled. Defaults to true
Envs []string
The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
ForceDestroy bool
If true, then the plugin is destroyed forcibly
ForceDisable bool
If true, then the plugin is disabled forcibly
GrantAllPermissions bool
If true, grant all permissions necessary to run the plugin
GrantPermissions []PluginGrantPermissionArgs
Grant specific permissions only
Name string
Docker Plugin name
alias string
Docker Plugin alias
enableTimeout number
HTTP client timeout to enable the plugin
enabled boolean
If true the plugin is enabled. Defaults to true
envs string[]
The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
forceDestroy boolean
If true, then the plugin is destroyed forcibly
forceDisable boolean
If true, then the plugin is disabled forcibly
grantAllPermissions boolean
If true, grant all permissions necessary to run the plugin
grantPermissions PluginGrantPermissionArgs[]
Grant specific permissions only
name string
Docker Plugin name
alias str
Docker Plugin alias
enable_timeout int
HTTP client timeout to enable the plugin
enabled bool
If true the plugin is enabled. Defaults to true
envs Sequence[str]
The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
force_destroy bool
If true, then the plugin is destroyed forcibly
force_disable bool
If true, then the plugin is disabled forcibly
grant_all_permissions bool
If true, grant all permissions necessary to run the plugin
grant_permissions Sequence[PluginGrantPermissionArgs]
Grant specific permissions only
name str
Docker Plugin name

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
PluginReference string
Docker Plugin Reference
Id string
The provider-assigned unique ID for this managed resource.
PluginReference string
Docker Plugin Reference
id string
The provider-assigned unique ID for this managed resource.
pluginReference string
Docker Plugin Reference
id str
The provider-assigned unique ID for this managed resource.
plugin_reference str
Docker Plugin Reference

Look up an 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,
        alias: Optional[str] = None,
        enable_timeout: Optional[int] = None,
        enabled: Optional[bool] = None,
        envs: Optional[Sequence[str]] = None,
        force_destroy: Optional[bool] = None,
        force_disable: Optional[bool] = None,
        grant_all_permissions: Optional[bool] = None,
        grant_permissions: Optional[Sequence[PluginGrantPermissionArgs]] = None,
        name: Optional[str] = None,
        plugin_reference: 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)
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.

The following state arguments are supported:

Alias string
Docker Plugin alias
EnableTimeout int
HTTP client timeout to enable the plugin
Enabled bool
If true the plugin is enabled. Defaults to true
Envs List<string>
The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
ForceDestroy bool
If true, then the plugin is destroyed forcibly
ForceDisable bool
If true, then the plugin is disabled forcibly
GrantAllPermissions bool
If true, grant all permissions necessary to run the plugin
GrantPermissions List<PluginGrantPermissionArgs>
Grant specific permissions only
Name string
Docker Plugin name
PluginReference string
Docker Plugin Reference
Alias string
Docker Plugin alias
EnableTimeout int
HTTP client timeout to enable the plugin
Enabled bool
If true the plugin is enabled. Defaults to true
Envs []string
The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
ForceDestroy bool
If true, then the plugin is destroyed forcibly
ForceDisable bool
If true, then the plugin is disabled forcibly
GrantAllPermissions bool
If true, grant all permissions necessary to run the plugin
GrantPermissions []PluginGrantPermissionArgs
Grant specific permissions only
Name string
Docker Plugin name
PluginReference string
Docker Plugin Reference
alias string
Docker Plugin alias
enableTimeout number
HTTP client timeout to enable the plugin
enabled boolean
If true the plugin is enabled. Defaults to true
envs string[]
The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
forceDestroy boolean
If true, then the plugin is destroyed forcibly
forceDisable boolean
If true, then the plugin is disabled forcibly
grantAllPermissions boolean
If true, grant all permissions necessary to run the plugin
grantPermissions PluginGrantPermissionArgs[]
Grant specific permissions only
name string
Docker Plugin name
pluginReference string
Docker Plugin Reference
alias str
Docker Plugin alias
enable_timeout int
HTTP client timeout to enable the plugin
enabled bool
If true the plugin is enabled. Defaults to true
envs Sequence[str]
The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
force_destroy bool
If true, then the plugin is destroyed forcibly
force_disable bool
If true, then the plugin is disabled forcibly
grant_all_permissions bool
If true, grant all permissions necessary to run the plugin
grant_permissions Sequence[PluginGrantPermissionArgs]
Grant specific permissions only
name str
Docker Plugin name
plugin_reference str
Docker Plugin Reference

Supporting Types

PluginGrantPermission

Name string
Values List<string>
Name string
Values []string
name string
values string[]
name str
values Sequence[str]

Import

Import is supported using the following syntax#!/bin/bash

 $ pulumi import docker:index/plugin:Plugin sample-volume-plugin "$(docker plugin inspect -f {{.ID}} tiborvass/sample-volume-plugin:latest)"

Package Details

Repository
https://github.com/pulumi/pulumi-docker
License
Apache-2.0
Notes
This Pulumi package is based on the docker Terraform Provider.