config

Documentation

Index

• func GetConfigDirctory() (string, error)
• func GetConfigFilePath() (string, error)
• type BackplaneConfiguration
  • func GetBackplaneConfiguration() (bpConfig BackplaneConfiguration, err error)
  • func (config BackplaneConfiguration) CheckAPIConnection() error
  • func (config *BackplaneConfiguration) GetBackplaneURL() (string, error)

Functions

func GetConfigDirctory

func GetConfigDirctory() (string, error)

func GetConfigFilePath

func GetConfigFilePath() (string, error)

GetConfigFilePath returns the Backplane CLI configuration filepath

Types

type BackplaneConfiguration

type BackplaneConfiguration struct {
	URL              string  `json:"url"`
	ProxyURL         *string `json:"proxy-url"` // Optional
	SessionDirectory string  `json:"session-dir"`
	AssumeInitialArn string  `json:"assume-initial-arn"`
	PagerDutyAPIKey  string  `json:"pd-key"`
}

func GetBackplaneConfiguration

func GetBackplaneConfiguration() (bpConfig BackplaneConfiguration, err error)

GetBackplaneConfiguration parses and returns the given backplane configuration

func (BackplaneConfiguration) CheckAPIConnection

func (config BackplaneConfiguration) CheckAPIConnection() error

CheckAPIConnection validate API connection via configured proxy and VPN

func (*BackplaneConfiguration) GetBackplaneURL

func (config *BackplaneConfiguration) GetBackplaneURL() (string, error)

GetBackplaneURL returns API URL