s3

Documentation

Overview

Package s3 implements a koanf.Provider that takes a []byte slice and provides it to koanf to be parsed by a koanf.Parser.

Index

• type Config
• type S3
  • func Provider(cfg Config) *S3
  • func (r *S3) Read() (map[string]interface{}, error)
  • func (r *S3) ReadBytes() ([]byte, error)

Types

type Config

type Config struct {
	// AWS Access Key
	AccessKey string

	// AWS Secret Key
	SecretKey string

	// AWS region
	Region string

	// Bucket Name
	Bucket string

	// Object Key
	ObjectKey string

	// Optional: Custom S3 compatible endpoint
	Endpoint string
}

Config for the provider.

type S3

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

S3 implements a s3 provider.

func Provider

func Provider(cfg Config) *S3

Provider returns a provider that takes a simples3 config.

func (*S3) Read

func (r *S3) Read() (map[string]interface{}, error)

Read is not supported for s3 provider.

func (*S3) ReadBytes

func (r *S3) ReadBytes() ([]byte, error)

ReadBytes reads the contents of a file on s3 and returns the bytes.