Index (terraform-gradle-plugin 0.9.0 API)

file(Object) - Method in Variables: Adds a name of a file containing terraform variables.
file(Object) - Method in VariablesSpec: Adds a name of a file containing terraform variables.
findExtension(Project) - Method in RemoteStateS3: Utility method to find this extension.
findExtension(Project) - Method in TerraformRemoteStateExtension: A utility to locate the extension.
FindTerraformConfig - Class in org.ysb33r.gradle.terraform.tasks: Locates the Terraform config for a project and caches the location in the local build directory.
FindTerraformConfig() - Constructor in FindTerraformConfig

G

generateFromTemplate(String, Project, String, Provider<File>, Provider<File>, String, String, Map<String, Object>) - Method in Templates: Generates a configuration file
getAdditionalProperties() - Method in TerraformCacheBinary
getAllVariables() - Method in TerraformExtension: Returns all terraform variables and descriptions of variables within files within the specific context
getAllVars() - Method in Variables: Returns a description of the files and variables
getAndVerifyDistributionRoot(File, String) - Method in Downloader: Validates that the unpacked distribution is good.
getAsFileTree() - Method in TerraformSourceDirectorySet: Returns terraform source tree
getAwsRegion() - Method in RemoteStateAwsS3ConfigGenerator: Get AWS region used for remote storage.
getBackendConfigFile() - Method in AbstractRemoteStateConfigGenerator: The location of the backend configuration file.
getBackendConfigFile() - Method in TerraformInit: Configuration for Terraform backend.
getBackendConfigValues() - Method in TerraformInit: Backend configuration files.
getBeginToken() - Method in AbstractRemoteStateConfigGenerator: Starting delimiter for tokens.
getBeginToken() - Method in TerraformWrapper
getBinaryLocation() - Method in TerraformCacheBinary
getBinaryVersion() - Method in TerraformCacheBinary
getBucket() - Method in RemoteStateS3: The default AWS bucket where remote state will be stored.
getCommandLineArgs() - Method in Lock
getCommandLineArgs() - Method in ResourceFilter
getCommandLineArgs() - Method in StateOptionsConcurrency
getCommandLineArgs() - Method in StateOptionsFull
getCommandLineArgs() - Method in TerraformTaskConfigExtension: Returns the list of Terraform command-line arguments.
getCommandLineArgs() - Method in Variables
getConfigFileName() - Method in AbstractRemoteStateConfigGenerator: Backend configuration file name
getConfigFileName() - Method in RemoteStateAwsS3ConfigGenerator
getDataDir() - Method in AbstractTerraformTask
getDataDir() - Method in TerraformSourceDirectorySet: Data directory provider.
getDefaultCommandParameters() - Method in AbstractTerraformTask: Returns a list of the default command parameters.
getDestinationDir() - Method in AbstractRemoteStateConfigGenerator: The output directory for the configuration file
getDestinationPath() - Method in TerraformStateMv: The destination path.
getDownloadBaseUri(String) - Method in HashicorpUtils: Get the download URI for Hashicorp Releases.
getEndToken() - Method in AbstractRemoteStateConfigGenerator: Terminating delimiter for tokens
getEndToken() - Method in TerraformWrapper
getEnvironment() - Method in AbstractTerraformTask: Environment for running the exe
getEnvironment() - Method in TerraformExtension: Environment for running the exe
getEscapedVars() - Method in Variables: Evaluate all variables and convert them to Terraform-compliant strings, ready to be passed to command-line.
getExcludes() - Method in TerraformSourceDirectorySet
getFileNames() - Method in Variables: List of file names containing Terraform variables.
getFilter() - Method in TerraformSourceDirectorySet: Returns the pattern filter.
getIncludes() - Method in TerraformSourceDirectorySet
getInputProperties() - Method in Lock
getInputProperties() - Method in ResourceFilter
getInputProperties() - Method in StateOptionsConcurrency
getInputProperties() - Method in TerraformTaskConfigExtension: Returns a list of closures which can be used to determine an input property for the purposes of up to date calculations.
getInputProperties() - Method in Variables
getInternalTrackerFile() - Method in TerraformPlan: This is the location of an internal tracker file used to keep state between apply & destroy cycles.
getLatestTerraformProviderVersion(String) - Method in HashicorpUtils: Obtains the latest version of a Terraform provider
getLogDir() - Method in AbstractTerraformTask
getLogDir() - Method in TerraformSourceDirectorySet: Log directory provider.
getLogLevel() - Method in AbstractTerraformTask: The level at which Terraform should log.
getMap() - Method in OutputVariablesCache
getName() - Method in TerraformTaskConfigExtension: The name under which the extension should be created.
getOutputName() - Method in TerraformOutput: List of names to retrieve output for.
getPlanOutputFile() - Method in TerraformPlan: Where the plan file will be written to.
getPlanReportOutputFile() - Method in TerraformPlan: Where the textual representation of the plan will be written to.
getPluginCacheDir() - Method in TerraformRCExtension: Location of Terraform plugin cache directory
getPrefix() - Method in TerraformRemoteStateExtension: A prefix that is added to remote state names.
getPropertiesDescription() - Method in TerraformCacheBinary
getRawOutputVariables() - Method in TerraformSourceDirectorySet: Returns a provider which can be used to access output variables from a source set.
getRegion() - Method in RemoteStateS3: The default AWS region where remote state will be stored.
getRemoteStateName() - Method in RemoteStateAwsS3ConfigGenerator: The name that will be used to identify remote state.
getReportsDir() - Method in AbstractTerraformTask
getReportsDir() - Method in TerraformSourceDirectorySet: Reports directory.
getResourceIdentifier() - Method in TerraformImport
getResourceName() - Method in TerraformImport
getResourceName() - Method in TerraformStateRm
getResourceType() - Method in TerraformImport
getResourceType() - Method in TerraformStateRm
getS3BucketName() - Method in RemoteStateAwsS3ConfigGenerator: The S3 bucket used for state storage
getSourceDir() - Method in AbstractTerraformTask
getSourcePath() - Method in TerraformStateMv: The source path.
getSourceSet() - Method in AbstractTerraformTask
getSrcDir() - Method in TerraformSourceDirectorySet: Provide for the root directory of the source set,
getStateFilePath() - Method in TerraformStatePush
getStatusReportOutputFile() - Method in TerraformOutput: Get the location where the report file needs to be generated.
getStatusReportOutputFile() - Method in TerraformShowState: Get the location where the report file needs to be generated.
getTemplateFile() - Method in AbstractRemoteStateConfigGenerator: Returns location of template file.
getTemplateResourcePath() - Method in AbstractRemoteStateConfigGenerator: Returns the name of the default template resource path.
getTemplateResourcePath() - Method in RemoteStateAwsS3ConfigGenerator
getTerraformCommand() - Method in AbstractTerraformTask: Retunbs the terraform command this task is implementing.
getTerraformEnvironment() - Method in AbstractTerraformTask
getTerraformExecutablePath() - Method in Downloader: Returns the path to the terraform executable.
getTerraFormLocationFile() - Method in FindTerraformConfig
getTerraformRC() - Method in TerraformRCExtension: Location of the terraformrc file if it shoudl be written by the project.
getTokens() - Method in AbstractRemoteStateConfigGenerator: Returns the current set of tokens
getTokenValuesAsMap() - Method in TerraformWrapper
getToolExtension() - Method in AbstractTerraformTask
getVariables() - Method in TerraformSourceDirectorySet: Get all terraform variables applicable to this source set.
getWarnOnNewVersion() - Method in TerraformExtension: Print a warning message if a new version of terraform is available.

