aws

Documentation

Overview

Package aws implements wrappers for AWS API calls.

Index

• func New(cfg *Config) (ss *session.Session, stsOutput *sts.GetCallerIdentityOutput, ...)
• func NewV2(cfg *Config) (awsCfg aws_v2.Config, err error)
• func Regions(partition string) (regions map[string]endpoints.Region, err error)
• type AMI
  • func FetchAMI(sa ssmiface.SSMAPI, key string) (*AMI, error)
• type Config

Functions

func New

func New(cfg *Config) (ss *session.Session, stsOutput *sts.GetCallerIdentityOutput, awsCredsPath string, err error)

New creates a new AWS session. Specify a custom endpoint for tests.

func NewV2

func NewV2(cfg *Config) (awsCfg aws_v2.Config, err error)

NewV2 creates a new AWS session. Specify a custom endpoint for tests.

func Regions

func Regions(partition string) (regions map[string]endpoints.Region, err error)

Regions returns the set of regions for the given partition. It maps from region ID (e.g. us-west-2) to its region object.

Types

type AMI

type AMI struct {
	ARN              string    `json:"arn"`
	Name             string    `json:"name"`
	Version          int64     `json:"version"`
	LastModifiedDate time.Time `json:"last-modified-date"`
	SchemaVersion    string    `json:"schema_version,omitempty"`
	ImageID          string    `json:"image_id,omitempty"`
	ImageName        string    `json:"image_name,omitempty"`
}

AMI represents AMI.

func FetchAMI

func FetchAMI(sa ssmiface.SSMAPI, key string) (*AMI, error)

FetchAMI gets AMI from the SSM parameter key. Automated "aws ssm get-parameter --name ...".

type Config

type Config struct {
	// Logger is the log object.
	Logger *zap.Logger

	// DebugAPICalls is true to log all AWS API call debugging messages.
	DebugAPICalls bool

	// Partition is an AWS partition (default "aws").
	Partition string
	// Region is a separate AWS geographic area for EKS service.
	// Each AWS Region has multiple, isolated locations known as Availability Zones.
	Region string

	// ResolverURL is a custom resolver URL.
	ResolverURL string
	// SigningName is the API signing name.
	SigningName string
}

Config defines a top-level AWS API configuration to create a session.