ssm

Documentation

Overview

Package ssm provides a client to make API requests to Amazon Systems Manager.

Index

• type ErrParameterAlreadyExists
  • func (e *ErrParameterAlreadyExists) Error() string
• type PutSecretInput
• type PutSecretOutput
• type SSM
  • func New(s *session.Session) *SSM
  • func (s *SSM) GetSecretValue(ctx context.Context, name string) (string, error)
  • func (s *SSM) PutSecret(in PutSecretInput) (*PutSecretOutput, error)

Types

type ErrParameterAlreadyExists

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

ErrParameterAlreadyExists occurs when the parameter with name already existed.

func (*ErrParameterAlreadyExists) Error

func (e *ErrParameterAlreadyExists) Error() string

type PutSecretInput

type PutSecretInput struct {
	Name      string
	Value     string
	Overwrite bool
	Tags      map[string]string
}

PutSecretInput contains fields needed to create or update a secret.

type PutSecretOutput

type PutSecretOutput ssm.PutParameterOutput

PutSecretOutput wraps an ssm PutParameterOutput struct.

type SSM

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

SSM wraps an AWS SSM client.

func New

func New(s *session.Session) *SSM

New returns a SSM service configured against the input session.

func (*SSM) GetSecretValue

func (s *SSM) GetSecretValue(ctx context.Context, name string) (string, error)

GetSecretValue retrieves the value of a parameter from AWS Systems Manager Parameter Store. It takes the name of the parameter as input and returns the corresponding value as a string.

func (*SSM) PutSecret

func (s *SSM) PutSecret(in PutSecretInput) (*PutSecretOutput, error)

PutSecret tries to create the secret, and overwrites it if the secret exists and that `Overwrite` is true. ErrParameterAlreadyExists is returned if the secret exists and `Overwrite` is false.