H

HashicorpUtils - Class in org.ysb33r.grashicorp: Code for dealing with Hashicorp standards.

I

IgnoreGlobal - Class in org.ysb33r.gradle.terraform.config.multilevel.ignore: @since 0.2
IgnoreSetting - Class in org.ysb33r.gradle.terraform.config.multilevel.ignore: @since 0.2
IgnoreSourceSet - Class in org.ysb33r.gradle.terraform.config.multilevel.ignore: @since 0.2
include(Closure) - Method in TerraformSourceDirectorySet
isDownloadSupported() - Method in Downloader: Tells the system whether downloading can be supported.

J

JSON_FORMAT - Field in AbstractTerraformTask: Command-line parameter for JSON output.

K

L

list(String, Iterable<?>) - Method in Variables: Adds a list as a variable.
list(String, Iterable<?>) - Method in VariablesSpec: Adds a list as a variable.
locateGlobalTerraformConfigAsString() - Method in TerraformConfigUtils: Locates the global terraformrc file
locateTerraformConfigFile(Project) - Method in TerraformConfigUtils: Locates the Terraform configuration file in use by the specific project
locateTerraformRCExtension(Project) - Method in TerraformConfigUtils: Locates the TerraformRCExtension in the project
locateTerraformRCGenerator(Project) - Method in TerraformConfigUtils: Locates the task that can generate a terraformrc file.
LOCATION_PROPERTIES_DEFAULT - Field in TerraformCacheBinary
Lock - Class in org.ysb33r.gradle.terraform.config: Allows for lock configurations on a task.
Lock(AbstractTerraformTask) - Constructor in Lock

