s3

Documentation

Overview

Package s3 provides a client to make API requests to Amazon Simple Storage Service.

Index

• func FormatARN(partition, location string) string
• func MkdirSHA256(key string, content []byte) string
• func MkdirTimestamp(key string) string
• func ParseURL(url string) (bucket string, key string, err error)
• type CompressAndUploadFunc
• type NamedBinary
• type S3
  • func New(s *session.Session) *S3
  • func (s *S3) EmptyBucket(bucket string) error
  • func (s *S3) Upload(bucket, key string, data io.Reader) (string, error)
  • func (s *S3) ZipAndUpload(bucket, key string, files ...NamedBinary) (string, error)

Functions

func FormatARN

func FormatARN(partition, location string) string

FormatARN formats an S3 object ARN. For example: arn:aws:s3:::stackset-myapp-infrastru-pipelinebuiltartifactbuc-1nk5t9zkymh8r.s3-us-west-2.amazonaws.com/scripts/dns-cert-validator/dd2278811c3

func MkdirSHA256

func MkdirSHA256(key string, content []byte) string

MkdirSHA prefixes the key with the SHA256 hash of the contents of "manual/<hash>/key".

func MkdirTimestamp

func MkdirTimestamp(key string) string

MkdirTimestamp prefixes the key with the current timestamp "manual/<timestamp>/key".

func ParseURL

func ParseURL(url string) (bucket string, key string, err error)

ParseURL parses S3 object URL and returns the bucket name and the key. For example: https://stackset-myapp-infrastru-pipelinebuiltartifactbuc-1nk5t9zkymh8r.s3-us-west-2.amazonaws.com/scripts/dns-cert-validator/dd2278811c3 returns "stackset-myapp-infrastru-pipelinebuiltartifactbuc-1nk5t9zkymh8r" and "scripts/dns-cert-validator/dd2278811c3"

Types

type CompressAndUploadFunc

type CompressAndUploadFunc func(key string, objects ...NamedBinary) (url string, err error)

CompressAndUploadFunc is invoked to zip multiple template contents and upload them to an S3 bucket under the specified key.

type NamedBinary

type NamedBinary interface {
	Name() string
	Content() []byte
}

NamedBinary is a named binary to be uploaded.

type S3

type S3 struct {
	// contains filtered or unexported fields
}

S3 wraps an Amazon Simple Storage Service client.

func New

func New(s *session.Session) *S3

New returns an S3 client configured against the input session.

func (*S3) EmptyBucket

func (s *S3) EmptyBucket(bucket string) error

EmptyBucket deletes all objects within the bucket.

func (*S3) Upload

func (s *S3) Upload(bucket, key string, data io.Reader) (string, error)

Upload uploads a file to an S3 bucket under the specified key.

func (*S3) ZipAndUpload

func (s *S3) ZipAndUpload(bucket, key string, files ...NamedBinary) (string, error)

ZipAndUpload zips all files and uploads the zipped file to an S3 bucket under the specified key.