config

Documentation

Index

• Constants
• type Config

Constants

const (
	// ConfigKeyAWSAccessKeyID is the config name for AWS access secret key
	ConfigKeyAWSAccessKeyID = "aws.accessKeyId"

	// ConfigKeyAWSSecretAccessKey is the config name for AWS secret access key
	ConfigKeyAWSSecretAccessKey = "aws.secretAccessKey"

	// ConfigKeyAWSRegion is the config name for AWS region
	ConfigKeyAWSRegion = "aws.region"

	// ConfigKeyAWSBucket is the config name for AWS S3 bucket
	ConfigKeyAWSBucket = "aws.bucket"

	// ConfigKeyPrefix is the config name for S3 key prefix.
	ConfigKeyPrefix = "prefix"
)

Types

type Config

type Config struct {
	// AWS access key id.
	AWSAccessKeyID string `json:"aws.accessKeyId" validate:"required"`
	// AWS secret access key.
	AWSSecretAccessKey string `json:"aws.secretAccessKey" validate:"required"`
	// the AWS S3 bucket region
	AWSRegion string `json:"aws.region" validate:"required"`
	// the AWS S3 bucket name.
	AWSBucket string `json:"aws.bucket" validate:"required"`
	// the S3 key prefix.
	Prefix string
}

Config represents configuration needed for S3