s3

README

s3 - Blobs in a Simple Storage System (S3)

Synopsis

type: s3/v1

Provided blobs use the following media type: attribute mediaType

Description

This method implements the access of a blob stored in an S3 bucket.

Specification Versions

Supported specification version is v1

Version v1

The type specific specification fields are:

• region (optional) string

  OCI repository reference (this artifact name used to store the blob).

• bucket string

  The name of the S3 bucket containing the blob

• key string

  The key of the desired blob

Documentation

Index

• Constants
• func AddConfig(opts flagsets.ConfigOptions, config flagsets.Config) error
• func ConfigHandler() flagsets.ConfigOptionTypeSetHandler
• type AccessSpec
  • func New(region, bucket, key, version, mediaType string, ...) *AccessSpec
  • func (a *AccessSpec) AccessMethod(c accspeccpi.ComponentVersionAccess) (accspeccpi.AccessMethod, error)
  • func (a *AccessSpec) Describe(ctx accspeccpi.Context) string
  • func (a *AccessSpec) GlobalAccessSpec(ctx accspeccpi.Context) accspeccpi.AccessSpec
  • func (_ *AccessSpec) IsLocal(accspeccpi.Context) bool
  • func (a AccessSpec) MarshalJSON() ([]byte, error)
• type AccessSpecV1
• type AccessSpecV2

Constants

const (
	Type = "s3"

	LegacyType   = "S3"
	LegacyTypeV1 = LegacyType + runtime.VersionSeparator + "v1"
)

Type is the access type of S3 registry.

const LegacyTypeV2 = LegacyType + runtime.VersionSeparator + "v2"

const TypeV1 = Type + runtime.VersionSeparator + "v1"

const TypeV2 = Type + runtime.VersionSeparator + "v2"

Functions

func AddConfig

func AddConfig(opts flagsets.ConfigOptions, config flagsets.Config) error

func ConfigHandler

func ConfigHandler() flagsets.ConfigOptionTypeSetHandler

Types

type AccessSpec

type AccessSpec struct {
	runtime.InternalVersionedTypedObject[accspeccpi.AccessSpec]

	// Region needs to be set even though buckets are global.
	// We can't assume that there is a default region setting sitting somewhere.
	// +optional
	Region string
	// Bucket where the s3 object is located.
	Bucket string
	// Key of the object to look for. This value will be used together with Bucket and Version to form an identity.
	Key string
	// Version of the object.
	// +optional
	Version string
	// MediaType defines the mime type of the object to download.
	// +optional
	MediaType string
	// contains filtered or unexported fields
}

AccessSpec describes the access for a S3 registry.

func New

func New(region, bucket, key, version, mediaType string, downloader ...downloader.Downloader) *AccessSpec

New creates a new GitHub registry access spec version v1.

func (*AccessSpec) AccessMethod

func (a *AccessSpec) AccessMethod(c accspeccpi.ComponentVersionAccess) (accspeccpi.AccessMethod, error)

func (*AccessSpec) Describe

func (a *AccessSpec) Describe(ctx accspeccpi.Context) string

func (*AccessSpec) GlobalAccessSpec

func (a *AccessSpec) GlobalAccessSpec(ctx accspeccpi.Context) accspeccpi.AccessSpec

func (*AccessSpec) IsLocal

func (_ *AccessSpec) IsLocal(accspeccpi.Context) bool

func (AccessSpec) MarshalJSON

func (a AccessSpec) MarshalJSON() ([]byte, error)

type AccessSpecV1

type AccessSpecV1 struct {
	runtime.ObjectVersionedType `json:",inline"`

	// Region needs to be set even though buckets are global.
	// We can't assume that there is a default region setting sitting somewhere.
	// +optional
	Region string `json:"region,omitempty"`
	// Bucket where the s3 object is located.
	Bucket string `json:"bucket"`
	// Key of the object to look for. This value will be used together with Bucket and Version to form an identity.
	Key string `json:"key"`
	// Version of the object.
	// +optional
	Version string `json:"version,omitempty"`
	// MediaType defines the mime type of the object to download.
	// +optional
	MediaType string `json:"mediaType,omitempty"`
}

AccessSpecV1 describes the v1 format.

type AccessSpecV2

type AccessSpecV2 struct {
	runtime.ObjectVersionedType `json:",inline"`

	// Region needs to be set even though buckets are global.
	// We can't assume that there is a default region setting sitting somewhere.
	// +optional
	Region string `json:"region,omitempty"`
	// Bucket where the s3 object is located.
	Bucket string `json:"bucketName"`
	// Key of the object to look for. This value will be used together with Bucket and Version to form an identity.
	Key string `json:"objectKey"`
	// Version of the object.
	// +optional
	Version string `json:"version,omitempty"`
	// MediaType defines the mime type of the object to download.
	// +optional
	MediaType string `json:"mediaType,omitempty"`
}

AccessSpecV2 describes the v2 format.