s3

package

v0.0.0-...-9b83d1d Latest Latest Go to latest Published: Oct 26, 2019 License: Apache-2.0 Imports: 17 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/tinsane/storages

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ConfigureFolder(prefix string, settings map[string]string) (storage.Folder, error)
func CreateUploaderAPI(svc s3iface.S3API, partsize, concurrency int) s3manageriface.UploaderAPI
func NewConfiguringError(settingName string) storage.Error
func NewFolderError(err error, format string, args ...interface{}) storage.Error
type Folder
- func NewFolder(uploader Uploader, s3API s3iface.S3API, bucket, path string) *Folder
type SseKmsIdNotSetError
- func NewSseKmsIdNotSetError() SseKmsIdNotSetError
- func (err SseKmsIdNotSetError) Error() string
type Uploader
- func NewUploader(uploaderAPI s3manageriface.UploaderAPI, ...) *Uploader

Constants ¶

View Source

const (
	NotFoundAWSErrorCode  = "NotFound"
	NoSuchKeyAWSErrorCode = "NoSuchKey"

	EndpointSetting          = "AWS_ENDPOINT"
	RegionSetting            = "AWS_REGION"
	ForcePathStyleSetting    = "AWS_S3_FORCE_PATH_STYLE"
	AccessKeyIdSetting       = "AWS_ACCESS_KEY_ID"
	AccessKeySetting         = "AWS_ACCESS_KEY"
	SecretAccessKeySetting   = "AWS_SECRET_ACCESS_KEY"
	SecretKeySetting         = "AWS_SECRET_KEY"
	SessionTokenSetting      = "AWS_SESSION_TOKEN"
	SseSetting               = "S3_SSE"
	SseKmsIdSetting          = "S3_SSE_KMS_ID"
	StorageClassSetting      = "S3_STORAGE_CLASS"
	UploadConcurrencySetting = "UPLOAD_CONCURRENCY"

	MaxPartSize = "S3_MAX_PART_SIZE"
)

View Source

const (
	DefaultMaxPartSize = 20 << 20
)

Variables ¶

View Source

var (
	// MaxRetries limit upload and download retries during interaction with S3
	MaxRetries  = 15
	SettingList = []string{
		EndpointSetting,
		RegionSetting,
		ForcePathStyleSetting,
		AccessKeyIdSetting,
		AccessKeySetting,
		SecretAccessKeySetting,
		SecretKeySetting,
		SessionTokenSetting,
		SseSetting,
		SseKmsIdSetting,
		StorageClassSetting,
		UploadConcurrencySetting,
		s3CertFile,
		MaxPartSize,
	}
)

Functions ¶

func ConfigureFolder ¶

func ConfigureFolder(prefix string, settings map[string]string) (storage.Folder, error)

func CreateUploaderAPI ¶

func CreateUploaderAPI(svc s3iface.S3API, partsize, concurrency int) s3manageriface.UploaderAPI

CreateUploaderAPI returns an uploader with customizable concurrency and part size.

func NewConfiguringError ¶

func NewConfiguringError(settingName string) storage.Error

func NewFolderError ¶

func NewFolderError(err error, format string, args ...interface{}) storage.Error

Types ¶

type Folder ¶

type Folder struct {
	S3API  s3iface.S3API
	Bucket *string
	Path   string
	// contains filtered or unexported fields
}

func NewFolder ¶

func NewFolder(uploader Uploader, s3API s3iface.S3API, bucket, path string) *Folder

func (*Folder) DeleteObjects ¶

func (folder *Folder) DeleteObjects(objectRelativePaths []string) error

func (*Folder) Exists ¶

func (folder *Folder) Exists(objectRelativePath string) (bool, error)

func (*Folder) GetPath ¶

func (folder *Folder) GetPath() string

func (*Folder) GetSubFolder ¶

func (folder *Folder) GetSubFolder(subFolderRelativePath string) storage.Folder

func (*Folder) ListFolder ¶

func (folder *Folder) ListFolder() (objects []storage.Object, subFolders []storage.Folder, err error)

func (*Folder) PutObject ¶

func (folder *Folder) PutObject(name string, content io.Reader) error

func (*Folder) ReadObject ¶

func (folder *Folder) ReadObject(objectRelativePath string) (io.ReadCloser, error)

type SseKmsIdNotSetError ¶

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

func NewSseKmsIdNotSetError ¶

func NewSseKmsIdNotSetError() SseKmsIdNotSetError

func (SseKmsIdNotSetError) Error ¶

func (err SseKmsIdNotSetError) Error() string

type Uploader ¶

type Uploader struct {
	SSEKMSKeyId  string
	StorageClass string
	// contains filtered or unexported fields
}

func NewUploader ¶

func NewUploader(uploaderAPI s3manageriface.UploaderAPI, serverSideEncryption, sseKmsKeyId, storageClass string) *Uploader

Source Files ¶

View all Source files

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