aws

package

v0.0.0-...-c2b5c71 Latest Latest Go to latest Published: Dec 12, 2023 License: Apache-2.0 Imports: 12 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

Repository

github.com/app-sre/go-qontract-reconcile

Documentation ¶

Overview ¶

Package aws provides a mockable client for interacting with AWS. revive:disable:unexported-return

Index ¶

func NewClient(ctx context.Context, creds *Credentials) (*awsClient, error)
type Client
type Credentials
- func GetAwsCredentials(ctx context.Context, vc *vault.Client) (*Credentials, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewClient ¶

func NewClient(ctx context.Context, creds *Credentials) (*awsClient, error)

NewClient returns a new AWS client, that implements the Client interface.

Types ¶

type Client ¶

type Client interface {
	//S3
	GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)
	HeadObject(ctx context.Context, params *s3.HeadObjectInput, optFns ...func(*s3.Options)) (*s3.HeadObjectOutput, error)
	PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)
	DeleteObject(ctx context.Context, params *s3.DeleteObjectInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectOutput, error)
	ListObjectsV2(ctx context.Context, params *s3.ListObjectsV2Input, optFns ...func(*s3.Options)) (*s3.ListObjectsV2Output, error)
}

Client is a wrapper object for actual AWS SDK clients to allow for easier testing.

type Credentials ¶

type Credentials struct {
	AccessKeyID     string
	SecretAccessKey string
	DefaultRegion   string
}

Credentials holds the AWS credentials that can be used with awsclient.NewClient

func GetAwsCredentials ¶

func GetAwsCredentials(ctx context.Context, vc *vault.Client) (*Credentials, error)

GetAwsCredentials returns AWS credentials from the environment or from vault

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock Package mock is a generated GoMock package.	Package mock is a generated GoMock package.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL