aws

Documentation

Index

• Constants
• type Action
  • func (a Action) GetSteps() []builder.ExecutableStep
  • func (a Action) MakeSteps() interface{}
  • func (a *Action) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Instruction
• type Mixin
  • func New() *Mixin
  • func (m *Mixin) Build() error
  • func (m *Mixin) Execute(ctx context.Context) error
  • func (m *Mixin) PrintSchema()
  • func (m *Mixin) PrintVersion(opts version.Options) error
  • func (m *Mixin) SetUserAgent()
  • func (m *Mixin) UserAgent() string
  • func (m *Mixin) Version() mixin.Metadata
• type Output
  • func (o Output) GetJsonPath() string
  • func (o Output) GetName() string
• type Step
  • func (s Step) GetArguments() []string
  • func (s Step) GetCommand() string
  • func (s Step) GetFlags() builder.Flags
  • func (s Step) GetOutputs() []builder.Output
  • func (s Step) GetWorkingDir() string
  • func (s Step) SuppressesOutput() bool
• type TestMixin
  • func NewTestMixin(t *testing.T) *TestMixin

Constants

const AWS_EXECUTION_ENV = "AWS_EXECUTION_ENV"

AWS_EXECUTION_ENV is the environment variable used by the aws CLI to set the user agent string.

Types

type Action

type Action struct {
	Name  string
	Steps []Step // using UnmarshalYAML so that we don't need a custom type per action
}

func (Action) GetSteps

func (a Action) GetSteps() []builder.ExecutableStep

func (Action) MakeSteps

func (a Action) MakeSteps() interface{}

MakeSteps builds a slice of Steps for data to be unmarshaled into.

func (*Action) UnmarshalYAML

func (a *Action) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML takes any yaml in this form ACTION: - aws: ... and puts the steps into the Action.Steps field

type Instruction

type Instruction struct {
	Description    string        `yaml:"description"`
	Service        string        `yaml:"service"`
	Operation      string        `yaml:"operation"`
	Arguments      []string      `yaml:"arguments,omitempty"`
	Flags          builder.Flags `yaml:"flags,omitempty"`
	Outputs        []Output      `yaml:"outputs,omitempty"`
	SuppressOutput bool          `yaml:"suppress-output,omitempty"`
}

type Mixin

type Mixin struct {
	// Config is a specialized context with additional runtime settings.
	runtime.RuntimeConfig
}

func New

func New() *Mixin

New aws mixin client, initialized with useful defaults.

func (*Mixin) Build

func (m *Mixin) Build() error

Build will generate the necessary Dockerfile lines for an invocation image using this mixin

func (*Mixin) Execute

func (m *Mixin) Execute(ctx context.Context) error

func (*Mixin) PrintSchema

func (m *Mixin) PrintSchema()

func (*Mixin) PrintVersion

func (m *Mixin) PrintVersion(opts version.Options) error

func (*Mixin) SetUserAgent

func (m *Mixin) SetUserAgent()

func (*Mixin) UserAgent

func (m *Mixin) UserAgent() string

func (*Mixin) Version

func (m *Mixin) Version() mixin.Metadata

type Output

type Output struct {
	Name     string `yaml:"name"`
	JsonPath string `yaml:"jsonPath"`
}

func (Output) GetJsonPath

func (o Output) GetJsonPath() string

func (Output) GetName

func (o Output) GetName() string

type Step

type Step struct {
	Instruction `yaml:"aws"`
}

func (Step) GetArguments

func (s Step) GetArguments() []string

func (Step) GetCommand

func (s Step) GetCommand() string

func (Step) GetFlags

func (s Step) GetFlags() builder.Flags

func (Step) GetOutputs

func (s Step) GetOutputs() []builder.Output

func (Step) GetWorkingDir

func (s Step) GetWorkingDir() string

func (Step) SuppressesOutput

func (s Step) SuppressesOutput() bool

type TestMixin

type TestMixin struct {
	*Mixin
	TestContext *portercontext.TestContext
}

func NewTestMixin

func NewTestMixin(t *testing.T) *TestMixin

NewTestMixin initializes a mixin test client, with the output buffered, and an in-memory file system.