ssmparameterresolver

Documentation

Overview

Package ssmparameterresolver contains types and methods for resolving SSM Parameter references.

Package ssmparameterresolver contains types and methods for resolving SSM Parameter references.

Package ssmparameterresolver contains types and methods for resolving SSM Parameter references.

Index

• func ExtractParametersFromText(service ISsmParameterService, log log.T, input string, options ResolveOptions) (map[string]SsmParameterInfo, error)
• func ResolveParameterReferenceList(service ISsmParameterService, log log.T, parameterReferences []string, ...) (map[string]SsmParameterInfo, error)
• func ResolveParametersInText(service ISsmParameterService, log log.T, input string, options ResolveOptions) (string, error)
• type ISsmParameterService
• type ResolveOptions
• type SsmParameterInfo
• type SsmParameterService
  • func NewService() (service SsmParameterService)

Functions

func ExtractParametersFromText

func ExtractParametersFromText(
	service ISsmParameterService,
	log log.T,
	input string,
	options ResolveOptions) (map[string]SsmParameterInfo, error)

ExtractParametersFromText takes text document and resolves all parameters in it according to ResolveOptions. It will return a map of (parameter references) to SsmParameterInfo.

func ResolveParameterReferenceList

func ResolveParameterReferenceList(
	service ISsmParameterService,
	log log.T,
	parameterReferences []string,
	options ResolveOptions) (map[string]SsmParameterInfo, error)

ResolveParameterReferenceList takes a list of SSM parameter references, resolves them according to ResolveOptions and returns a map of (parameter references) to SsmParameterInfo.

func ResolveParametersInText

func ResolveParametersInText(
	service ISsmParameterService,
	log log.T,
	input string,
	options ResolveOptions) (string, error)

ResolveParametersInText takes text document, resolves all parameters in it according to ResolveOptions and returns resolved document.

Types

type ISsmParameterService

type ISsmParameterService interface {
	// contains filtered or unexported methods
}

ISsmParameterService interface represents SSM Parameter service API.

type ResolveOptions

type ResolveOptions struct {
	IgnoreSecureParameters bool
}

ResolveOptions structure represents a set of options for the parameter resolution. At this time it has only one flag IgnoreSecureParameters if IgnoreSecureParameters == true the parameters prefixed with ssm-secure: will not be resolved.

type SsmParameterInfo

type SsmParameterInfo struct {
	Name  string
	Type  string
	Value string
}

SsmParameterInfo structure represents a resolved SSM Parameter.

type SsmParameterService

type SsmParameterService struct {
	ISsmParameterService
	// contains filtered or unexported fields
}

SsmParameterService structure represents an SSM parameter service and implements ISsmParameterService interface.

func NewService

func NewService() (service SsmParameterService)

NewService creates an instance of the SsmParameterService.