A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

AbstractBackendSpec - Class in org.ysb33r.gradle.terraform.remotestate
Base class for simplify implementation of backend specifications.
AbstractBackendSpec(ProjectOperations, ObjectFactory) - Constructor in AbstractBackendSpec
AbstractTerraformBaseTask - Class in org.ysb33r.gradle.terraform.tasks
Base class for Terraform tasks.
AbstractTerraformBaseTask(String, List<Class>, List<TerraformExtensionConfigTypes>) - Constructor in AbstractTerraformBaseTask
AbstractTerraformCustomFmt - Class in org.ysb33r.gradle.terraform.tasks
Base class for custom formatting tasks.
AbstractTerraformCustomFmt() - Constructor in AbstractTerraformCustomFmt
AbstractTerraformProviderTask - Class in org.ysb33r.gradle.terraform.tasks
Base classs all terraform provider subcommands.
AbstractTerraformProviderTask(String) - Constructor in AbstractTerraformProviderTask
AbstractTerraformStateTask - Class in org.ysb33r.gradle.terraform.tasks
Base classs all terraform state subcommands.
AbstractTerraformStateTask(String, String) - Constructor in AbstractTerraformStateTask
AbstractTerraformTask - Class in org.ysb33r.gradle.terraform.tasks
A base class for performing a terraform execution.
AbstractTerraformTask(String, List<Class>, List<TerraformExtensionConfigTypes>, String) - Constructor in AbstractTerraformTask
Parameters:
command - Command to be executed.
accessKeyId() - Method in TerraformAwsCredentialsProvider.Credentials
addBackend(String, Class<T>, Closure) - Method in TerraformBackendExtension
Adds the backend to the project's TerraformRemoteStateExtension and to every TerraformSourceDirectorySet's remote extension.
addBooleanCmdLineOption(TerraformExecSpec, String, boolean) - Method in AbstractTerraformTask
Adds a boolean command-line option with correct formatting to the execution specification.
addCommandLineProvider(Provider<List<String>>) - Method in AbstractTerraformBaseTask
Adds a command-line provider.
addCommandSpecificsForFmt(TerraformExecSpec) - Method in AbstractTerraformCustomFmt
addCommandSpecificsForFmt(TerraformExecSpec) - Method in TerraformCustomFmtApply
addCommandSpecificsForFmt(TerraformExecSpec) - Method in TerraformCustomFmtCheck
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in AbstractTerraformBaseTask
Add specific command-line options for the command.
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in AbstractTerraformCustomFmt
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in AbstractTerraformProviderTask
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in AbstractTerraformStateTask
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformApply
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformDestroy
Add specific command-line options for the command.
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformDestroyPlan
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformFmtApply
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformFmtCheck
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformImport
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformInit
Add specific command-line options for the command.
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformOutput
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformPlan
Add specific command-line options for the command.
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformProvidersLock
Add specific command-line options for the command.
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformProvidersSchema
Add specific command-line options for the command.
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformShowState
Add specific command-line options for the command.
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformStateMv
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformStatePush
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformStateRm
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformUntaint
addCommandSpecificsToExecSpec(TerraformExecSpec) - Method in TerraformValidate
Add specific command-line options for the command.
addRemoteStateExtension(Project, ExtensionAware) - Method in TerraformBasePlugin
addSessionCredentialsIfAvailable(TerraformExecSpec) - Method in AbstractTerraformTask
addTokenProvider(Provider<Map<String, Object>>) - Method in AbstractBackendSpec
Adds a provider of tokens.
addTokenProvider(Provider<Map<String, Object>>) - Method in BackendSpec
Adds a provider of tokens.
addTokenProvider(Provider<Map<String, Object>>) - Method in RemoteStateAwsS3ConfigGenerator
addTokenProvider(Provider<Map<String, Object>>) - Method in RemoteStateConfigGenerator
Adds a provider of tokens.
addVariableFilesToCmdLine(TerraformExecSpec, FileCollection) - Method in AbstractTerraformTask
Add files containing variables to command-line.
addVariablesToCmdLine(TerraformExecSpec, Map<String, String>) - Method in AbstractTerraformTask
Adds Terraform variables to execution specification.
allTokenTemplate() - Method in AbstractBackendSpec
The template is simply a dump of all tokens that were set.
allTokenTemplate() - Method in BackendSpec
The template is simply a dump of all tokens that were set.
alwaysOutOfDate() - Method in AbstractTerraformTask
Marks task to always be out of date.
apply(Project) - Method in TerraformAwsPlugin
apply(Project) - Method in TerraformBasePlugin
apply(Project) - Method in TerraformCheckPlugin
apply(Project) - Method in TerraformGitlabPlugin
apply(Project) - Method in TerraformPlugin
apply(Project) - Method in TerraformRCPlugin
apply(Project) - Method in TerraformRemoteStateAwsS3Plugin
apply(Project) - Method in TerraformRemoteStateTerraformCloudPlugin
apply(Project) - Method in TerraformWrapperPlugin
ARCH - Field in Downloader
AssumedRoleSpec - Class in org.ysb33r.gradle.terraform.aws
Specification for an assumed AWS role.
assumeRole(AwsCredentialsProviderChain, AssumedRoleSpec) - Method in AwsAuthentication
AWS_KEY - Field in AwsAuthentication
AWS_SECRET - Field in AwsAuthentication
AWS_TOKEN - Field in AwsAuthentication
AwsAuthentication - Class in org.ysb33r.gradle.terraform.aws.internal
Utilities for AWS Authentication
AwsAuthentication.SimpleAwsCredentials - Class in org.ysb33r.gradle.terraform.aws.internal
awsEnvironment() - Method in TerraformUtils
Get all AWS-related environmental variables.
AwsExtension - Class in org.ysb33r.gradle.terraform.aws
An extension that is added to terraform source sets.
AwsExtension(Project) - Constructor in AwsExtension

B

backend(Class<? extends BackendSpec>, Action<? extends BackendSpec>) - Method in TerraformRemoteStateExtension
Replaces the existing backend with another registered one and configures it.
backendConfigValue(String, Object) - Method in TerraformInit
Adds a single backend value.
backendConfigValues(Map<String, Object>) - Method in TerraformInit
Adds additional backend configuration values
BackendFactory - Class in org.ysb33r.gradle.terraform.internal.remotestate
Utilities for working with backends.
BackendSpec - Interface in org.ysb33r.gradle.terraform.remotestate
Describes the configuration for a backend.
backendTaskName(String) - Method in TerraformConvention
THe name of the backend configuration task.
BackendTextTemplate - Interface in org.ysb33r.gradle.terraform.remotestate
Represents a text template for creating a backend configuration file.
BASEURI - Field in Downloader
buildExecSpec() - Method in AbstractTerraformBaseTask
buildExecSpec() - Method in AbstractTerraformTask
byCommand(String) - Method in DefaultTerraformTasks
Find instance by command name

C

