config

Documentation

Index

• Constants
• Variables
• type S3Cli
  • func NewFromReader(reader io.Reader) (S3Cli, error)
  • func (c *S3Cli) S3Endpoint() string
  • func (c *S3Cli) UseRegion() bool

Constants

const EmptyRegion = " "

EmptyRegion is required to allow us to use the AWS SDK against S3 compatible blobstores which do not have the concept of a region

const NoneCredentialsSource = "none"

NoneCredentialsSource specifies that credentials will be empty. The blobstore client operates in read only mode.

const StaticCredentialsSource = "static"

StaticCredentialsSource specifies that credentials will be supplied using access_key_id and secret_access_key

Variables

var AWSHostToRegion = map[string]string{
	"s3.amazonaws.com":            "us-east-1",
	"s3-external-1.amazonaws.com": "us-east-1",

	"s3.us-east-2.amazonaws.com": "us-east-2",
	"s3-us-east-2.amazonaws.com": "us-east-2",

	"s3-us-west-1.amazonaws.com": "us-west-1",
	"s3-us-west-2.amazonaws.com": "us-west-2",

	"s3.ca-central-1.amazonaws.com": "ca-central-1",
	"s3-ca-central-1.amazonaws.com": "ca-central-1",

	"s3-eu-west-1.amazonaws.com": "eu-west-1",
	"s3-eu-west-2.amazonaws.com": "eu-west-2",

	"s3.eu-central-1.amazonaws.com": "eu-central-1",
	"s3-eu-central-1.amazonaws.com": "eu-central-1",

	"s3.ap-south-1.amazonaws.com": "ap-south-1",
	"s3-ap-south-1.amazonaws.com": "ap-south-1",

	"s3-ap-southeast-1.amazonaws.com": "ap-southeast-1",
	"s3-ap-southeast-2.amazonaws.com": "ap-southeast-2",

	"s3-ap-northeast-1.amazonaws.com": "ap-northeast-1",
	"s3.ap-northeast-2.amazonaws.com": "ap-northeast-2",
	"s3-ap-northeast-2.amazonaws.com": "ap-northeast-2",

	"s3-sa-east-1.amazonaws.com": "sa-east-1",

	"s3.cn-north-1.amazonaws.com.cn": "cn-north-1",
}

Types

type S3Cli

type S3Cli struct {
	AccessKeyID          string `json:"access_key_id"`
	SecretAccessKey      string `json:"secret_access_key"`
	BucketName           string `json:"bucket_name"`
	FolderName           string `json:"folder_name"`
	CredentialsSource    string `json:"credentials_source"`
	Host                 string `json:"host"`
	Port                 int    `json:"port"` // 0 means no custom port
	Region               string `json:"region"`
	SSLVerifyPeer        bool   `json:"ssl_verify_peer"`
	UseSSL               bool   `json:"use_ssl"`
	SignatureVersion     int    `json:"signature_version,string"`
	ServerSideEncryption string `json:"server_side_encryption"`
	SSEKMSKeyID          string `json:"sse_kms_key_id"`
	UseV2SigningMethod   bool
	MultipartUpload      bool
}

The S3Cli represents configuration for the s3cli

func NewFromReader

func NewFromReader(reader io.Reader) (S3Cli, error)

NewFromReader returns a new s3cli configuration struct from the contents of reader. reader.Read() is expected to return valid JSON

func (*S3Cli) S3Endpoint

func (c *S3Cli) S3Endpoint() string

S3Endpoint returns the S3 URI to use if custom host information has been provided

func (*S3Cli) UseRegion

func (c *S3Cli) UseRegion() bool

UseRegion signals to users of the S3Cli whether to use Region information