util

README

lambda-util - A collection of utility methods for my serverless apps

A collection of utility methods for my serverless apps

Layout

.                                   
├── http.go         <-- Utils to interact with HTTP requests
├── os.go           <-- Utils to interact with the Operating System
├── s3.go           <-- Utils to interact with Amazon S3
├── ses.go          <-- Utils to interact with Amazon Simple Email Service
├── ssm.go          <-- Utils to interact with Amazon SSM
├── .gitignore      <-- Ignoring the things you do not want in git
├── LICENSE         <-- The license file
└── README.md       <-- This file

Documentation

Overview

Package util implements utility methods

Package util implements utility methods

Package util implements utility methods

Package util implements utility methods

Package util implements utility methods

Index

• func CopyFile(awsSession *session.Session, filename string, bucket string) error
• func DownloadFile(awsSession *session.Session, folder string, filename string, bucket string) error
• func GetEnvKey(key string, fallback string) string
• func GetSSMParameter(awsSession *session.Session, name string, decrypt bool) (string, error)
• func SendEmail(awsSession *session.Session, toAddress string, bodyContent string, ...) error
• func UploadFile(awsSession *session.Session, folder string, filename string, bucket string) error
• type HTTPResponse
  • func HTTPGet(URL string, header http.Header) (HTTPResponse, error)
  • func HTTPPost(URL string, encoding string, postData url.Values) (HTTPResponse, error)

Functions

func CopyFile

func CopyFile(awsSession *session.Session, filename string, bucket string) error

CopyFile creates a copy of an existing file with a new name

func DownloadFile

func DownloadFile(awsSession *session.Session, folder string, filename string, bucket string) error

DownloadFile downloads a file from Amazon S3 and stores it in the specified location.

func GetEnvKey

func GetEnvKey(key string, fallback string) string

GetEnvKey tries to get the specified key from the OS environment and returns either the value or the fallback that was provided

func GetSSMParameter

func GetSSMParameter(awsSession *session.Session, name string, decrypt bool) (string, error)

GetSSMParameter gets a parameter from the AWS Simple Systems Manager service.

func SendEmail

func SendEmail(awsSession *session.Session, toAddress string, bodyContent string, fromAddress string, subject string) error

SendEmail sends an email using Simple Email Service.

func UploadFile

func UploadFile(awsSession *session.Session, folder string, filename string, bucket string) error

UploadFile uploads a file to Amazon S3

Types

type HTTPResponse

type HTTPResponse struct {
	Body    map[string]interface{}
	Headers http.Header
}

HTTPResponse is the response type for the HTTP requests

func HTTPGet

func HTTPGet(URL string, header http.Header) (HTTPResponse, error)

HTTPGet executes a GET request to a URL and returns the response body as a JSON object

func HTTPPost

func HTTPPost(URL string, encoding string, postData url.Values) (HTTPResponse, error)

HTTPPost executes a POST request to a URL and returns the response body as a JSON object