CACHE_BINARY_TASK_NAME - Field in TerraformWrapperPlugin
captureStdOutTo(Provider<File>) - Method in AbstractTerraformBaseTask
When command is run, capture the standard output
clear() - Method in AbstractBackendSpec
Reset all tokens as well as token delimiters.
clear() - Method in BackendSpec
Clear all tokens.
clear() - Method in Variables
Removes all existing variables and file references.
clear() - Method in VarsFilesPair
clearAllCredentials() - Method in AwsExtension
Removes any credential customisations and reset to a no-credential state.
clearAllCredentials() - Method in GitlabExtension
Removes any credential customisations and reset to a no-credential state.
commandLineArgs(Path) - Method in VarsFilesPair
Returns the command-line representation.
configure(Closure) - Method in AbstractBackendSpec
Configures the backend according to a specification
configure(Closure) - Method in BackendSpec
Configures the backend according to a specification
configure(Action<? extends BackendSpec>) - Method in RemoteStateConfigGenerator
configureExecSpec(TerraformExecSpec) - Method in AbstractTerraformBaseTask
Configures a TerraformExecSpec.
configureExecSpecForCmd(TerraformExecSpec, String, List<String>) - Method in AbstractTerraformBaseTask
Configures execution specification for a specific command.
copyTo(VarsFilesPair) - Method in VarsFilesPair
Copy these settings to another instance.
createBackend(ProjectOperations, ObjectFactory, TerraformSourceDirectorySet, String, Class<T>) - Method in BackendFactory
Creates an instance of a backend on a TerraformSourceDirectorySet.
createExecSpec() - Method in AbstractTerraformBaseTask
Creates a TerraformExecSpec.
createPluginCacheDir(TerraformRCExtension) - Method in TerraformConfigUtils
Creates the plugin cache directory if it is not a global configuration.
createTasksByConvention(Project, TerraformSourceDirectorySet) - Method in TerraformConvention
Creates or registers the tasks associated with a sourceset using specific conventions
createWorkspaceTasksByConvention(Project, TerraformSourceDirectorySet, String) - Method in TerraformConvention
Creates or registers the tasks associated with an additional workspace in a sourceset.
credentials(String, String) - Method in TerraformRCExtension
Adds a credential set to the configuration file.
CredentialsCache - Class in org.ysb33r.gradle.terraform.internal
Caches session credentials between tasks.
CredentialsCache(ProjectOperations) - Constructor in CredentialsCache
credentialsCacheFor(String, String, Provider<Set<SessionCredentials>>) - Method in TerraformExtension
Returns a map of credentials for for a source set.
CUSTOM_FMT_APPLY - Field in TerraformPlugin
CUSTOM_FMT_CHECK - Field in TerraformPlugin

D

dataDir - Field in AbstractTerraformCustomFmt
DEFAULT_SOURCESET_NAME - Field in TerraformConvention
DEFAULT_TOKEN_DELIMITER - Field in AbstractBackendSpec
DEFAULT_WORKSPACE - Field in TerraformConvention
DefaultTerraformSourceSets - Class in org.ysb33r.gradle.terraform.internal
DefaultTerraformSourceSets(Project) - Constructor in DefaultTerraformSourceSets
DefaultTerraformTasks - Enum in org.ysb33r.gradle.terraform.internal
Maps terraform tasks to conventions.
delimiterTokenPair(String, String) - Method in AbstractBackendSpec
Sets new delimiters for tokens.
delimiterTokenPair(String, String) - Method in BackendSpec
Sets new delimiters for tokens.
delimiterTokenPair(String, String) - Method in RemoteStateAwsS3ConfigGenerator
dirs(Object) - Method in TerraformCustomFmtCheck
Add directories to be set.
doesNotRequireSessionCredentials() - Method in AbstractTerraformTask
This specific task does not interact with state and thus does not require any session credentials.
doNotSwitchWorkspace() - Method in AbstractTerraformTask
This task is workspace aware, but workspaces should not be switched
Downloader - Class in org.ysb33r.gradle.terraform.internal
Downloads specific versions of Terraform.
Downloader(String, ProjectOperations) - Constructor in Downloader
Creates a downloader

E

environment(Map<String, ?>) - Method in TerraformExtension
Add environmental variables to be passed to the exe.
escapedFilePath(OperatingSystem, File) - Method in HashicorpUtils
Escapes file paths for safe inclusion in HCL files.
escapedList(Iterable<Object>, boolean) - Method in TerraformUtils
Takes a list and creates a HCL-list with appropriate escaping.
escapedMap(Map<String, ?>, boolean) - Method in TerraformUtils
Takes a map and creates a HCL-map with appropriate escaping.
escapeHclVars(Map<String, Object>, boolean) - Method in TerraformUtils
Escape HCL variables in a form suitable for using in a variables or backend configuration file.
escapeOneItem(Object, boolean) - Method in TerraformUtils
Escaped a single item.
escapeQuotesInString(String) - Method in TerraformUtils
Escapes any Terraform string quotes.
exclude(Iterable<String>) - Method in TerraformSourceDirectorySet
exec() - Method in AbstractTerraformBaseTask
exec() - Method in AbstractTerraformCustomFmt
exec() - Method in AbstractTerraformTask
exec() - Method in FindTerraformConfig
exec() - Method in RemoteStateConfigGenerator
exec() - Method in TerraformCleanupWorkspaces
exec() - Method in TerraformDestroy
exec() - Method in TerraformImport
exec() - Method in TerraformInit
exec() - Method in TerraformOutput
exec() - Method in TerraformPlan
exec() - Method in TerraformProvidersLock
exec() - Method in TerraformProvidersSchema
exec() - Method in TerraformShowState
exec() - Method in TerraformStatePull
executable(Map<String, ?>) - Method in TerraformExtension

F

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.
find(Project) - Method in TerraformBackendExtension
findBackend(Project, Class<T>) - Method in TerraformRemoteStateExtension
A utility to find the global configuration for a specific backend
findExtension(Project, String, Class<T>) - Method in AbstractBackendSpec
Utility to find a backend extension on a terraform source set.
findExtension(Project, String) - Method in RemoteStateS3
Utility to find this extension on a terraform source set.
findExtension(Project, String) - Method in RemoteStateS3Spec
Utility to find this extension on a terraform source set.
findExtension(Project, String) - Method in TerraformCloudBackendSpec
Utility to find this extension on a terraform source set.
findExtension(Project, String) - Method in TerraformRemoteStateExtension
Utility to find this extension on a terraform source set.
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
follow(RemoteStateS3Provider) - Method in RemoteStateS3Spec
Make settings follow that of another RemoteStateS3 provider.
follow(TerraformRemoteStateExtension) - Method in TerraformRemoteStateExtension
Follows the settings of another remote state extension.
FORMAT_ALL - Field in TerraformPlugin

G

