/lua-resty-aws

Make Authenticated AWS Rest API Requests

Primary LanguageLua

Name

lua-resty-aws - Make Authenticated AWS Rest API Requests.

This library is meant to be a fast connection to the services that might be called repeatedly from a webserver, if you're looking for a full sdk, I recommend boto.

Table of Contents

Status

This library is still under early development and considered experimental.

Description

This Lua library handles communicating with the amazon REST api endpoints. With it you can make signed requests to the Amazon APIs much more easily.

Synopsis

    lua_package_path "/path/to/lua-resty-aws/lib/?.lua;;";
    
    server {
        location /aws/mobile_analytics {
            content_by_lua_block {
                local aws = require "resty.aws"
                local aws, err = aws:new("aws-id", "aws-key")
                
            }
        }
    }

Back to TOC

Modules

Each module contains a new function that initializes it.

All of the commands return either something that evaluates to true on success, or nil and an error message on failure.

new

syntax: module, err = module:new(id, key, region)

Creates an uploading object. In case of failures, returns nil and a string describing the error.

Back to TOC

mobileanalytics

local mobile_analytics = require "resty.mobile_analytics"
local ma, err = mobile_analytics:new("id", "key", "[region]")
local event_information = {
        client_id = "TEST-TEST-TEST-TEST",
        mobile_analytics_app_id = "testtesttesttesttest",
        event_type = "LevelComplete",
        session_id = "TEST-TEST-TEST-TEST",
    }
local ok, err = ma:record(event_information)

Send an event to mobile analytics for tracking.

Back to TOC

kinesisfirehose

local kinesis_firehose = require "resty.kinesis_firehose"
local fh, err = kinesis_firehose:new("id", "key", "[region]")
local event_information = {
        stream_name = "TEST",
        stream_data = "testtesttesttesttest",
        partition_key = "TESTTEST",
    }
local ok, err = fh:put_record(event_information)

Send an event to kinesis firehose.

local kinesis_firehose = require "resty.kinesis_firehose"
local fh, err = kinesis_firehose:new("id", "key", "[region]")
local event_information = {
        stream_name = "TEST",
        stream_data = "testtesttesttesttest",
        partition_key = "TESTTEST",
    }
local ok, err = fh:put_batch(event_information)

Send batched events to kinesis firehose.

Back to TOC

s3

this module requires some extra packages:

sudo luarocks install lua-resty-jit-uuid
sudo luarocks install lzlib

local restys3 = require "resty.s3"
local s3, err = restys3:new("id", "key", "[region]")
local event_information = {
        bucket_name = "TEST",
        stream_data = "test, test, test, test, test",
        bucket_date = true, -- uses year/month/day/hour/file binning and filenaming
        gzip_upload = true, -- gzips content and ads .gz to filename
        file_name = "data", -- name of file or filename prefix if using bucket_date
    }
local ok, err = s3:put_record(event_information)

Send a record to s3.

local restys3 = require "resty.s3"
local s3, err = restys3:new("id", "key", "[region]")
local event_information = {
        bucket_name = "TEST",
        stream_data = "test, test, test, test, test",
        bucket_date = true, -- uses year/month/day/hour/file binning and filenaming
        gzip_upload = true, -- gzips content and ads .gz to filename
        file_name = "data", -- name of file or filename prefix if using bucket_date
    }
local ok, err = s3:put_batch(event_information)

Send batched records to s3.

Back to TOC

Limitations

  • only has support for very few aws apis currently

Back to TOC

Installation

You can install it with luarocks luarocks install lua-resty-aws

Otherwise you need to configure the lua_package_path directive to add the path of your lua-resty-aws source to ngx_lua's LUA_PATH search path, as in

    # nginx.conf
    http {
        lua_package_path "/path/to/lua-resty-aws/lib/?.lua;;";
        ...
    }

This package also requires the lua-resty-http package to be installed (https://github.com/pintsized/lua-resty-http)

Ensure that the system account running your Nginx ''worker'' proceses have enough permission to read the .lua file.

Back to TOC

TODO

Back to TOC

Author

James Marlowe "jamesmarlowe" jameskmarlowe@gmail.com, Lumate LLC.

Back to TOC

Copyright and License

This module is licensed under the BSD license.

Copyright (C) 2012-2014, by James Marlowe (jamesmarlowe) jameskmarlowe@gmail.com, Lumate LLC.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC

See Also

Back to TOC