kmskey

Documentation

Index

• Constants
• func IsInvalidConfig(err error) bool
• func IsKeyNotFound(err error) bool
• func IsWrongType(err error) bool
• type Clients
• type Config
  • func DefaultConfig() Config
• type KMSClient
• type KMSClientMock
  • func (k *KMSClientMock) CreateAlias(input *kms.CreateAliasInput) (*kms.CreateAliasOutput, error)
  • func (k *KMSClientMock) CreateKey(input *kms.CreateKeyInput) (*kms.CreateKeyOutput, error)
  • func (k *KMSClientMock) DeleteAlias(input *kms.DeleteAliasInput) (*kms.DeleteAliasOutput, error)
  • func (k *KMSClientMock) DescribeKey(input *kms.DescribeKeyInput) (*kms.DescribeKeyOutput, error)
  • func (k *KMSClientMock) EnableKeyRotation(input *kms.EnableKeyRotationInput) (*kms.EnableKeyRotationOutput, error)
  • func (k *KMSClientMock) ScheduleKeyDeletion(input *kms.ScheduleKeyDeletionInput) (*kms.ScheduleKeyDeletionOutput, error)
  • func (k *KMSClientMock) TagResource(input *kms.TagResourceInput) (*kms.TagResourceOutput, error)
• type KMSKeyState
• type Resource
  • func New(config Config) (*Resource, error)
  • func (r *Resource) ApplyCreateChange(ctx context.Context, obj, createChange interface{}) error
  • func (r *Resource) ApplyDeleteChange(ctx context.Context, obj, deleteChange interface{}) error
  • func (r *Resource) ApplyUpdateChange(ctx context.Context, obj, updateChange interface{}) error
  • func (r *Resource) GetCurrentState(ctx context.Context, obj interface{}) (interface{}, error)
  • func (r *Resource) GetDesiredState(ctx context.Context, obj interface{}) (interface{}, error)
  • func (r *Resource) Name() string
  • func (r *Resource) NewDeletePatch(ctx context.Context, obj, currentState, desiredState interface{}) (*framework.Patch, error)
  • func (r *Resource) NewUpdatePatch(ctx context.Context, obj, currentState, desiredState interface{}) (*framework.Patch, error)

Constants

const (
	// Name is the identifier of the resource.
	Name = "kmskey"
)

Functions

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

func IsKeyNotFound

func IsKeyNotFound(err error) bool

func IsWrongType

func IsWrongType(err error) bool

IsWrongType asserts wrongTypeError.

Types

type Clients

type Clients struct {
	KMS KMSClient
}

type Config

type Config struct {
	// Dependencies.
	Clients Clients
	Logger  micrologger.Logger
}

Config represents the configuration used to create a new cloudformation resource.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new cloudformation resource by best effort.

type KMSClient

type KMSClient interface {
	CreateKey(*kms.CreateKeyInput) (*kms.CreateKeyOutput, error)
	CreateAlias(*kms.CreateAliasInput) (*kms.CreateAliasOutput, error)
	DescribeKey(*kms.DescribeKeyInput) (*kms.DescribeKeyOutput, error)
	DeleteAlias(*kms.DeleteAliasInput) (*kms.DeleteAliasOutput, error)
	EnableKeyRotation(*kms.EnableKeyRotationInput) (*kms.EnableKeyRotationOutput, error)
	ScheduleKeyDeletion(*kms.ScheduleKeyDeletionInput) (*kms.ScheduleKeyDeletionOutput, error)
	TagResource(*kms.TagResourceInput) (*kms.TagResourceOutput, error)
}

type KMSClientMock

type KMSClientMock struct {
	// contains filtered or unexported fields
}

func (*KMSClientMock) CreateAlias

func (k *KMSClientMock) CreateAlias(input *kms.CreateAliasInput) (*kms.CreateAliasOutput, error)

func (*KMSClientMock) CreateKey

func (k *KMSClientMock) CreateKey(input *kms.CreateKeyInput) (*kms.CreateKeyOutput, error)

func (*KMSClientMock) DeleteAlias

func (k *KMSClientMock) DeleteAlias(input *kms.DeleteAliasInput) (*kms.DeleteAliasOutput, error)

func (*KMSClientMock) DescribeKey

func (k *KMSClientMock) DescribeKey(input *kms.DescribeKeyInput) (*kms.DescribeKeyOutput, error)

func (*KMSClientMock) EnableKeyRotation

func (k *KMSClientMock) EnableKeyRotation(input *kms.EnableKeyRotationInput) (*kms.EnableKeyRotationOutput, error)

func (*KMSClientMock) ScheduleKeyDeletion

func (k *KMSClientMock) ScheduleKeyDeletion(input *kms.ScheduleKeyDeletionInput) (*kms.ScheduleKeyDeletionOutput, error)

func (*KMSClientMock) TagResource

func (k *KMSClientMock) TagResource(input *kms.TagResourceInput) (*kms.TagResourceOutput, error)

type KMSKeyState

type KMSKeyState struct {
	KeyID    string
	KeyAlias string
}

type Resource

type Resource struct {
	// contains filtered or unexported fields
}

Resource implements the cloudformation resource.

func New

func New(config Config) (*Resource, error)

New creates a new configured cloudformation resource.

func (*Resource) ApplyCreateChange

func (r *Resource) ApplyCreateChange(ctx context.Context, obj, createChange interface{}) error

func (*Resource) ApplyDeleteChange

func (r *Resource) ApplyDeleteChange(ctx context.Context, obj, deleteChange interface{}) error

func (*Resource) ApplyUpdateChange

func (r *Resource) ApplyUpdateChange(ctx context.Context, obj, updateChange interface{}) error

func (*Resource) GetCurrentState

func (r *Resource) GetCurrentState(ctx context.Context, obj interface{}) (interface{}, error)

func (*Resource) GetDesiredState

func (r *Resource) GetDesiredState(ctx context.Context, obj interface{}) (interface{}, error)

func (*Resource) Name

func (r *Resource) Name() string

func (*Resource) NewDeletePatch

func (r *Resource) NewDeletePatch(ctx context.Context, obj, currentState, desiredState interface{}) (*framework.Patch, error)

func (*Resource) NewUpdatePatch

func (r *Resource) NewUpdatePatch(ctx context.Context, obj, currentState, desiredState interface{}) (*framework.Patch, error)