runcommand

Documentation

Overview

Package runcommand implements runcommand core processing module

Package runcommand implements runcommand core processing module

Package runcommand implements runcommand core processing module

Package runcommand implements runcommand core processing module

Package runcommand implements runcommand core processing module

Index

• func FormatPayload(log log.T, pluginID string, agentInfo contracts.AgentInfo, ...) messageContracts.SendReplyPayload
• type ExecuterCreator
• type RunCommandService
  • func NewMDSService(context context.T) *RunCommandService
  • func NewOfflineService(context context.T) (*RunCommandService, error)
  • func NewService(ctx context.T, serviceName string, service mdsService.Service, ...) *RunCommandService
  • func (s *RunCommandService) ModuleExecute(context context.T) (err error)
  • func (s *RunCommandService) ModuleName() string
  • func (s *RunCommandService) ModuleRequestStop(stopType contracts.StopType) (err error)
• type SendDocumentLevelResponse
• type SendResponse
• type TopicPrefix

Functions

func FormatPayload

func FormatPayload(log log.T, pluginID string, agentInfo contracts.AgentInfo, outputs map[string]*contracts.PluginResult) messageContracts.SendReplyPayload

build SendReply Payload from the internal plugins map

Types

type ExecuterCreator

type ExecuterCreator func(ctx context.T) executer.Executer

type RunCommandService

type RunCommandService struct {
	// contains filtered or unexported fields
}

Processor is an object that can process MDS messages.

func NewMDSService

func NewMDSService(context context.T) *RunCommandService

NewMdsProcessor initializes a new mds processor with the given parameters.

func NewOfflineService

func NewOfflineService(context context.T) (*RunCommandService, error)

NewOfflineProcessor initialize a new offline command document processor

func NewService

func NewService(ctx context.T, serviceName string, service mdsService.Service, commandWorkerLimit int, cancelWorkerLimit int, pollAssoc bool, supportedDocs []contracts.DocumentType) *RunCommandService

NewProcessor performs common initialization for Mds and Offline processors

func (*RunCommandService) ModuleExecute

func (s *RunCommandService) ModuleExecute(context context.T) (err error)

Execute starts the scheduling of the message processor plugin

func (*RunCommandService) ModuleName

func (s *RunCommandService) ModuleName() string

Name returns the module name

func (*RunCommandService) ModuleRequestStop

func (s *RunCommandService) ModuleRequestStop(stopType contracts.StopType) (err error)

type SendDocumentLevelResponse

type SendDocumentLevelResponse func(messageID string, resultStatus contracts.ResultStatus, documentTraceOutput string)

SendDocumentLevelResponse is used to send status response before plugin begins

type SendResponse

type SendResponse func(messageID string, res contracts.DocumentResult)

type TopicPrefix

type TopicPrefix string

TopicPrefix is the prefix of the Topic field in an MDS message.

const (
	// SendCommandTopicPrefix is the topic prefix for a send command MDS message.
	SendCommandTopicPrefix TopicPrefix = "aws.ssm.sendCommand."

	// CancelCommandTopicPrefix is the topic prefix for a cancel command MDS message.
	CancelCommandTopicPrefix TopicPrefix = "aws.ssm.cancelCommand."

	// SendCommandTopicPrefixOffline is the topic prefix for a send command MDS message received from the offline service.
	SendCommandTopicPrefixOffline TopicPrefix = "aws.ssm.sendCommand.offline."

	// CancelCommandTopicPrefix is the topic prefix for a cancel command MDS message received from the offline service.
	CancelCommandTopicPrefixOffline TopicPrefix = "aws.ssm.cancelCommand.offline."

	CancelWorkersLimit = 3
)