s3

package

v0.0.0-...-c2ba8ab Latest Latest Go to latest Published: May 28, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

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

This section is empty.

This section is empty.

This section is empty.

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

Client is an S3 client and configured Uploader.

func NewClient(config *Config) (*Client, error)

NewClient constructs a new S3 backup upload provider client that can upload/download backups to any S3 compliant API e.g. OCI, AWS, GCE.

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

Config holds the credentials required to authenticate with an S3 compliant API.

func NewConfig(storage *v1.Storage, creds map[string]string) *Config

NewConfig creates an S3 configuration based on the input parameters.

func (c *Config) Validate() error

Validate checks the required S3 configuration parameters are set.

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

Provider is storage implementation of provider.Interface.

func NewStorage(config *v1.Storage, creds map[string]string) (*Provider, error)

NewStorage creates a provider capable of storing and retreiving objects against the specified 's3' storage configuration and credentials.

func (p *Provider) Retrieve(key string) (io.ReadCloser, error)

Retrieve will provide a data stream on the specified object from S3.

func (p *Provider) Store(key string, body io.ReadCloser) error

Store will upload the content of the data stream to S3.