Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Plugin

Manages the lifecycle of a Docker plugin.

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
        {
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := docker.NewPlugin(ctx, "sample_volume_plugin", nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_docker as docker

sample_volume_plugin = docker.Plugin("sample-volume-plugin")
import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const sample_volume_plugin = new docker.Plugin("sample-volume-plugin", {});

Create a Plugin Resource

new Plugin(name: string, args?: PluginArgs, opts?: CustomResourceOptions);
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)
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.
opts ResourceOptions
A bag of options that control this 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 Programming Model docs.

Inputs

The Plugin resource accepts the following input properties:

Alias string

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

EnableTimeout int

HTTP client timeout to enable the plugin.

Enabled bool

If true, the plugin is enabled. The default value is true.

Envs List<string>

. The environment variables.

ForceDestroy bool

If true, the plugin is removed forcibly when the plugin is removed.

ForceDisable bool

If true, then the plugin is disabled forcibly when the plugin is disabled.

GrantAllPermissions bool

If true, grant all permissions necessary to run the plugin. This attribute conflicts with grant_permissions.

GrantPermissions List<PluginGrantPermissionArgs>

grant permissions necessary to run the plugin. This attribute conflicts with grant_all_permissions. See grant_permissions below for details.

Name string

Docker Plugin name

Alias string

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

EnableTimeout int

HTTP client timeout to enable the plugin.

Enabled bool

If true, the plugin is enabled. The default value is true.

Envs []string

. The environment variables.

ForceDestroy bool

If true, the plugin is removed forcibly when the plugin is removed.

ForceDisable bool

If true, then the plugin is disabled forcibly when the plugin is disabled.

GrantAllPermissions bool

If true, grant all permissions necessary to run the plugin. This attribute conflicts with grant_permissions.

GrantPermissions []PluginGrantPermission

grant permissions necessary to run the plugin. This attribute conflicts with grant_all_permissions. See grant_permissions below for details.

Name string

Docker Plugin name

alias string

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

enableTimeout number

HTTP client timeout to enable the plugin.

enabled boolean

If true, the plugin is enabled. The default value is true.

envs string[]

. The environment variables.

forceDestroy boolean

If true, the plugin is removed forcibly when the plugin is removed.

forceDisable boolean

If true, then the plugin is disabled forcibly when the plugin is disabled.

grantAllPermissions boolean

If true, grant all permissions necessary to run the plugin. This attribute conflicts with grant_permissions.

grantPermissions PluginGrantPermission[]

grant permissions necessary to run the plugin. This attribute conflicts with grant_all_permissions. See grant_permissions below for details.

name string

Docker Plugin name

alias str

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

enable_timeout int

HTTP client timeout to enable the plugin.

enabled bool

If true, the plugin is enabled. The default value is true.

envs Sequence[str]

. The environment variables.

force_destroy bool

If true, the plugin is removed forcibly when the plugin is removed.

force_disable bool

If true, then the plugin is disabled forcibly when the plugin is disabled.

grant_all_permissions bool

If true, grant all permissions necessary to run the plugin. This attribute conflicts with grant_permissions.

grant_permissions Sequence[PluginGrantPermissionArgs]

grant permissions necessary to run the plugin. This attribute conflicts with grant_all_permissions. See grant_permissions below for details.

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

(string) The plugin reference.

Id string
The provider-assigned unique ID for this managed resource.
PluginReference string

(string) The plugin reference.

id string
The provider-assigned unique ID for this managed resource.
pluginReference string

(string) The plugin reference.

id str
The provider-assigned unique ID for this managed resource.
plugin_reference str

(string) The 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

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

EnableTimeout int

HTTP client timeout to enable the plugin.

Enabled bool

If true, the plugin is enabled. The default value is true.

Envs List<string>

. The environment variables.

ForceDestroy bool

If true, the plugin is removed forcibly when the plugin is removed.

ForceDisable bool

If true, then the plugin is disabled forcibly when the plugin is disabled.

GrantAllPermissions bool

If true, grant all permissions necessary to run the plugin. This attribute conflicts with grant_permissions.

GrantPermissions List<PluginGrantPermissionArgs>

grant permissions necessary to run the plugin. This attribute conflicts with grant_all_permissions. See grant_permissions below for details.

Name string

Docker Plugin name

PluginReference string

(string) The plugin reference.

Alias string

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

EnableTimeout int

HTTP client timeout to enable the plugin.

Enabled bool

If true, the plugin is enabled. The default value is true.

Envs []string

. The environment variables.

ForceDestroy bool

If true, the plugin is removed forcibly when the plugin is removed.

ForceDisable bool

If true, then the plugin is disabled forcibly when the plugin is disabled.

GrantAllPermissions bool

If true, grant all permissions necessary to run the plugin. This attribute conflicts with grant_permissions.

GrantPermissions []PluginGrantPermission

grant permissions necessary to run the plugin. This attribute conflicts with grant_all_permissions. See grant_permissions below for details.

Name string

Docker Plugin name

PluginReference string

(string) The plugin reference.

alias string

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

enableTimeout number

HTTP client timeout to enable the plugin.

enabled boolean

If true, the plugin is enabled. The default value is true.

envs string[]

. The environment variables.

forceDestroy boolean

If true, the plugin is removed forcibly when the plugin is removed.

forceDisable boolean

If true, then the plugin is disabled forcibly when the plugin is disabled.

grantAllPermissions boolean

If true, grant all permissions necessary to run the plugin. This attribute conflicts with grant_permissions.

grantPermissions PluginGrantPermission[]

grant permissions necessary to run the plugin. This attribute conflicts with grant_all_permissions. See grant_permissions below for details.

name string

Docker Plugin name

pluginReference string

(string) The plugin reference.

alias str

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

enable_timeout int

HTTP client timeout to enable the plugin.

enabled bool

If true, the plugin is enabled. The default value is true.

envs Sequence[str]

. The environment variables.

force_destroy bool

If true, the plugin is removed forcibly when the plugin is removed.

force_disable bool

If true, then the plugin is disabled forcibly when the plugin is disabled.

grant_all_permissions bool

If true, grant all permissions necessary to run the plugin. This attribute conflicts with grant_permissions.

grant_permissions Sequence[PluginGrantPermissionArgs]

grant permissions necessary to run the plugin. This attribute conflicts with grant_all_permissions. See grant_permissions below for details.

name str

Docker Plugin name

plugin_reference str

(string) The plugin reference.

Supporting Types

PluginGrantPermission

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

Import

Docker plugins can be imported using the long id, e.g. for a plugin tiborvass/sample-volume-plugin:latest

 $ 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.