baiji v0.6.11 Baiji.Auth behaviour

Link to this section Summary

Functions

Attempt to assume the role specified in the operation’s options. The role can be defined either as an ARN, or a tuple containing the role ARN and a session name. If no session name is provided, the default session name “Baiji (Elixir)” will be used instead

Populate the authorization credentials of the given operation

Try successive auth population methods until one of them successfully populates the specified key in the given operation or we run out of methods

Attempt to populate the access_key_id field of the given operation using the methods defined in the application config. If the operation already has an access key ID, nothing will be done

Attempt to populate the secret_access_key field of the given operation using the methods defined in the application config. If the operation already has a secret access key, nothing will be done

Attempt to populate the security_token field of the given operation using the methods defined in the application config. If the operation already has a security token, nothing will be done

Verify that an Operation struct contains the required credentials

Link to this section Functions

Link to this function assume_role(op, role_arn)

Attempt to assume the role specified in the operation’s options. The role can be defined either as an ARN, or a tuple containing the role ARN and a session name. If no session name is provided, the default session name “Baiji (Elixir)” will be used instead.

Populate the authorization credentials of the given operation

Link to this function populate(op, methods, key)

Try successive auth population methods until one of them successfully populates the specified key in the given operation or we run out of methods

Link to this function populate_access_key_id(op)

Attempt to populate the access_key_id field of the given operation using the methods defined in the application config. If the operation already has an access key ID, nothing will be done.

Link to this function populate_secret_access_key(op)

Attempt to populate the secret_access_key field of the given operation using the methods defined in the application config. If the operation already has a secret access key, nothing will be done.

Link to this function populate_security_token(op)

Attempt to populate the security_token field of the given operation using the methods defined in the application config. If the operation already has a security token, nothing will be done.

Verify that an Operation struct contains the required credentials

Link to this section Callbacks

Link to this callback populate(%, atom)
populate(%Baiji.Operation{access_key_id: term, action: term, assigns: term, endpoint: term, errors: term, halted: term, input: term, input_shape: term, method: term, options: term, output_shape: term, output_wrapper: term, parser: term, path: term, region: term, secret_access_key: term, security_token: term}, atom) :: %Baiji.Operation{access_key_id: term, action: term, assigns: term, endpoint: term, errors: term, halted: term, input: term, input_shape: term, method: term, options: term, output_shape: term, output_wrapper: term, parser: term, path: term, region: term, secret_access_key: term, security_token: term}