Help us shape the future of Go! Take the 2026 Go Developer Survey

param

package
v1.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2026 License: MIT Imports: 28 Imported by: 0

Documentation

Overview

Package param provides CLI commands for AWS SSM Parameter Store. command.go is this package's subject: the aws param command group it assembles, together with the vocabulary its sibling files share. Hence core.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Command

func Command() *cli.Command

Command returns the param command with all subcommands.

func CreateCommand added in v1.10.0

func CreateCommand() *cli.Command

CreateCommand returns the create command.

func DeleteCommand added in v1.10.0

func DeleteCommand() *cli.Command

DeleteCommand returns the delete command.

func DiffCommand

func DiffCommand() *cli.Command

DiffCommand returns the SSM Parameter Store diff command.

func ListCommand

func ListCommand() *cli.Command

ListCommand returns the SSM Parameter Store list command.

func LogCommand

func LogCommand() *cli.Command

LogCommand returns the SSM Parameter Store log command.

func NewDiffPresenter

func NewDiffPresenter(reader provider.Reader, spec1, spec2 *version.NumericSpec) generic.DiffPresenter

NewDiffPresenter builds a param diff presenter over the given reader and specs. It is exported for the shared golden-output test harness.

func NewLogPresenter

func NewLogPresenter(reader provider.Reader, req generic.LogRequest) generic.LogPresenter

NewLogPresenter builds a param log presenter over the given reader and request. It is exported for the shared golden-output test harness.

func NewShowPresenter

func NewShowPresenter(reader provider.Reader, spec *version.NumericSpec) generic.ShowPresenter

NewShowPresenter builds a param show presenter over the given reader and spec. It is exported for the shared golden-output test harness.

func ShowCommand

func ShowCommand() *cli.Command

ShowCommand returns the SSM Parameter Store show command.

func TagCommand

func TagCommand() *cli.Command

TagCommand returns the SSM Parameter Store tag command.

func UntagCommand

func UntagCommand() *cli.Command

UntagCommand returns the SSM Parameter Store untag command.

func UpdateCommand added in v1.10.0

func UpdateCommand() *cli.Command

UpdateCommand returns the update command.

Types

type CreateOptions added in v1.10.0

type CreateOptions struct {
	Name        string
	Value       string
	Type        string
	Description string
	// ParamOpts holds the raw AWS-specific option flag values (tier, data
	// type, allowed pattern, policies). Empty fields contribute no option.
	ParamOpts WriteOptionFlags
}

CreateOptions holds the options for the create command.

type CreateRunner added in v1.10.0

type CreateRunner struct {
	UseCase *param.CreateUseCase
	Stdout  io.Writer
	Stderr  io.Writer
}

CreateRunner executes the create command.

func (*CreateRunner) Run added in v1.10.0

func (r *CreateRunner) Run(ctx context.Context, opts CreateOptions) error

Run executes the create command.

type DeleteOptions added in v1.10.0

type DeleteOptions struct {
	Name string
}

DeleteOptions holds the options for the delete command.

type DeleteRunner added in v1.10.0

type DeleteRunner struct {
	UseCase *param.DeleteUseCase
	Stdout  io.Writer
	Stderr  io.Writer
}

DeleteRunner executes the delete command.

func (*DeleteRunner) Run added in v1.10.0

func (r *DeleteRunner) Run(ctx context.Context, opts DeleteOptions) error

Run executes the delete command.

type UpdateOptions added in v1.10.0

type UpdateOptions struct {
	Name        string
	Value       string
	Type        string
	Description string
	// PreserveType keeps the parameter's existing type when neither --type nor
	// --secure was given, so a value-only update never downgrades a
	// SecureString/StringList to String. When true, Type is ignored.
	PreserveType bool
	// ParamOpts holds the raw AWS-specific option flag values (tier, data
	// type, allowed pattern, policies). Empty fields contribute no option.
	ParamOpts WriteOptionFlags
}

UpdateOptions holds the options for the update command.

type UpdateRunner added in v1.10.0

type UpdateRunner struct {
	UseCase *param.UpdateUseCase
	Stdout  io.Writer
	Stderr  io.Writer
}

UpdateRunner executes the update command.

func (*UpdateRunner) Run added in v1.10.0

func (r *UpdateRunner) Run(ctx context.Context, opts UpdateOptions) error

Run executes the update command.

type WriteOptionFlags added in v1.10.0

type WriteOptionFlags struct {
	Tier           string
	DataType       string
	AllowedPattern string
	Policies       string
}

WriteOptionFlags holds the raw flag values for the provider-specific param options.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL