mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-21 02:37:43 -05:00
a18e643a8d
Signed-off-by: Janos <86970079+janosdebugs@users.noreply.github.com> Signed-off-by: Christian Mesh <christianmesh1@gmail.com> Co-authored-by: Christian Mesh <christianmesh1@gmail.com> Co-authored-by: James Humphries <jamesh@spacelift.io>
21 lines
650 B
Go
21 lines
650 B
Go
// Copyright (c) The OpenTofu Authors
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package keyprovider
|
|
|
|
// Descriptor is a high level description of a key provider.
|
|
type Descriptor interface {
|
|
// ID returns the unique identifier used when parsing HCL or JSON configs.
|
|
ID() ID
|
|
|
|
// ConfigStruct creates a new configuration struct pointer annotated with hcl tags. The Build() receiver on
|
|
// this struct must be able to build a KeyProvider from the configuration:
|
|
//
|
|
// Common errors:
|
|
// - Returning a struct without a pointer
|
|
// - Returning a non-struct
|
|
ConfigStruct() Config
|
|
}
|