generateFromTemplate(String, ProjectOperations, BackendAttributesSpec, Provider<File>, Provider<BackendTextTemplate>, Provider<File>, String, String, Map<String, Object>) - Method in Templates
Generates a configuration file
get(String, String, Provider<Set<SessionCredentials>>) - Method in CredentialsCache
getAdditionalProperties() - Method in TerraformCacheBinary
getAllPlatforms() - Method in TerraformExtension
Standard set of platforms.
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
getAssociatedRemoteStateExtension() - Method in RemoteStateS3Spec
getAttributesMap() - Method in RemoteStateS3Spec
Returns a provider to a map of all S3 backend attributes that could possible be configured.
getAwsRegion() - Method in RemoteStateAwsS3ConfigGenerator
Get AWS region used for remote storage.
getBackendConfigFile() - Method in RemoteStateAwsS3ConfigGenerator
getBackendConfigFile() - Method in RemoteStateConfigGenerator
The location of the backend configuration file.
getBackendConfigFile() - Method in TerraformInit
Configuration for Terraform backend.
getBackendConfigValues() - Method in TerraformInit
Backend configuration files.
getBackendFileRequired() - Method in RemoteStateConfigGenerator
Returns whether a backend partial configuration file should be generated.
getBackendName() - Method in TerraformRemoteStateExtension
The name of the currently configured backend.
getBackendProvider() - Method in RemoteStateConfigGenerator
getBackendProvider() - Method in TerraformRemoteStateExtension
A provider to the configured backend.
getBeginToken() - Method in RemoteStateAwsS3ConfigGenerator
getBeginToken() - Method in RemoteStateConfigGenerator
Starting delimiter for tokens.
getBeginToken() - Method in TerraformWrapper
getBeginTokenProvider() - Method in AbstractBackendSpec
Starting delimiter for tokens.
getBeginTokenProvider() - Method in RemoteStateConfigGenerator
Starting delimiter for tokens.
getBeginTokenProvider() - Method in TerraformRemoteStateExtension
Starting delimiter for tokens.
getBinaryLocation() - Method in TerraformCacheBinary
getBinaryVersion() - Method in TerraformCacheBinary
getCommandLineArgs() - Method in Lock
getCommandLineArgs() - Method in ResourceFilter
getCommandLineArgs() - Method in StateOptionsConcurrency
getCommandLineArgs() - Method in StateOptionsFull
getCommandLineArgs() - Method in Variables
getCommandLineProviders() - Method in AbstractTerraformBaseTask
getCredentialProviders(String) - Method in TerraformSourceDirectorySet
Returns the credential providers on a per workspace basis.
getCredentialsEnvForWorkspace(String) - Method in AwsExtension
getCredentialsEnvForWorkspace(String) - Method in GitlabExtension
Provide the credentials for a specific workspace.
getDataDir() - Method in AbstractTerraformTask
getDataDir() - Method in TerraformSourceDirectorySet
Data directory provider.
getDefaultCommandParameters() - Method in AbstractTerraformBaseTask
getDefaultEnvironment() - Method in AbstractTerraformBaseTask
getDefaultTextTemplate() - Method in RemoteStateConfigGenerator
The default text template that will be used if nothing else is configured.
getDefaultTextTemplate() - Method in TerraformRemoteStateExtension
The default template used for the partial configuration of the backend.
getDestinationDir() - Method in RemoteStateAwsS3ConfigGenerator
getDestinationDir() - Method in RemoteStateConfigGenerator
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 RemoteStateAwsS3ConfigGenerator
getEndToken() - Method in RemoteStateConfigGenerator
Terminating delimiter for tokens
getEndToken() - Method in TerraformWrapper
getEndTokenProvider() - Method in AbstractBackendSpec
Terminating delimiter for tokens
getEndTokenProvider() - Method in RemoteStateConfigGenerator
Terminating delimiter for tokens
getEndTokenProvider() - Method in TerraformRemoteStateExtension
Terminating delimiter for tokens
getEnvironment() - Method in AbstractTerraformBaseTask
Environment for running the exe
getEnvironment() - Method in GitlabSessionCredentials
Get the AWS credentials environment to pass to Terraform.
getEnvironment() - Method in SessionCredentials
Get the AWS credentials environment to pass to Terraform.
getEnvironment() - Method in TerraformAwsAssumeRoleCredentials
getEnvironment() - Method in TerraformAwsFixedCredentials
Get the AWS credentials environment to pass to Terraform.
getEnvironment() - Method in TerraformAwsSessionCredentials
Get the AWS credentials environment to pass to Terraform.
getEnvironment() - Method in TerraformExtension
Environment for running the exe
getEscapedVars() - Method in Variables
Evaluate all provided and local variables and convert them to Terraform-compliant strings, ready to be passed to command-line.
getEscapedVars(boolean) - Method in VarsFilesPair
Evaluate all provided and local 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.
getFileNames() - Method in VarsFilesPair
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 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
getLocalMirrorDirectory() - Method in TerraformExtension
An alternative local directory to look for provider packages rather than in upstream registries.
getLogDir() - Method in AbstractTerraformTask
getLogDir() - Method in TerraformSourceDirectorySet
Log directory provider.
getLogLevel() - Method in AbstractTerraformTask
The level at which Terraform should log to a file.
getMap() - Method in OutputVariablesCache
getNetMirror() - Method in TerraformExtension
An alternative network mirror service for provider packages.
getOutputName() - Method in TerraformOutput
List of names to retrieve output for.
getPlanFile() - Method in TerraformApply
getPlanOutputFile() - Method in TerraformDestroyPlan
getPlanOutputFile() - Method in TerraformPlan
Where the plan file will be written to.
getPlanReportOutputFile() - Method in TerraformDestroyPlan
getPlanReportOutputFile() - Method in TerraformPlan
Where the textual representation of the plan will be written to.
getPlatforms() - Method in TerraformExtension
Provide the list of platforms that need to be supported.
getPluginCacheDir() - Method in TerraformRCExtension
Location of Terraform plugin cache directory
getPrefix() - Method in TerraformRemoteStateExtension
A prefix that is added to remote state names.
getProjectOperations() - Method in AbstractBackendSpec
getProjectOperations() - Method in AbstractTerraformBaseTask
Project operations that replaces legacy methods on the org.gradle.api.Project class and which are safe to use in configuration cache environments.
getProjectTerraform() - Method in AbstractTerraformBaseTask
getPropertiesDescription() - Method in TerraformCacheBinary
getProviderLockFile() - Method in TerraformProvidersLock
Configuration for Terraform backend.
getRawOutputVariables(String) - Method in TerraformSourceDirectorySet
Returns a provider which can be used to access output variables from a source set.
getRegion() - Method in AssumedRoleSpec
getRemoteStateName() - Method in RemoteStateAwsS3ConfigGenerator
The name that will be used to identify remote state.
getRemoteStateVarProvider() - Method in TerraformRemoteStateExtension
A provider to indicate whether remote state tokens should be added as a terraform map variable.
getReportsDir() - Method in AbstractTerraformTask
getReportsDir() - Method in TerraformSourceDirectorySet
Reports directory.
getRequiredPlatforms() - Method in AbstractTerraformProviderTask
getResourceIdentifier() - Method in TerraformImport
getResourcePath() - Method in TerraformImport
The resource path
getResourcePath() - Method in TerraformStateRm
The resource path
getResourcePath() - Method in TerraformUntaint
getRoleArn() - Method in AssumedRoleSpec
getS3BucketName() - Method in RemoteStateAwsS3ConfigGenerator
The S3 bucket used for state storage
getSchemaOutputFile() - Method in TerraformProvidersSchema
Get the location where the report file needs to be generated.
getSecondarySources() - Method in AbstractTerraformTask
Additional sources that are not in the source set directory, but for which changes will require a re-run of the task.
getSecondarySources() - Method in TerraformSourceDirectorySet
Provides a list of secondary sources.
getSessionName() - Method in AssumedRoleSpec
getSourceDir() - Method in AbstractTerraformTask
getSourceDirectories() - Method in AbstractTerraformCustomFmt
The list of toplevel directories to check
getSourceDirectories() - Method in TerraformCustomFmtApply
getSourceDirectories() - Method in TerraformCustomFmtCheck
The list of toplevel directories to check
getSourceDirectoryProvider() - Method in TerraformCustomFmtCheck
getSourceFiles() - Method in AbstractTerraformTask
Files in the source directory that act as input files to determine up to date status.
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
getStateOutputFile() - Method in TerraformStatePull
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.
getStdoutCapture() - Method in AbstractTerraformBaseTask
getTemplateFile() - Method in AbstractBackendSpec
Returns location of template file.
getTemplateFile() - Method in RemoteStateAwsS3ConfigGenerator
getTemplateFile() - Method in RemoteStateConfigGenerator
Returns location of template file.
getTemplateFile() - Method in TerraformRemoteStateExtension
Returns location of template file.
getTerraformCommand() - Method in AbstractTerraformBaseTask
Returns the terraform command this task is implementing.
getTerraformCommand() - Method in TerraformUpgrade
getTerraformEnvironment() - Method in AbstractTerraformBaseTask
getTerraformEnvironment() - Method in AbstractTerraformCustomFmt
getTerraformEnvironment() - Method in AbstractTerraformTask
getTerraformExecutablePath() - Method in Downloader
Returns the path to the terraform executable.
getTerraformExtension() - Method in AbstractTerraformBaseTask
getTerraFormLocationFile() - Method in FindTerraformConfig
getTerraformMajorVersion() - Method in AbstractTerraformTask
Tries to determine the current terraform version group
getTerraformrc() - Method in AbstractTerraformBaseTask
getTerraformRC() - Method in TerraformRCExtension
Location of the terraformrc file if it shoudl be written by the project.
getTerraformRCTask() - Method in TerraformRCExtension
Task that creates the .terraformrc file.
getTextTemplate() - Method in AbstractBackendSpec
Returns text template.
getTextTemplate() - Method in RemoteStateAwsS3ConfigGenerator
getTextTemplate() - Method in RemoteStateConfigGenerator
Returns text template.
getTextTemplate() - Method in TerraformRemoteStateExtension
Returns text template.
getTfVarProviders() - Method in AbstractTerraformBaseTask
Obtain a list of associated variables, should if be a valid condition for the task.
getTfVars() - Method in Variables
getTokenProvider() - Method in AbstractBackendSpec
A provider for all the tokens that were set.
getTokenProvider() - Method in TerraformRemoteStateExtension
A provider of all of the tokens that were configured in the active backend.
getTokens() - Method in AbstractBackendSpec
Returns the current set of tokens
getTokens() - Method in RemoteStateAwsS3ConfigGenerator
Returns the current set of tokens
getTokens() - Method in RemoteStateConfigGenerator
Returns the current set of tokens
getTokens() - Method in TerraformRemoteStateExtension
Returns the current set of tokens
getTokenValuesAsMap() - Method in TerraformWrapper
getToolExtension() - Method in AbstractTerraformBaseTask
getVariables() - Method in TerraformSourceDirectorySet
Get all terraform variables applicable to this source set.
getVariablesFile() - Method in TerraformDestroyPlan
getVariablesFile() - Method in TerraformImport
This is the location of an variables file used to keep anything provided via the build script.
getVariablesFile() - Method in TerraformPlan
This is the location of an variables file used to keep anything provided via the build script.
getVarsInTfFormat() - Method in VarsFilesPair
Gets all variables in a Terraform file format.
getWarnOnNewVersion() - Method in TerraformExtension
Print a warning message if a new version of terraform is available.
getWorkingDirForCommand() - Method in AbstractTerraformBaseTask
getWorkingDirForCommand() - Method in AbstractTerraformCustomFmt
getWorkingDirForCommand() - Method in AbstractTerraformTask
getWorkspaceName() - Method in AbstractTerraformTask
The workspace name.
getWorkspaceNames() - Method in TerraformSourceDirectorySet
List of additional workspaces.
GITLAB_TOKEN - Field in GitlabSessionCredentials
GitlabExtension - Class in org.ysb33r.gradle.terraform.gitlab
Provides Gitlab token authentication to Terraform.
GitlabExtension(Project) - Constructor in GitlabExtension
GitlabSessionCredentials - Class in org.ysb33r.gradle.terraform.gitlab
Maintains sessions credentials for Gitlab
GitlabSessionCredentials(Provider<String>) - Constructor in GitlabSessionCredentials

