predictor

Documentation

Index

• Variables
• func SetLogger(l *logrus.Logger)
• func SupportedListField(name string) bool
• type Predictor
  • func NewPredictor(cacheFile, configFile string) *Predictor
  • func (p *Predictor) AccountComplete() complete.Predictor
  • func (p *Predictor) ArnComplete() complete.Predictor
  • func (p *Predictor) FieldListComplete() complete.Predictor
  • func (p *Predictor) ProfileComplete() complete.Predictor
  • func (p *Predictor) RegionComplete() complete.Predictor
  • func (p *Predictor) RoleComplete() complete.Predictor
  • func (p *Predictor) SsoComplete() complete.Predictor

Variables

var AllListFields = map[string]string{
	"Id":            "Column Index",
	"Arn":           "AWS Role Resource Name",
	"AccountId":     "AWS AccountID (integer)",
	"AccountIdPad":  "AWS AccountID (zero padded)",
	"AccountName":   "Configured Account Name",
	"AccountAlias":  "AWS Account Alias",
	"DefaultRegion": "Default AWS Region",
	"EmailAddress":  "Root Email for AWS account",
	"Expires":       "Time until STS creds expire",
	"ExpiresEpoch":  "Unix Epoch when STS creds expire",
	"RoleName":      "AWS Role Name",
	"SSO":           "AWS SSO Instance Name",
	"Via":           "Role Chain Via",
	"Profile":       "AWS_SSO_PROFILE / AWS_PROFILE",
}

keys match AWSRoleFlat header and value is the description

var AvailableAwsRegions []string = []string{
	"us-gov-west-1",
	"us-gov-east-1",
	"us-east-1",
	"us-east-2",
	"us-west-1",
	"us-west-2",
	"af-south-1",
	"ap-east-1",
	"ap-south-1",
	"ap-northeast-1",
	"ap-northeast-2",
	"ap-northeast-3",
	"ap-southeast-1",
	"ap-southeast-2",
	"ap-southeast-3",
	"ap-southeast-4",
	"ap-northeast-1",
	"ca-central-1",
	"eu-central-1",
	"eu-central-2",
	"eu-west-1",
	"eu-west-2",
	"eu-west-3",
	"eu-south-1",
	"eu-south-2",
	"eu-north-1",
	"il-central-1",
	"me-central-1",
	"me-south-1",
	"sa-east-1",
}

AvailableAwsRegions lists all the AWS regions that AWS provides https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions

var AvailableAwsSSORegions []string = []string{
	"us-east-1",
	"us-east-2",
	"us-west-1",
	"us-west-2",
	"af-south-1",
	"ap-east-1",
	"ap-south-1",
	"ap-northeast-1",
	"ap-northeast-2",
	"ap-northeast-3",
	"ap-southeast-1",
	"ap-southeast-2",
	"ap-southeast-3",
	"ca-central-1",
	"eu-central-1",
	"eu-west-1",
	"eu-west-2",
	"eu-west-3",
	"eu-south-1",
	"eu-north-1",
	"sa-east-1",
	"me-south-1",
	"us-gov-east-1",
	"us-gov-west-1",
}

https://docs.aws.amazon.com/general/latest/gr/sso.html

Functions

func SetLogger

func SetLogger(l *logrus.Logger)

func SupportedListField

func SupportedListField(name string) bool

Types

type Predictor

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

func NewPredictor

func NewPredictor(cacheFile, configFile string) *Predictor

NewPredictor loads our cache file (if exists) and loads the values

func (*Predictor) AccountComplete

func (p *Predictor) AccountComplete() complete.Predictor

AccountComplete returns a list of all the valid AWS Accounts we have in the cache

func (*Predictor) ArnComplete

func (p *Predictor) ArnComplete() complete.Predictor

ArnComplete returns a list of all the valid AWS Role ARNs we have in the cache

func (*Predictor) FieldListComplete

func (p *Predictor) FieldListComplete() complete.Predictor

FieldListComplete returns a completor for the `list` fields

func (*Predictor) ProfileComplete

func (p *Predictor) ProfileComplete() complete.Predictor

ProfileComplete returns a list of all the valid AWS_PROFILE values

func (*Predictor) RegionComplete

func (p *Predictor) RegionComplete() complete.Predictor

RegionsComplete returns a list of all the valid AWS Regions

func (*Predictor) RoleComplete

func (p *Predictor) RoleComplete() complete.Predictor

RoleComplete returns a list of all the valid AWS Roles we have in the cache

func (*Predictor) SsoComplete

func (p *Predictor) SsoComplete() complete.Predictor

SsoComplete returns a list of the valid AWS SSO Instances