module Kitchen::Terraform::ConfigAttribute::PluginDirectory

This attribute contains the path to the directory which contains {www.terraform.io/docs/commands/init.html#plugin-installation customized Terraform provider plugins} to install in place of the official Terraform provider plugins.

Type

{www.yaml.org/spec/1.2/spec.html#id2760844 Scalar}

Required

False

Default

There is no default value because any value will disable the normal Terraform plugin retrieval process.

Example

plugin_directory: /path/to/terraform/plugins

Public Class Methods

included(plugin_class) click to toggle source

A callback to define the configuration attribute which is invoked when this module is included in a plugin class.

@param plugin_class [Kitchen::Configurable] A plugin class. @return [void]

# File lib/kitchen/terraform/config_attribute/plugin_directory.rb, line 41
def included(plugin_class)
  ::Kitchen::Terraform::FilePathConfigAttributeDefiner.new(
    attribute: self,
    schema: ::Kitchen::Terraform::ConfigAttributeContract::OptionalString.new,
  ).define plugin_class: plugin_class
end
to_sym() click to toggle source

@return [Symbol] the symbol corresponding to this attribute.

# File lib/kitchen/terraform/config_attribute/plugin_directory.rb, line 49
def to_sym
  :plugin_directory
end

Public Instance Methods

config_plugin_directory_default_value() click to toggle source

@return [nil]

# File lib/kitchen/terraform/config_attribute/plugin_directory.rb, line 57
def config_plugin_directory_default_value
  nil
end