H

handleExecResult(ExecResult) - Method in AbstractTerraformCustomFmt
handleExecResult(ExecResult) - Method in TerraformCustomFmtApply
handleExecResult(ExecResult) - Method in TerraformCustomFmtCheck
hasCredentials() - Method in AwsExtension
Whether credentials were configured.
hasCredentials() - Method in GitlabExtension
Whether any credentials has been configured for this provider.
HashicorpUtils - Class in org.ysb33r.grashicorp
Code for dealing with Hashicorp standards.
hasWorkspaces() - Method in AbstractTerraformTask
Indicated whether this task is associated with a source set which has workspaces other than just default.
hasWorkspaces() - Method in TerraformSourceDirectorySet
Flags whether workspaces have been defined.

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
INSTANCE - Field in TextTemplates.AllTokens
INSTANCE - Field in TextTemplates.LegacyS3ReplaceTokens
isDownloadSupported() - Method in Downloader
Tells the system whether downloading can be supported.
isExpired() - Method in GitlabSessionCredentials
Whether the credentials expired.
isExpired() - Method in SessionCredentials
Whether the credentials expired.
isExpired() - Method in TerraformAwsAssumeRoleCredentials
isExpired() - Method in TerraformAwsFixedCredentials
Whether the credentials expired.
isExpired() - Method in TerraformAwsSessionCredentials
Whether the credentials expired.

J

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

K

L