M

map(Map<String, ?>, String) - Method in Variables: Adds a map as a variable.
map(Map<String, ?>, String) - Method in VariablesSpec: Adds a map as a variable.
MissingTerraformConfiguration - Class in org.ysb33r.gradle.terraform.errors: Thrown when there is an issue locating the terraformrc file.

N

NAME - Field in IgnoreGlobal
NAME - Field in IgnoreSourceSet
NAME - Field in RemoteStateS3
NAME - Field in TerraformExtension: The standard extension name.
NAME - Field in TerraformRemoteStateExtension
NO_COLOR - Field in AbstractTerraformTask: Command-line parameter for no colour.

O

ordered() - Method in DefaultTerraformTasks
OS - Field in Downloader
osArch(OperatingSystem) - Method in HashicorpUtils: Returns a formatted string that can be used in file names and URIs.
OutputVariablesCache - Class in org.ysb33r.gradle.terraform.internal.output: An internal cache of output variables
OutputVariablesCache(Project, Provider<TerraformOutput>) - Constructor in OutputVariablesCache

P

Q

R

rawOutputVariable(String) - Method in TerraformSourceDirectorySet: Returns a provider to a specific output variable.
RemoteStateAwsS3ConfigGenerator - Class in org.ysb33r.gradle.terraform.tasks
RemoteStateAwsS3ConfigGenerator() - Constructor in RemoteStateAwsS3ConfigGenerator
RemoteStateS3 - Class in org.ysb33r.gradle.terraform.remotestate: An extension that is added to TerraformRemoteStateExtension.
RemoteStateS3(Project) - Constructor in RemoteStateS3
ResourceFilter - Class in org.ysb33r.gradle.terraform.config: Allows for lock configurations on a task.
ResourceFilter(AbstractTerraformTask) - Constructor in ResourceFilter

S

