ssm

Documentation

Index

• func DeleteActivation(session *session.Session, activationId string) (*ssm.DeleteActivationOutput, error)
• func DeregisterInstance(session *session.Session, id string) (*ssm.DeregisterManagedInstanceOutput, error)
• func GetInstanceByActivationId(session *session.Session, id string) (*ssm.InstanceInformation, error)
• func Run(session *session.Session, logger logr.Logger, instanceID, command string, ...) error
• func WaitForSSMReady(session *session.Session, instanceID string, timeout time.Duration) error
• type ActivationInfo
  • func CreateActivation(session *session.Session, instanceName, role string) (*ActivationInfo, error)
• type CommandOpt
  • func WithOutputToCloudwatch() CommandOpt
  • func WithOutputToS3(bucket, dir string) CommandOpt
• type RunOutput
  • func RunCommand(session *session.Session, logger logr.Logger, instanceID, command string, ...) (*RunOutput, error)
  • func (r *RunOutput) StatusDetails() string
  • func (r *RunOutput) Successful() bool

Functions

func DeleteActivation

func DeleteActivation(session *session.Session, activationId string) (*ssm.DeleteActivationOutput, error)

func DeregisterInstance

func DeregisterInstance(session *session.Session, id string) (*ssm.DeregisterManagedInstanceOutput, error)

func GetInstanceByActivationId

func GetInstanceByActivationId(session *session.Session, id string) (*ssm.InstanceInformation, error)

func Run

func Run(session *session.Session, logger logr.Logger, instanceID, command string, timeout time.Duration, opts ...CommandOpt) error

Run runs the command using SSM on the instance corresponding to the instanceID.

func WaitForSSMReady

func WaitForSSMReady(session *session.Session, instanceID string, timeout time.Duration) error

WaitForSSMReady waits for the SSM command to be ready.

Types

type ActivationInfo

type ActivationInfo struct {
	ActivationCode string
	ActivationID   string
}

func CreateActivation

func CreateActivation(session *session.Session, instanceName, role string) (*ActivationInfo, error)

type CommandOpt

type CommandOpt func(c *ssm.SendCommandInput)

func WithOutputToCloudwatch

func WithOutputToCloudwatch() CommandOpt

func WithOutputToS3

func WithOutputToS3(bucket, dir string) CommandOpt

type RunOutput

type RunOutput struct {
	CommandId      string
	StdOut, StdErr []byte
	// contains filtered or unexported fields
}

func RunCommand

func RunCommand(session *session.Session, logger logr.Logger, instanceID, command string, timeout time.Duration, opts ...CommandOpt) (*RunOutput, error)

RunCommand runs the command using SSM on the instance corresponding to the instanceID.

func (*RunOutput) StatusDetails

func (r *RunOutput) StatusDetails() string

StatusDetails returns the status details of the ssm command.

func (*RunOutput) Successful

func (r *RunOutput) Successful() bool