secretbackends

Documentation

Overview

Package secretbackends provides the api client for the secretbackends facade.

Index

• Variables
• type Client
  • func NewClient(caller base.APICallCloser, options ...Option) *Client
  • func (api *Client) AddSecretBackend(ctx context.Context, backend CreateSecretBackend) error
  • func (api *Client) ListSecretBackends(ctx context.Context, names []string, reveal bool) ([]SecretBackend, error)
  • func (api *Client) RemoveSecretBackend(ctx context.Context, name string, force bool) error
  • func (api *Client) UpdateSecretBackend(ctx context.Context, arg UpdateSecretBackend, force bool) error
• type CreateSecretBackend
• type Option
• type SecretBackend
• type UpdateSecretBackend

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

Types

type Client

type Client struct {
	base.ClientFacade
	// contains filtered or unexported fields
}

Client is the api client for the SecretBackends facade.

func NewClient

func NewClient(caller base.APICallCloser, options ...Option) *Client

NewClient creates a secret backends api client.

func (*Client) AddSecretBackend

func (api *Client) AddSecretBackend(ctx context.Context, backend CreateSecretBackend) error

AddSecretBackend adds the specified secret backend.

func (*Client) ListSecretBackends

func (api *Client) ListSecretBackends(ctx context.Context, names []string, reveal bool) ([]SecretBackend, error)

ListSecretBackends lists the specified secret backends, or all available if no names are provided.

func (*Client) RemoveSecretBackend

func (api *Client) RemoveSecretBackend(ctx context.Context, name string, force bool) error

RemoveSecretBackend removes the specified secret backend.

func (*Client) UpdateSecretBackend

func (api *Client) UpdateSecretBackend(ctx context.Context, arg UpdateSecretBackend, force bool) error

UpdateSecretBackend updates the specified secret backend.

type CreateSecretBackend

type CreateSecretBackend struct {
	ID                  string
	Name                string
	BackendType         string
	TokenRotateInterval *time.Duration
	Config              map[string]interface{}
}

CreateSecretBackend holds details for creating a secret backend.

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.

type SecretBackend

type SecretBackend struct {
	Name                string
	BackendType         string
	TokenRotateInterval *time.Duration
	Config              map[string]interface{}
	NumSecrets          int
	Status              status.Status
	Message             string
	ID                  string
	Error               error
}

SecretBackend holds details for a secret backend.

type UpdateSecretBackend

type UpdateSecretBackend struct {
	Name                string
	NameChange          *string
	TokenRotateInterval *time.Duration
	Config              map[string]interface{}
	Reset               []string
}

UpdateSecretBackend holds details for updating a secret backend.