s3

Documentation

Overview

Package s3 provides a simple client to interact with a AWS S3 bucket, including the ability to upload, download, and delete objects.

It is based on the official aws-sdk-go-v2 library.

Ref.: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/s3

Index

• type Client
  • func New(ctx context.Context, bucketName string, opts ...Option) (*Client, error)
  • func (c *Client) Delete(ctx context.Context, key string) error
  • func (c *Client) Get(ctx context.Context, key string) (*Object, error)
  • func (c *Client) ListKeys(ctx context.Context, prefix string) ([]string, error)
  • func (c *Client) Put(ctx context.Context, key string, reader io.Reader) error
• type Object
• type Option
  • func WithAWSOptions(opt awsopt.Options) Option
  • func WithEndpointImmutable(url string) Option
  • func WithEndpointMutable(url string) Option
  • func WithSrvOptionFuncs(opt ...SrvOptionFunc) Option
• type S3
• type SrvOptionFunc

Types

type Client

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

Client is a wrapper for the S3 client in the AWS SDK.

func New

func New(ctx context.Context, bucketName string, opts ...Option) (*Client, error)

New creates a new instance of the S3 client wrapper.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, key string) error

Delete removes an object from S3 Bucket by key.

func (*Client) Get

func (c *Client) Get(ctx context.Context, key string) (*Object, error)

Get returns *Object.

func (*Client) ListKeys

func (c *Client) ListKeys(ctx context.Context, prefix string) ([]string, error)

ListKeys searches for keys by a provided prefix; returns all keys if prefix is empty string.

func (*Client) Put

func (c *Client) Put(ctx context.Context, key string, reader io.Reader) error

Put uploads data from reader to S3 Bucket.

type Object

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

Object represents object retrieved from S3.

type Option

type Option func(*cfg)

Option is a type to allow setting custom client options.

func WithAWSOptions

func WithAWSOptions(opt awsopt.Options) Option

WithAWSOptions allows to add an arbitrary AWS options.

func WithEndpointImmutable

func WithEndpointImmutable(url string) Option

WithEndpointImmutable sets an immutable endpoint.

func WithEndpointMutable

func WithEndpointMutable(url string) Option

WithEndpointMutable sets a mutable endpoint.

func WithSrvOptionFuncs

func WithSrvOptionFuncs(opt ...SrvOptionFunc) Option

WithSrvOptionFuncs allows to specify specific options.

type S3

type S3 interface {
	DeleteObject(ctx context.Context, params *s3.DeleteObjectInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectOutput, error)
	GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)
	ListObjectsV2(ctx context.Context, params *s3.ListObjectsV2Input, optFns ...func(*s3.Options)) (*s3.ListObjectsV2Output, error)
	PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)
}

S3 represents the mockable functions in the AWS SDK S3 client.

type SrvOptionFunc

type SrvOptionFunc = func(*s3.Options)

SrvOptionFunc is an alias for this service option function.