Documentation ¶
Index ¶
- Variables
- func StringToCommand(raw string) ([]string, error)
- type AssumeRoleOptions
- type Creds
- func (c Creds) AccountID() (string, error)
- func (c Creds) AssumeRole(options AssumeRoleOptions) (Creds, error)
- func (c Creds) Client() (*sts.STS, error)
- func (c Creds) Exec(command []string) ExecResult
- func (c Creds) ExecString(command string) ExecResult
- func (c Creds) GetSessionToken(options GetSessionTokenOptions) (Creds, error)
- func (c Creds) MfaArn() (string, error)
- func (c Creds) Session() (*session.Session, error)
- func (c Creds) ToConsoleURL() (string, error)
- func (c Creds) ToCustomConsoleURL(dest string) (string, error)
- func (c Creds) ToEnvVars() []string
- func (c Creds) ToEnviron() []string
- func (c Creds) ToLinuxEnvVars() []string
- func (c Creds) ToMap() map[string]string
- func (c *Creds) ToSdk() *credentials.Credentials
- func (c Creds) ToSignoutURL() (string, error)
- func (c Creds) ToWindowsEnvVars() []string
- func (c Creds) Translate(dictionary map[string]string) map[string]string
- func (c Creds) UserName() (string, error)
- type DefaultMfaPrompt
- type ExecResult
- type GetSessionTokenOptions
- type LifetimeLimits
- type MfaPrompt
- type MultiMfaPrompt
- type UserAgentItem
- type WritableMfaPrompt
Constants ¶
This section is empty.
Variables ¶
var AssumeRoleLifetimeLimits = LifetimeLimits{Min: 900, Max: 3600 * 12, Default: 3600}
AssumeRoleLifetimeLimits describes the min, max, and default lifespan for the sts:AssumeRole call
var SessionTokenLifetimeLimits = LifetimeLimits{Min: 900, Max: 3600 * 36, Default: 3600}
SessionTokenLifetimeLimits describes the min, max, and default lifespan for the sts:GetSessionToken call
var Translations = map[string]map[string]string{
"envvar": {
"AWS_ACCESS_KEY_ID": "AccessKey",
"AWS_SECRET_ACCESS_KEY": "SecretKey",
"AWS_SESSION_TOKEN": "SessionToken",
"AWS_SECURITY_TOKEN": "SessionToken",
"AWS_DEFAULT_REGION": "Region",
"AWS_REGION": "Region",
},
"console": {
"sessionId": "AccessKey",
"sessionKey": "SecretKey",
"sessionToken": "SessionToken",
},
}
Translations defines common mappings for credential variables
Functions ¶
func StringToCommand ¶ added in v2.3.1
StringToCommand converts a string to a command slice for use in Exec
Types ¶
type AssumeRoleOptions ¶
type AssumeRoleOptions struct { RoleName string AccountID string SessionName string Policy string Lifetime int64 UseMfa bool MfaCode string MfaPrompt MfaPrompt }
AssumeRoleOptions defines the available parameters for assuming roles
type Creds ¶
type Creds struct {
AccessKey, SecretKey, SessionToken, Region string
UserAgentItems []UserAgentItem
}
Creds defines a set of AWS credentials
func NewFromEnv ¶
NewFromEnv initializes credentials from the environment variables
func NewFromStsSdk ¶
func NewFromStsSdk(stsCreds *sts.Credentials) (Creds, error)
NewFromStsSdk initializes a credential object from an AWS SDK Credentials object
func (Creds) AssumeRole ¶
func (c Creds) AssumeRole(options AssumeRoleOptions) (Creds, error)
AssumeRole executes an AWS role assumption
func (Creds) Exec ¶ added in v2.1.0
func (c Creds) Exec(command []string) ExecResult
Exec runs a command with the provided credentials
func (Creds) ExecString ¶ added in v2.1.0
func (c Creds) ExecString(command string) ExecResult
ExecString runs a simple command with the provided credentials
func (Creds) GetSessionToken ¶
func (c Creds) GetSessionToken(options GetSessionTokenOptions) (Creds, error)
GetSessionToken executes an AWS session token request
func (Creds) ToConsoleURL ¶
ToConsoleURL returns a console URL for the role
func (Creds) ToCustomConsoleURL ¶
ToCustomConsoleURL returns a console URL with a custom path
func (Creds) ToEnvVars ¶
ToEnvVars returns environment variables suitable for evaling on the current platform
func (Creds) ToEnviron ¶ added in v2.1.0
ToEnviron returns a golang os.Environ object built from the current env plus these credentials
func (Creds) ToLinuxEnvVars ¶ added in v2.0.8
ToLinuxEnvVars returns environment variables suitable for eval-ing into the POSIX shell
func (*Creds) ToSdk ¶
func (c *Creds) ToSdk() *credentials.Credentials
ToSdk returns an AWS SDK Credentials object
func (Creds) ToSignoutURL ¶
ToSignoutURL returns a signout URL for the console
func (Creds) ToWindowsEnvVars ¶ added in v2.0.8
ToWindowsEnvVars returns environment variables suitable for eval-ing into Windows Powershell
type DefaultMfaPrompt ¶
DefaultMfaPrompt defines the standard CLI-based MFA prompt
type ExecResult ¶ added in v2.1.0
type ExecResult struct { Error error `json:"error"` ExitCode int `json:"exitcode"` StdOut string `json:"stdout"` StdErr string `json:"stderr"` }
ExecResult returns the results of executing a command
type GetSessionTokenOptions ¶
type GetSessionTokenOptions struct { Lifetime int64 UseMfa bool MfaCode string MfaPrompt MfaPrompt }
GetSessionTokenOptions defines the available parameters for session tokens
type LifetimeLimits ¶ added in v2.1.3
type LifetimeLimits struct {
Min, Max, Default int64
}
LifetimeLimits describes the minimum, maximum, and default values for credential lifespan
type MultiMfaPrompt ¶ added in v2.0.6
type MultiMfaPrompt struct {
Backends []MfaPrompt
}
MultiMfaPrompt allows a slice of sequential backends to check for Mfa
func (*MultiMfaPrompt) Prompt ¶ added in v2.0.6
func (m *MultiMfaPrompt) Prompt(arn string) (string, error)
Prompt iterates through the backends to find an Mfa code
func (*MultiMfaPrompt) RetryText ¶ added in v2.4.0
func (m *MultiMfaPrompt) RetryText(arn string) string
RetryText returns helper text for retrying a failed mfa storage
func (*MultiMfaPrompt) Store ¶ added in v2.4.0
func (m *MultiMfaPrompt) Store(arn, seed string) error
Store attempts to store the Mfa in a backend
type UserAgentItem ¶ added in v2.2.0
UserAgentItem defines an entry in the HTTP User Agent field