@pulumi/docker
Version:
A Pulumi package for interacting with Docker in Pulumi programs
101 lines (100 loc) • 2.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Reads the local Docker plugin. The plugin must be installed locally.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as docker from "@pulumi/docker";
*
* //## With alias
* const byAlias = docker.getPlugin({
* alias: "sample-volume-plugin:latest",
* });
* //## With ID
* const byId = docker.getPlugin({
* id: "e9a9db917b3bfd6706b5d3a66d4bceb9f",
* });
* ```
*/
export declare function getPlugin(args?: GetPluginArgs, opts?: pulumi.InvokeOptions): Promise<GetPluginResult>;
/**
* A collection of arguments for invoking getPlugin.
*/
export interface GetPluginArgs {
/**
* The alias of the Docker plugin. If the tag is omitted, `:latest` is complemented to the attribute value.
*/
alias?: string;
/**
* The ID of the plugin, which has precedence over the `alias` of both are given
*/
id?: string;
}
/**
* A collection of values returned by getPlugin.
*/
export interface GetPluginResult {
/**
* The alias of the Docker plugin. If the tag is omitted, `:latest` is complemented to the attribute value.
*/
readonly alias?: string;
/**
* If `true` the plugin is enabled
*/
readonly enabled: boolean;
/**
* The environment variables in the form of `KEY=VALUE`, e.g. `DEBUG=0`
*/
readonly envs: string[];
/**
* If true, grant all permissions necessary to run the plugin
*/
readonly grantAllPermissions: boolean;
/**
* The ID of the plugin, which has precedence over the `alias` of both are given
*/
readonly id?: string;
/**
* The plugin name. If the tag is omitted, `:latest` is complemented to the attribute value.
*/
readonly name: string;
/**
* The Docker Plugin Reference
*/
readonly pluginReference: string;
}
/**
* Reads the local Docker plugin. The plugin must be installed locally.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as docker from "@pulumi/docker";
*
* //## With alias
* const byAlias = docker.getPlugin({
* alias: "sample-volume-plugin:latest",
* });
* //## With ID
* const byId = docker.getPlugin({
* id: "e9a9db917b3bfd6706b5d3a66d4bceb9f",
* });
* ```
*/
export declare function getPluginOutput(args?: GetPluginOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPluginResult>;
/**
* A collection of arguments for invoking getPlugin.
*/
export interface GetPluginOutputArgs {
/**
* The alias of the Docker plugin. If the tag is omitted, `:latest` is complemented to the attribute value.
*/
alias?: pulumi.Input<string>;
/**
* The ID of the plugin, which has precedence over the `alias` of both are given
*/
id?: pulumi.Input<string>;
}