Documentation
¶
Overview ¶
Package rundocument implements the aws:runDocument plugin
Package rundocument implements the aws:runDocument plugin
Package rundocument implements the aws:runDocument plugin
Index ¶
- Constants
- func Name() string
- type ExecDocument
- type ExecDocumentImpl
- func (exec ExecDocumentImpl) ExecuteDocument(config contracts.Configuration, context context.T, ...) (resultChannels chan contracts.DocumentResult, err error)
- func (exec ExecDocumentImpl) ParseDocument(context context.T, documentRaw []byte, orchestrationDir string, ...) (pluginsInfo []contracts.PluginState, err error)
- type ExecMock
- type ExecutePluginDepth
- type Plugin
- type RunDocumentPluginInput
Constants ¶
const ( SSMDocumentType = "SSMDocument" LocalPathType = "LocalPath" FailExitCode = 1 PassExitCode = 0 )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ExecDocument ¶
type ExecDocument interface {
ParseDocument(context context.T, documentRaw []byte, orchestrationDir string,
s3Bucket string, s3KeyPrefix string, messageID string, documentID string, defaultWorkingDirectory string,
params map[string]interface{}) (pluginsInfo []contracts.PluginState, err error)
ExecuteDocument(config contracts.Configuration, context context.T, pluginInput []contracts.PluginState, documentID string,
documentCreatedDate string) (chan contracts.DocumentResult, error)
}
type ExecDocumentImpl ¶
func (ExecDocumentImpl) ExecuteDocument ¶
func (exec ExecDocumentImpl) ExecuteDocument(config contracts.Configuration, context context.T, pluginInput []contracts.PluginState, documentID string, documentCreatedDate string) (resultChannels chan contracts.DocumentResult, err error)
ExecuteDocument is responsible to execute the sub-documents that are created or downloaded by the executeCommand plugin
func (ExecDocumentImpl) ParseDocument ¶
func (exec ExecDocumentImpl) ParseDocument(context context.T, documentRaw []byte, orchestrationDir string, s3Bucket string, s3KeyPrefix string, messageID string, documentID string, defaultWorkingDirectory string, params map[string]interface{}) (pluginsInfo []contracts.PluginState, err error)
ParseDocument parses the remote document obtained to a format that the executor can use. This function is also responsible for all the validation of document and replacement of parameters
type ExecMock ¶
func NewExecMock ¶
func NewExecMock() ExecMock
func (ExecMock) ExecuteDocument ¶
func (e ExecMock) ExecuteDocument(config contracts.Configuration, context context.T, pluginInput []contracts.PluginState, documentID string, documentCreatedDate string) (chan contracts.DocumentResult, error)
func (ExecMock) ParseDocument ¶
type ExecutePluginDepth ¶
type ExecutePluginDepth struct {
// contains filtered or unexported fields
}
ExecutePluginDepth is the struct that is sent through to the sub-documents to maintain the depth of execution
type Plugin ¶
type Plugin struct {
// contains filtered or unexported fields
}
Plugin is the type for the aws:copyContent plugin.
func (*Plugin) Execute ¶
func (p *Plugin) Execute(config contracts.Configuration, cancelFlag task.CancelFlag, output iohandler.IOHandler)
Execute runs multiple sets of commands and returns their outputs. res.Output will contain a slice of RunCommandPluginOutput.
type RunDocumentPluginInput ¶
type RunDocumentPluginInput struct {
contracts.PluginInput
DocumentType string `json:"documentType"`
DocumentPath string `json:"documentPath"`
DocumentParameters interface{} `json:"documentParameters"`
}
RunDocumentPluginInput is a struct that holds the parameters sent through send command
Source Files