config

package

v0.0.290 Latest Latest Go to latest Published: May 4, 2024 License: Apache-2.0 Imports: 6 Imported by: 25

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/cloudfoundry/bosh-s3cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AWSHostToRegion(host string) string
func AlicloudHostToRegion(host string) string
func Provider(host string) string
type S3Cli
- func NewFromReader(reader io.Reader) (S3Cli, error)
- func (c *S3Cli) S3Endpoint() string
- func (c *S3Cli) UseRegion() bool

Constants ¶

View Source

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

View Source

const NoneCredentialsSource = "none"

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

View Source

const StaticCredentialsSource = "static"

StaticCredentialsSource specifies that credentials will be supplied using access_key_id and secret_access_key

Variables ¶

This section is empty.

Functions ¶

func AWSHostToRegion ¶ added in v0.0.53

func AWSHostToRegion(host string) string

func AlicloudHostToRegion ¶ added in v0.0.65

func AlicloudHostToRegion(host string) string

func Provider ¶ added in v0.0.65

func Provider(host string) string

Provider returns one of (aws, alicloud, google) based on a host name. Returns "" if a known provider cannot be detected.

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"`
	AssumeRoleArn        string `json:"assume_role_arn"`
	MultipartUpload      bool   `json:"multipart_upload"`
	UseV2SigningMethod   bool
	HostStyle            bool   `json:"host_style"`
	SwiftAuthAccount     string `json:"swift_auth_account"`
	SwiftTempURLKey      string `json:"swift_temp_url_key"`
}

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

Source Files ¶

View all Source files

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