S3Conventions - Class in org.ysb33r.gradle.terraform.internal.remotestate: Conventions for when TerraformRemoteStateAwsS3Plugin is applied.
searchPath() - Method in TerraformExtension: Use this to configure a system path search for Terraform.
setAutoApprove(Boolean) - Method in TerraformDestroy: Set auto-approve mode.
setAwsRegion(Object) - Method in RemoteStateAwsS3ConfigGenerator: The AWS region used for remote state.
setBackendConfigFile(Object) - Method in TerraformInit: Set location of backend configuration file.
setBackendConfigValues(Map<String, Object>) - Method in TerraformInit: Replaces any existing backend configuration values with a new set.
setBucket(Object) - Method in RemoteStateS3: Set the default AWS bucket where the remote state will be stored.
setDataDir(Object) - Method in TerraformSourceDirectorySet: Sets the Terraform data directory.
setDestinationDir(Object) - Method in AbstractRemoteStateConfigGenerator: Override the output directory.
setDestinationPath(String) - Method in TerraformStateMv
setEnvironment(Map<String, ?>) - Method in AbstractTerraformTask: Replace current environment with new one.
setEnvironment(Map<String, ?>) - Method in TerraformExtension: Replace current environment with new one.
setExcludes(Iterable<String>) - Method in TerraformSourceDirectorySet
setIncludes(Iterable<String>) - Method in TerraformSourceDirectorySet
setJson(boolean) - Method in TerraformPlan: Where to write the report in human-readable or JSON format.
setLogDir(Object) - Method in TerraformSourceDirectorySet: Sets the log directory.
setLogLevel(LogLevel) - Method in AbstractTerraformTask
setName(String) - Method in TerraformOutput: Set the list of output names to retrieve.
setPluginCacheDir(Object) - Method in TerraformRCExtension: Sets the location of the Terraform plugin cache directory
setPrefix(Object) - Method in TerraformRemoteStateExtension: Assign the prefix.
setRegion(Object) - Method in RemoteStateS3: Set the default AWS region where the remote state will be stored.
setRemoteStateName(Object) - Method in RemoteStateAwsS3ConfigGenerator: Sets a new remote state name
setReportsDir(Object) - Method in TerraformSourceDirectorySet: Sets the reports directory.
setResourceIdentifier(String) - Method in TerraformImport
setResourceName(String) - Method in TerraformImport
setResourceName(String) - Method in TerraformStateRm
setResourceType(String) - Method in TerraformImport
setResourceType(String) - Method in TerraformStateRm
setS3BucketName(Object) - Method in RemoteStateAwsS3ConfigGenerator: Sets the S3 bucket used for state storage.
setSourcePath(String) - Method in TerraformStateMv
setSourceSet(Object) - Method in AbstractTerraformTask: @param source Source set of anything that can be resolved using org.ysb33r.grolifant.api.StringUtils#stringize(Object s) and looked up as a Terraform source set.
setSrcDir(Object) - Method in TerraformSourceDirectorySet: Sets the source directory.
setStateFileType(String) - Method in TerraformStatePush
setTargets(List<String>) - Method in AbstractTerraformApplyTask
setTargets(Iterable<String>) - Method in ResourceFilter
setTargets(List<String>) - Method in TerraformPlan: Select specific resources.
setTemplateFile(Object) - Method in AbstractRemoteStateConfigGenerator: Applies a custom template file for backend configuration.
setTokens(Map<String, Object>) - Method in AbstractRemoteStateConfigGenerator: Replace all tokens with a new set.
setWarnOnNewVersion(boolean) - Method in TerraformExtension: Turn checkpoint warning on or off
sourceSetDisplayName(String) - Method in TerraformConvention: Returns the default text used for a Terraform source set
StateOptionsConcurrency - Class in org.ysb33r.gradle.terraform.config: Allows for options related to walking the state tree.
StateOptionsConcurrency(AbstractTerraformTask) - Constructor in StateOptionsConcurrency
StateOptionsFull - Class in org.ysb33r.gradle.terraform.config: Allows for options related to walking the state tree.
StateOptionsFull(AbstractTerraformTask) - Constructor in StateOptionsFull
supportsAutoApprove() - Method in AbstractTerraformTask: To be called from tasks where the command supports auto-approve.
supportsColor(boolean) - Method in AbstractTerraformTask: To be called from tasks where the command supports no-color.
supportsForce() - Method in AbstractTerraformTask
supportsInputs() - Method in AbstractTerraformTask: To be called from tasks where the command supports input.

T

