docker.Plugin
Explore with Pulumi AI
Manages the lifecycle of a Docker plugin.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Docker = Pulumi.Docker;
return await Deployment.RunAsync(() =>
{
var sample_volume_plugin = new Docker.Plugin("sample-volume-plugin", new()
{
Alias = "sample-volume-plugin",
EnableTimeout = 60,
Enabled = false,
Envs = new[]
{
"DEBUG=1",
},
ForceDestroy = true,
ForceDisable = true,
GrantAllPermissions = true,
});
});
package main
import (
"github.com/pulumi/pulumi-docker/sdk/v4/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
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.Plugin;
import com.pulumi.docker.PluginArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var sample_volume_plugin = new Plugin("sample-volume-plugin", PluginArgs.builder()
.alias("sample-volume-plugin")
.enableTimeout(60)
.enabled(false)
.envs("DEBUG=1")
.forceDestroy(true)
.forceDisable(true)
.grantAllPermissions(true)
.build());
}
}
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,
});
resources:
sample-volume-plugin:
type: docker:Plugin
properties:
alias: sample-volume-plugin
enableTimeout: 60
enabled: false
envs:
- DEBUG=1
forceDestroy: true
forceDisable: true
grantAllPermissions: true
Create 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)
public Plugin(String name, PluginArgs args)
public Plugin(String name, PluginArgs args, CustomResourceOptions options)
type: docker:Plugin
properties: # The arguments to resource properties.
options: # 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.
- 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.
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
- Enable
Timeout int HTTP client timeout to enable the plugin
- Enabled bool
If
true
the plugin is enabled. Defaults totrue
- Envs List<string>
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 boolPermissions If true, grant all permissions necessary to run the plugin
- Grant
Permissions List<PluginGrant Permission> Grant specific permissions only
- Name string
Docker Plugin name
- Alias string
Docker Plugin alias
- Enable
Timeout int HTTP client timeout to enable the plugin
- Enabled bool
If
true
the plugin is enabled. Defaults totrue
- Envs []string
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 boolPermissions If true, grant all permissions necessary to run the plugin
- Grant
Permissions []PluginGrant Permission Args Grant specific permissions only
- Name string
Docker Plugin name
- alias String
Docker Plugin alias
- enable
Timeout Integer HTTP client timeout to enable the plugin
- enabled Boolean
If
true
the plugin is enabled. Defaults totrue
- envs List<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 BooleanPermissions If true, grant all permissions necessary to run the plugin
- grant
Permissions List<PluginGrant Permission> Grant specific permissions only
- name String
Docker Plugin name
- alias string
Docker Plugin alias
- enable
Timeout number HTTP client timeout to enable the plugin
- enabled boolean
If
true
the plugin is enabled. Defaults totrue
- envs 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 booleanPermissions If true, grant all permissions necessary to run the plugin
- grant
Permissions PluginGrant Permission[] 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 totrue
- 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_ boolpermissions If true, grant all permissions necessary to run the plugin
- grant_
permissions Sequence[PluginGrant Permission Args] Grant specific permissions only
- name str
Docker Plugin name
- alias String
Docker Plugin alias
- enable
Timeout Number HTTP client timeout to enable the plugin
- enabled Boolean
If
true
the plugin is enabled. Defaults totrue
- envs List<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 BooleanPermissions If true, grant all permissions necessary to run the plugin
- grant
Permissions List<Property Map> Grant specific permissions only
- name String
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.
- Plugin
Reference string Docker Plugin Reference
- Id string
The provider-assigned unique ID for this managed resource.
- Plugin
Reference string Docker Plugin Reference
- id String
The provider-assigned unique ID for this managed resource.
- plugin
Reference String Docker Plugin Reference
- id string
The provider-assigned unique ID for this managed resource.
- plugin
Reference string Docker Plugin Reference
- id str
The provider-assigned unique ID for this managed resource.
- plugin_
reference str Docker Plugin Reference
- id String
The provider-assigned unique ID for this managed resource.
- plugin
Reference String Docker Plugin Reference
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,
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)
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.
- Alias string
Docker Plugin alias
- Enable
Timeout int HTTP client timeout to enable the plugin
- Enabled bool
If
true
the plugin is enabled. Defaults totrue
- Envs List<string>
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 boolPermissions If true, grant all permissions necessary to run the plugin
- Grant
Permissions List<PluginGrant Permission> Grant specific permissions only
- Name string
Docker Plugin name
- Plugin
Reference string Docker Plugin Reference
- Alias string
Docker Plugin alias
- Enable
Timeout int HTTP client timeout to enable the plugin
- Enabled bool
If
true
the plugin is enabled. Defaults totrue
- Envs []string
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 boolPermissions If true, grant all permissions necessary to run the plugin
- Grant
Permissions []PluginGrant Permission Args Grant specific permissions only
- Name string
Docker Plugin name
- Plugin
Reference string Docker Plugin Reference
- alias String
Docker Plugin alias
- enable
Timeout Integer HTTP client timeout to enable the plugin
- enabled Boolean
If
true
the plugin is enabled. Defaults totrue
- envs List<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 BooleanPermissions If true, grant all permissions necessary to run the plugin
- grant
Permissions List<PluginGrant Permission> Grant specific permissions only
- name String
Docker Plugin name
- plugin
Reference String Docker Plugin Reference
- alias string
Docker Plugin alias
- enable
Timeout number HTTP client timeout to enable the plugin
- enabled boolean
If
true
the plugin is enabled. Defaults totrue
- envs 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 booleanPermissions If true, grant all permissions necessary to run the plugin
- grant
Permissions PluginGrant Permission[] Grant specific permissions only
- name string
Docker Plugin name
- plugin
Reference 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 totrue
- 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_ boolpermissions If true, grant all permissions necessary to run the plugin
- grant_
permissions Sequence[PluginGrant Permission Args] Grant specific permissions only
- name str
Docker Plugin name
- plugin_
reference str Docker Plugin Reference
- alias String
Docker Plugin alias
- enable
Timeout Number HTTP client timeout to enable the plugin
- enabled Boolean
If
true
the plugin is enabled. Defaults totrue
- envs List<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 BooleanPermissions If true, grant all permissions necessary to run the plugin
- grant
Permissions List<Property Map> Grant specific permissions only
- name String
Docker Plugin name
- plugin
Reference String Docker Plugin Reference
Supporting Types
PluginGrantPermission, PluginGrantPermissionArgs
Import
#!/bin/bash
$ pulumi import docker:index/plugin:Plugin sample-volume-plugin "$(docker plugin inspect -f {{.ID}} tiborvass/sample-volume-plugin:latest)"
Package Details
- Repository
- Docker pulumi/pulumi-docker
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
docker
Terraform Provider.