awsds

Documentation

Index

• Constants
• func GetUserAgentString(name string) string
• type AWSDatasourceSettings
  • func (s *AWSDatasourceSettings) Load(config backend.DataSourceInstanceSettings) error
• type AmazonSessionProvider
• type AuthSettings
  • func ReadAuthSettingsFromEnvironmentVariables() *AuthSettings
• type AuthType
  • func ToAuthType(authType string) (AuthType, error)
  • func (at *AuthType) MarshalJSON() ([]byte, error)
  • func (at AuthType) String() string
  • func (at *AuthType) UnmarshalJSON(b []byte) error
• type SessionCache
  • func NewSessionCache() *SessionCache
  • func (sc *SessionCache) GetSession(c SessionConfig) (*session.Session, error)
• type SessionConfig

Constants

const AllowedAuthProvidersEnvVarKeyName = "AWS_AUTH_AllowedAuthProviders"

AllowedAuthProvidersEnvVarKeyName is the string literal for the aws allowed auth providers environment variable key name

const AssumeRoleEnabledEnvVarKeyName = "AWS_AUTH_AssumeRoleEnabled"

AssumeRoleEnabledEnvVarKeyName is the string literal for the aws assume role enabled environment variable key name

Functions

func GetUserAgentString

func GetUserAgentString(name string) string

GetUserAgentString returns an agent that can be parsed in server logs

Types

type AWSDatasourceSettings

type AWSDatasourceSettings struct {
	Profile       string   `json:"profile"`
	Region        string   `json:"region"`
	AuthType      AuthType `json:"authType"`
	AssumeRoleARN string   `json:"assumeRoleARN"`
	ExternalID    string   `json:"externalId"`

	// Override the client endpoint
	Endpoint string `json:"endpoint"`

	//go:deprecated Use Region instead
	DefaultRegion string `json:"defaultRegion"`

	// Loaded from DecryptedSecureJSONData (not the json object)
	AccessKey    string `json:"-"`
	SecretKey    string `json:"-"`
	SessionToken string `json:"-"`
}

DatasourceSettings holds basic connection info

func (*AWSDatasourceSettings) Load

func (s *AWSDatasourceSettings) Load(config backend.DataSourceInstanceSettings) error

LoadSettings will read and validate Settings from the DataSourceConfg

type AmazonSessionProvider

type AmazonSessionProvider func(region string, s AWSDatasourceSettings) (*session.Session, error)

AmazonSessionProvider will return a session (perhaps cached) for given region and settings

type AuthSettings

type AuthSettings struct {
	AllowedAuthProviders []string
	AssumeRoleEnabled    bool
}

AuthSettings defines whether certain auth types and provider can be used or not

func ReadAuthSettingsFromEnvironmentVariables

func ReadAuthSettingsFromEnvironmentVariables() *AuthSettings

type AuthType

type AuthType int

const (
	AuthTypeDefault AuthType = iota
	AuthTypeSharedCreds
	AuthTypeKeys
	AuthTypeEC2IAMRole
)

func ToAuthType

func ToAuthType(authType string) (AuthType, error)

func (*AuthType) MarshalJSON

func (at *AuthType) MarshalJSON() ([]byte, error)

MarshalJSON marshals the enum as a quoted json string

func (AuthType) String

func (at AuthType) String() string

func (*AuthType) UnmarshalJSON

func (at *AuthType) UnmarshalJSON(b []byte) error

UnmarshalJSON unmashals a quoted json string to the enum value

type SessionCache

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

SessionCache cache sessions for a while

func NewSessionCache

func NewSessionCache() *SessionCache

NewSessionCache creates a new session cache using the default settings loaded from environment variables

func (*SessionCache) GetSession

func (sc *SessionCache) GetSession(c SessionConfig) (*session.Session, error)

GetSession returns a session from the config and possible region overrides -- implements AmazonSessionProvider

type SessionConfig

type SessionConfig struct {
	Settings      AWSDatasourceSettings
	HTTPClient    *http.Client
	UserAgentName *string
}