s3

Documentation

Index

• Variables
• func EnsureBucketExists(ctx context.Context, client *s3.Client, bc *BucketConfig) error
• func EnsureBucketExistsByName(ctx context.Context, client *s3.Client, name, region string) error
• type AwsConfig
• type Bucket
  • func ProvideBucket(ctx context.Context, bc *BucketConfig, deps ExtensionDeps) (*Bucket, error)
  • func (b Bucket) GetObject(ctx context.Context, key string) (*s3.GetObjectOutput, error)
  • func (b Bucket) PutObject(ctx context.Context, key string, body io.Reader, opts ...PutObjectOpt) (*s3.PutObjectOutput, error)
• type BucketConfig
  • func (*BucketConfig) Descriptor() ([]byte, []int)
  • func (x *BucketConfig) GetBucketName() string
  • func (x *BucketConfig) GetRegion() string
  • func (*BucketConfig) ProtoMessage()
  • func (x *BucketConfig) ProtoReflect() protoreflect.Message
  • func (x *BucketConfig) Reset()
  • func (x *BucketConfig) String() string
• type ExtensionDeps
• type PutObjectOpt
  • func WithExpiration(expiration time.Time) PutObjectOpt

Variables

var (
	Package__eoj2dq = &core.Package{
		PackageName: "namespacelabs.dev/foundation/universe/aws/s3",
	}

	Provider__eoj2dq = core.Provider{
		Package:     Package__eoj2dq,
		Instantiate: makeDeps__eoj2dq,
	}
)

var File_universe_aws_s3_provider_proto protoreflect.FileDescriptor

Functions

func EnsureBucketExists

func EnsureBucketExists(ctx context.Context, client *s3.Client, bc *BucketConfig) error

EnsureBucketExists creates the requested bucket before it is used.

func EnsureBucketExistsByName

func EnsureBucketExistsByName(ctx context.Context, client *s3.Client, name, region string) error

Types

type AwsConfig

type AwsConfig struct {
	Region, CredentialsPath string
}

type Bucket

type Bucket struct {
	BucketName string
	S3Client   *s3.Client
}

func ProvideBucket

func ProvideBucket(ctx context.Context, bc *BucketConfig, deps ExtensionDeps) (*Bucket, error)

func (Bucket) GetObject

func (b Bucket) GetObject(ctx context.Context, key string) (*s3.GetObjectOutput, error)

func (Bucket) PutObject

func (b Bucket) PutObject(ctx context.Context, key string, body io.Reader, opts ...PutObjectOpt) (*s3.PutObjectOutput, error)

type BucketConfig

type BucketConfig struct {
	Region     string `protobuf:"bytes,1,opt,name=region,proto3" json:"region,omitempty"`
	BucketName string `protobuf:"bytes,2,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// contains filtered or unexported fields
}

func (*BucketConfig) Descriptor

func (*BucketConfig) Descriptor() ([]byte, []int)

Deprecated: Use BucketConfig.ProtoReflect.Descriptor instead.

func (*BucketConfig) GetBucketName

func (x *BucketConfig) GetBucketName() string

func (*BucketConfig) GetRegion

func (x *BucketConfig) GetRegion() string

func (*BucketConfig) ProtoMessage

func (*BucketConfig) ProtoMessage()

func (*BucketConfig) ProtoReflect

func (x *BucketConfig) ProtoReflect() protoreflect.Message

func (*BucketConfig) Reset

func (x *BucketConfig) Reset()

func (*BucketConfig) String

func (x *BucketConfig) String() string

type ExtensionDeps

type ExtensionDeps struct {
	ClientFactory  client.ClientFactory
	ReadinessCheck core.Check
}

Dependencies that are instantiated once for the lifetime of the extension.

type PutObjectOpt

type PutObjectOpt func(*s3.PutObjectInput)

func WithExpiration

func WithExpiration(expiration time.Time) PutObjectOpt