s3

Documentation

Index

• func CanRunS3Test() bool
• func DefaultAWSConfig() (aws.Config, error)
• func HasValidCredentials(config aws.Config) bool
• func IsAWSEndpoint(endpoint string) bool
• type ClientProvider
  • func NewClientProvider(params ClientProviderParams) *ClientProvider
  • func (s *ClientProvider) GetClient(endpoint, region string) *ClientWrapper
  • func (s *ClientProvider) GetConfig() aws.Config
  • func (s *ClientProvider) IsInstalled() bool
• type ClientProviderParams
• type ClientWrapper
  • func (c *ClientWrapper) IsAWSEndpoint() bool
  • func (c *ClientWrapper) PresignClient() *s3.PresignClient
• type PreSignedResultSpec
  • func DecodePreSignedResultSpec(spec *models.SpecConfig) (PreSignedResultSpec, error)
  • func (c PreSignedResultSpec) ToMap() map[string]interface{}
  • func (c PreSignedResultSpec) Validate() error
• type PublisherSpec
  • func DecodePublisherSpec(spec *models.SpecConfig) (PublisherSpec, error)
  • func (c PublisherSpec) ToMap() map[string]interface{}
  • func (c PublisherSpec) Validate() error
• type ResultSigner
  • func NewResultSigner(params ResultSignerParams) *ResultSigner
  • func (signer *ResultSigner) Transform(ctx context.Context, spec *models.SpecConfig) error
• type ResultSignerParams
• type SourceSpec
  • func DecodeSourceSpec(spec *models.SpecConfig) (SourceSpec, error)
  • func (c SourceSpec) ToMap() map[string]interface{}
  • func (c SourceSpec) Validate() error

Functions

func CanRunS3Test

func CanRunS3Test() bool

func DefaultAWSConfig

func DefaultAWSConfig() (aws.Config, error)

func HasValidCredentials

func HasValidCredentials(config aws.Config) bool

HasValidCredentials returns true if the AWS config has valid credentials.

func IsAWSEndpoint

func IsAWSEndpoint(endpoint string) bool

IsAWSEndpoint checks if the given S3 endpoint URL is an AWS endpoint by its suffix. If the endpoint is empty, it is considered an AWS endpoint.

Types

type ClientProvider

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

func NewClientProvider

func NewClientProvider(params ClientProviderParams) *ClientProvider

func (*ClientProvider) GetClient

func (s *ClientProvider) GetClient(endpoint, region string) *ClientWrapper

func (*ClientProvider) GetConfig

func (s *ClientProvider) GetConfig() aws.Config

GetConfig returns the AWS config used by the client provider.

func (*ClientProvider) IsInstalled

func (s *ClientProvider) IsInstalled() bool

IsInstalled returns true if the S3 client is installed.

type ClientProviderParams

type ClientProviderParams struct {
	AWSConfig aws.Config
}

type ClientWrapper

type ClientWrapper struct {
	S3 *s3.Client

	Downloader *manager.Downloader
	Uploader   *manager.Uploader
	Endpoint   string
	Region     string
	// contains filtered or unexported fields
}

func (*ClientWrapper) IsAWSEndpoint

func (c *ClientWrapper) IsAWSEndpoint() bool

IsAWSEndpoint checks if the given S3 endpoint URL is an AWS endpoint by its suffix.

func (*ClientWrapper) PresignClient

func (c *ClientWrapper) PresignClient() *s3.PresignClient

type PreSignedResultSpec

type PreSignedResultSpec struct {
	SourceSpec
	PreSignedURL string
}

func DecodePreSignedResultSpec

func DecodePreSignedResultSpec(spec *models.SpecConfig) (PreSignedResultSpec, error)

func (PreSignedResultSpec) ToMap

func (c PreSignedResultSpec) ToMap() map[string]interface{}

func (PreSignedResultSpec) Validate

func (c PreSignedResultSpec) Validate() error

type PublisherSpec

type PublisherSpec struct {
	Bucket   string `json:"Bucket"`
	Key      string `json:"Key"`
	Endpoint string `json:"Endpoint"`
	Region   string `json:"Region"`
	Compress bool   `json:"Compress"`
}

func DecodePublisherSpec

func DecodePublisherSpec(spec *models.SpecConfig) (PublisherSpec, error)

func (PublisherSpec) ToMap

func (c PublisherSpec) ToMap() map[string]interface{}

func (PublisherSpec) Validate

func (c PublisherSpec) Validate() error

type ResultSigner

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

func NewResultSigner

func NewResultSigner(params ResultSignerParams) *ResultSigner

func (*ResultSigner) Transform

func (signer *ResultSigner) Transform(ctx context.Context, spec *models.SpecConfig) error

Transform signs S3 SourceSpec with a pre-signed URL.

type ResultSignerParams

type ResultSignerParams struct {
	ClientProvider *ClientProvider
	Expiration     time.Duration
}

type SourceSpec

type SourceSpec struct {
	Bucket         string
	Key            string
	Filter         string
	Region         string
	Endpoint       string
	VersionID      string
	ChecksumSHA256 string
}

func DecodeSourceSpec

func DecodeSourceSpec(spec *models.SpecConfig) (SourceSpec, error)

func (SourceSpec) ToMap

func (c SourceSpec) ToMap() map[string]interface{}

func (SourceSpec) Validate

func (c SourceSpec) Validate() error