schema.json

{
    "name": "command",
    "displayName": "Command",
    "description": "The Pulumi Command Provider enables you to execute commands and scripts either locally or remotely as part of the Pulumi resource model.",
    "keywords": [
        "pulumi",
        "command",
        "category/utility",
        "kind/native"
    ],
    "homepage": "https://pulumi.com",
    "license": "Apache-2.0",
    "repository": "https://github.com/pulumi/pulumi-command",
    "publisher": "Pulumi",
    "logoUrl": "https://raw.githubusercontent.com/pulumi/pulumi-command/master/assets/logo.svg",
    "types": {
        "command:remote:Connection": {
            "type": "object",
            "description": "Instructions for how to connect to a remote endpoint.",
            "properties": {
                "user": {
                    "type": "string",
                    "description": "The user that we should use for the connection.",
                    "default": "root"
                },
                "password": {
                    "type": "string",
                    "description": "The password we should use for the connection."
                },
                "host": {
                    "type": "string",
                    "description": "The address of the resource to connect to."
                },
                "port": {
                    "type": "number",
                    "description": "The port to connect to.",
                    "default": 22
                },
                "privateKey": {
                    "type": "string",
                    "description": "The contents of an SSH key to use for the connection. This takes preference over the password if provided."
                },
                "privateKeyPassword": {
                    "type": "string",
                    "description": "The password to use in case the private key is encrypted."
                },
                "agentSocketPath": {
                    "type": "string",
                    "description": "SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present."
                }
            },
            "required": [
                "host"
            ]
        }
    },
    "resources": {
        "command:local:Command": {
            "description": "A local command to be executed.\nThis command can be inserted into the life cycles of other resources using the\n`dependsOn` or `parent` resource options. A command is considered to have\nfailed when it finished with a non-zero exit code. This will fail the CRUD step\nof the `Command` resource.",
            "properties": {
                "interpreter": {
                    "description": "The program and arguments to run the command.\nFor example: `[\"/bin/sh\", \"-c\"]`",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "dir": {
                    "description": "The directory from which to run the command from. If `dir` does not exist, then\n`Command` will fail.",
                    "type": "string"
                },
                "environment": {
                    "description": "Additional environment variables available to the command's process.",
                    "type": "object",
                    "additionalProperties": {
                        "type": "string"
                    }
                },
                "triggers": {
                    "type": "array",
                    "description": "Trigger replacements on changes to this input.",
                    "items": {
                        "$ref": "pulumi.json#/Any"
                    }
                },
                "create": {
                    "type": "string",
                    "description": "The command to run on create."
                },
                "delete": {
                    "type": "string",
                    "description": "The command to run on delete."
                },
                "update": {
                    "type": "string",
                    "description": "The command to run on update, if empty, create will run again."
                },
                "stdout": {
                    "description": "The standard output of the command's process",
                    "type": "string"
                },
                "stderr": {
                    "description": "The standard error of the command's process",
                    "type": "string"
                },
                "stdin": {
                    "description": "Pass a string to the command's process as standard in",
                    "type": "string"
                },
                "assetPaths": {
                    "description": "A list of path globs to read after the command completes.",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "archivePaths": {
                    "description": "A list of path globs to return as a single archive asset after the command completes.",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "assets": {
                    "description": "A map of assets found after running the command.\nThe key is the relative path from the command dir",
                    "type": "object",
                    "additionalProperties": {
                        "$ref": "pulumi.json#/Asset"
                    }
                },
                "archive": {
                    "description": "An archive asset containing files found after running the command.",
                    "$ref": "pulumi.json#/Archive"
                }
            },
            "required": [
                "stdout",
                "stderr"
            ],
            "inputProperties": {
                "interpreter": {
                    "description": "The program and arguments to run the command.\nOn Linux and macOS, defaults to: `[\"/bin/sh\", \"-c\"]`. On Windows, defaults to: `[\"cmd\", \"/C\"]`",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "dir": {
                    "description": "The working directory in which to run the command from.",
                    "type": "string"
                },
                "environment": {
                    "description": "Additional environment variables available to the command's process.",
                    "type": "object",
                    "additionalProperties": {
                        "type": "string"
                    }
                },
                "triggers": {
                    "type": "array",
                    "items": {
                        "$ref": "pulumi.json#/Any"
                    }
                },
                "create": {
                    "type": "string",
                    "description": "The command to run on create."
                },
                "delete": {
                    "type": "string",
                    "description": "The command to run on delete."
                },
                "update": {
                    "type": "string",
                    "description": "The command to run on update, if empty, create will run again."
                },
                "stdin": {
                    "description": "Pass a string to the command's process as standard in",
                    "type": "string"
                },
                "assetPaths": {
                    "description": "A list of path globs to read after the command completes.\n\nWhen specifying glob patterns the following rules apply:\n- We only include files not directories for assets and archives.\n- Path separators are `/` on all platforms - including Windows.\n- Patterns starting with `!` are 'exclude' rules.\n- Rules are evaluated in order, so exclude rules should be after inclusion rules.\n- `*` matches anything except `/`\n- `**` matches anything, _including_ `/`\n- All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.\n- For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)\n\n#### Example\n\nGiven the rules:\n```yaml\n- \"assets/**\"\n- \"src/**.js\"\n- \"!**secret.*\"\n```\n\nWhen evaluating against this folder:\n\n```yaml\n- assets/\n  - logos/\n    - logo.svg\n- src/\n  - index.js\n  - secret.js\n```\n\nThe following paths will be returned:\n\n```yaml\n- assets/logos/logo.svg\n- src/index.js\n```",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "archivePaths": {
                    "description": "A list of path globs to return as a single archive asset after the command completes.\n\nWhen specifying glob patterns the following rules apply:\n- We only include files not directories for assets and archives.\n- Path separators are `/` on all platforms - including Windows.\n- Patterns starting with `!` are 'exclude' rules.\n- Rules are evaluated in order, so exclude rules should be after inclusion rules.\n- `*` matches anything except `/`\n- `**` matches anything, _including_ `/`\n- All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.\n- For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)\n\n#### Example\n\nGiven the rules:\n```yaml\n- \"assets/**\"\n- \"src/**.js\"\n- \"!**secret.*\"\n```\n\nWhen evaluating against this folder:\n\n```yaml\n- assets/\n  - logos/\n    - logo.svg\n- src/\n  - index.js\n  - secret.js\n```\n\nThe following paths will be returned:\n\n```yaml\n- assets/logos/logo.svg\n- src/index.js\n```",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "requiredInputs": []
        },
        "command:remote:Command": {
            "description": "A command to run on a remote host.\nThe connection is established via ssh.",
            "properties": {
                "connection": {
                    "description": "The parameters with which to connect to the remote host",
                    "secret": true,
                    "$ref": "#/types/command:remote:Connection"
                },
                "environment": {
                    "description": "Additional environment variables available to the command's process.",
                    "type": "object",
                    "additionalProperties": {
                        "type": "string"
                    }
                },
                "triggers": {
                    "description": "Trigger replacements on changes to this input.",
                    "type": "array",
                    "items": {
                        "$ref": "pulumi.json#/Any"
                    }
                },
                "create": {
                    "description": "The command to run on create.",
                    "type": "string"
                },
                "delete": {
                    "description": "The command to run on delete.",
                    "type": "string"
                },
                "update": {
                    "type": "string",
                    "description": "The command to run on update, if empty, create will run again."
                },
                "stdout": {
                    "description": "The standard output of the command's process",
                    "type": "string"
                },
                "stderr": {
                    "description": "The standard error of the command's process",
                    "type": "string"
                },
                "stdin": {
                    "description": "Pass a string to the command's process as standard in",
                    "type": "string"
                }
            },
            "required": [
                "stdout",
                "stderr"
            ],
            "inputProperties": {
                "connection": {
                    "description": "The parameters with which to connect to the remote host.",
                    "secret": true,
                    "$ref": "#/types/command:remote:Connection"
                },
                "environment": {
                    "description": "Additional environment variables available to the command's process.",
                    "type": "object",
                    "additionalProperties": {
                        "type": "string"
                    }
                },
                "triggers": {
                    "description": "Trigger replacements on changes to this input.",
                    "type": "array",
                    "items": {
                        "$ref": "pulumi.json#/Any"
                    }
                },
                "create": {
                    "description": "The command to run on create.",
                    "type": "string"
                },
                "delete": {
                    "description": "The command to run on delete.",
                    "type": "string"
                },
                "update": {
                    "type": "string",
                    "description": "The command to run on update, if empty, create will run again."
                },
                "stdin": {
                    "description": "Pass a string to the command's process as standard in",
                    "type": "string"
                }
            },
            "requiredInputs": [
                "connection"
            ]
        },
        "command:remote:CopyFile": {
            "description": "Copy a local file to a remote host.",
            "inputProperties": {
                "connection": {
                    "description": "The parameters with which to connect to the remote host.",
                    "secret": true,
                    "$ref": "#/types/command:remote:Connection"
                },
                "triggers": {
                    "description": "Trigger replacements on changes to this input.",
                    "type": "array",
                    "items": {
                        "$ref": "pulumi.json#/Any"
                    }
                },
                "localPath": {
                    "description": "The path of the file to be copied.",
                    "type": "string"
                },
                "remotePath": {
                    "description": "The destination path in the remote host.",
                    "type": "string"
                }
            },
            "requiredInputs": [
                "connection",
                "localPath",
                "remotePath"
            ],
            "properties": {
                "connection": {
                    "description": "The parameters with which to connect to the remote host.",
                    "secret": true,
                    "$ref": "#/types/command:remote:Connection"
                },
                "triggers": {
                    "description": "Trigger replacements on changes to this input.",
                    "type": "array",
                    "items": {
                        "$ref": "pulumi.json#/Any"
                    }
                },
                "localPath": {
                    "description": "The path of the file to be copied.",
                    "type": "string"
                },
                "remotePath": {
                    "description": "The destination path in the remote host.",
                    "type": "string"
                }
            },
            "required": [
                "connection",
                "localPath",
                "remotePath"
            ]
        }
    },
    "functions": {
        "command:local:run": {
            "description": "A local command to be executed.\nThis command will always be run on any preview or deployment. Use `local.Command` to avoid duplicating executions.",
            "inputs": {
                "properties": {
                    "interpreter": {
                        "description": "The program and arguments to run the command.\nOn Linux and macOS, defaults to: `[\"/bin/sh\", \"-c\"]`. On Windows, defaults to: `[\"cmd\", \"/C\"]`",
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "dir": {
                        "description": "The working directory in which to run the command from.",
                        "type": "string"
                    },
                    "environment": {
                        "description": "Additional environment variables available to the command's process.",
                        "type": "object",
                        "additionalProperties": {
                            "type": "string"
                        }
                    },
                    "assetPaths": {
                        "description": "A list of path globs to read after the command completes.\n\nWhen specifying glob patterns the following rules apply:\n- We only include files not directories for assets and archives.\n- Path separators are `/` on all platforms - including Windows.\n- Patterns starting with `!` are 'exclude' rules.\n- Rules are evaluated in order, so exclude rules should be after inclusion rules.\n- `*` matches anything except `/`\n- `**` matches anything, _including_ `/`\n- All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.\n- For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)\n\n#### Example\n\nGiven the rules:\n```yaml\n- \"assets/**\"\n- \"src/**.js\"\n- \"!**secret.*\"\n```\n\nWhen evaluating against this folder:\n\n```yaml\n- assets/\n  - logos/\n    - logo.svg\n- src/\n  - index.js\n  - secret.js\n```\n\nThe following paths will be returned:\n\n```yaml\n- assets/logos/logo.svg\n- src/index.js\n```",
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "archivePaths": {
                        "description": "A list of path globs to return as a single archive asset after the command completes.\n\nWhen specifying glob patterns the following rules apply:\n- We only include files not directories for assets and archives.\n- Path separators are `/` on all platforms - including Windows.\n- Patterns starting with `!` are 'exclude' rules.\n- Rules are evaluated in order, so exclude rules should be after inclusion rules.\n- `*` matches anything except `/`\n- `**` matches anything, _including_ `/`\n- All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.\n- For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)\n\n#### Example\n\nGiven the rules:\n```yaml\n- \"assets/**\"\n- \"src/**.js\"\n- \"!**secret.*\"\n```\n\nWhen evaluating against this folder:\n\n```yaml\n- assets/\n  - logos/\n    - logo.svg\n- src/\n  - index.js\n  - secret.js\n```\n\nThe following paths will be returned:\n\n```yaml\n- assets/logos/logo.svg\n- src/index.js\n```",
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "command": {
                        "type": "string",
                        "description": "The command to run."
                    },
                    "stdin": {
                        "description": "Pass a string to the command's process as standard in",
                        "type": "string"
                    }
                },
                "required": ["command"]
            },
            "outputs": {
                "properties": {
                    "interpreter": {
                        "description": "The program and arguments to run the command.\nFor example: `[\"/bin/sh\", \"-c\"]`",
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    },
                    "dir": {
                        "description": "The directory from which the command was run from.",
                        "type": "string"
                    },
                    "environment": {
                        "description": "Additional environment variables available to the command's process.",
                        "type": "object",
                        "additionalProperties": {
                            "type": "string"
                        }
                    },
                    "command": {
                        "type": "string",
                        "description": "The command to run."
                    },
                    "stdout": {
                        "description": "The standard output of the command's process",
                        "type": "string"
                    },
                    "stderr": {
                        "description": "The standard error of the command's process",
                        "type": "string"
                    },
                    "stdin": {
                        "description": "String passed to the command's process as standard in.",
                        "type": "string"
                    },
                    "assets": {
                        "description": "A map of assets found after running the command.\nThe key is the relative path from the command dir",
                        "type": "object",
                        "additionalProperties": {
                            "$ref": "pulumi.json#/Asset"
                        }
                    },
                    "archive": {
                        "description": "An archive asset containing files found after running the command.",
                        "$ref": "pulumi.json#/Archive"
                    }
                },
                "required": ["command", "stdin", "stderr"]
            }
        }
    },
    "language": {
        "java": {
            "buildFiles": "gradle",
            "gradleNexusPublishPluginVersion": "1.1.0",
            "dependencies": {
                "com.pulumi:pulumi": "0.6.0",
                "com.google.code.gson:gson": "2.8.9",
                "com.google.code.findbugs:jsr305": "3.0.2"
            }
        },
        "csharp": {
            "packageReferences": {
                "Pulumi": "3.*"
            }
        },
        "go": {
            "generateResourceContainerTypes": true,
            "importBasePath": "github.com/pulumi/pulumi-command/sdk/go/command"
        },
        "nodejs": {
            "dependencies": {
                "@pulumi/pulumi": "^3.0.0"
            }
        },
        "python": {
            "requires": {
                "pulumi": ">=3.0.0,<4.0.0"
            }
        }
    }
}