legacyTaskCreator(Project, TerraformSourceDirectorySet) - Method in S3Conventions
list(String, Iterable<?>) - Method in Variables
Adds a list as a variable.
list(String, Iterable<?>) - Method in VariablesSpec
Adds a list as a variable.
listWorkspaces() - Method in AbstractTerraformTask
Lists the workspaces as currently known to Terraform
LocalBackendSpec - Class in org.ysb33r.gradle.terraform.remotestate
Terraform local backend specification.
LocalBackendSpec(ProjectOperations, ObjectFactory) - Constructor in LocalBackendSpec
locateGlobalTerraformConfigAsString() - Method in TerraformConfigUtils
Locates the global terraformrc file
locateTerraformConfigFile(TerraformRCExtension) - 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(String, Provider<Map<String, ?>>) - Method in Variables
Adds a map provider as a variable.
map(String, Provider<Map<String, ?>>) - Method in VariablesSpec
Adds a map provider 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 AwsExtension
NAME - Field in GitlabExtension
NAME - Field in IgnoreGlobal
NAME - Field in IgnoreSourceSet
NAME - Field in LocalBackendSpec
NAME - Field in RemoteStateS3Spec
NAME - Field in TerraformBackendExtension
NAME - Field in TerraformCloudBackendSpec
NAME - Field in TerraformExtension
The standard extension name.
NAME - Field in TerraformRemoteStateExtension
NO_COLOR - Field in AbstractTerraformTask
Command-line parameter for no colour.
noFollow() - Method in TerraformRemoteStateExtension
Do not follow any other remote state.

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(ProjectOperations, TerraformRCExtension, Provider<TerraformOutput>) - Constructor in OutputVariablesCache

P

platforms(String) - Method in TerraformExtension
Add one or more platforms to support for providers.
PLUGIN_VERSION - Field in TerraformUtils
provider(Action<VariablesSpec>) - Method in Variables
Adds additional actions which can add variables.
provider(Action<VariablesSpec>) - Method in VariablesSpec
Adds additional actions which can add variables.

Q

R

rawOutputVariable(String, String) - Method in TerraformSourceDirectorySet
Returns a provider to a specific output variable.
refresh() - Method in GitlabSessionCredentials
Create a new set of credentials.
refresh() - Method in SessionCredentials
Create a new set of credentials.
refresh() - Method in TerraformAwsAssumeRoleCredentials
refresh() - Method in TerraformAwsFixedCredentials
Create a new set of credentials.
refresh() - Method in TerraformAwsSessionCredentials
Create a new set of credentials.
registerCredentialProvider(SessionCredentialsProvider) - Method in TerraformSourceDirectorySet
Registers a credentials provider.
REMOTE_STATE_VARIABLE - Field in TerraformBasePlugin
RemoteStateAwsS3ConfigGenerator - Class in org.ysb33r.gradle.terraform.tasks
Legacy way of generating S3 backend config files.
RemoteStateAwsS3ConfigGenerator(TaskProvider<RemoteStateConfigGenerator>) - Constructor in RemoteStateAwsS3ConfigGenerator
RemoteStateConfigGenerator - Class in org.ysb33r.gradle.terraform.tasks
Generates a remote state file containing partial configuration for backend.
RemoteStateConfigGenerator() - Constructor in RemoteStateConfigGenerator
RemoteStateS3 - Class in org.ysb33r.gradle.terraform.remotestate
An extension that is added to TerraformRemoteStateExtension.
RemoteStateS3Spec - Class in org.ysb33r.gradle.terraform.remotestate
Describes the attributed for a remote S3 backend.
RemoteStateS3Spec(ProjectOperations, ObjectFactory) - Constructor in RemoteStateS3Spec
replace(Iterable<String>) - Method in ResourceFilter
resolveCredentials() - Method in TerraformAwsCredentialsProvider
Resolves credentials
resolveTerraformVersion() - Method in TerraformExtension
If the version is set via a version string return that, otherwise run terraform and parse the output
ResourceFilter - Class in org.ysb33r.gradle.terraform.config
Allows for lock configurations on a task.
ResourceFilter(AbstractTerraformTask) - Constructor in ResourceFilter
runWorkspaceSubcommand(String, String) - Method in AbstractTerraformTask
Runs a terraform workspace subcommand.

S

