tfe

Documentation

Overview

Copyright (c) HashiCorp, Inc. SPDX-License-Identifier: MPL-2.0

Index

• Constants
• func NewFrameworkProvider() provider.Provider
• func NewLoggingTransport(name string, t http.RoundTripper) *loggingTransport
• func NewResourceVariable() resource.Resource
• func NewSAMLSettingsDataSource() datasource.DataSource
• func NewSAMLSettingsResource() resource.Resource
• func PluginProviderServer() tfprotov5.ProviderServer
• func Provider() *schema.Provider
• type AttrGettable
• type Config
• type ConfigHost
• type ConfiguredClient
• type FrameworkProviderConfig

Constants

const (
	EnvLog = "TF_LOG"
)

const RunTasksURLEnvName = "RUN_TASKS_URL"

Functions

func NewFrameworkProvider

func NewFrameworkProvider() provider.Provider

NewFrameworkProvider is a helper function for initializing the portion of the tfe provider implemented via the terraform-plugin-framework.

func NewLoggingTransport

func NewLoggingTransport(name string, t http.RoundTripper) *loggingTransport

NewLoggingTransport wraps the given transport with a logger that logs request and response details

func NewResourceVariable

func NewResourceVariable() resource.Resource

NewResourceVariable is a resource function for the framework provider.

func NewSAMLSettingsDataSource

func NewSAMLSettingsDataSource() datasource.DataSource

NewSAMLSettingsDataSource is a helper function to simplify the provider implementation.

func NewSAMLSettingsResource

func NewSAMLSettingsResource() resource.Resource

NewSAMLSettingsResource is a resource function for the framework provider.

func PluginProviderServer

func PluginProviderServer() tfprotov5.ProviderServer

PluginProviderServer returns the implementation of an interface for a lower level usage of the Provider to Terraform protocol. This relies on the terraform-plugin-go library, which provides low level bindings for the Terraform plugin protocol.

func Provider

func Provider() *schema.Provider

Provider returns a schema.Provider

Types

type AttrGettable

type AttrGettable interface {
	GetAttribute(ctx context.Context, path path.Path, target interface{}) diag.Diagnostics
}

AttrGettable is a small enabler for helper functions that need to read one attribute of a Plan or State.

type Config

type Config struct {
	Hosts       map[string]*ConfigHost            `hcl:"host"`
	Credentials map[string]map[string]interface{} `hcl:"credentials"`
}

Config is the structure of the configuration for the Terraform CLI.

type ConfigHost

type ConfigHost struct {
	Services map[string]interface{} `hcl:"services"`
}

ConfigHost is the structure of the "host" nested block within the CLI configuration, which can be used to override the default service host discovery behavior for a particular hostname.

type ConfiguredClient

type ConfiguredClient struct {
	Client       *tfe.Client
	Organization string
}

ConfiguredClient wraps the tfe.Client the provider uses, plus the default organization name to be used by resources that need an organization but don't specify one.

type FrameworkProviderConfig

type FrameworkProviderConfig struct {
	Hostname      types.String `tfsdk:"hostname"`
	Token         types.String `tfsdk:"token"`
	Organization  types.String `tfsdk:"organization"`
	SSLSkipVerify types.Bool   `tfsdk:"ssl_skip_verify"`
}

FrameworkProviderConfig is a helper type for extracting the provider configuration from the provider block.