Package provider contains all interfaces, request types, and response types for a provider implementation.
In Terraform, a provider is a concept which enables provider developers to offer practitioners data sources and managed resources. Those concepts are described in more detail in their respective datasource and resource packages.
Providers generally store any infrastructure clients or shared data that is applicable across data sources and managed resources. Providers are generally configured early in Terraform operations, such as plan and apply, before data source and managed resource logic is called. However, this early provider configuration is not guaranteed in the case there are unknown Terraform configuration values, so additional logic checks may be required throughout an implementation to handle this case. Providers may contain a schema representing the structure and data types of Terraform-based configuration.
The main starting point for implementations in this package is the Provider type which represents an instance of a provider that has its own configuration.
This section is empty.
This section is empty.
This section is empty.
ConfigValidator describes reusable Provider configuration validation functionality.
type ConfigureProviderClientCapabilities struct {
DeferralAllowed bool
}
ConfigureProviderClientCapabilities allows Terraform to publish information regarding optionally supported protocol features for the ConfigureProvider RPC, such as forward-compatible Terraform behavior changes.
ConfigureRequest represents a request containing the values the user specified for the provider configuration block, along with other runtime information from Terraform or the Plugin SDK. An instance of this request struct is supplied as an argument to the provider's Configure function.
ConfigureResponse represents a response to a ConfigureRequest. An instance of this response struct is supplied as an argument to the provider's Configure function, in which the provider should set values on the ConfigureResponse as appropriate.
Deferred is used to indicate to Terraform that a change needs to be deferred for a reason.
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.
type DeferredReason int32
DeferredReason represents different reasons for deferring a change.
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.
MAINTAINER NOTE: The deferred reason at enum value 1 in the plugin-protocol is not relevant for provider-level automatic deferred responses. provider.DeferredReason is directly mapped to the plugin-protocol which is why enum value 1 is skipped here
type MetaSchemaRequest struct{}
MetaSchemaRequest represents a request for the Provider to return its schema. An instance of this request struct is supplied as an argument to the Provider type Schema method.
MetaSchemaResponse represents a response to a MetaSchemaRequest. An instance of this response struct is supplied as an argument to the Provider type Schema method.
type MetadataRequest struct{}
MetadataRequest represents a request for the Provider to return its type name. An instance of this request struct is supplied as an argument to the Provider type Metadata method.
type MetadataResponse struct {
TypeName string
Version string
}
MetadataResponse represents a response to a MetadataRequest. An instance of this response struct is supplied as an argument to the Provider type Metadata method.
Provider is the core interface that all Terraform providers must implement.
Providers can optionally implement these additional concepts:
ProviderWithConfigValidators is an interface type that extends Provider to include declarative validations.
Declaring validation using this methodology simplifies implementation of reusable functionality. These also include descriptions, which can be used for automating documentation.
Validation will include ConfigValidators and ValidateConfig, if both are implemented, in addition to any Attribute or Type validation.
ProviderWithEphemeralResources is an interface type that extends Provider to include ephemeral resources for usage in practitioner configurations.
Ephemeral resources are supported in Terraform version 1.10 and later.
ProviderWithFunctions is an interface type that extends Provider to include provider defined functions for usage in practitioner configurations.
Provider-defined functions are supported in Terraform version 1.8 and later.
ProviderWithMetaSchema is a provider with a provider meta schema, which is configured by practitioners via the provider_meta configuration block and the configuration data is included with certain data source and resource operations. The intended use case is to enable Terraform module authors within the same organization of the provider to track module usage in requests. Other use cases are explicitly not supported. All provider instances (aliases) receive the same data.
This functionality is currently experimental and subject to change or break without warning. It is not protected by version compatibility guarantees.
ProviderWithValidateConfig is an interface type that extends Provider to include imperative validation.
Declaring validation using this methodology simplifies one-off functionality that typically applies to a single provider. Any documentation of this functionality must be manually added into schema descriptions.
Validation will include ConfigValidators and ValidateConfig, if both are implemented, in addition to any Attribute or Type validation.
type SchemaRequest struct{}
SchemaRequest represents a request for the Provider to return its schema. An instance of this request struct is supplied as an argument to the Provider type Schema method.
SchemaResponse represents a response to a SchemaRequest. An instance of this response struct is supplied as an argument to the Provider type Schema method.
type ValidateConfigRequest struct {
Config tfsdk.Config
}
ValidateConfigRequest represents a request to validate the configuration of a provider. An instance of this request struct is supplied as an argument to the Provider ValidateConfig receiver method or automatically passed through to each ConfigValidator.
ValidateConfigResponse represents a response to a ValidateConfigRequest. An instance of this response struct is supplied as an argument to the Provider ValidateConfig receiver method or automatically passed through to each ConfigValidator.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4