awskms

Documentation

Index

• Constants
• func NewKmsDeprovision(c *kingpin.CmdClause) shared.Command
• func NewKmsEditKeyPolicy(c *kingpin.CmdClause) shared.Command
• func NewKmsGrantsCreate(c *kingpin.CmdClause) shared.Command
• func NewKmsGrantsList(c *kingpin.CmdClause) shared.Command
• func NewKmsGrantsRetire(c *kingpin.CmdClause) shared.Command
• func NewKmsInit(c *kingpin.CmdClause, keyCloudformationTemplate string) shared.Command
• type KmsGetCallerIdentity
  • func (w *KmsGetCallerIdentity) Run(ctx context.Context) error
• type MultiRegionKey
  • func NewMultiRegionKey(ctx context.Context, aliasName string, regions []string, forceRegion string) (*MultiRegionKey, error)
  • func (m *MultiRegionKey) AddGrant(ctx context.Context, grant kms.CreateGrantInput) (map[string]kms.CreateGrantOutput, error)
  • func (m *MultiRegionKey) GetGrantDetails(ctx context.Context) (map[string][]types.GrantListEntry, error)
  • func (m *MultiRegionKey) RetireGrant(ctx context.Context, name string) error
  • func (m *MultiRegionKey) SetKeyPolicy(ctx context.Context, policy string) error

Constants

const (
	// AliasPrefix is the prefix of all KMS Key Aliases.
	AliasPrefix = "alias/" + shared.ProgName + "-"

	// GrantPrefix is the prefix of all KMS Grant Names.
	GrantPrefix = shared.ProgName + "-"
)

Functions

func NewKmsDeprovision

func NewKmsDeprovision(c *kingpin.CmdClause) shared.Command

NewKmsDeprovision configures the flags for kmsDeprovision.

func NewKmsEditKeyPolicy

func NewKmsEditKeyPolicy(c *kingpin.CmdClause) shared.Command

NewKmsEditKeyPolicy configures the flags for kmsEditKeyPolicy.

func NewKmsGrantsCreate

func NewKmsGrantsCreate(c *kingpin.CmdClause) shared.Command

NewKmsGrantsCreate constructs the command to create a grant.

func NewKmsGrantsList

func NewKmsGrantsList(c *kingpin.CmdClause) shared.Command

NewKmsGrantsList constructs the command to list grants.

func NewKmsGrantsRetire

func NewKmsGrantsRetire(c *kingpin.CmdClause) shared.Command

NewKmsGrantsRetire constructs the command to retire grants.

func NewKmsInit

func NewKmsInit(c *kingpin.CmdClause, keyCloudformationTemplate string) shared.Command

NewKmsInit configures the command to configure AWS.

Types

type KmsGetCallerIdentity

type KmsGetCallerIdentity struct{}

KmsGetCallerIdentity prints AWS client configuration info.

func (*KmsGetCallerIdentity) Run

func (w *KmsGetCallerIdentity) Run(ctx context.Context) error

Run prints the results of STS GetCallerIdentity.

type MultiRegionKey

type MultiRegionKey struct {
	Policy string
	// contains filtered or unexported fields
}

MultiRegionKey represents a collection of KMS Keys that are operated on simultaneously.

func NewMultiRegionKey

func NewMultiRegionKey(ctx context.Context, aliasName string, regions []string, forceRegion string) (*MultiRegionKey, error)

NewMultiRegionKey constructs a MultiRegionKey.

func (*MultiRegionKey) AddGrant

func (m *MultiRegionKey) AddGrant(ctx context.Context, grant kms.CreateGrantInput) (map[string]kms.CreateGrantOutput, error)

AddGrant adds a grant to all of the underlying regions. Returns a map of region -> grant.

func (*MultiRegionKey) GetGrantDetails

func (m *MultiRegionKey) GetGrantDetails(ctx context.Context) (map[string][]types.GrantListEntry, error)

GetGrantDetails returns a list of grants for each region.

func (*MultiRegionKey) RetireGrant

func (m *MultiRegionKey) RetireGrant(ctx context.Context, name string) error

RetireGrant retires a grant in all regions.

func (*MultiRegionKey) SetKeyPolicy

func (m *MultiRegionKey) SetKeyPolicy(ctx context.Context, policy string) error

SetKeyPolicy sets a new Key Policy.