Mercurial > prosody-modules
view mod_aws_profile/README.markdown @ 5820:742142f9771e
mod_groups_internal: Fix traceback when room doesn't exist
I'm not sure if it should even be included if it doesn't exist, but I'm not
currently sure how this situation occurs, so I'm implementing the lightest
possible fix for now.
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Thu, 11 Jan 2024 15:53:18 +0000 |
parents | 1d719d4ef18f |
children |
line wrap: on
line source
# Introduction This module adds support for reading AWS IAM access credentials from EC2 instance metadata, to allow Prosody modules to gain role-based access to AWS services. # Configuring ``` {.lua} modules_enabled = { "aws_profile"; } ``` There is no other configuration. # Usage in other modules Other modules can import the credentials as a shared table: ``` {.lua} local aws_credentials = module:shared("/*/aws_profile/credentials"); do_something(aws_credentials.access_key, aws_credentials.secret_key); ``` Note that credentials are time-limited, and will change periodically. The shared table will automatically be updated. If you need to know when this happens, you can also hook the `'aws_profile/credentials-refreshed'` event: ``` {.lua} module:hook_global("aws_profile/credentials-refreshed", function (new_credentials) -- do something with new_credentials.access_key/secret_key end); ``` # Compatibility Meant for use with Prosody 0.11.x, may work in older versions.