util

package module

v1.1.0 Latest Latest Go to latest Published: Sep 26, 2018 License: MIT Imports: 13 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/retgits/lambda-util

Links

Open Source Insights

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

Index ¶

func CopyFile(awsSession *session.Session, filename string, bucket string) error
func DownloadFile(awsSession *session.Session, folder string, filename string, bucket string) error
func GetCurrentDirectory() (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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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 GetCurrentDirectory ¶ added in v1.1.0

func GetCurrentDirectory() (string, error)

GetCurrentDirectory gets the directory in which the app was started and returns either the full directory or an error

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{}
	StatusCode int
	Headers    http.Header
}

HTTPResponse is the response type for the HTTP requests

func HTTPGet ¶

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

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

func HTTPPatch ¶ added in v1.1.0

func HTTPPatch(URL string, encoding string, postData string, header http.Header) (HTTPResponse, error)

HTTPPatch executes a PATCH request to a URL and returns the response body as a JSON object

func HTTPPost ¶

func HTTPPost(URL string, encoding string, postData string, header http.Header) (HTTPResponse, error)

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL