type ConfigValidator interface {// Description describes the validation in plain text formatting.//// This information may be automatically added to provider plain text// descriptions by external tooling.Description(context.Context)string// MarkdownDescription describes the validation in Markdown formatting.//// This information may be automatically added to provider Markdown// descriptions by external tooling.MarkdownDescription(context.Context)string// ValidateProvider performs the validation.//// This method name is separate from ConfigValidators in resource and other packages in// order to allow generic validators.ValidateProvider(context.Context,ValidateConfigRequest, *ValidateConfigResponse)}

type ConfigureProviderClientCapabilities struct {// DeferralAllowed indicates whether the Terraform client initiating// the request allows a deferral response.//// NOTE: This functionality is related to deferred action support, which is currently experimental and is subject// to change or break without warning. It is not protected by version compatibility guarantees.DeferralAllowedbool}

type ConfigureRequest struct {// TerraformVersion is the version of Terraform executing the request.// This is supplied for logging, analytics, and User-Agent purposes// only. Providers should not try to gate provider behavior on// Terraform versions.TerraformVersionstring// Config is the configuration the user supplied for the provider. This// information should usually be persisted to the underlying type// that's implementing the Provider interface, for use in later// resource CRUD operations.Configtfsdk.Config// ClientCapabilities defines optionally supported protocol features for the// ConfigureProvider RPC, such as forward-compatible Terraform behavior changes.ClientCapabilitiesConfigureProviderClientCapabilities}

type ConfigureResponse struct {// DataSourceData is provider-defined data, clients, etc. that is passed// to [datasource.ConfigureRequest.ProviderData] for each DataSource type// that implements the Configure method.DataSourceDataany// Diagnostics report errors or warnings related to configuring the// provider. An empty slice indicates success, with no warnings or// errors generated.Diagnosticsdiag.Diagnostics// ResourceData is provider-defined data, clients, etc. that is passed// to [resource.ConfigureRequest.ProviderData] for each Resource type// that implements the Configure method.ResourceDataany// EphemeralResourceData is provider-defined data, clients, etc. that is// passed to [ephemeral.ConfigureRequest.ProviderData] for each// EphemeralResource type that implements the Configure method.EphemeralResourceDataany// ActionData is provider-defined data, clients, etc. that is// passed to [action.ConfigureRequest.ProviderData] for each// Action type that implements the Configure method.ActionDataany// ListResourceData is provider-defined data, clients, etc. that is// passed to [action.ConfigureRequest.ProviderData] for each// Action type that implements the Configure method.ListResourceDataany// Deferred indicates that Terraform should automatically defer// all resources and data sources for this provider.//// This field can only be set if// `(provider.ConfigureRequest).ClientCapabilities.DeferralAllowed` is true.//// NOTE: This functionality is related to deferred action support, which is currently experimental and is subject// to change or break without warning. It is not protected by version compatibility guarantees.Deferred *Deferred}

type Deferred struct {// Reason is the reason for deferring the change.ReasonDeferredReason}

type DeferredReasonint32

const (// DeferredReasonUnknown is used to indicate an invalid `DeferredReason`.// Provider developers should not use it.DeferredReasonUnknownDeferredReason = 0// DeferredReasonProviderConfigUnknown is used to indicate that the provider configuration// is partially unknown and the real values need to be known before the change can be planned.DeferredReasonProviderConfigUnknownDeferredReason = 2)

MAINTAINER NOTE: The deferred reason at enum value 1 in the plugin-protocolis not relevant for provider-level automatic deferred responses.provider.DeferredReason is directly mapped to the plugin-protocol which iswhy enum value 1 is skipped here

func (DeferredReason)String¶added inv1.9.0

func (dDeferredReason) String()string

type MetaSchemaRequest struct{}

type MetaSchemaResponse struct {// Schema is the meta schema of the provider.Schemametaschema.Schema// Diagnostics report errors or warnings related to validating the data// source configuration. An empty slice indicates success, with no warnings// or errors generated.Diagnosticsdiag.Diagnostics}

type MetadataRequest struct{}

type MetadataResponse struct {// TypeName should be the provider type. For example, examplecloud, if// the intended resource or data source types are examplecloud_thing, etc.TypeNamestring// Version should be the provider version, such as 1.2.3.//// This is not connected to any framework functionality currently, but may// be in the future.Versionstring}

type Provider interface {// Metadata should return the metadata for the provider, such as// a type name and version data.//// Implementing the MetadataResponse.TypeName will populate the// datasource.MetadataRequest.ProviderTypeName and// resource.MetadataRequest.ProviderTypeName fields automatically.Metadata(context.Context,MetadataRequest, *MetadataResponse)// Schema should return the schema for this provider.Schema(context.Context,SchemaRequest, *SchemaResponse)// Configure is called at the beginning of the provider lifecycle, when// Terraform sends to the provider the values the user specified in the// provider configuration block. These are supplied in the// ConfigureProviderRequest argument.// Values from provider configuration are often used to initialise an// API client, which should be stored on the struct implementing the// Provider interface.Configure(context.Context,ConfigureRequest, *ConfigureResponse)// DataSources returns a slice of functions to instantiate each DataSource// implementation.//// The data source type name is determined by the DataSource implementing// the Metadata method. All data sources must have unique names.DataSources(context.Context) []func()datasource.DataSource// Resources returns a slice of functions to instantiate each Resource// implementation.//// The resource type name is determined by the Resource implementing// the Metadata method. All resources must have unique names.Resources(context.Context) []func()resource.Resource}

type ProviderWithActions interface {Provider// Actions returns a slice of functions to instantiate each Action// implementation.//// The action type is determined by the Action implementing// the Metadata method. All action types must have unique names.Actions(context.Context) []func()action.Action}

type ProviderWithConfigValidators interface {Provider// ConfigValidators returns a list of functions which will all be performed during validation.ConfigValidators(context.Context) []ConfigValidator}

type ProviderWithEphemeralResources interface {Provider// EphemeralResources returns a slice of functions to instantiate each EphemeralResource// implementation.//// The ephemeral resource type name is determined by the EphemeralResource implementing// the Metadata method. All ephemeral resources must have unique names.EphemeralResources(context.Context) []func()ephemeral.EphemeralResource}

type ProviderWithFunctions interface {Provider// Functions returns a slice of functions to instantiate each Function// implementation.//// The function name is determined by the Function implementing its Metadata// method. All functions must have unique names.Functions(context.Context) []func()function.Function}

type ProviderWithListResources interface {Provider// ListResources returns a slice of functions to instantiate each Resource// List implementation.//// The resource type name is determined by the ListResource implementing// the Metadata method. All ListResources must have unique names.ListResources(context.Context) []func()list.ListResource}

type ProviderWithMetaSchema interface {Provider// MetaSchema should return the meta schema for this provider.//// This functionality is currently experimental and subject to change or// break without warning. It is not protected by version compatibility// guarantees.MetaSchema(context.Context,MetaSchemaRequest, *MetaSchemaResponse)}

type ProviderWithValidateConfig interface {Provider// ValidateConfig performs the validation.ValidateConfig(context.Context,ValidateConfigRequest, *ValidateConfigResponse)}

type SchemaRequest struct{}

type SchemaResponse struct {// Schema is the schema of the provider.Schemaschema.Schema// Diagnostics report errors or warnings related to validating the data// source configuration. An empty slice indicates success, with no warnings// or errors generated.Diagnosticsdiag.Diagnostics}

type ValidateConfigRequest struct {// Config is the configuration the user supplied for the provider.//// This configuration may contain unknown values if a user uses// interpolation or other functionality that would prevent Terraform// from knowing the value at request time.Configtfsdk.Config}

type ValidateConfigResponse struct {// Diagnostics report errors or warnings related to validating the provider// configuration. An empty slice indicates success, with no warnings or// errors generated.Diagnosticsdiag.Diagnostics}