target(Iterable<String>) - Method in ResourceFilter
taskCreator(Project, TerraformSourceDirectorySet) - Method in S3Conventions
taskLazyCreator(Project, NamedDomainObjectProvider<TerraformSourceDirectorySet>) - Method in S3Conventions
taskName(String, String) - Method in TerraformConvention: Provides a task name
Templates - Class in org.ysb33r.gradle.terraform.internal.remotestate
TERRAFORM_DEFAULT - Field in TerraformExtension: The default version of Terraform that will be used on a supported platform if nothing else is configured.
TERRAFORM_INIT - Field in TerraformConvention
TERRAFORM_RC_EXT - Field in TerraformRCPlugin
TERRAFORM_RC_TASK - Field in TerraformRCPlugin
TERRAFORM_SOURCESETS - Field in TerraformBasePlugin
TERRAFORM_TASK_GROUP - Field in TerraformBasePlugin
TerraformApply - Class in org.ysb33r.gradle.terraform.tasks: Equivalent of terraform apply.
TerraformApply(TerraformPlanProvider) - Constructor in TerraformApply
TerraformBasePlugin - Class in org.ysb33r.gradle.terraform.plugins: Provide the basic capabilities for dealing with Terraform tasks.
TerraformCacheBinary - Class in org.ysb33r.gradle.terraform.tasks
TerraformCacheBinary() - Constructor in TerraformCacheBinary
TerraformConfigurationException - Class in org.ysb33r.gradle.terraform.errors: Thrown when there is an issue configuring terraform.
TerraformConfigUtils - Class in org.ysb33r.gradle.terraform.internal: Internal utilities for dealing with Terraform tool configuration.
TerraformConvention - Class in org.ysb33r.gradle.terraform.internal: Provide convention naming.
TerraformDestroy - Class in org.ysb33r.gradle.terraform.tasks: Equivalent of terraform destroy.
TerraformDestroy(TerraformPlanProvider) - Constructor in TerraformDestroy
terraformEnvironment(Project, String, Provider<File>, Provider<File>, String) - Method in TerraformUtils: Obtain the required terraform execution environmental variables
TerraformExecSpec - Class in org.ysb33r.gradle.terraform: An execution specification for Terraform.
TerraformExecSpec(Project, ExternalExecutable) - Constructor in TerraformExecSpec: Construct class and attach it to specific project.
TerraformExecutionException - Class in org.ysb33r.gradle.terraform.errors: Thrown when there is an issue executing terraform.
TerraformExtension - Class in org.ysb33r.gradle.terraform: Configure project defaults or task specifics for Terraform.
TerraformExtension(AbstractTerraformTask, List<TerraformExtensionConfigTypes>) - Constructor in TerraformExtension: Constructs a new extension which is attached to the provided task.
TerraformExtensionConfigTypes - Enum in org.ysb33r.gradle.terraform.config.multilevel: Describes configuration types that can be added to Terraform extensions and to source sets.
TerraformExtensionEmbeddable - Interface in org.ysb33r.gradle.terraform.config.multilevel
TerraformImport - Class in org.ysb33r.gradle.terraform.tasks: Equivalent of terraform import.
TerraformImport() - Constructor in TerraformImport
TerraformInit - Class in org.ysb33r.gradle.terraform.tasks: Equivalent of terraform init.
TerraformInit() - Constructor in TerraformInit
TerraformOutput - Class in org.ysb33r.gradle.terraform.tasks: Equivalent of terraform output.
TerraformOutput() - Constructor in TerraformOutput
terraformPath(Object) - Method in AbstractTerraformTask: Converts a file path to a format suitable for interpretation by Terraform on the appropriate platform.
terraformPath(Object) - Method in TerraformExtension: Converts a file path to a format suitable for interpretation by Terraform on the appropriate platform.
terraformPath(Object) - Method in TerraformSourceDirectorySet: Converts a file path to a format suitable for interpretation by Terraform on the appropriate platform.
terraformPath(Project, Object) - Method in TerraformUtils: Converts a file path to a format suitable for interpretation by Terraform on the appropriate platform.
TerraformPlan - Class in org.ysb33r.gradle.terraform.tasks: Equivalent of terraform plan.
TerraformPlan() - Constructor in TerraformPlan
TerraformPlanProvider - Class in org.ysb33r.gradle.terraform.tasks: A provider of a TerraformPlan task instance.
TerraformPlanProvider(Project, String) - Constructor in TerraformPlanProvider
TerraformPlugin - Class in org.ysb33r.gradle.terraform.plugins: Provide the basic capabilities for dealing with Terraform tasks.
TerraformRCExtension - Class in org.ysb33r.gradle.terraform: Extension that describes a terraformrc file.
TerraformRCExtension(Project) - Constructor in TerraformRCExtension
TerraformRCPlugin - Class in org.ysb33r.gradle.terraform.plugins: A plugin that deals with Terraform tool configuration.
TerraformRemoteStateAwsS3Plugin - Class in org.ysb33r.gradle.terraform.plugins
TerraformRemoteStateBasePlugin - Class in org.ysb33r.gradle.terraform.plugins
TerraformRemoteStateExtension - Class in org.ysb33r.gradle.terraform.remotestate: Extension that is added to the project TerraformExtension
TerraformRemoteStateExtension(Project) - Constructor in TerraformRemoteStateExtension
TerraformShowState - Class in org.ysb33r.gradle.terraform.tasks: Equivalent of terraform show /path/to/terraform.tfstate.
TerraformShowState() - Constructor in TerraformShowState
TerraformSourceDirectorySet - Class in org.ysb33r.gradle.terraform: Describes a Terraform source set
TerraformSourceDirectorySet(Project, String, String) - Constructor in TerraformSourceDirectorySet: Constructs the source set.
TerraformSourceSetEmbeddable - Interface in org.ysb33r.gradle.terraform.config.multilevel
TerraformSourceSets - Class in org.ysb33r.gradle.terraform
TerraformSourceSets(Project) - Constructor in TerraformSourceSets
TerraformStateMv - Class in org.ysb33r.gradle.terraform.tasks: The terraform state mv command.
TerraformStateMv() - Constructor in TerraformStateMv
TerraformStatePush - Class in org.ysb33r.gradle.terraform.tasks: The terraform state rm command.
TerraformStatePush() - Constructor in TerraformStatePush
TerraformStateRm - Class in org.ysb33r.gradle.terraform.tasks: The terraform state rm command.
TerraformStateRm() - Constructor in TerraformStateRm
TerraformTaskConfigExtension - Interface in org.ysb33r.gradle.terraform.config: An extension that can be added to a task for representing a specific grouping of Terraform command-line parameters.
TerraformUtils - Class in org.ysb33r.gradle.terraform.internal: General utilities for Terraform.
TerraformValidate - Class in org.ysb33r.gradle.terraform.tasks: Equivalent of terraform validate.
TerraformValidate() - Constructor in TerraformValidate
TerraformWrapper - Class in org.ysb33r.gradle.terraform.tasks
TerraformWrapper(TerraformCacheBinary) - Constructor in TerraformWrapper
TerraformWrapperPlugin - Class in org.ysb33r.gradle.terraform.plugins
toHCL(Writer) - Method in TerraformRCExtension: Writes to the content of the Terraform configuration to an HCL writer.
tokens(Map<String, Object>) - Method in AbstractRemoteStateConfigGenerator: Adds more tokens.
toList(Collection<I>, Function<I, O>) - Method in Transform
toSet(Iterable<I>, Function<I, O>) - Method in Transform
toString() - Method in TerraformSourceDirectorySet: The display name is the string representation of the source set.
toString() - Method in Variables
toString() - Method in VarsFilesPair: Returns a string representation of the object.
Transform - Class in org.ysb33r.gradle.terraform.internal

