ssm

Documentation

Index

• type Param
  • func (p *Param) GetValue() (string, error)
  • func (p *Param) SetValue() (string, error)
  • func (p *Param) UpdateValue() (string, error)
• type SSM
  • func NewSSMClient() (*SSM, error)
  • func (s *SSM) Param(name string, decryption bool, overwrite bool, dataType string, ...) *Param

Types

type Param

type Param struct {
	// Get Param fields
	Name           string
	WithDecryption bool

	// update/insert param fields
	Overwrite bool   // set to true when updating param, dont set when inserting param
	DataType  string // can be text or aws:ec2:image
	Type      string //e.g SecureString
	Value     string // value of ssm parameter
	// contains filtered or unexported fields
}

Param struct

func (*Param) GetValue

func (p *Param) GetValue() (string, error)

GetValue Returns SSM parameter value

func (*Param) SetValue

func (p *Param) SetValue() (string, error)

SetValue Creates new SSM parameter

func (*Param) UpdateValue

func (p *Param) UpdateValue() (string, error)

UpdateValue Updates SSM parameter value

type SSM

type SSM struct {
	// contains filtered or unexported fields
}

SSM implements the SSM API interface.

func NewSSMClient

func NewSSMClient() (*SSM, error)

NewSSMClient Returns an SSM client

func (*SSM) Param

func (s *SSM) Param(name string, decryption bool, overwrite bool, dataType string, paramType string, value string) *Param

Param function creates the struct for querying the ssm parameter store name param is used to set the ssm key decryption param determine whither Return decrypted or encrypted values for secure string. is ignored for String and StringList overwrite param determine whither to overwrite existing value or not. used only with update value. dataType param specify data type. valid values are: text | aws:ec2:image paramType param specify data type. valid values are: String | StringList | SecureString value param specify the actual value for parameter