S3Conventions - Class in org.ysb33r.gradle.terraform.internal.remotestate
Conventions for when TerraformRemoteStateAwsS3Plugin is applied.
s3Spec(Closure) - Method in RemoteStateAwsS3ConfigGenerator
Configures a RemoteStateS3Spec.
searchPath() - Method in TerraformExtension
Use this to configure a system path search for Terraform.
secondarySources(Iterable<Object>) - Method in TerraformSourceDirectorySet
Additional sources that affects infrastructure.
secretAccessKey() - Method in TerraformAwsCredentialsProvider.Credentials
SessionCredentials - Interface in org.ysb33r.gradle.terraform.credentials
Interface for using Gradle as a credentials provider to various Terraform providers.
setAccessKey(Object) - Method in RemoteStateS3Spec
Sets a token called access_key.
setAcl(Object) - Method in RemoteStateS3Spec
Sets a token called acl.
setAllowMissing(boolean) - Method in TerraformUntaint
setAssociatedRemoteStateExtension(TerraformRemoteStateExtension) - Method in RemoteStateS3Spec
setAssumeRoleDurationSeconds(Integer) - Method in RemoteStateS3Spec
Sets a token called assume_role_duration_seconds.
setAssumeRolePolicy(String) - Method in RemoteStateS3Spec
Sets a token called assume_role_policy.
setAssumeRolePolicyARNs(Object) - Method in RemoteStateS3Spec
Sets a token called assume_role_policy_arns.
setAssumeRoleTags(Map<String, Object>) - Method in RemoteStateS3Spec
Sets a token called assume_role_tags.
setAssumeRoleTransitiveTagKeys(Object) - Method in RemoteStateS3Spec
Sets a token called assume_role_transitive_tag_keys.
setAuthToken(Object) - Method in TerraformCloudBackendSpec
Set authentication token.
setAutoApprove(Boolean) - Method in TerraformDestroy
Set auto-approve mode.
setAutoApprove(Boolean) - Method in TerraformUpgrade
Set auto-approve mode.
setAwsRegion(Object) - Method in RemoteStateAwsS3ConfigGenerator
The AWS region used for remote state.
setAwsRegion(Object) - Method in RemoteStateS3Spec
The AWS region used for remote state.
setBackend(Class<? extends BackendSpec>) - Method in TerraformRemoteStateExtension
Replaces the existing backend with another registered one.
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 RemoteStateS3Spec
Alias for setS3BucketName
setCredentialsFile(Object) - Method in RemoteStateS3Spec
Sets a token called shared_credentials_file.
setDataDir(Object) - Method in TerraformSourceDirectorySet
Sets the Terraform data directory.
setDestinationDir(Object) - Method in RemoteStateAwsS3ConfigGenerator
setDestinationDir(Object) - Method in RemoteStateConfigGenerator
Override the output directory.
setDestinationPath(String) - Method in TerraformStateMv
setDirs(Iterable<?>) - Method in TerraformCustomFmtCheck
Replace existing directories with a new set.
setDynamoDbEndpoint(Object) - Method in RemoteStateS3Spec
Sets a token called dynamodb_endpoint.
setDynamoDbLockTableArn(Object) - Method in RemoteStateS3Spec
Sets a token called aws_dynamodb_lock_table_arn.
setDynamoDbTable(Object) - Method in RemoteStateS3Spec
Sets a token called dynamodb_table_arn.
setEncrypt(Boolean) - Method in RemoteStateS3Spec
Sets a token called encrypt.
setEnvironment(Map<String, ?>) - Method in AbstractTerraformBaseTask
Replace current environment with new one.
setEnvironment(Map<String, ?>) - Method in TerraformExtension
Replace current environment with new one.
setExcludes(Iterable<String>) - Method in TerraformSourceDirectorySet
setExternalId(Object) - Method in RemoteStateS3Spec
Sets a token called external_id.
setForcePathStyle(Boolean) - Method in RemoteStateS3Spec
Sets a token called force_path_style.
setHostname(Object) - Method in TerraformCloudBackendSpec
Sets a hostname if other than app.terraform.io.
setIamEndpoint(Object) - Method in RemoteStateS3Spec
Sets a token called iam_endpoint.
setIgnoreRemote(boolean) - Method in TerraformUntaint
setIncludes(Iterable<String>) - Method in TerraformSourceDirectorySet
setJson(boolean) - Method in TerraformApply
Output progress in json as per https://www.terraform.io/docs/internals/machine-readable-ui.html
setJson(boolean) - Method in TerraformPlan
Where to write the report in human-readable or JSON format.
setKey(Object) - Method in RemoteStateS3Spec
Sets a new remote state name
setLocalMirrorDirectory(Object) - Method in TerraformExtension
Set an alternative local directory to look for provider packages rather than in upstream registries.
setLogDir(Object) - Method in TerraformSourceDirectorySet
Sets the log directory.
setLogLevel(LogLevel) - Method in AbstractTerraformTask
setLogProgress(boolean) - Method in AbstractTerraformTask
Whether to log progress to the directory specified in getLogDir.
setMaxRetries(Integer) - Method in RemoteStateS3Spec
Sets a token called iam_endpoint.
setName(String) - Method in TerraformOutput
Set the list of output names to retrieve.
setNetMirror(Object) - Method in TerraformExtension
Set an alternative network mirror service for provide packages.
setOrganization(Object) - Method in TerraformCloudBackendSpec
Set organization name.
setPath(Object) - Method in LocalBackendSpec
Sets a path where local state will be stored.
setPluginCacheDir(Object) - Method in TerraformRCExtension
Sets the location of the Terraform plugin cache directory
setPrefix(Object) - Method in TerraformRemoteStateExtension
Assign the prefix.
setProfile(Object) - Method in RemoteStateS3Spec
Sets a token called profile.
setRegion(Object) - Method in AssumedRoleSpec
setRegion(Object) - Method in RemoteStateS3Spec
Alias for setAwsRegion.
setRemoteState(TerraformRemoteStateExtension) - Method in RemoteStateConfigGenerator
Set remote state.
setRemoteStateName(Object) - Method in RemoteStateAwsS3ConfigGenerator
Sets a new remote state name
setRemoteStateName(Object) - Method in RemoteStateS3Spec
Sets a new remote state name
setRemoteStateVar(boolean) - Method in TerraformRemoteStateExtension
Whether tokens should be bundled in a map variable called remote_state.
setReplacements(Iterable<String>) - Method in ResourceFilter
setReplacements(List<String>) - Method in TerraformApply
Mark resources to be replaced.
setReplacements(List<String>) - Method in TerraformPlan
Mark resources to be replaces.
setReportsDir(Object) - Method in TerraformSourceDirectorySet
Sets the reports directory.
setResourceIdentifier(String) - Method in TerraformImport
setResourceName(String) - Method in TerraformImport
setResourceName(String) - Method in TerraformStateRm
setResourcePath(String) - Method in TerraformImport
setResourcePath(String) - Method in TerraformStateRm
setResourcePath(String) - Method in TerraformUntaint
setResourceType(String) - Method in TerraformImport
setResourceType(String) - Method in TerraformStateRm
setRoleArn(Object) - Method in AssumedRoleSpec
setRoleArn(Object) - Method in RemoteStateS3Spec
Sets a token called role_arn.
setS3BucketName(Object) - Method in RemoteStateAwsS3ConfigGenerator
Sets the S3 bucket used for state storage.
setS3BucketName(Object) - Method in RemoteStateS3Spec
Sets the S3 bucket used for state storage.
setS3Endpoint(Object) - Method in RemoteStateS3Spec
Sets a token called endpoint.
setSecretKey(Object) - Method in RemoteStateS3Spec
Sets a token called secret_key.
setSessionName(Object) - Method in AssumedRoleSpec
setSessionName(Object) - Method in RemoteStateS3Spec
Sets a token called session_name.
setSessionNameFactory(Callable<Provider<String>>) - Method in AwsExtension
Set a factory for creating session names
setSetKmsKeyId(Object) - Method in RemoteStateS3Spec
Sets a token called kms_key_id.
setSkipCredentialsValidation(Boolean) - Method in RemoteStateS3Spec
Sets a token called skip_credentials_validation.
setSkipMetadataApiCheck(Boolean) - Method in RemoteStateS3Spec
Sets a token called skip_metadata_api_check.
setSkipRegionValidation(Boolean) - Method in RemoteStateS3Spec
Sets a token called skip_region_validation.
setSourcePath(String) - Method in TerraformStateMv
setSourceSet(Object) - Method in AbstractTerraformTask
@param source Source set of anything that can be resolved using StringUtils#stringize(Object s)#stringize(Object s) and looked up as a Terraform source set.
setSrcDir(Object) - Method in TerraformSourceDirectorySet
Sets the source directory.
setSseCustomerKey(Object) - Method in RemoteStateS3Spec
Sets a token called sse_customer_key.
setStateFile(String) - Method in TerraformStatePull
setStateFileType(String) - Method in TerraformStatePush
setStsEndpoint(Object) - Method in RemoteStateS3Spec
Sets a token called sts_endpoint.
setTargets(Iterable<String>) - Method in ResourceFilter
setTargets(List<String>) - Method in TerraformApply
Select specific resources.
setTargets(List<String>) - Method in TerraformDestroy
setTargets(List<String>) - Method in TerraformPlan
Select specific resources.
setTemplateFile(Object) - Method in AbstractBackendSpec
Applies a custom template file for backend configuration.
setTemplateFile(Object) - Method in BackendSpec
Applies a custom template file for backend configuration.
setTemplateFile(Object) - Method in RemoteStateAwsS3ConfigGenerator
setTemplateFile(Object) - Method in RemoteStateConfigGenerator
Applies a custom template file for backend configuration.
setTextTemplate(Object) - Method in AbstractBackendSpec
Use a string as a template.
setTextTemplate(Object) - Method in BackendSpec
Use a string as a template.
setTextTemplate(Object) - Method in RemoteStateAwsS3ConfigGenerator
setTextTemplate(Object) - Method in RemoteStateConfigGenerator
Use a string as a template.
setTokens(Map<String, Object>) - Method in AbstractBackendSpec
Replace all tokens with a new set.
setTokens(Map<String, Object>) - Method in BackendSpec
Replace all tokens with a new set.
setTokens(Map<String, Object>) - Method in RemoteStateAwsS3ConfigGenerator
setUseBackendFile(Provider<Boolean>) - Method in TerraformInit
Whether a backend config file should be used.
setWarnOnNewVersion(boolean) - Method in TerraformExtension
Turn checkpoint warning on or off
setWorkspaceKeyPrefix(Object) - Method in RemoteStateS3Spec
Sets a token called workspace_key_prefix.
setWorkspaceName(Object) - Method in TerraformCloudBackendSpec
The full name of one remote workspace.
setWorkspacePrefix(Object) - Method in TerraformCloudBackendSpec
A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration.
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
stringizeOrNull(Object) - Method in TerraformUtils
Converts item to string if not null
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.
supportsYes() - Method in AbstractTerraformTask
To be called from tasks where the command supports yes.
switchWorkspace() - Method in AbstractTerraformTask
Switches workspaces to the correct one if the source set has workspaces and the current workspace is not the correct one.

