awsstore

package
v1.84.3 Latest Latest
Warning

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

Go to latest
Published: Jun 26, 2025 License: BSD-3-Clause Imports: 14 Imported by: 3

Documentation

Overview

Package awsstore contains an ipn.StateStore implementation using AWS SSM.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(_ logger.Logf, ssmARN string, opts ...Option) (ipn.StateStore, error)

New returns a new ipn.StateStore using the AWS SSM storage location given by ssmARN.

Note that we store the entire store in a single parameter key, therefore if the state is above 8kb, it can cause Tailscaled to only only store new state in-memory and restarting Tailscaled can fail until you delete your state from the AWS Parameter Store.

If you want to specify an optional KMS key, pass one or more Option objects, e.g. awsstore.WithKeyID("alias/my-key").

Types

type Option added in v1.82.0

type Option func(*storeOptions)

Option defines a functional option type for configuring awsStore.

func ParseARNAndOpts added in v1.82.0

func ParseARNAndOpts(arg string) (ssmARN string, opts []Option, err error)

ParseARNAndOpts parses an ARN and optional URL-encoded parameters from arg.

func WithKeyID added in v1.82.0

func WithKeyID(kmsKey string) Option

WithKeyID sets the KMS key to be used for encryption. It can be a KeyID, an alias ("alias/my-key"), or a full ARN.

If kmsKey is empty, the Option is a no-op.

Jump to

Keyboard shortcuts

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