commands

Documentation

Index

• type Client
  • func (c *Client) Cancel(command *Command, signal int) error
  • func (c *Client) Get(commandID string) (*Command, error)
  • func (c *Client) GetInstanceIDToNameMap() (map[string]string, error)
  • func (c *Client) GetInstances(instanceIDs []string, tags map[string][]string) ([]*Instance, error)
  • func (c *Client) GetInvocations(commandID string) ([]*CommandInvocation, error)
  • func (c *Client) Send(opts *SendOptions) (*Command, error)
  • func (c *Client) WaitStatus(commandID string, statuses []string) chan *Command
• type Command
• type CommandInvocation
• type Instance
• type SendOptions

Types

type Client

type Client struct {
	SSM   awsclient.SSM
	S3    awsclient.S3
	Store *store.Store
}

func (*Client) Cancel

func (c *Client) Cancel(command *Command, signal int) error

Cancel a command by sending signal

func (*Client) Get

func (c *Client) Get(commandID string) (*Command, error)

Get a command by ID

func (*Client) GetInstanceIDToNameMap

func (c *Client) GetInstanceIDToNameMap() (map[string]string, error)

GetInstanceIDToNameMap returns a map between instance ID and name

func (*Client) GetInstances

func (c *Client) GetInstances(instanceIDs []string, tags map[string][]string) ([]*Instance, error)

GetInstances returns filtered instances

func (*Client) GetInvocations

func (c *Client) GetInvocations(commandID string) ([]*CommandInvocation, error)

GetInvocations finds command invocations by command ID

func (*Client) Send

func (c *Client) Send(opts *SendOptions) (*Command, error)

Send a new command

func (*Client) WaitStatus

func (c *Client) WaitStatus(commandID string, statuses []string) chan *Command

WaitStatus waits a command to be in specified status

type Command

type Command struct {
	CommandID    string
	PcommandID   string
	Status       string
	Targets      map[string][]string
	DocumentName string

	OutputLogGroup        string
	OutputLogStreamPrefix string
	SignalS3Bucket        string
	SignalS3Key           string
}

type CommandInvocation

type CommandInvocation struct {
	CommandID    string
	InstanceID   string
	InstanceName string
	Status       string
}

type Instance

type Instance struct {
	InstanceID   string
	ComputerName string
	PingStatus   string
}

type SendOptions

type SendOptions struct {
	DocumentName      string
	InstanceIDs       []string
	Tags              map[string][]string
	MaxConcurrency    string
	MaxErrors         string
	OutputLogGroup    string
	SignalS3Bucket    string
	SignalS3KeyPrefix string
}

SendOptions is options for Send