T

target(Iterable<String>) - Method in ResourceFilter
taskName(String, String, String) - Method in TerraformConvention
Provides a task name
taskProvider(String) - Method in AbstractTerraformTask
Provider to another Terraform task.
template(BackendAttributesSpec) - Method in BackendTextTemplate
Returns a template based upon backend attributes.
template(BackendAttributesSpec) - Method in TextTemplates.AllTokens
Returns a template based upon backend attributes.
template(BackendAttributesSpec) - Method in TextTemplates.ReplaceTokens
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, String) - Constructor in TerraformApply
TerraformAwsAssumeRoleCredentials - Class in org.ysb33r.gradle.terraform.aws.internal
Credentials that can be used for a specific session
TerraformAwsAssumeRoleCredentials(AwsCredentialsProviderChain, AssumedRoleSpec) - Constructor in TerraformAwsAssumeRoleCredentials
TerraformAwsCredentialsProvider - Class in org.ysb33r.gradle.terraform.aws
A special credentials provider for use in the Terraform Gradle plugin, which can be add to an authentication chain.
TerraformAwsCredentialsProvider.Credentials - Class in org.ysb33r.gradle.terraform.aws
TerraformAwsCredentialsProvider.Credentials(String, String) - Constructor in TerraformAwsCredentialsProvider.Credentials
TerraformAwsCredentialsProvider(Provider<String>, Provider<String>, ProjectOperations) - Constructor in TerraformAwsCredentialsProvider
A provider that will look for AWS credentials.
TerraformAwsFixedCredentials - Class in org.ysb33r.gradle.terraform.aws.internal
Fixed credentials that are supplied to Terraform.
TerraformAwsFixedCredentials(Map<String, String>) - Constructor in TerraformAwsFixedCredentials
TerraformAwsPlugin - Class in org.ysb33r.gradle.terraform.aws
TerraformAwsSessionCredentials - Interface in org.ysb33r.gradle.terraform.aws
Holds AWS credentials for task execution
TerraformBackendExtension - Class in org.ysb33r.gradle.terraform.remotestate
TerraformBackendExtension(ProjectOperations, ObjectFactory, TerraformRemoteStateExtension, TerraformSourceSets) - Constructor in TerraformBackendExtension
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
TerraformCheckPlugin - Class in org.ysb33r.gradle.terraform.plugins
Forces terraform formatting checks as part of lifecycle.
TerraformCleanupWorkspaces - Class in org.ysb33r.gradle.terraform.tasks
The terraform workspace delete command.
TerraformCleanupWorkspaces() - Constructor in TerraformCleanupWorkspaces
TerraformCloudBackendSpec - Class in org.ysb33r.gradle.terraform.remotestate
Support the Terraform Cloud bakend a.k.a remote.
TerraformCloudBackendSpec(ProjectOperations, ObjectFactory) - Constructor in TerraformCloudBackendSpec
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.
TerraformCustomFmtApply - Class in org.ysb33r.gradle.terraform.tasks
Checks the format of Terraform source in an arbitrary collection of directories.
TerraformCustomFmtApply(TaskProvider<TerraformCustomFmtCheck>) - Constructor in TerraformCustomFmtApply
TerraformCustomFmtCheck - Class in org.ysb33r.gradle.terraform.tasks
Checks the format of Terraform source in an arbritrary collection of directories.
TerraformCustomFmtCheck() - Constructor in TerraformCustomFmtCheck
TerraformDestroy - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform destroy.
TerraformDestroy(TerraformPlanProvider, String) - Constructor in TerraformDestroy
TerraformDestroyPlan - Class in org.ysb33r.gradle.terraform.tasks
Generates a destroy plan
TerraformDestroyPlan(String) - Constructor in TerraformDestroyPlan
terraformEnvironment(TerraformRCExtension, 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(ProjectOperations, 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(AbstractTerraformBaseTask, 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
TerraformFmtApply - Class in org.ysb33r.gradle.terraform.tasks
The terraform fmt -write=true command.
TerraformFmtApply() - Constructor in TerraformFmtApply
TerraformFmtCheck - Class in org.ysb33r.gradle.terraform.tasks
The terraform fmt -check command.
TerraformFmtCheck() - Constructor in TerraformFmtCheck
TerraformGitlabPlugin - Class in org.ysb33r.gradle.terraform.gitlab
TerraformImport - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform import.
TerraformImport(String) - Constructor in TerraformImport
TerraformInit - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform init.
TerraformInit() - Constructor in TerraformInit
terraformLogFile(String, Provider<File>) - Method in TerraformUtils
Resolves the location of the log file.
TerraformMajorVersion - Enum in org.ysb33r.gradle.terraform
Major version groupings for Terraform
TerraformOutput - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform output.
TerraformOutput(String) - 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(ProjectOperations, 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(String) - Constructor in TerraformPlan
TerraformPlanProvider - Class in org.ysb33r.gradle.terraform.tasks
A provider of a TerraformPlan task instance.
TerraformPlanProvider(Project, String, String) - Constructor in TerraformPlanProvider
TerraformPlugin - Class in org.ysb33r.gradle.terraform.plugins
Provide the basic capabilities for dealing with Terraform tasks.
TerraformProvidersLock - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform providers lock.
TerraformProvidersLock() - Constructor in TerraformProvidersLock
TerraformProvidersSchema - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform providers schema.
TerraformProvidersSchema() - Constructor in TerraformProvidersSchema
TerraformProvidersShow - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform providers.
TerraformProvidersShow() - Constructor in TerraformProvidersShow
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
Adds RemoteStateS3Spec backends to the global TerraformBackendExtension and to each of the same extensions on each TerraformSourceDirectorySet.
TerraformRemoteStateExtension - Class in org.ysb33r.gradle.terraform.remotestate
Extension that is added to the project TerraformExtension and to instances of TerraformSourceDirectorySet
TerraformRemoteStateExtension(Project) - Constructor in TerraformRemoteStateExtension
TerraformRemoteStateTerraformCloudPlugin - Class in org.ysb33r.gradle.terraform.plugins
Adds TerraformCloudBackendSpec backends to the global TerraformBackendExtension and to each of the same extensions on each TerraformSourceDirectorySet.
TerraformShowState - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform show /path/to/terraform.tfstate.
TerraformShowState(String) - Constructor in TerraformShowState
TerraformSourceDirectorySet - Class in org.ysb33r.gradle.terraform
Describes a Terraform source set
TerraformSourceDirectorySet.Workspace - Class in org.ysb33r.gradle.terraform
TerraformSourceDirectorySet.Workspace(String) - Constructor in TerraformSourceDirectorySet.Workspace
TerraformSourceDirectorySet(Project, ObjectFactory, TaskContainer, TerraformRCExtension, String, String) - Constructor in TerraformSourceDirectorySet
Constructs the source set.
TerraformSourceFormatViolation - Class in org.ysb33r.gradle.terraform.errors
Thrown when terraform source format does not conform to convention.
TerraformSourceSetEmbeddable - Interface in org.ysb33r.gradle.terraform.config.multilevel
TerraformSourceSets - Interface in org.ysb33r.gradle.terraform
TerraformStateMv - Class in org.ysb33r.gradle.terraform.tasks
The terraform state mv command.
TerraformStateMv(String) - Constructor in TerraformStateMv
TerraformStatePull - Class in org.ysb33r.gradle.terraform.tasks
The terraform state rm command.
TerraformStatePull(String) - Constructor in TerraformStatePull
TerraformStatePush - Class in org.ysb33r.gradle.terraform.tasks
The terraform state rm command.
TerraformStatePush(String) - Constructor in TerraformStatePush
TerraformStateRm - Class in org.ysb33r.gradle.terraform.tasks
The terraform state rm command.
TerraformStateRm(String) - Constructor in TerraformStateRm
TerraformUnknownBackendException - Class in org.ysb33r.gradle.terraform.errors
Thrown when an unregistered backend is requested.
TerraformUntaint - Class in org.ysb33r.gradle.terraform.tasks
The terraform untaint command.
TerraformUntaint(String) - Constructor in TerraformUntaint
TerraformUpgrade - Class in org.ysb33r.gradle.terraform.tasks
Equivalent of terraform 0.12upgrade.
TerraformUpgrade() - Constructor in TerraformUpgrade
TerraformUpgradeNotSupportedException - Class in org.ysb33r.gradle.terraform.errors
Thrown when the specific version of terraform does not support upgrading.
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(String) - Constructor in TerraformValidate
TerraformWrapper - Class in org.ysb33r.gradle.terraform.tasks
TerraformWrapper(TerraformCacheBinary) - Constructor in TerraformWrapper
TerraformWrapperPlugin - Class in org.ysb33r.gradle.terraform.plugins
TextTemplates - Class in org.ysb33r.gradle.terraform.internal.remotestate
A collection of text templates.
TextTemplates.AllTokens - Class in org.ysb33r.gradle.terraform.internal.remotestate
TextTemplates.LegacyS3ReplaceTokens - Class in org.ysb33r.gradle.terraform.internal.remotestate
TextTemplates.ReplaceTokens - Class in org.ysb33r.gradle.terraform.internal.remotestate
A template to which ANT's ReplaceTokens can be applied to
TextTemplates.ReplaceTokens(Object) - Constructor in TextTemplates.ReplaceTokens
Provide the template.
toHCL(Writer) - Method in TerraformRCExtension
Writes to the content of the Terraform configuration to an HCL writer.
token(String, Object) - Method in AbstractBackendSpec
Set a single token value.
TOKEN_ASSUME_ROLE_POLICY - Field in RemoteStateS3Spec
token(String, Object) - Method in BackendSpec
Set a single token value.
TOKEN_BUCKET - Field in RemoteStateS3Spec
TOKEN_DYNAMODB_TABLE_ARN - Field in RemoteStateS3Spec
TOKEN_REGION - Field in RemoteStateS3Spec
TOKEN_REMOTE_STATE_NAME - Field in RemoteStateS3Spec
token(String, Object) - Method in RemoteStateAwsS3ConfigGenerator
tokenPath(String, Object) - Method in AbstractBackendSpec
Adds a token value that will be evaluated to a file path.
tokens(Map<String, Object>) - Method in AbstractBackendSpec
Adds more tokens.
tokens(Map<String, Object>) - Method in BackendSpec
Adds more tokens.
tokens(Map<String, Object>) - Method in RemoteStateAwsS3ConfigGenerator
toList(Map<I, V>, Entry<I, V>, O>) - Method in Transform
TOOL_IDENTIFIER - Field in Downloader
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.
useAwsCredentialsFromEnvironment(String) - Method in AwsExtension
Sets the credentials for a specific workspace to use AWS credentials from the environment and pass as-is to Terraform.
useAwsCredentialsFromEnvironmentForAssumeRole(String, Action<AssumedRoleSpec>) - Method in AwsExtension
Obtain a session key for an assumed role.
useAwsEnvironment() - Method in AbstractTerraformTask
Adds AWS environmental variables to Terraform runtime environment.
useAwsEnvironment() - Method in TerraformExtension
Adds AWS environmental variables to Terraform runtime environment.
useGitlabTokenFromEnvironment(String) - Method in GitlabExtension
Sets the credentials for a specific workspace to use Gitlab credentials from the environment and pass as-is to Terraform.
usePropertiesForAssumeRole(String, Provider<String>, Provider<String>, Action<AssumedRoleSpec>) - Method in AwsExtension
Obtain a session key for an assume role on a specific workspace.
usePropertiesForAws(String, Provider<String>, Provider<String>) - Method in AwsExtension
Pass these provider values to Terraform to use as authentication for a specific workspace.
useProperty(String, Provider<String>) - Method in GitlabExtension
Use a provider for the Gitlab token for a specific workspace.

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 definition 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.
version(String) - Method in TerraformMajorVersion

W

warnOnNewVersion(boolean) - Method in TerraformExtension
Turn checkpoint warning on or off
workspaces(String) - Method in TerraformSourceDirectorySet
Adds one or more workspaces.
WRAPPER_TASK_NAME - Field in TerraformWrapperPlugin

X

Y

Z

_

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _