Configuration.Utils.Aws.Credentials

Configuration Types

data CredentialConfigKey

Constructors

CredentialConfigKey

Fields

_credentialConfigKeyId :: !ByteString

_credentialConfigKeySecret :: !ByteString

Instances

Eq CredentialConfigKey

Ord CredentialConfigKey

Read CredentialConfigKey

Show CredentialConfigKey

ToJSON CredentialConfigKey

FromJSON CredentialConfigKey

Typeable * CredentialConfigKey

credentialConfigKeyId :: Lens' CredentialConfigKey ByteString

credentialConfigKeySecret :: Lens' CredentialConfigKey ByteString

validateCredentialConfigKey :: ConfigValidation CredentialConfigKey λ

data CredentialConfigFile

Constructors

CredentialConfigFile

Fields

_credentialConfigFileName :: !FilePath

_credentialConfigKeyName :: !Text

default value is "default"

Instances

Eq CredentialConfigFile

Ord CredentialConfigFile

Read CredentialConfigFile

Show CredentialConfigFile

ToJSON CredentialConfigFile

FromJSON CredentialConfigFile

Typeable * CredentialConfigFile

credentialConfigFileName :: Lens' CredentialConfigFile FilePath

credentialConfigKeyName :: Lens' CredentialConfigFile Text

validateCredentialConfigFile :: ConfigValidation CredentialConfigFile λ

data CredentialConfig

When parsed from configuration files or the command line the settings take the following precedence:

Explicit credential configuration gets precedence over credential file configuration which has precedence over loading the credentials from the environment over loading the credentials from the instance meta data.

Any setting on the command line always has precedence over any setting in a configuration file.

If the configured file does not exist an parse error is triggered. Set this value of _credentialConfigFile to Nothing if you don't want to suppress this error.

Constructors

CredentialConfig

Fields

_credentialConfigKey :: !(Maybe CredentialConfigKey)

_credentialConfigFile :: !(Maybe CredentialConfigFile)

_credentialConfigEnvironment :: !Bool

_credentialConfigInstanceMetadata :: !Bool

Instances

Eq CredentialConfig

Ord CredentialConfig

Show CredentialConfig

ToJSON CredentialConfig

FromJSON (CredentialConfig -> CredentialConfig)

credentialConfigKey :: Lens' CredentialConfig (Maybe CredentialConfigKey)

credentialConfigFile :: Lens' CredentialConfig (Maybe CredentialConfigFile)

credentialConfigEnvironment :: Lens' CredentialConfig Bool

credentialConfigInstanceMetadata :: Lens' CredentialConfig Bool

defaultCredentialConfig :: CredentialConfig

pCredentialConfig

Arguments

:: String

prefix

-> MParser CredentialConfig

A command-line argument parser for CredentialConfig. The prefix argument will be prepended directly onto the argument names.

pCredentialConfig_ :: MParser CredentialConfig

This is pCredentialConfig with an empty prefix.

validateCredentialConfig :: ConfigValidation CredentialConfig λ

Load Credentials

credentialsFromConfig :: (MonadError LoadCredentialsException m, MonadIO m) => CredentialConfig -> m Credentials

Load Credentials according to the credential configuration

Credentials are loaded with a precedence according to the order of the record fields of CredentialConfig:

1. _credentialConfigKey, loads the explicitely specified credentials,
2. _credentialConfigFile, loads credentials with the given key name from the given file,
3. _credentialConfigEnvironment, loads credentials from the environment varialbes AWS_ACCESS_KEY_ID and AWS_ACCESS_KEY_SECRET), and
4. _credentialConfigInstanceMetadata, load the credentials from the EC2 instance metadata.

It is an error if a particular method is specified in the configuration but loading the credentials with that methods fails.

data LoadCredentialsException

Constructors

LoadCredentialsFromFileFailed CredentialConfigFile

LoadCredentialsFromEnvironementFailed

LoadCredentialsFromInstanceMetadataFailed

NoCredentialLoadingMethodSpecified

Instances

Eq LoadCredentialsException

Show LoadCredentialsException

Exception LoadCredentialsException

Typeable * LoadCredentialsException