Documentation ¶
Overview ¶
This file is automatically generated by scripts/generate-plugins.go -- Do not edit!
Index ¶
- Constants
- Variables
- func BuildPluginCommandString(pluginType, pluginName string) (string, error)
- func FormatPlan(opts *FormatPlanOpts) string
- func FormatState(opts *FormatStateOpts) string
- type ApplyCommand
- type ColorizeUi
- type ConsoleCommand
- type CountHook
- func (h *CountHook) PostApply(n *terraform.InstanceInfo, s *terraform.InstanceState, e error) (terraform.HookAction, error)
- func (h *CountHook) PostDiff(n *terraform.InstanceInfo, d *terraform.InstanceDiff) (terraform.HookAction, error)
- func (h *CountHook) PreApply(n *terraform.InstanceInfo, s *terraform.InstanceState, ...) (terraform.HookAction, error)
- func (h *CountHook) Reset()
- type DebugCommand
- type DebugJSON2DotCommand
- type FlagStringKV
- type FlagStringSlice
- type FmtCommand
- type FormatPlanOpts
- type FormatStateOpts
- type GetCommand
- type GraphCommand
- type ImportCommand
- type InitCommand
- type InternalPluginCommand
- type Meta
- func (m *Meta) Colorize() *colorstring.Colorize
- func (m *Meta) Context(copts contextOpts) (*terraform.Context, bool, error)
- func (m *Meta) DataDir() string
- func (m *Meta) Input() bool
- func (m *Meta) InputMode() terraform.InputMode
- func (m *Meta) PersistState(s *terraform.State) error
- func (m *Meta) State() (state.State, error)
- func (m *Meta) StateOpts() *StateOpts
- func (m *Meta) StateOutPath() string
- func (m *Meta) StateRaw(opts *StateOpts) (*StateResult, error)
- func (m *Meta) StdinPiped() bool
- func (m *Meta) UIInput() terraform.UIInput
- type OutputCommand
- type PlanCommand
- type PushCommand
- type RefreshCommand
- type RemoteCommand
- type RemoteConfigCommand
- type RemotePullCommand
- type RemotePushCommand
- type ShowCommand
- type StateCommand
- type StateHook
- type StateListCommand
- type StateMeta
- type StateMvCommand
- type StateOpts
- type StateResult
- type StateRmCommand
- type StateShowCommand
- type TaintCommand
- type UIInput
- type UiHook
- func (h *UiHook) PostApply(n *terraform.InstanceInfo, s *terraform.InstanceState, applyerr error) (terraform.HookAction, error)
- func (h *UiHook) PostImportState(n *terraform.InstanceInfo, s []*terraform.InstanceState) (terraform.HookAction, error)
- func (h *UiHook) PreApply(n *terraform.InstanceInfo, s *terraform.InstanceState, ...) (terraform.HookAction, error)
- func (h *UiHook) PreDiff(n *terraform.InstanceInfo, s *terraform.InstanceState) (terraform.HookAction, error)
- func (h *UiHook) PreImportState(n *terraform.InstanceInfo, id string) (terraform.HookAction, error)
- func (h *UiHook) PreProvision(n *terraform.InstanceInfo, provId string) (terraform.HookAction, error)
- func (h *UiHook) PreRefresh(n *terraform.InstanceInfo, s *terraform.InstanceState) (terraform.HookAction, error)
- func (h *UiHook) ProvisionOutput(n *terraform.InstanceInfo, provId string, msg string)
- type UntaintCommand
- type ValidateCommand
- type VersionCheckFunc
- type VersionCheckInfo
- type VersionCommand
Constants ¶
const ( // ModuleDepthDefault is the default value for // module depth, which can be overridden by flag // or env var ModuleDepthDefault = -1 // ModuleDepthEnvVar is the name of the environment variable that can be used to set module depth. ModuleDepthEnvVar = "TF_MODULE_DEPTH" )
const DefaultBackupExtension = ".backup"
DefaultBackupExtension is added to the state file to form the path
const DefaultDataDir = ".terraform"
DefaultDataDir is the default directory for storing local data.
const DefaultParallelism = 10
DefaultParallelism is the limit Terraform places on total parallel operations as it walks the dependency graph.
const DefaultStateFilename = "terraform.tfstate"
DefaultStateFilename is the default filename used for the state file.
const DefaultVarsFilename = "terraform.tfvars"
DefaultVarsFilename is the default filename used for vars
const ( // InputModeEnvVar is the environment variable that, if set to "false" or // "0", causes terraform commands to behave as if the `-input=false` flag was // specified. InputModeEnvVar = "TF_INPUT" )
const TFSPACE = "-TFSPACE-"
Variables ¶
var InternalProviders = map[string]plugin.ProviderFunc{ "archive": archiveprovider.Provider, "arukas": arukasprovider.Provider, "atlas": atlasprovider.Provider, "aws": awsprovider.Provider, "azure": azureprovider.Provider, "azurerm": azurermprovider.Provider, "bitbucket": bitbucketprovider.Provider, "chef": chefprovider.Provider, "clc": clcprovider.Provider, "cloudflare": cloudflareprovider.Provider, "cloudstack": cloudstackprovider.Provider, "cobbler": cobblerprovider.Provider, "consul": consulprovider.Provider, "datadog": datadogprovider.Provider, "digitalocean": digitaloceanprovider.Provider, "dme": dmeprovider.Provider, "dnsimple": dnsimpleprovider.Provider, "docker": dockerprovider.Provider, "dyn": dynprovider.Provider, "external": externalprovider.Provider, "fastly": fastlyprovider.Provider, "github": githubprovider.Provider, "google": googleprovider.Provider, "grafana": grafanaprovider.Provider, "heroku": herokuprovider.Provider, "icinga2": icinga2provider.Provider, "ignition": ignitionprovider.Provider, "influxdb": influxdbprovider.Provider, "librato": libratoprovider.Provider, "logentries": logentriesprovider.Provider, "mailgun": mailgunprovider.Provider, "mysql": mysqlprovider.Provider, "newrelic": newrelicprovider.Provider, "nomad": nomadprovider.Provider, "null": nullprovider.Provider, "openstack": openstackprovider.Provider, "opsgenie": opsgenieprovider.Provider, "packet": packetprovider.Provider, "pagerduty": pagerdutyprovider.Provider, "postgresql": postgresqlprovider.Provider, "powerdns": powerdnsprovider.Provider, "rabbitmq": rabbitmqprovider.Provider, "rancher": rancherprovider.Provider, "random": randomprovider.Provider, "rundeck": rundeckprovider.Provider, "scaleway": scalewayprovider.Provider, "softlayer": softlayerprovider.Provider, "statuscake": statuscakeprovider.Provider, "template": templateprovider.Provider, "terraform": terraformprovider.Provider, "test": testprovider.Provider, "tls": tlsprovider.Provider, "triton": tritonprovider.Provider, "ultradns": ultradnsprovider.Provider, "vault": vaultprovider.Provider, "vcd": vcdprovider.Provider, "vsphere": vsphereprovider.Provider, }
var InternalProvisioners = map[string]plugin.ProvisionerFunc{ "chef": func() terraform.ResourceProvisioner { return new(chefresourceprovisioner.ResourceProvisioner) }, "file": func() terraform.ResourceProvisioner { return new(fileresourceprovisioner.ResourceProvisioner) }, "local-exec": func() terraform.ResourceProvisioner { return new(localexecresourceprovisioner.ResourceProvisioner) }, "remote-exec": func() terraform.ResourceProvisioner { return new(remoteexecresourceprovisioner.ResourceProvisioner) }, }
Functions ¶
func BuildPluginCommandString ¶ added in v0.7.0
BuildPluginCommandString builds a special string for executing internal plugins. It has the following format:
/path/to/terraform-TFSPACE-internal-plugin-TFSPACE-terraform-provider-aws
We split the string on -TFSPACE- to build the command executor. The reason we use -TFSPACE- is so we can support spaces in the /path/to/terraform part.
func FormatPlan ¶
func FormatPlan(opts *FormatPlanOpts) string
FormatPlan takes a plan and returns a
func FormatState ¶
func FormatState(opts *FormatStateOpts) string
FormatState takes a state and returns a string
Types ¶
type ApplyCommand ¶
type ApplyCommand struct { Meta // If true, then this apply command will become the "destroy" // command. It is just like apply but only processes a destroy. Destroy bool // When this channel is closed, the apply will be cancelled. ShutdownCh <-chan struct{} }
ApplyCommand is a Command implementation that applies a Terraform configuration and actually builds or changes infrastructure.
func (*ApplyCommand) Help ¶
func (c *ApplyCommand) Help() string
func (*ApplyCommand) Run ¶
func (c *ApplyCommand) Run(args []string) int
func (*ApplyCommand) Synopsis ¶
func (c *ApplyCommand) Synopsis() string
type ColorizeUi ¶
type ColorizeUi struct { Colorize *colorstring.Colorize OutputColor string InfoColor string ErrorColor string WarnColor string Ui cli.Ui }
ColoredUi is a Ui implementation that colors its output according to the given color schemes for the given type of output.
func (*ColorizeUi) AskSecret ¶ added in v0.5.0
func (u *ColorizeUi) AskSecret(query string) (string, error)
func (*ColorizeUi) Error ¶
func (u *ColorizeUi) Error(message string)
func (*ColorizeUi) Info ¶
func (u *ColorizeUi) Info(message string)
func (*ColorizeUi) Output ¶
func (u *ColorizeUi) Output(message string)
func (*ColorizeUi) Warn ¶ added in v0.4.0
func (u *ColorizeUi) Warn(message string)
type ConsoleCommand ¶ added in v0.8.0
type ConsoleCommand struct { Meta // When this channel is closed, the apply will be cancelled. ShutdownCh <-chan struct{} }
ConsoleCommand is a Command implementation that applies a Terraform configuration and actually builds or changes infrastructure.
func (*ConsoleCommand) Help ¶ added in v0.8.0
func (c *ConsoleCommand) Help() string
func (*ConsoleCommand) Run ¶ added in v0.8.0
func (c *ConsoleCommand) Run(args []string) int
func (*ConsoleCommand) Synopsis ¶ added in v0.8.0
func (c *ConsoleCommand) Synopsis() string
type CountHook ¶
type CountHook struct { Added int Changed int Removed int ToAdd int ToChange int ToRemove int ToRemoveAndAdd int sync.Mutex terraform.NilHook // contains filtered or unexported fields }
CountHook is a hook that counts the number of resources added, removed, changed during the course of an apply.
func (*CountHook) PostApply ¶
func (h *CountHook) PostApply( n *terraform.InstanceInfo, s *terraform.InstanceState, e error) (terraform.HookAction, error)
func (*CountHook) PostDiff ¶ added in v0.6.0
func (h *CountHook) PostDiff( n *terraform.InstanceInfo, d *terraform.InstanceDiff) ( terraform.HookAction, error)
func (*CountHook) PreApply ¶
func (h *CountHook) PreApply( n *terraform.InstanceInfo, s *terraform.InstanceState, d *terraform.InstanceDiff) (terraform.HookAction, error)
type DebugCommand ¶ added in v0.8.0
type DebugCommand struct {
Meta
}
DebugCommand is a Command implementation that just shows help for the subcommands nested below it.
func (*DebugCommand) Help ¶ added in v0.8.0
func (c *DebugCommand) Help() string
func (*DebugCommand) Run ¶ added in v0.8.0
func (c *DebugCommand) Run(args []string) int
func (*DebugCommand) Synopsis ¶ added in v0.8.0
func (c *DebugCommand) Synopsis() string
type DebugJSON2DotCommand ¶ added in v0.8.0
type DebugJSON2DotCommand struct {
Meta
}
DebugJSON2DotCommand is a Command implementation that translates a json graph debug log to Dot format.
func (*DebugJSON2DotCommand) Help ¶ added in v0.8.0
func (c *DebugJSON2DotCommand) Help() string
func (*DebugJSON2DotCommand) Run ¶ added in v0.8.0
func (c *DebugJSON2DotCommand) Run(args []string) int
func (*DebugJSON2DotCommand) Synopsis ¶ added in v0.8.0
func (c *DebugJSON2DotCommand) Synopsis() string
type FlagStringKV ¶ added in v0.7.0
FlagStringKV is a flag.Value implementation for parsing user variables from the command-line in the format of '-var key=value', where value is only ever a primitive.
func (*FlagStringKV) Set ¶ added in v0.7.0
func (v *FlagStringKV) Set(raw string) error
func (*FlagStringKV) String ¶ added in v0.7.0
func (v *FlagStringKV) String() string
type FlagStringSlice ¶ added in v0.4.0
type FlagStringSlice []string
FlagStringSlice is a flag.Value implementation for parsing targets from the command line, e.g. -target=aws_instance.foo -target=aws_vpc.bar
func (*FlagStringSlice) Set ¶ added in v0.4.0
func (v *FlagStringSlice) Set(raw string) error
func (*FlagStringSlice) String ¶ added in v0.4.0
func (v *FlagStringSlice) String() string
type FmtCommand ¶ added in v0.6.15
type FmtCommand struct { Meta // contains filtered or unexported fields }
FmtCommand is a Command implementation that rewrites Terraform config files to a canonical format and style.
func (*FmtCommand) Help ¶ added in v0.6.15
func (c *FmtCommand) Help() string
func (*FmtCommand) Run ¶ added in v0.6.15
func (c *FmtCommand) Run(args []string) int
func (*FmtCommand) Synopsis ¶ added in v0.6.15
func (c *FmtCommand) Synopsis() string
type FormatPlanOpts ¶ added in v0.3.0
type FormatPlanOpts struct { // Plan is the plan to format. This is required. Plan *terraform.Plan // Color is the colorizer. This is optional. Color *colorstring.Colorize // ModuleDepth is the depth of the modules to expand. By default this // is zero which will not expand modules at all. ModuleDepth int }
FormatPlanOpts are the options for formatting a plan.
type FormatStateOpts ¶ added in v0.3.0
type FormatStateOpts struct { // State is the state to format. This is required. State *terraform.State // Color is the colorizer. This is optional. Color *colorstring.Colorize // ModuleDepth is the depth of the modules to expand. By default this // is zero which will not expand modules at all. ModuleDepth int }
FormatStateOpts are the options for formatting a state.
type GetCommand ¶ added in v0.3.0
type GetCommand struct {
Meta
}
GetCommand is a Command implementation that takes a Terraform configuration and downloads all the modules.
func (*GetCommand) Help ¶ added in v0.3.0
func (c *GetCommand) Help() string
func (*GetCommand) Run ¶ added in v0.3.0
func (c *GetCommand) Run(args []string) int
func (*GetCommand) Synopsis ¶ added in v0.3.0
func (c *GetCommand) Synopsis() string
type GraphCommand ¶
type GraphCommand struct {
Meta
}
GraphCommand is a Command implementation that takes a Terraform configuration and outputs the dependency tree in graphical form.
func (*GraphCommand) Help ¶
func (c *GraphCommand) Help() string
func (*GraphCommand) Run ¶
func (c *GraphCommand) Run(args []string) int
func (*GraphCommand) Synopsis ¶
func (c *GraphCommand) Synopsis() string
type ImportCommand ¶ added in v0.7.0
type ImportCommand struct {
Meta
}
ImportCommand is a cli.Command implementation that imports resources into the Terraform state.
func (*ImportCommand) Help ¶ added in v0.7.0
func (c *ImportCommand) Help() string
func (*ImportCommand) Run ¶ added in v0.7.0
func (c *ImportCommand) Run(args []string) int
func (*ImportCommand) Synopsis ¶ added in v0.7.0
func (c *ImportCommand) Synopsis() string
type InitCommand ¶ added in v0.3.0
type InitCommand struct {
Meta
}
InitCommand is a Command implementation that takes a Terraform module and clones it to the working directory.
func (*InitCommand) Help ¶ added in v0.3.0
func (c *InitCommand) Help() string
func (*InitCommand) Run ¶ added in v0.3.0
func (c *InitCommand) Run(args []string) int
func (*InitCommand) Synopsis ¶ added in v0.3.0
func (c *InitCommand) Synopsis() string
type InternalPluginCommand ¶ added in v0.7.0
type InternalPluginCommand struct {
Meta
}
InternalPluginCommand is a Command implementation that allows plugins to be compiled into the main Terraform binary and executed via a subcommand.
func (*InternalPluginCommand) Help ¶ added in v0.7.0
func (c *InternalPluginCommand) Help() string
func (*InternalPluginCommand) Run ¶ added in v0.7.0
func (c *InternalPluginCommand) Run(args []string) int
func (*InternalPluginCommand) Synopsis ¶ added in v0.7.0
func (c *InternalPluginCommand) Synopsis() string
type Meta ¶
type Meta struct { Color bool ContextOpts *terraform.ContextOpts Ui cli.Ui // contains filtered or unexported fields }
Meta are the meta-options that are available on all or most commands.
func (*Meta) Colorize ¶
func (m *Meta) Colorize() *colorstring.Colorize
Colorize returns the colorization structure for a command.
func (*Meta) Context ¶
Context returns a Terraform Context taking into account the context options used to initialize this meta configuration.
func (*Meta) DataDir ¶ added in v0.4.0
DataDir returns the directory where local data will be stored.
func (*Meta) InputMode ¶ added in v0.3.0
InputMode returns the type of input we should ask for in the form of terraform.InputMode which is passed directly to Context.Input.
func (*Meta) PersistState ¶ added in v0.3.5
PersistState is used to write out the state, handling backup of the existing state file and respecting path configurations.
func (*Meta) StateOutPath ¶ added in v0.3.5
StateOutPath returns the true output path for the state file
func (*Meta) StateRaw ¶ added in v0.4.0
func (m *Meta) StateRaw(opts *StateOpts) (*StateResult, error)
StateRaw is used to setup the state manually.
func (*Meta) StdinPiped ¶ added in v0.8.0
StdinPiped returns true if the input is piped.
type OutputCommand ¶
type OutputCommand struct {
Meta
}
OutputCommand is a Command implementation that reads an output from a Terraform state and prints it.
func (*OutputCommand) Help ¶
func (c *OutputCommand) Help() string
func (*OutputCommand) Run ¶
func (c *OutputCommand) Run(args []string) int
func (*OutputCommand) Synopsis ¶
func (c *OutputCommand) Synopsis() string
type PlanCommand ¶
type PlanCommand struct {
Meta
}
PlanCommand is a Command implementation that compares a Terraform configuration to an actual infrastructure and shows the differences.
func (*PlanCommand) Help ¶
func (c *PlanCommand) Help() string
func (*PlanCommand) Run ¶
func (c *PlanCommand) Run(args []string) int
func (*PlanCommand) Synopsis ¶
func (c *PlanCommand) Synopsis() string
type PushCommand ¶ added in v0.3.5
type PushCommand struct { Meta // contains filtered or unexported fields }
func (*PushCommand) Help ¶ added in v0.3.5
func (c *PushCommand) Help() string
func (*PushCommand) Run ¶ added in v0.3.5
func (c *PushCommand) Run(args []string) int
func (*PushCommand) Synopsis ¶ added in v0.3.5
func (c *PushCommand) Synopsis() string
type RefreshCommand ¶
type RefreshCommand struct {
Meta
}
RefreshCommand is a cli.Command implementation that refreshes the state file.
func (*RefreshCommand) Help ¶
func (c *RefreshCommand) Help() string
func (*RefreshCommand) Run ¶
func (c *RefreshCommand) Run(args []string) int
func (*RefreshCommand) Synopsis ¶
func (c *RefreshCommand) Synopsis() string
type RemoteCommand ¶ added in v0.3.5
type RemoteCommand struct {
Meta
}
func (*RemoteCommand) Help ¶ added in v0.3.5
func (c *RemoteCommand) Help() string
func (*RemoteCommand) Run ¶ added in v0.3.5
func (c *RemoteCommand) Run(argsRaw []string) int
func (*RemoteCommand) Synopsis ¶ added in v0.3.5
func (c *RemoteCommand) Synopsis() string
type RemoteConfigCommand ¶ added in v0.4.0
type RemoteConfigCommand struct { Meta // contains filtered or unexported fields }
RemoteConfigCommand is a Command implementation that is used to enable and disable remote state management
func (*RemoteConfigCommand) Help ¶ added in v0.4.0
func (c *RemoteConfigCommand) Help() string
func (*RemoteConfigCommand) Run ¶ added in v0.4.0
func (c *RemoteConfigCommand) Run(args []string) int
func (*RemoteConfigCommand) Synopsis ¶ added in v0.4.0
func (c *RemoteConfigCommand) Synopsis() string
type RemotePullCommand ¶ added in v0.4.0
type RemotePullCommand struct {
Meta
}
func (*RemotePullCommand) Help ¶ added in v0.4.0
func (c *RemotePullCommand) Help() string
func (*RemotePullCommand) Run ¶ added in v0.4.0
func (c *RemotePullCommand) Run(args []string) int
func (*RemotePullCommand) Synopsis ¶ added in v0.4.0
func (c *RemotePullCommand) Synopsis() string
type RemotePushCommand ¶ added in v0.4.0
type RemotePushCommand struct {
Meta
}
func (*RemotePushCommand) Help ¶ added in v0.4.0
func (c *RemotePushCommand) Help() string
func (*RemotePushCommand) Run ¶ added in v0.4.0
func (c *RemotePushCommand) Run(args []string) int
func (*RemotePushCommand) Synopsis ¶ added in v0.4.0
func (c *RemotePushCommand) Synopsis() string
type ShowCommand ¶
type ShowCommand struct {
Meta
}
ShowCommand is a Command implementation that reads and outputs the contents of a Terraform plan or state file.
func (*ShowCommand) Help ¶
func (c *ShowCommand) Help() string
func (*ShowCommand) Run ¶
func (c *ShowCommand) Run(args []string) int
func (*ShowCommand) Synopsis ¶
func (c *ShowCommand) Synopsis() string
type StateCommand ¶ added in v0.7.0
type StateCommand struct {
Meta
}
StateCommand is a Command implementation that just shows help for the subcommands nested below it.
func (*StateCommand) Help ¶ added in v0.7.0
func (c *StateCommand) Help() string
func (*StateCommand) Run ¶ added in v0.7.0
func (c *StateCommand) Run(args []string) int
func (*StateCommand) Synopsis ¶ added in v0.7.0
func (c *StateCommand) Synopsis() string
type StateHook ¶ added in v0.4.0
StateHook is a hook that continuously updates the state by calling WriteState on a state.State.
func (*StateHook) PostStateUpdate ¶ added in v0.4.0
type StateListCommand ¶ added in v0.7.0
type StateListCommand struct {
Meta
}
StateListCommand is a Command implementation that lists the resources within a state file.
func (*StateListCommand) Help ¶ added in v0.7.0
func (c *StateListCommand) Help() string
func (*StateListCommand) Run ¶ added in v0.7.0
func (c *StateListCommand) Run(args []string) int
func (*StateListCommand) Synopsis ¶ added in v0.7.0
func (c *StateListCommand) Synopsis() string
type StateMeta ¶ added in v0.7.0
type StateMeta struct{}
StateMeta is the meta struct that should be embedded in state subcommands.
type StateMvCommand ¶ added in v0.7.0
StateMvCommand is a Command implementation that shows a single resource.
func (*StateMvCommand) Help ¶ added in v0.7.0
func (c *StateMvCommand) Help() string
func (*StateMvCommand) Run ¶ added in v0.7.0
func (c *StateMvCommand) Run(args []string) int
func (*StateMvCommand) Synopsis ¶ added in v0.7.0
func (c *StateMvCommand) Synopsis() string
type StateOpts ¶ added in v0.4.0
type StateOpts struct { // LocalPath is the path where the state is stored locally. // // LocalPathOut is the path where the local state will be saved. If this // isn't set, it will be saved back to LocalPath. LocalPath string LocalPathOut string // RemotePath is the path where the remote state cache would be. // // RemoteCache, if true, will set the result to only be the cache // and not backed by any real durable storage. RemotePath string RemoteCacheOnly bool RemoteRefresh bool // BackupPath is the path where the backup will be placed. If not set, // it is assumed to be the path where the state is stored locally // plus the DefaultBackupExtension. BackupPath string // ForceState is a state structure to force the value to be. This // is used by Terraform plans (which contain their state). ForceState *terraform.State }
StateOpts are options to get the state for a command.
type StateResult ¶ added in v0.4.0
type StateResult struct { // State is the final outer state that should be used for all // _real_ reads/writes. // // StatePath is the local path where the state will be stored or // cached, no matter whether State is local or remote. State state.State StatePath string // Local and Remote are the local/remote state implementations, raw // and unwrapped by any backups. The paths here are the paths where // these state files would be saved. Local *state.LocalState LocalPath string Remote *state.CacheState RemotePath string }
StateResult is the result of calling State and holds various different State implementations so they can be accessed directly.
func State ¶ added in v0.4.0
func State(opts *StateOpts) (*StateResult, error)
State returns the proper state.State implementation to represent the current environment.
localPath is the path to where state would be if stored locally. dataDir is the path to the local data directory where the remote state cache would be stored.
type StateRmCommand ¶ added in v0.7.1
StateRmCommand is a Command implementation that shows a single resource.
func (*StateRmCommand) Help ¶ added in v0.7.1
func (c *StateRmCommand) Help() string
func (*StateRmCommand) Run ¶ added in v0.7.1
func (c *StateRmCommand) Run(args []string) int
func (*StateRmCommand) Synopsis ¶ added in v0.7.1
func (c *StateRmCommand) Synopsis() string
type StateShowCommand ¶ added in v0.7.0
StateShowCommand is a Command implementation that shows a single resource.
func (*StateShowCommand) Help ¶ added in v0.7.0
func (c *StateShowCommand) Help() string
func (*StateShowCommand) Run ¶ added in v0.7.0
func (c *StateShowCommand) Run(args []string) int
func (*StateShowCommand) Synopsis ¶ added in v0.7.0
func (c *StateShowCommand) Synopsis() string
type TaintCommand ¶ added in v0.4.0
type TaintCommand struct {
Meta
}
TaintCommand is a cli.Command implementation that manually taints a resource, marking it for recreation.
func (*TaintCommand) Help ¶ added in v0.4.0
func (c *TaintCommand) Help() string
func (*TaintCommand) Run ¶ added in v0.4.0
func (c *TaintCommand) Run(args []string) int
func (*TaintCommand) Synopsis ¶ added in v0.4.0
func (c *TaintCommand) Synopsis() string
type UIInput ¶ added in v0.3.0
type UIInput struct { // Colorize will color the output. Colorize *colorstring.Colorize // Reader and Writer for IO. If these aren't set, they will default to // Stdout and Stderr respectively. Reader io.Reader Writer io.Writer // contains filtered or unexported fields }
UIInput is an implementation of terraform.UIInput that asks the CLI for input stdin.
type UiHook ¶
type UiHook struct { terraform.NilHook Colorize *colorstring.Colorize Ui cli.Ui // contains filtered or unexported fields }
func (*UiHook) PostApply ¶
func (h *UiHook) PostApply( n *terraform.InstanceInfo, s *terraform.InstanceState, applyerr error) (terraform.HookAction, error)
func (*UiHook) PostImportState ¶ added in v0.7.0
func (h *UiHook) PostImportState( n *terraform.InstanceInfo, s []*terraform.InstanceState) (terraform.HookAction, error)
func (*UiHook) PreApply ¶
func (h *UiHook) PreApply( n *terraform.InstanceInfo, s *terraform.InstanceState, d *terraform.InstanceDiff) (terraform.HookAction, error)
func (*UiHook) PreDiff ¶
func (h *UiHook) PreDiff( n *terraform.InstanceInfo, s *terraform.InstanceState) (terraform.HookAction, error)
func (*UiHook) PreImportState ¶ added in v0.7.0
func (h *UiHook) PreImportState( n *terraform.InstanceInfo, id string) (terraform.HookAction, error)
func (*UiHook) PreProvision ¶
func (h *UiHook) PreProvision( n *terraform.InstanceInfo, provId string) (terraform.HookAction, error)
func (*UiHook) PreRefresh ¶
func (h *UiHook) PreRefresh( n *terraform.InstanceInfo, s *terraform.InstanceState) (terraform.HookAction, error)
func (*UiHook) ProvisionOutput ¶ added in v0.3.0
func (h *UiHook) ProvisionOutput( n *terraform.InstanceInfo, provId string, msg string)
type UntaintCommand ¶ added in v0.6.13
type UntaintCommand struct {
Meta
}
UntaintCommand is a cli.Command implementation that manually untaints a resource, marking it as primary and ready for service.
func (*UntaintCommand) Help ¶ added in v0.6.13
func (c *UntaintCommand) Help() string
func (*UntaintCommand) Run ¶ added in v0.6.13
func (c *UntaintCommand) Run(args []string) int
func (*UntaintCommand) Synopsis ¶ added in v0.6.13
func (c *UntaintCommand) Synopsis() string
type ValidateCommand ¶ added in v0.6.12
type ValidateCommand struct {
Meta
}
ValidateCommand is a Command implementation that validates the terraform files
func (*ValidateCommand) Help ¶ added in v0.6.12
func (c *ValidateCommand) Help() string
func (*ValidateCommand) Run ¶ added in v0.6.12
func (c *ValidateCommand) Run(args []string) int
func (*ValidateCommand) Synopsis ¶ added in v0.6.12
func (c *ValidateCommand) Synopsis() string
type VersionCheckFunc ¶ added in v0.3.0
type VersionCheckFunc func() (VersionCheckInfo, error)
VersionCheckFunc is the callback called by the Version command to check if there is a new version of Terraform.
type VersionCheckInfo ¶ added in v0.3.0
VersionCheckInfo is the return value for the VersionCheckFunc callback and tells the Version command information about the latest version of Terraform.
type VersionCommand ¶
type VersionCommand struct { Meta Revision string Version string VersionPrerelease string CheckFunc VersionCheckFunc }
VersionCommand is a Command implementation prints the version.
func (*VersionCommand) Help ¶
func (c *VersionCommand) Help() string
func (*VersionCommand) Run ¶
func (c *VersionCommand) Run(args []string) int
func (*VersionCommand) Synopsis ¶
func (c *VersionCommand) Synopsis() string
Source Files ¶
- apply.go
- cli_ui.go
- command.go
- console.go
- console_interactive.go
- counthookaction_string.go
- debug_command.go
- debug_json2dot.go
- flag_kv.go
- fmt.go
- format_plan.go
- format_state.go
- get.go
- graph.go
- hcl_printer.go
- hook_count.go
- hook_count_action.go
- hook_state.go
- hook_ui.go
- import.go
- init.go
- internal_plugin.go
- internal_plugin_list.go
- meta.go
- module_storage.go
- output.go
- plan.go
- push.go
- refresh.go
- remote.go
- remote_config.go
- remote_pull.go
- remote_push.go
- show.go
- state.go
- state_command.go
- state_list.go
- state_meta.go
- state_mv.go
- state_rm.go
- state_show.go
- taint.go
- ui_input.go
- untaint.go
- validate.go
- version.go