s3util

Documentation

Index

• func IsNotFound(err error) bool
• func SetupS3(c *Config) (*session.Session, error)
• type Bucket
  • func NewBucket(ctx context.Context, c *Config) (*Bucket, error)
  • func (b *Bucket) SignedURL(ctx context.Context, key string, opts *SignedURLOptions) (string, error)
• type Config
• type SignedURLOptions

Functions

func IsNotFound

func IsNotFound(err error) bool

func SetupS3

func SetupS3(c *Config) (*session.Session, error)

Types

type Bucket

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

bucket represents an S3 bucket and handles read, write and delete operations.

func NewBucket

func NewBucket(ctx context.Context, c *Config) (*Bucket, error)

func (*Bucket) SignedURL

func (b *Bucket) SignedURL(ctx context.Context, key string, opts *SignedURLOptions) (string, error)

type Config

type Config struct {
	Endpoint        string
	Region          string
	AccessKeyID     string
	SecretAccessKey string
	BucketName      string

	// The prefix should end with "/", so that the resulting bucket operates in a subfolder.
	Prefix string
	Debug  bool
}

type SignedURLOptions

type SignedURLOptions struct {
	// Expiry sets how long the returned URL is valid for. It is guaranteed to be > 0.
	Expiry time.Duration

	// Method is the HTTP method that can be used on the URL; one of "GET", "PUT",
	// or "DELETE". Drivers must implement all 3.
	Method string

	// ContentType specifies the Content-Type HTTP header the user agent is
	// permitted to use in the PUT request. It must match exactly. See
	// EnforceAbsentContentType for behavior when ContentType is the empty string.
	// If this field is not empty and the bucket cannot enforce the Content-Type
	// header, it must return an Unimplemented error.
	//
	// This field will not be set for any non-PUT requests.
	ContentType string

	// If EnforceAbsentContentType is true and ContentType is the empty string,
	// then PUTing to the signed URL must fail if the Content-Type header is
	// present or the implementation must return an error if it cannot enforce
	// this. If EnforceAbsentContentType is false and ContentType is the empty
	// string, implementations should validate the Content-Type header if possible.
	// If EnforceAbsentContentType is true and the bucket cannot enforce the
	// Content-Type header, it must return an Unimplemented error.
	//
	// This field will always be false for non-PUT requests.
	EnforceAbsentContentType bool

	// The canned ACL to apply to the object. For more information, see Canned ACL
	// (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
	ACL string

	// Can be used to specify caching behavior along the request/reply chain. For
	// more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
	// (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).
	CacheControl string
}

SignedURLOptions sets options for SignedURL.