Categorygithub.com/apparentlymart/terraform-sdk
modulepackage
0.0.0-20190921203246-567adf8e5271
Repository: https://github.com/apparentlymart/terraform-sdk.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package tflegacy is the final resting place for various legacy Terraform types and associated functions that used to live in Terraform packages like "helper/schema", "helper/resource", and "terraform" itself, so that resource type implementations written in terms of these can be fixed up just by simple package selector rewriting (replace existing imports with this tflegacy package) and then a provider can be adapted to the new SDK one resource type at a time.
Package tfobj contains helper types for working with Terraform object values (resource configurations, etc) in a higher-level way while still retaining the Terraform schema concepts.
Package tfschema contains types and functions for working with Terraform configuration schemas, such as the schema for a resource type in a provider.

# Functions

FormatError returns a string representation of the given error.
FormatPath returns a string representation of the given path using a syntax that resembles an expression in the Terraform language.
InitProviderTesting is the main entrypoint for testing provider plugins using this package.
LegacyDataResourceType wraps a data resource type implemented as tflegacy.Resource (formerly schema.Resource) to behave as a DataResourceType, by applying shims from the new protocol to the older types that legacy implementations depend on.
LegacyManagedResourceType wraps a managed resource type implemented as tflegacy.Resource (formerly schema.Resource) to behave as a ManagedResourceType, by applying shims from the new protocol to the older types that legacy implementations depend on.
NewDataResourceType prepares a DataResourceType implementation using the definition from the given ResourceType instance.
NewManagedResourceType prepares a ManagedResourceType implementation using the definition from the given ResourceType instance.
ServeProviderPlugin starts a plugin server for the given provider, which will first deal with the plugin protocol handshake and then, once initialized, serve RPC requests from the client (usually Terraform CLI).
UpstreamAPIError is a helper for constructing a Diagnostic to report an otherwise-unhandled error response from an upstream API/SDK.
ValidateAttrValue checks that the given value is a suitable value for the given attribute schema, returning diagnostics if not.
ValidateBlockObject checks that the given object value is suitable for the recieving block type, returning diagnostics if not.
ValidationError is a helper for constructing a Diagnostic to report an unsuitable value inside an attribute's ValidateFn.

# Constants

Error is a diagnostic severity used to indicate that an option could not be completed as requested.
Warning is a diagnostic severity used to indicate a problem that did not block the competion of the requested operation but that the user should be aware of nonetheless.

# Structs

Provider is the main type for describing a Terraform provider implementation.
ResourceTypeDef is the type that provider packages should instantiate to describe the implementation of a specific resource type.

# Interfaces

DataResourceType is an interface implemented by data resource type implementations.
ManagedResourceType is the interface implemented by managed resource type implementations.

# Type aliases

Diagnostic represents a single problem that occurred during an operation.
Diagnostics is a collection type used to report zero or more problems that occurred during an operation.
No description provided by the author