forgelib

Documentation

Index

• func AssumeRole(roleArn string) error
• func AssumeRoleWithMFA(roleArn, mfaToken, mfaSerial string) error
• func UnassumeAllRoles()
• type DeployOut
• type Stack
  • func (s *Stack) Deploy() (output DeployOut, err error)
  • func (s *Stack) Destroy() (err error)
  • func (s *Stack) GetLastEventTime() (*time.Time, error)
  • func (s *Stack) GetStackInfo() (err error)
  • func (s *Stack) ListEvents(after *time.Time) (events []*cloudformation.StackEvent, err error)

Functions

func AssumeRole

func AssumeRole(roleArn string) error

AssumeRole will change your credentials for Forge to those of an assumed role as specific by the ARN specified in the arguments to AssumeRole

func AssumeRoleWithMFA

func AssumeRoleWithMFA(roleArn, mfaToken, mfaSerial string) error

AssumeRoleWithMFA performs the same function as AssumeRole, but accepts an MFA token as well. A blank value for mfaSerial will attempt to auto-detect the serial of the users MFA

func UnassumeAllRoles

func UnassumeAllRoles()

UnassumeAllRoles will change your credentials back to their original state after using AssumeRole

Types

type DeployOut

type DeployOut struct {
	Message string
}

DeployOut provides a controlled format for information to be passed out of the Deploy function

type Stack

type Stack struct {
	ParameterBodies       []string
	ParameterOverrides    map[string]string
	ProjectManifest       string
	CfnRoleName           string
	StackID               string
	StackInfo             *cloudformation.Stack
	StackName             string
	StackPolicyBody       string
	TagsBody              string
	TemplateBody          string
	TerminationProtection bool
}

Stack represents the attributes of a stack deployment, including the AWS parameters, and local resources which represent what needs to be deployed

func (*Stack) Deploy

func (s *Stack) Deploy() (output DeployOut, err error)

Deploy will create or update the stack (depending on its current state)

func (*Stack) Destroy

func (s *Stack) Destroy() (err error)

Destroy will delete the stack

func (*Stack) GetLastEventTime

func (s *Stack) GetLastEventTime() (*time.Time, error)

GetLastEventTime will get the time of the last event for the stack

func (*Stack) GetStackInfo

func (s *Stack) GetStackInfo() (err error)

GetStackInfo populates the StackInfo for this object from the existing stack found in the environment

func (*Stack) ListEvents

func (s *Stack) ListEvents(after *time.Time) (events []*cloudformation.StackEvent, err error)

ListEvents will get all events for a stack and sort them in chronological order within a time range