Documentation
¶
Index ¶
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
Variables ¶
This section is empty.
Functions ¶
func GetUserAgentString ¶ added in v0.8.0
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 ¶ added in v0.2.0
AuthSettings defines whether certain auth types and provider can be used or not
func ReadAuthSettingsFromEnvironmentVariables ¶ added in v0.3.0
func ReadAuthSettingsFromEnvironmentVariables() *AuthSettings
type AuthType ¶
type AuthType int
func ToAuthType ¶ added in v0.3.0
func (*AuthType) MarshalJSON ¶
MarshalJSON marshals the enum as a quoted json string
func (*AuthType) UnmarshalJSON ¶
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 ¶ added in v0.9.0
type SessionConfig struct {
Settings AWSDatasourceSettings
Config backend.DataSourceInstanceSettings
UserAgentName *string
}
Source Files