U

unsetLogLevel() - Method in AbstractTerraformTask
uriFromVersion(String) - Method in Downloader: Provides an appropriate URI to download a specific version of Terraform.
useAwsEnvironment() - Method in AbstractTerraformTask: Adds AWS environmental variables to Terraform runtime environment.
useAwsEnvironment() - Method in TerraformExtension: Adds AWS environmental variables to Terraform runtime environment.

V

var(String, Object) - Method in Variables: Adds one variable.
var(String, Object) - Method in VariablesSpec: Adds one variable.
Variables - Class in org.ysb33r.gradle.terraform.config.multilevel: A configuration building block for tasks that need to pass variables to a terraform task.
variables(Action<VariablesSpec>) - Method in TerraformSourceDirectorySet: Sets Terraform variables that are applicable to this source set.
Variables(VarsFilesPair, Provider<File>) - Constructor in Variables: Constructs instance from defintiion of files and variables
VariablesSpec - Interface in org.ysb33r.gradle.terraform.config: @since 0.2
VarsFilesPair - Class in org.ysb33r.gradle.terraform.config.multilevel: Keeps a collection of variables and variable files.

W

warnOnNewVersion(boolean) - Method in TerraformExtension: Turn checkpoint warning on or off
WRAPPER_TASK_NAME - Field in TerraformWrapperPlugin