awssh

README

awssh

CLI tool to login ec2 instance.

Install

• Brew

$ brew tap youyo/tap
$ brew install awssh

Other platforms are download from github release page.

Requirements

• ec2-instance-connect must be possible.
• port forwarding with amazon-ssm-agent must be possible
• session-manager-plugin command.

Usage

$ awssh

Author

youyo

Documentation

Index

• Constants
• func ExecSshLogin(username, host, port, identityFilePath string) (err error)
• func PreRun(cmd *cobra.Command, args []string) (err error)
• func Run(cmd *cobra.Command, args []string) (err error)
• func Validate(cmd *cobra.Command, args []string) (err error)
• type Cache
  • func NewCache(path, key string) (c *Cache, err error)
  • func (c *Cache) Load() (creds *credentials.Value, err error)
  • func (c *Cache) Save(creds *credentials.Value, expire time.Duration) (err error)
• type Config
  • func NewConfig() *Config
  • func (c *Config) ListProfiles() (profiles []string)
  • func (c *Config) Load() (err error)
• type Instance
• type Instances
• type SsmDocument
• type SsmDocumentParameters

Constants

const (
	CmdSessionManagerPlugin      string = "session-manager-plugin"
	CmdSessionManagerPluginOrder string = "StartSession"
)

const (
	CachePath string = "~/.config/awssh/cache"
)

const (
	ConnectHost string = "127.0.0.1"
)

const (
	DocumentNameAwsStartPortForwardingSession string = "AWS-StartPortForwardingSession"
)

Functions

func ExecSshLogin

func ExecSshLogin(username, host, port, identityFilePath string) (err error)

func PreRun

func PreRun(cmd *cobra.Command, args []string) (err error)

func Run

func Run(cmd *cobra.Command, args []string) (err error)

func Validate

func Validate(cmd *cobra.Command, args []string) (err error)

Types

type Cache

type Cache struct {
	Store   *filesystem.FSStore
	Marshal *onecache.CacheSerializer
	Key     string
}

func NewCache

func NewCache(path, key string) (c *Cache, err error)

func (*Cache) Load

func (c *Cache) Load() (creds *credentials.Value, err error)

func (*Cache) Save

func (c *Cache) Save(creds *credentials.Value, expire time.Duration) (err error)

type Config

type Config struct {
	Data     *ini.File
	Profiles []string
}

func NewConfig

func NewConfig() *Config

func (*Config) ListProfiles

func (c *Config) ListProfiles() (profiles []string)

func (*Config) Load

func (c *Config) Load() (err error)

type Instance

type Instance struct {
	ID      string
	TagName string
}

type Instances

type Instances []Instance

type SsmDocument

type SsmDocument struct {
	Target       string                `json:"Target"`
	DocumentName string                `json:"DocumentName"`
	Parameters   SsmDocumentParameters `json:"Parameters"`
}

type SsmDocumentParameters

type SsmDocumentParameters struct {
	PortNumber      []string `json:"portNumber"`
	LocalPortNumber []string `json:"localPortNumber"`
}