s3

Documentation

Overview

Package s3 wraps AWS S3 API in a basic interface that provides calls specific to our needs

Index

• type Client
  • func New(opts ...ClientOptions) (*Client, error)
  • func (c *Client) WriteBytes(bucket string, key string, r io.ReadSeeker) error
• type ClientOptions
  • func WithRegion(r string) ClientOptions
  • func WithRoleARN(r string) ClientOptions
  • func WithS3APIClient(s3c s3iface.S3API) ClientOptions

Types

type Client

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

Client is our own parameter store client

func New

func New(opts ...ClientOptions) (*Client, error)

New returns a new Client instance

func (*Client) WriteBytes

func (c *Client) WriteBytes(bucket string, key string, r io.ReadSeeker) error

WriteBytes writes the given bytes to an object key

type ClientOptions

type ClientOptions func(*Client)

ClientOptions provides the ability to override client settings during initialization

func WithRegion

func WithRegion(r string) ClientOptions

WithRegion allows specifying the region we're operating in

func WithRoleARN

func WithRoleARN(r string) ClientOptions

WithRoleARN allows specifying a role ARN to assume for S3 operations

func WithS3APIClient

func WithS3APIClient(s3c s3iface.S3API) ClientOptions

WithS3APIClient allows providing the AWS S3 API client instead of initializing one