session

Documentation

Index

• func FieldSpecs() docs.FieldSpecs
• type Config
  • func NewConfig() Config
  • func (c Config) GetSession(opts ...func(*aws.Config)) (*session.Session, error)
• type CredentialsConfig

Functions

func FieldSpecs

func FieldSpecs() docs.FieldSpecs

FieldSpecs returns documentation specs for AWS session fields.

Types

type Config

type Config struct {
	Credentials CredentialsConfig `json:"credentials" yaml:"credentials"`
	Endpoint    string            `json:"endpoint" yaml:"endpoint"`
	Region      string            `json:"region" yaml:"region"`
}

Config contains configuration fields for an AWS session. This config is common across any AWS components.

func NewConfig

func NewConfig() Config

NewConfig returns a Config with default values.

func (Config) GetSession

func (c Config) GetSession(opts ...func(*aws.Config)) (*session.Session, error)

GetSession attempts to create an AWS session based on Config.

type CredentialsConfig

type CredentialsConfig struct {
	Profile    string `json:"profile" yaml:"profile"`
	ID         string `json:"id" yaml:"id"`
	Secret     string `json:"secret" yaml:"secret"`
	Token      string `json:"token" yaml:"token"`
	Role       string `json:"role" yaml:"role"`
	ExternalID string `json:"role_external_id" yaml:"role_external_id"`
}

CredentialsConfig contains configuration params for AWS credentials.