runs3

Documentation

Index

• Variables
• func NewClient(connectionString string) *s3.Client
• func Setup(ctx context.Context, connectionString string) error

Variables

var BucketName = "brick"

BucketName is the name of the S3 bucket used by the application.

It is a hard-coded string because the application uses MinIO instead of Amazon S3, and MinIO isn't expected to be shared.

It is a also variable instead of a constant because aws-sdk-go-v2 often requires a pointer to a string which is easier to acqurie with a variable.

Functions

func NewClient

func NewClient(connectionString string) *s3.Client

NewClient creates a new Client using the provided connection string. The connection string must be a valid URL in the format: http://key:secret@s3:9000. For MinIO, the key and secret are the username and password respectively. It panics if the connection string is not a valid URL.

func Setup

func Setup(ctx context.Context, connectionString string) error

Setup shouldn't be used with AWS as is because it doesn't specify the region. See NewClient for connection string format and panic conditions.