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 ModulePath(args []string) (string, error)
- func StripArgFlags(args []string) []string
- type ApplyCommand
- type BackendOpts
- type ColorizeUi
- type ConsoleCommand
- type DebugCommand
- type DebugJSON2DotCommand
- type FlagStringKV
- type FlagStringSlice
- type FlagTargetSlice
- type FmtCommand
- type GetCommand
- type GraphCommand
- type ImportCommand
- type InitCommand
- type InternalPluginCommand
- type LoginCommand
- type LogoutCommand
- type Meta
- func (m *Meta) Backend(opts *BackendOpts) (backend.Enhanced, tfdiags.Diagnostics)
- func (m *Meta) BackendForPlan(settings plans.Backend) (backend.Enhanced, tfdiags.Diagnostics)
- func (m *Meta) Colorize() *colorstring.Colorize
- func (m *Meta) DataDir() string
- func (m *Meta) Input() bool
- func (m *Meta) InputMode() terraform.InputMode
- func (m *Meta) IsLocalBackend(b backend.Backend) bool
- func (m *Meta) Operation(b backend.Backend) *backend.Operation
- func (m *Meta) PlanFile(path string) (*planfile.Reader, error)
- func (m *Meta) RunOperation(b backend.Enhanced, opReq *backend.Operation) (*backend.RunningOperation, error)
- func (m *Meta) SetWorkspace(name string) error
- func (m *Meta) StateOutPath() string
- func (m *Meta) StdinPiped() bool
- func (m *Meta) UIInput() terraform.UIInput
- func (m *Meta) Workspace() string
- func (m *Meta) WorkspaceOverridden() (string, bool)
- type OutputCommand
- type PlanCommand
- type PluginOverrides
- type ProvidersCommand
- type ProvidersSchemaCommand
- type PushCommand
- type RefreshCommand
- type ShowCommand
- type StateCommand
- type StateListCommand
- type StateMeta
- type StateMvCommand
- type StatePullCommand
- type StatePushCommand
- type StateRmCommand
- type StateShowCommand
- type TaintCommand
- type UIInput
- type UiHook
- func (h *UiHook) PostApply(addr addrs.AbsResourceInstance, gen states.Generation, newState cty.Value, ...) (terraform.HookAction, error)
- func (h *UiHook) PostImportState(addr addrs.AbsResourceInstance, imported []providers.ImportedResource) (terraform.HookAction, error)
- func (h *UiHook) PreApply(addr addrs.AbsResourceInstance, gen states.Generation, action plans.Action, ...) (terraform.HookAction, error)
- func (h *UiHook) PreDiff(addr addrs.AbsResourceInstance, gen states.Generation, ...) (terraform.HookAction, error)
- func (h *UiHook) PreImportState(addr addrs.AbsResourceInstance, importID string) (terraform.HookAction, error)
- func (h *UiHook) PreProvisionInstanceStep(addr addrs.AbsResourceInstance, typeName string) (terraform.HookAction, error)
- func (h *UiHook) PreRefresh(addr addrs.AbsResourceInstance, gen states.Generation, priorState cty.Value) (terraform.HookAction, error)
- func (h *UiHook) ProvisionOutput(addr addrs.AbsResourceInstance, typeName string, msg string)
- type UnlockCommand
- type UntaintCommand
- type ValidateCommand
- type VersionCheckFunc
- type VersionCheckInfo
- type VersionCommand
- type WorkspaceCommand
- type WorkspaceDeleteCommand
- type WorkspaceListCommand
- type WorkspaceNewCommand
- type WorkspaceSelectCommand
- type WorkspaceShowCommand
- type ZeroTwelveUpgradeCommand
Constants ¶
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 DefaultPluginVendorDir = "terraform.d/plugins/" + pluginMachineName
DefaultPluginVendorDir is the location in the config directory to look for user-added plugin binaries. Terraform only reads from this path if it exists, it is never created by terraform.
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 ErrUnsupportedLocalOp = `` /* 290-byte string literal not displayed */
ErrUnsupportedLocalOp is the common error message shown for operations that require a backend.Local.
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 PluginPathFile = "plugin_path"
PluginPathFile is the name of the file in the data dir which stores the list of directories supplied by the user with the `-plugin-dir` flag during init.
const (
ProviderSkipVerifyEnvVar = "TF_SKIP_PROVIDER_VERIFY"
)
const TFSPACE = "-TFSPACE-"
const VarEnvPrefix = "TF_VAR_"
VarEnvPrefix is the prefix for environment variables that represent values for root module input variables.
const WorkspaceNameEnvVar = "TF_WORKSPACE"
WorkspaceNameEnvVar is the name of the environment variable that can be used to set the name of the Terraform workspace, overriding the workspace chosen by `terraform workspace select`.
Note that this environment variable is ignored by `terraform workspace new` and `terraform workspace delete`.
Variables ¶
var InternalProviders = map[string]plugin.ProviderFunc{}
var InternalProvisioners = map[string]plugin.ProvisionerFunc{ "chef": chefprovisioner.Provisioner, "file": fileprovisioner.Provisioner, "habitat": habitatprovisioner.Provisioner, "local-exec": localexecprovisioner.Provisioner, "puppet": puppetprovisioner.Provisioner, "remote-exec": remoteexecprovisioner.Provisioner, "salt-masterless": saltmasterlessprovisioner.Provisioner, }
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 ModulePath ¶ added in v0.9.0
ModulePath returns the path to the root module from the CLI args.
This centralizes the logic for any commands that expect a module path on their CLI args. This will verify that only one argument is given and that it is a path to configuration.
If your command accepts more than one arg, then change the slice bounds to pass validation.
func StripArgFlags ¶ added in v0.12.18
Internal plugins do not support any CLI args, but we do receive flags that main.go:mergeEnvArgs has merged in from EnvCLI. Instead of making main.go aware of this exception, we strip all flags from our args. Flags are easily identified by the '-' prefix, ensured by the cli package used.
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 }
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 BackendOpts ¶ added in v0.9.0
type BackendOpts struct { // Config is a representation of the backend configuration block given in // the root module, or nil if no such block is present. Config *configs.Backend // ConfigOverride is an hcl.Body that, if non-nil, will be used with // configs.MergeBodies to override the type-specific backend configuration // arguments in Config. ConfigOverride hcl.Body // Init should be set to true if initialization is allowed. If this is // false, then any configuration that requires configuration will show // an error asking the user to reinitialize. Init bool // ForceLocal will force a purely local backend, including state. // You probably don't want to set this. ForceLocal bool }
BackendOpts are the options used to initialize a backend.Backend.
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
}
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 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 FlagTargetSlice ¶ added in v0.12.0
type FlagTargetSlice []addrs.Targetable
FlagTargetSlice is a flag.Value implementation for parsing target addresses from the command line, such as -target=aws_instance.foo -target=aws_vpc.bar .
func (*FlagTargetSlice) Set ¶ added in v0.12.0
func (v *FlagTargetSlice) Set(raw string) error
func (*FlagTargetSlice) String ¶ added in v0.12.0
func (v *FlagTargetSlice) 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 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 // contains filtered or unexported fields }
InitCommand is a Command implementation that takes a Terraform module and clones it to the working directory.
func (*InitCommand) AutocompleteArgs ¶ added in v0.10.7
func (c *InitCommand) AutocompleteArgs() complete.Predictor
func (*InitCommand) AutocompleteFlags ¶ added in v0.10.7
func (c *InitCommand) AutocompleteFlags() complete.Flags
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 LoginCommand ¶ added in v0.12.9
type LoginCommand struct {
Meta
}
LoginCommand is a Command implementation that runs an interactive login flow for a remote service host. It then stashes credentials in a tfrc file in the user's home directory.
func (*LoginCommand) Help ¶ added in v0.12.9
func (c *LoginCommand) Help() string
Help implements cli.Command.
func (*LoginCommand) Run ¶ added in v0.12.9
func (c *LoginCommand) Run(args []string) int
Run implements cli.Command.
func (*LoginCommand) Synopsis ¶ added in v0.12.9
func (c *LoginCommand) Synopsis() string
Synopsis implements cli.Command.
type LogoutCommand ¶ added in v0.12.21
type LogoutCommand struct {
Meta
}
LogoutCommand is a Command implementation which removes stored credentials for a remote service host.
func (*LogoutCommand) Help ¶ added in v0.12.21
func (c *LogoutCommand) Help() string
Help implements cli.Command.
func (*LogoutCommand) Run ¶ added in v0.12.21
func (c *LogoutCommand) Run(args []string) int
Run implements cli.Command.
func (*LogoutCommand) Synopsis ¶ added in v0.12.21
func (c *LogoutCommand) Synopsis() string
Synopsis implements cli.Command.
type Meta ¶
type Meta struct { Color bool // True if output should be colored GlobalPluginDirs []string // Additional paths to search for plugins PluginOverrides *PluginOverrides // legacy overrides from .terraformrc file Ui cli.Ui // Ui for output // ExtraHooks are extra hooks to add to the context. ExtraHooks []terraform.Hook // Services provides access to remote endpoint information for // "terraform-native' services running at a specific user-facing hostname. Services *disco.Disco // RunningInAutomation indicates that commands are being run by an // automated system rather than directly at a command prompt. // // This is a hint to various command routines that it may be confusing // to print out messages that suggest running specific follow-up // commands, since the user consuming the output will not be // in a position to run such commands. // // The intended use-case of this flag is when Terraform is running in // some sort of workflow orchestration tool which is abstracting away // the specific commands being run. RunningInAutomation bool // CLIConfigDir is the directory from which CLI configuration files were // read by the caller and the directory where any changes to CLI // configuration files by commands should be made. // // If this is empty then no configuration directory is available and // commands which require one cannot proceed. CLIConfigDir string // PluginCacheDir, if non-empty, enables caching of downloaded plugins // into the given directory. PluginCacheDir string // OverrideDataDir, if non-empty, overrides the return value of the // DataDir method for situations where the local .terraform/ directory // is not suitable, e.g. because of a read-only filesystem. OverrideDataDir string // BrowserLauncher is used by commands that need to open a URL in a // web browser. BrowserLauncher webbrowser.Launcher // When this channel is closed, the command will be cancelled. ShutdownCh <-chan struct{} // contains filtered or unexported fields }
Meta are the meta-options that are available on all or most commands.
func (*Meta) Backend ¶ added in v0.9.0
func (m *Meta) Backend(opts *BackendOpts) (backend.Enhanced, tfdiags.Diagnostics)
Backend initializes and returns the backend for this CLI session.
The backend is used to perform the actual Terraform operations. This abstraction enables easily sliding in new Terraform behavior such as remote state storage, remote operations, etc. while allowing the CLI to remain mostly identical.
This will initialize a new backend for each call, which can carry some overhead with it. Please reuse the returned value for optimal behavior.
Only one backend should be used per Meta. This function is stateful and is unsafe to create multiple backends used at once. This function can be called multiple times with each backend being "live" (usable) one at a time.
A side-effect of this method is the population of m.backendState, recording the final resolved backend configuration after dealing with overrides from the "terraform init" command line, etc.
func (*Meta) BackendForPlan ¶ added in v0.12.0
BackendForPlan is similar to Backend, but uses backend settings that were stored in a plan.
The current workspace name is also stored as part of the plan, and so this method will check that it matches the currently-selected workspace name and produce error diagnostics if not.
func (*Meta) Colorize ¶
func (m *Meta) Colorize() *colorstring.Colorize
Colorize returns the colorization structure for a command.
func (*Meta) DataDir ¶ added in v0.4.0
DataDir returns the directory where local data will be stored. Defaults to DefaultDataDir in the current working directory.
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) IsLocalBackend ¶ added in v0.9.1
IsLocalBackend returns true if the backend is a local backend. We use this for some checks that require a remote backend.
func (*Meta) Operation ¶ added in v0.9.0
Operation initializes a new backend.Operation struct.
This prepares the operation. After calling this, the caller is expected to modify fields of the operation such as Sequence to specify what will be called.
func (*Meta) PlanFile ¶ added in v0.12.0
PlanFile returns a reader for the plan file at the given path.
If the return value and error are both nil, the given path exists but seems to be a configuration directory instead.
Error will be non-nil if path refers to something which looks like a plan file and loading the file fails.
func (*Meta) RunOperation ¶ added in v0.11.4
func (m *Meta) RunOperation(b backend.Enhanced, opReq *backend.Operation) (*backend.RunningOperation, error)
RunOperation executes the given operation on the given backend, blocking until that operation completes or is interrupted, and then returns the RunningOperation object representing the completed or aborted operation that is, despite the name, no longer running.
An error is returned if the operation either fails to start or is cancelled. If the operation runs to completion then no error is returned even if the operation itself is unsuccessful. Use the "Result" field of the returned operation object to recognize operation-level failure.
func (*Meta) SetWorkspace ¶ added in v0.10.0
SetWorkspace saves the given name as the current workspace in the local filesystem.
func (*Meta) StateOutPath ¶ added in v0.3.5
StateOutPath returns the true output path for the state file
func (*Meta) StdinPiped ¶ added in v0.8.0
StdinPiped returns true if the input is piped.
func (*Meta) UIInput ¶ added in v0.3.0
UIInput returns a UIInput object to be used for asking for input.
func (*Meta) Workspace ¶ added in v0.10.0
Workspace returns the name of the currently configured workspace, corresponding to the desired named state.
func (*Meta) WorkspaceOverridden ¶ added in v0.10.0
WorkspaceOverridden returns the name of the currently configured workspace, corresponding to the desired named state, as well as a bool saying whether this was set via the TF_WORKSPACE environment variable.
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 PluginOverrides ¶ added in v0.10.0
type ProvidersCommand ¶ added in v0.10.0
type ProvidersCommand struct {
Meta
}
ProvidersCommand is a Command implementation that prints out information about the providers used in the current configuration/state.
func (*ProvidersCommand) Help ¶ added in v0.10.0
func (c *ProvidersCommand) Help() string
func (*ProvidersCommand) Run ¶ added in v0.10.0
func (c *ProvidersCommand) Run(args []string) int
func (*ProvidersCommand) Synopsis ¶ added in v0.10.0
func (c *ProvidersCommand) Synopsis() string
type ProvidersSchemaCommand ¶ added in v0.12.0
type ProvidersSchemaCommand struct {
Meta
}
ProvidersCommand is a Command implementation that prints out information about the providers used in the current configuration/state.
func (*ProvidersSchemaCommand) Help ¶ added in v0.12.0
func (c *ProvidersSchemaCommand) Help() string
func (*ProvidersSchemaCommand) Run ¶ added in v0.12.0
func (c *ProvidersSchemaCommand) Run(args []string) int
func (*ProvidersSchemaCommand) Synopsis ¶ added in v0.12.0
func (c *ProvidersSchemaCommand) Synopsis() string
type PushCommand ¶ added in v0.3.5
type PushCommand struct {
Meta
}
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 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 {
StateMeta
}
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 StateListCommand ¶ added in v0.7.0
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 {
Meta
}
StateMeta is the meta struct that should be embedded in state subcommands.
type StateMvCommand ¶ added in v0.7.0
type StateMvCommand struct {
StateMeta
}
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 StatePullCommand ¶ added in v0.9.0
StatePullCommand is a Command implementation that shows a single resource.
func (*StatePullCommand) Help ¶ added in v0.9.0
func (c *StatePullCommand) Help() string
func (*StatePullCommand) Run ¶ added in v0.9.0
func (c *StatePullCommand) Run(args []string) int
func (*StatePullCommand) Synopsis ¶ added in v0.9.0
func (c *StatePullCommand) Synopsis() string
type StatePushCommand ¶ added in v0.9.0
StatePushCommand is a Command implementation that shows a single resource.
func (*StatePushCommand) Help ¶ added in v0.9.0
func (c *StatePushCommand) Help() string
func (*StatePushCommand) Run ¶ added in v0.9.0
func (c *StatePushCommand) Run(args []string) int
func (*StatePushCommand) Synopsis ¶ added in v0.9.0
func (c *StatePushCommand) Synopsis() string
type StateRmCommand ¶ added in v0.7.1
type StateRmCommand struct {
StateMeta
}
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 // Stdin and Stdout 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 PeriodicUiTimer time.Duration // contains filtered or unexported fields }
func (*UiHook) PostApply ¶
func (h *UiHook) PostApply(addr addrs.AbsResourceInstance, gen states.Generation, newState cty.Value, applyerr error) (terraform.HookAction, error)
func (*UiHook) PostImportState ¶ added in v0.7.0
func (h *UiHook) PostImportState(addr addrs.AbsResourceInstance, imported []providers.ImportedResource) (terraform.HookAction, error)
func (*UiHook) PreApply ¶
func (h *UiHook) PreApply(addr addrs.AbsResourceInstance, gen states.Generation, action plans.Action, priorState, plannedNewState cty.Value) (terraform.HookAction, error)
func (*UiHook) PreDiff ¶
func (h *UiHook) PreDiff(addr addrs.AbsResourceInstance, gen states.Generation, priorState, proposedNewState cty.Value) (terraform.HookAction, error)
func (*UiHook) PreImportState ¶ added in v0.7.0
func (h *UiHook) PreImportState(addr addrs.AbsResourceInstance, importID string) (terraform.HookAction, error)
func (*UiHook) PreProvisionInstanceStep ¶ added in v0.12.0
func (h *UiHook) PreProvisionInstanceStep(addr addrs.AbsResourceInstance, typeName string) (terraform.HookAction, error)
func (*UiHook) PreRefresh ¶
func (h *UiHook) PreRefresh(addr addrs.AbsResourceInstance, gen states.Generation, priorState cty.Value) (terraform.HookAction, error)
func (*UiHook) ProvisionOutput ¶ added in v0.3.0
func (h *UiHook) ProvisionOutput(addr addrs.AbsResourceInstance, typeName string, msg string)
type UnlockCommand ¶ added in v0.9.0
type UnlockCommand struct {
Meta
}
UnlockCommand is a cli.Command implementation that manually unlocks the state.
func (*UnlockCommand) Help ¶ added in v0.9.0
func (c *UnlockCommand) Help() string
func (*UnlockCommand) Run ¶ added in v0.9.0
func (c *UnlockCommand) Run(args []string) int
func (*UnlockCommand) Synopsis ¶ added in v0.9.0
func (c *UnlockCommand) Synopsis() 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
type WorkspaceCommand ¶ added in v0.10.0
WorkspaceCommand is a Command Implementation that manipulates workspaces, which allow multiple distinct states and variables from a single config.
func (*WorkspaceCommand) Help ¶ added in v0.10.0
func (c *WorkspaceCommand) Help() string
func (*WorkspaceCommand) Run ¶ added in v0.10.0
func (c *WorkspaceCommand) Run(args []string) int
func (*WorkspaceCommand) Synopsis ¶ added in v0.10.0
func (c *WorkspaceCommand) Synopsis() string
type WorkspaceDeleteCommand ¶ added in v0.10.0
func (*WorkspaceDeleteCommand) AutocompleteArgs ¶ added in v0.10.7
func (c *WorkspaceDeleteCommand) AutocompleteArgs() complete.Predictor
func (*WorkspaceDeleteCommand) AutocompleteFlags ¶ added in v0.10.7
func (c *WorkspaceDeleteCommand) AutocompleteFlags() complete.Flags
func (*WorkspaceDeleteCommand) Help ¶ added in v0.10.0
func (c *WorkspaceDeleteCommand) Help() string
func (*WorkspaceDeleteCommand) Run ¶ added in v0.10.0
func (c *WorkspaceDeleteCommand) Run(args []string) int
func (*WorkspaceDeleteCommand) Synopsis ¶ added in v0.10.0
func (c *WorkspaceDeleteCommand) Synopsis() string
type WorkspaceListCommand ¶ added in v0.10.0
func (*WorkspaceListCommand) AutocompleteArgs ¶ added in v0.10.7
func (c *WorkspaceListCommand) AutocompleteArgs() complete.Predictor
func (*WorkspaceListCommand) AutocompleteFlags ¶ added in v0.10.7
func (c *WorkspaceListCommand) AutocompleteFlags() complete.Flags
func (*WorkspaceListCommand) Help ¶ added in v0.10.0
func (c *WorkspaceListCommand) Help() string
func (*WorkspaceListCommand) Run ¶ added in v0.10.0
func (c *WorkspaceListCommand) Run(args []string) int
func (*WorkspaceListCommand) Synopsis ¶ added in v0.10.0
func (c *WorkspaceListCommand) Synopsis() string
type WorkspaceNewCommand ¶ added in v0.10.0
func (*WorkspaceNewCommand) AutocompleteArgs ¶ added in v0.10.7
func (c *WorkspaceNewCommand) AutocompleteArgs() complete.Predictor
func (*WorkspaceNewCommand) AutocompleteFlags ¶ added in v0.10.7
func (c *WorkspaceNewCommand) AutocompleteFlags() complete.Flags
func (*WorkspaceNewCommand) Help ¶ added in v0.10.0
func (c *WorkspaceNewCommand) Help() string
func (*WorkspaceNewCommand) Run ¶ added in v0.10.0
func (c *WorkspaceNewCommand) Run(args []string) int
func (*WorkspaceNewCommand) Synopsis ¶ added in v0.10.0
func (c *WorkspaceNewCommand) Synopsis() string
type WorkspaceSelectCommand ¶ added in v0.10.0
func (*WorkspaceSelectCommand) AutocompleteArgs ¶ added in v0.10.7
func (c *WorkspaceSelectCommand) AutocompleteArgs() complete.Predictor
func (*WorkspaceSelectCommand) AutocompleteFlags ¶ added in v0.10.7
func (c *WorkspaceSelectCommand) AutocompleteFlags() complete.Flags
func (*WorkspaceSelectCommand) Help ¶ added in v0.10.0
func (c *WorkspaceSelectCommand) Help() string
func (*WorkspaceSelectCommand) Run ¶ added in v0.10.0
func (c *WorkspaceSelectCommand) Run(args []string) int
func (*WorkspaceSelectCommand) Synopsis ¶ added in v0.10.0
func (c *WorkspaceSelectCommand) Synopsis() string
type WorkspaceShowCommand ¶ added in v0.10.0
type WorkspaceShowCommand struct {
Meta
}
func (*WorkspaceShowCommand) AutocompleteArgs ¶ added in v0.10.7
func (c *WorkspaceShowCommand) AutocompleteArgs() complete.Predictor
func (*WorkspaceShowCommand) AutocompleteFlags ¶ added in v0.10.7
func (c *WorkspaceShowCommand) AutocompleteFlags() complete.Flags
func (*WorkspaceShowCommand) Help ¶ added in v0.10.0
func (c *WorkspaceShowCommand) Help() string
func (*WorkspaceShowCommand) Run ¶ added in v0.10.0
func (c *WorkspaceShowCommand) Run(args []string) int
func (*WorkspaceShowCommand) Synopsis ¶ added in v0.10.0
func (c *WorkspaceShowCommand) Synopsis() string
type ZeroTwelveUpgradeCommand ¶ added in v0.12.0
type ZeroTwelveUpgradeCommand struct {
Meta
}
ZeroTwelveUpgradeCommand is a Command implementation that can upgrade the configuration files for a module from pre-0.11 syntax to new 0.12 idiom, while also flagging any suspicious constructs that will require human review.
func (*ZeroTwelveUpgradeCommand) Help ¶ added in v0.12.0
func (c *ZeroTwelveUpgradeCommand) Help() string
func (*ZeroTwelveUpgradeCommand) Run ¶ added in v0.12.0
func (c *ZeroTwelveUpgradeCommand) Run(args []string) int
func (*ZeroTwelveUpgradeCommand) Synopsis ¶ added in v0.12.0
func (c *ZeroTwelveUpgradeCommand) Synopsis() string
Source Files
¶
- 012_config_upgrade.go
- apply.go
- autocomplete.go
- cli_ui.go
- command.go
- console.go
- console_interactive.go
- debug_command.go
- debug_json2dot.go
- flag_kv.go
- fmt.go
- get.go
- graph.go
- hook_module_install.go
- hook_ui.go
- import.go
- init.go
- internal_plugin.go
- internal_plugin_list.go
- login.go
- logout.go
- meta.go
- meta_backend.go
- meta_backend_migrate.go
- meta_config.go
- meta_new.go
- meta_vars.go
- output.go
- plan.go
- plugins.go
- plugins_lock.go
- providers.go
- providers_schema.go
- push.go
- refresh.go
- show.go
- state_command.go
- state_list.go
- state_meta.go
- state_mv.go
- state_pull.go
- state_push.go
- state_rm.go
- state_show.go
- taint.go
- ui_input.go
- unlock.go
- untaint.go
- validate.go
- version.go
- workspace_command.go
- workspace_delete.go
- workspace_list.go
- workspace_new.go
- workspace_select.go
- workspace_show.go
Directories
¶
Path | Synopsis |
---|---|
Package cliconfig has the types representing and the logic to load CLI-level configuration settings.
|
Package cliconfig has the types representing and the logic to load CLI-level configuration settings. |
Package state exposes common helpers for working with state from the CLI.
|
Package state exposes common helpers for working with state from the CLI. |
Package e2etest contains a small number of tests that run against a real Terraform binary, compiled on the fly at the start of the test run.
|
Package e2etest contains a small number of tests that run against a real Terraform binary, compiled on the fly at the start of the test run. |
Package format contains helpers for formatting various Terraform structures for human-readabout output.
|
Package format contains helpers for formatting various Terraform structures for human-readabout output. |
Package jsonconfig implements methods for outputting a configuration snapshot in machine-readable json format
|
Package jsonconfig implements methods for outputting a configuration snapshot in machine-readable json format |
Package jsonplan implements methods for outputting a plan in a machine-readable json format
|
Package jsonplan implements methods for outputting a plan in a machine-readable json format |
Package jsonprovider contains types and functions to marshal terraform provider schemas into a json formatted output.
|
Package jsonprovider contains types and functions to marshal terraform provider schemas into a json formatted output. |
Package jsonstate implements methods for outputting a state in a machine-readable json format
|
Package jsonstate implements methods for outputting a state in a machine-readable json format |