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

AbstractApplyTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of apply.
AbstractApplyTask.1 - Class in org.ysb33r.gradle.iac.base.tf.tasks
AbstractApplyTask.1() - Constructor in AbstractApplyTask.1
AbstractApplyTask(java.lang.String, java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>, boolean) - Constructor in AbstractApplyTask
AbstractCleanupWorkspacesTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
The workspace delete command.
AbstractCleanupWorkspacesTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractCleanupWorkspacesTask
AbstractCustomFmtApplyTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Checks the format of Terraform/OpenTofu source in an arbitrary collection of directories.
AbstractCustomFmtApplyTask(Class<? extends IacTfExecSpec>) - Constructor in AbstractCustomFmtApplyTask
AbstractCustomFmtBaseTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Base class for custom formatting tasks.
AbstractCustomFmtBaseTask(Class<? extends IacTfExecSpec>) - Constructor in AbstractCustomFmtBaseTask
AbstractCustomFmtCheckTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Checks the format of OpenTofuTerraform source in an arbitrary collection of directories.
AbstractCustomFmtCheckTask(Class<? extends IacTfExecSpec>) - Constructor in AbstractCustomFmtCheckTask
AbstractDestroyTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Base class for destroying resources.
AbstractDestroyTask(java.lang.String, java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractDestroyTask
AbstractFmtApplyTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
The fmt -write=true command.
AbstractFmtApplyTask(Class<? extends IacTfExecSpec>) - Constructor in AbstractFmtApplyTask
AbstractFmtCheckTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
The fmt -check command.
AbstractFmtCheckTask(Class<? extends IacTfExecSpec>) - Constructor in AbstractFmtCheckTask
AbstractGlobalConfigExtension - Class in org.ysb33r.gradle.iac.base.tf
Extension that describes a terraformrc or opentofurc file.
AbstractGlobalConfigExtension(org.gradle.api.Project, java.lang.String, java.lang.String) - Constructor in AbstractGlobalConfigExtension
AbstractIacBackend - Class in org.ysb33r.gradle.iac.base.tf.backends
Configuration for an OpenTofu/Terraform backend.
AbstractIacBackend.BackendTokenOverrideProxy - Class in org.ysb33r.gradle.iac.base.tf.backends
For configuring backend token overrides on the command-line.
AbstractIacBackend(java.lang.String, org.gradle.api.Project) - Constructor in AbstractIacBackend
A constructor to be used by generic backends.
AbstractIacCacheBinaryTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
AbstractIacCacheBinaryTask(java.lang.String, java.lang.String) - Constructor in AbstractIacCacheBinaryTask
AbstractIacToolchain - Class in org.ysb33r.gradle.iac.base.tf
Abstract toolchain for OpenTofu and Terraform.
AbstractIacToolchain(java.lang.String, org.gradle.api.Project) - Constructor in AbstractIacToolchain
AbstractIacWrapperTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Script wrapper generator task.
AbstractIacWrapperTask(java.lang.String, java.lang.String, Map<String, String>) - Constructor in AbstractIacWrapperTask
AbstractImportTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of terraform import.
AbstractImportTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractImportTask
AbstractInitTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Abstract infra init task.
AbstractInitTask.1 - Class in org.ysb33r.gradle.iac.base.tf.tasks
AbstractInitTask.1() - Constructor in AbstractInitTask.1
AbstractInitTask.2 - Class in org.ysb33r.gradle.iac.base.tf.tasks
AbstractInitTask.2() - Constructor in AbstractInitTask.2
AbstractInitTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractInitTask
AbstractOutputJsonTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of output -json, but primarily used for when output variables need to provided to another task.
AbstractOutputJsonTask(java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractOutputJsonTask
AbstractOutputTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of output.
AbstractOutputTask(java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractOutputTask
AbstractPlanTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of plan.
AbstractPlanTask.1 - Class in org.ysb33r.gradle.iac.base.tf.tasks
AbstractPlanTask.1() - Constructor in AbstractPlanTask.1
AbstractPlanTask(java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>, boolean) - Constructor in AbstractPlanTask
AbstractProvidersLockTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of providers lock.
AbstractProvidersLockTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractProvidersLockTask
AbstractProvidersSchemaTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of providers schema.
AbstractProvidersSchemaTask(Class<? extends IacTfExecSpec>) - Constructor in AbstractProvidersSchemaTask
AbstractProvidersShowTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of providers.
AbstractProvidersShowTask(Class<? extends IacTfExecSpec>) - Constructor in AbstractProvidersShowTask
AbstractProviderTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Base class all terraform provider subcommands.
AbstractProviderTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractProviderTask
AbstractRunTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Ability to run any command using the appropriate environment, directory and workspace.
AbstractRunTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractRunTask
AbstractShowStateTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of show /path/to/terraform.tfstate.
AbstractShowStateTask(java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractShowStateTask
AbstractStateListTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
The state list command.
AbstractStateListTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractStateListTask
AbstractStateMvTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
The state mv command.
AbstractStateMvTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractStateMvTask
AbstractStatePullTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
The state pull command.
AbstractStatePullTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractStatePullTask
AbstractStatePushTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
The state push command.
AbstractStatePushTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractStatePushTask
AbstractStateRmTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
The state rm command.
AbstractStateRmTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractStateRmTask
AbstractStateTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Base classs for all opentofu/terraform state subcommands.
AbstractStateTask(java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>, org.ysb33r.gradle.iac.base.tf.characteristics.TaskAttributes.Builder) - Constructor in AbstractStateTask
AbstractTaintingTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Base task for the untaint and taint commands.
AbstractTaintingTask(java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>, boolean) - Constructor in AbstractTaintingTask
AbstractTestTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Base class for implementing the {code test} command.
AbstractTestTask(Class<? extends IacTfExecSpec>, List<String>, java.lang.String) - Constructor in AbstractTestTask
AbstractTfBaseTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
A base class for all Terraform and OpenTofu tasks.
AbstractTfBaseTask(java.lang.String, Class<? extends IacTfExecSpec>, org.ysb33r.gradle.iac.base.tf.execspec.DefaultArguments.Builder) - Constructor in AbstractTfBaseTask
AbstractTfStandardTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
A base class for all Terraform and OpenTofu tasks.
AbstractTfStandardTask(java.lang.String, java.lang.String, Class<? extends IacTfExecSpec>, org.ysb33r.gradle.iac.base.tf.characteristics.TaskAttributes.Builder, org.ysb33r.gradle.iac.base.tf.execspec.DefaultArguments.Builder) - Constructor in AbstractTfStandardTask
AbstractValidateTask - Class in org.ysb33r.gradle.iac.base.tf.tasks
Equivalent of validate.
AbstractValidateTask(java.lang.String, Class<? extends IacTfExecSpec>) - Constructor in AbstractValidateTask
addConditionalToken(java.lang.String, Provider<?>) - Method in AbstractIacBackend
Only adds the token is the value is not null or an empty provider.
addDestroyRelationshipTasks(java.lang.String) - Method in SourceSetBase
Add task naming objects
addEnvironmentProvider(Provider<? extends Map<String, String>>) - Method in AbstractTfStandardTask
Adds an environment provider.
addEnvironmentProvider(Provider<Map<String, String>>) - Method in TfSourceSetBase
Adds a provider to environment variables.
addExecutionOptions(Provider<List<String>>) - Method in AbstractTfBaseTask
Add additional command-line parameters from external sources.
additionalVariables - Property in VarsFilesPair
Additional variables from other sources.
addRelationshipTasks(java.lang.String) - Method in SourceSetBase
Add task naming objects
addTaintedResource(java.lang.String) - Method in AbstractTfStandardTask
Mark a resource as tainted.
addTokenProvider(Provider<Map<String, TokenValue>>) - Method in AbstractIacBackend
Adds a provider of tokens.
addTokenProvider(Provider<Map<String, TokenValue>>) - Method in AbstractIacBackend.BackendTokenOverrideProxy
Adds a provider of tokens.
addTokenProvider(Provider<Map<String,TokenValue>>) - Method in TokenConfiguration
Adds a provider of tokens.
allowSubdirectories(java.lang.String) - Method in ModuleSourceSetBase
Allow additional subdirectories to exist in the module directory.
alwaysOutOfDate() - Method in AbstractTfBaseTask
Marks task to always be out of date.
apply(org.gradle.api.Project) - Method in IacBasePlugin
ApprovalRequiredException - Class in org.ysb33r.gradle.iac.base.errors
Thrown when approval is required.
ApprovalRequiredException() - Constructor in ApprovalRequiredException
approveChange() - Method in AbstractApplyTask
Explicitly approve the change.
approveChange() - Method in AbstractDestroyTask
Explicitly approve the change.
ASCIIDOC_PATTERN - Field in CopySpecUtils
asEnvTfVar - Property in DefaultRemoteStateVarProvider
asFileTree - Property in TfSourceSetBase
Source tree
associateCacheTask(TaskProvider<? extends AbstractIacCacheBinaryTask>) - Method in AbstractIacWrapperTask
asTfVar - Property in DefaultRemoteStateVarProvider
AWS_CONFIG_FILE - Field in AwsSecrets
AWS_CREDENTIALS_FILE - Field in AwsSecrets
AWS_KEY - Field in AwsSecrets
AWS_PROFILE - Field in AwsSecrets
AWS_SDK_LOAD_CONFIG - Field in AwsSecrets
AWS_SECRET - Field in AwsSecrets
AWS_TOKEN - Field in AwsSecrets
AwsSecrets - Class in org.ysb33r.gradle.iac.base.secrets
Holds AWS secrets as environment variables.
AwsSecrets(java.lang.String, org.gradle.api.Project) - Constructor in AwsSecrets

B

backendByInstance(Provider<? extends AbstractIacBackend>) - Method in SourceSetBase
Sets a reference to an existing backend.
BackendConfigOverrides - Interface in org.ysb33r.gradle.iac.base.tf.backends
Indicates which backend configuration should be sent via the command-line rather than the backend configuration file or secret environment variables.
backendOverrides(Closure<?>) - Method in AbstractIacBackend
Configure backend command-line overrides.
BasicSourceSetExecutionEnvironment - Interface in org.ysb33r.gradle.iac.base.tf
Provide the default executable and environment associated with a source set or module source set.
build(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Method in DefaultArguments.Builder
build() - Method in TaskAttributes.Builder
builder() - Method in DefaultArguments
builder() - Method in TaskAttributes

C

captureStdOutTo(Provider<File>) - Method in AbstractTfBaseTask
When command is run, capture the standard output
ccso - Field in AbstractIacBackend
Configuration cache safe operations that can be used by backend implementations.
ccso - Field in IacSecrets
ccso - Field in TfSourceSetBase
clear() - Method in Variables
Removes all existing variables and file references.
clear() - Method in VarsFilesPair
cmdArgs(java.lang.Object) - Method in AbstractTfBaseTask
Helper methods to add additional command arguments
CodeFormatting - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Configure formatting of code.
CodeFormatting(org.gradle.api.Project) - Constructor in CodeFormatting
commandLineArgs - Property in CodeFormatting
commandLineArgs - Property in Lock
commandLineArgs - Property in ResolvedExecutionsOptions
Returns the list of Terraform/OpenTofu command-line arguments.
commandLineArgs - Property in StateOptionsConcurrency
commandLineArgs - Property in StateOptionsFull
commandLineArgs - Property in Testing
commandLineArgs - Property in TestingWithConcurrency
ConcurrencyProtector - Class in org.ysb33r.gradle.iac.base.tf.services
A build service that prevents a group of tasks from running in parallel.
concurrencyProtector - Property in AbstractTfStandardTask
For internal use by tasks only.
ConcurrencyProtector() - Constructor in ConcurrencyProtector
config - Field in AbstractGlobalConfigExtension
configure(org.gradle.api.file.CopySpec, java.lang.Boolean, Provider<File>, Provider<String>, Provider<List<String>>, Iterable<String>, Iterable<String>, Provider<Boolean>) - Method in CopySpecUtils
Configures a copy specification
consumes(java.lang.String, java.lang.String, java.lang.String, java.lang.String) - Method in SourceSetBase
This source set is dependent on an outgoing variant of a source set in another subproject.
CopySpecUtils - Class in org.ysb33r.gradle.iac.base.tf.modules
Utilities to help manage the configuration of a CopySpec used for publication.
CopySpecUtils() - Constructor in CopySpecUtils
copyTo(org.ysb33r.gradle.iac.base.tf.config.multilevel.VarsFilesPair) - Method in VarsFilesPair
Copy these settings to another instance.
createInternalExecSpec(Class<? extends IacTfExecSpec>, java.lang.String) - Method in AbstractTfStandardTask
Creates an execution specification to something that will be run internally in the task as a supplement to the main Terraform/OpenTofu command.
createLogDir() - Method in AbstractTfStandardTask
Creates the logging directory
createPluginDirIfItDoesNotExist() - Method in PluginCacheDirGenerator
createWorkspaceTasks(java.lang.String) - Method in SourceSetBase
Invoked when a workspace is added.
credentials(java.lang.String, java.lang.String) - Method in AbstractGlobalConfigExtension
Adds a credential set to the configuration file.
customSourceSetTokens(org.ysb33r.gradle.iac.base.tf.SourceSetBase) - Method in AbstractIacBackend
Generates tokens for a specific source set & backend combination.

D

DefaultArguments - Class in org.ysb33r.gradle.iac.base.tf.execspec
Build default arguments for specific commands.
DefaultArguments.Builder - Class in org.ysb33r.gradle.iac.base.tf.execspec
DefaultArguments() - Constructor in DefaultArguments
DefaultRemoteStateVarProvider - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Implementation of {@linkRemoteStateVarProvider}.
DefaultRemoteStateVarProvider(Provider<Map<String, TokenValue>>, org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Constructor in DefaultRemoteStateVarProvider
dirs(java.lang.Object) - Method in OtherSources
Add directories to be set.

E

eachModule(Action<T>) - Method in ModulePublishTarget
Configure each module linked to this publisher.
enabled - Property in Lock
Whether locking should be enabled
ENVIRONMENT - Enum Constant in RemoteStateInjection
Inject remote state configuration as an environment variable with TF_VAR_ prefix.
environment(java.lang.String, java.lang.Object) - Method in TfSourceSetBase
escapedList(Provider<Iterable<?>>, boolean) - Method in HclTransformer
Takes a list and creates a HCL-list with appropriate escaping.
escapedMap(Map<String, ?>, boolean) - Method in HclTransformer
Takes a map and creates a HCL-map with appropriate escaping.
escapedVarsProvider - Property in VarsFilesPair
escapeFilePath(java.lang.Object) - Method in HclTransformer
Escapes file paths for safe inclusion in HCL files.
escapeOneItem(java.lang.Object, boolean) - Method in HclTransformer
Escaped a single item.
escapeQuotesInString(Provider<String>) - Method in HclTransformer
Escapes any Terraform string quotes.
exclude(Iterable<String>) - Method in TfSourceSetBase
exec() - Method in AbstractApplyTask
Ensures that the plan file will be last on the command-line.
exec() - Method in AbstractCleanupWorkspacesTask
exec() - Method in AbstractCustomFmtBaseTask
exec() - Method in AbstractDestroyTask
exec() - Method in AbstractImportTask
exec() - Method in AbstractInitTask
exec() - Method in AbstractOutputTask
exec() - Method in AbstractPlanTask
exec() - Method in AbstractProvidersLockTask
exec() - Method in AbstractProvidersSchemaTask
exec() - Method in AbstractRunTask
exec() - Method in AbstractShowStateTask
exec() - Method in AbstractStateListTask
exec() - Method in AbstractStateMvTask
exec() - Method in AbstractStatePullTask
exec() - Method in AbstractStatePushTask
exec() - Method in AbstractStateRmTask
exec() - Method in AbstractTaintingTask
exec() - Method in AbstractTestTask
exec() - Method in AbstractTfBaseTask
Add secret environment variables, execute the specification and then handle the result code.
exec() - Method in AbstractTfStandardTask
Creates logging directory, set source directory as working directory, switch to appropriate workspace, then run and handle result.
exec() - Method in GlobalConfigDetailsConsumerBase
exec() - Method in GlobalConfigDetailsGenerator
exec() - Method in GlobalConfigGenerator
exec() - Method in ModuleStructureCheck
exec() - Method in RemoteStateConfigGenerator
exec() - Method in VariablesCacheGenerator
ExecutionConfiguration - Interface in org.ysb33r.gradle.iac.base.tf.config.multilevel
An extension that can be added to a task for representing a specific grouping of Terraform command-line parameters.
ExecutionOptions - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Configurable execution options for OpenTofu/Terraform.
ExecutionOptions(org.gradle.api.Project) - Constructor in ExecutionOptions
executionOptions(Closure<?>) - Method in SourceSetBase
executionOptionsFor(Iterable<Class<? extends ExecutionConfiguration>>) - Method in SourceSetBase
The execution options configured on the toolchain.
executionOptionsFor(Iterable<Class<? extends ExecutionConfiguration>>) - Method in SourceSetExecutionEnvironment
The execution options configured on the toolchain.

F

FeatureNotSupportedException - Class in org.ysb33r.gradle.iac.base.errors
When a tool feature is not supported on a specific version of the tool.
FeatureNotSupportedException() - Constructor in FeatureNotSupportedException
file(java.lang.Object) - Method in VariablesSpec
Adds a name of a file containing terraform variables.
files(java.lang.Object) - Method in Variables
Adds a name of a file containing terraform variables.
files(java.lang.Object) - Method in VariablesSpec
Adds one or more file names containing terraform variables.
files - Property in VarsFilesPair
List of filenames or relative paths to a source set.
fileToken(java.lang.String, java.lang.Object) - Method in AbstractIacBackend
Set a single token value.
fileToken(java.lang.String, java.lang.Object) - Method in AbstractIacBackend.BackendTokenOverrideProxy
Set a single token value.
fileToken(java.lang.String, java.lang.Object) - Method in TokenConfiguration
Set a single token value.
filterExeOptions(List<String>) - Method in AbstractTfBaseTask
Allow the possibility of filtering out or modify specific execution options.
forceLoadConfig() - Method in AwsSecrets
Use this to force the SDK to load the config.
forceRemoval - Property in AbstractCleanupWorkspacesTask
formatting - Property in ExecutionOptions
fromSecretsProvider(org.ysb33r.gradle.iac.base.tf.SecretVariablesProvider) - Method in SecretVariables
Use secrets from another provider of secrets.

G

GenericSecrets - Class in org.ysb33r.gradle.iac.base.secrets
A generic way of building secrets.
GenericSecrets(java.lang.String, org.gradle.api.Project) - Constructor in GenericSecrets
getAdditionalProperties() - Method in AbstractIacCacheBinaryTask
getAllowedDirectories() - Method in ModuleSourceSetBase
Get directories that are allowed in a module.
getAllPlatforms() - Method in IacPlatforms
Standard set of supported platforms.
getAllVariablesFiles() - Method in SourceSetBase
The file defined by {
Link:
#getVariablesFile} as well as any files declared in the VariablesSpec
getAsEnvTfVar() - Method in RemoteStateVarProvider
A provider for TF variables when configured for RemoteStateInjection.ENVIRONMENT.
getAsFileTree() - Method in SourceSetSources
Source tree
getAsTfVar() - Method in RemoteStateVarProvider
A provider for TF variables when configured for RemoteStateInjection.VARIABLE.
getBackendConfigFile() - Method in AbstractInitTask
Configuration of a state backend.
getBackendConfigFile() - Method in RemoteStateConfigGenerator
The location of the backend configuration file.
getBackendConfigurationDir() - Method in SourceSetBase
Location where backend directory is located.
getBackendIsWorkspaceAware() - Method in SourceSetBase
Indicates whether the backend associated with the source set is workspace aware.
getBackendOverrides() - Method in AbstractIacBackend
Accesses the backend overrides proxy.
getBackendTokenOverrides() - Method in AbstractIacBackend
Returns a provider to a set of variables which will be passed on the command-line as backend configuration
getBackendTokenOverrides() - Method in BackendConfigOverrides
Returns a provider to a set of variables which will be passed on the command-line as backend configuration
getBackendTokenOverrides() - Method in SourceSetBase
Returns a provider to a set of variables which will be passed on the command-line as backend configuration
getBackendTokenProvider() - Method in SourceSetBase
The tokens associated with the backend for this sourceset.
getBackendWorkspaceAwareness() - Method in AbstractTfStandardTask
Returns whether the curretnly attached backend is workspace aware.
getBeginToken() - Method in AbstractIacWrapperTask
getBinaryLocationProvider() - Method in AbstractIacCacheBinaryTask
getBinaryVersionProvider() - Method in AbstractIacCacheBinaryTask
getByType(Class<? extends ExecutionConfiguration>) - Method in ExecutionOptions
Gets an execution option by type.
getCcso() - Method in ModuleRepository
getCommandLineArgs() - Method in ExecutionConfiguration
Returns the list of Terraform/OpenTofu command-line arguments.
getCommandLineArgs(Iterable<Class<? extends ExecutionConfiguration>>) - Method in ExecutionOptions
Returns the list of Terraform/OpenTofu command-line arguments.
getConfigFile() - Method in AbstractGlobalConfigExtension
Location of the terraformrc/opentofurc file if it should be written by the project.
getConfigFile() - Method in TfConfig
Location of the global config.
getConfigLocation() - Method in AbstractIacCacheBinaryTask
Location of the configuration file.
getConfigTokens() - Method in AbstractGlobalConfigExtension
Get all configuration tokens.
getCredentialTokens() - Method in AbstractGlobalConfigExtension
Get all credentials tokens.
getDataDir() - Method in AbstractTfStandardTask
getDataDir() - Method in SourceSetSources
Data directory provider.
getDataDir() - Method in TfSourceSetBase
Data directory provider.
getDeclaredFiles() - Method in Variables
All provider to a list of files declared to contain variables.
getDestinationDir() - Method in RemoteStateConfigGenerator
The output directory for the configuration file
getDestroyRelationshipTaskNames(java.lang.String) - Method in SourceSetBase
Names of tasks that are important in inter-source set relationships when resources are being destroyed.
getDestroyTaskTypes() - Method in SourceSetBase
Types of tasks that are important in inter-source set relationships when resources are being destroyed.
getDetailsLocation() - Method in GlobalConfigDetailsConsumerBase
getEndToken() - Method in AbstractIacWrapperTask
getEnvironment() - Method in BasicSourceSetExecutionEnvironment
Provider to the full running environment.
getEnvironment() - Method in TfSourceSetBase
Provider to the full running environment.
getEscapedVariables() - Method in SourceSetBase
All declared variables correctly escaped.
getEscapedVars() - 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 TfSourceSetBase
getExecSpec() - Method in AbstractTfBaseTask
Access to the execution specification.
getExecutableLocation() - Method in AbstractTfBaseTask
getExecutableLocation() - Method in BasicSourceSetExecutionEnvironment
Location of the executable that will be used for this source set
getExecutableLocation() - Method in TfSourceSetBase
Location of the executable that will used for this source set
getExecutableVersion() - Method in AbstractTfBaseTask
getExecutableVersion() - Method in BasicSourceSetExecutionEnvironment
Version of the executable that will be used for this source set
getExecutableVersion() - Method in TfSourceSetBase
Version of the executable that will used for this source set
getExecutionOptions() - Method in SourceSetBase
getFailOnExtraDirectories() - Method in ModuleSourceSetBase
Whether check should fail if extraneous directories are found.
getIncludes() - Method in TfSourceSetBase
getIncludeTestsWhenPublishing() - Method in ModuleSourceSetBase
Indicates whether tests should be included when publishing.
getInjectVar() - Method in DefaultRemoteStateVarProvider
A provider to indicate whether remote state tokens should be added as an any type variable.
getInjectVar() - Method in RemoteStateVarProvider
A provider to indicate whether remote state tokens should be injected.
getInputFiles() - Method in GlobalConfigDetailsConsumerBase
getInputProperty() - Method in ExecutionConfiguration
A value that is used as an input property and which can be used to signal that a task needs to be run again.
getInternalSerialTrackerFile() - Method in AbstractTfStandardTask
This is the location of an internal tracker file used to keep track of the state serial number.
getInternalTrackerFile() - Method in AbstractPlanTask
This is the location of an internal tracker file used to keep state between apply & destroy cycles.
getLogDir() - Method in AbstractTfStandardTask
getLogDir() - Method in SourceSetSources
Log directory provider.
getLogDir() - Method in TfSourceSetBase
Log directory provider.
getModuleName() - Method in ModuleDescription
The name of the module that will be used for publication.
getModulePublishTaskGroup() - Method in ModuleSourceSetBase
The task group for tasks that publishes modules.
getModuleSourceSet(java.lang.String) - Method in ModuleRepository
getModuleVersion() - Method in ModuleDescription
The version of the module.
getName() - Method in ModuleRepository
Repository name
getObjectFactory() - Method in ModuleRepository
getOutputFile() - Method in GlobalConfigGenerator
getOutputName() - Method in AbstractOutputTask
List of names to retrieve output for.
getOutputTask(java.lang.String) - Method in SourceSetBase
The name of the output task that will generate JSON output variables
getPlanOutputFile() - Method in AbstractPlanTask
Where the plan file will be written to.
getPlanReportOutputFile() - Method in AbstractPlanTask
Where the textual representation of the plan will be written to.
getPlatforms() - Method in IacPlatforms
Provide the list of platforms that need to be supported.
getPluginCacheDir() - Method in AbstractGlobalConfigExtension
Location of plugin cache directory.
getPluginCacheDir() - Method in PluginCache
Location of plugin cache directory.
getPluginDir() - Method in PluginCacheManagement
Cache directory for plugins / providers.
getPluginDir() - Method in TfSourceSetBase
Cache directory for plugins / providers.
getPluginDirectory() - Method in AbstractInitTask
getPluginDirTimeout() - Method in PluginCacheManagement
Local timeout for the cache directory for plugins / providers.
getPluginDirTimeout() - Method in TfSourceSetBase
Local timeout for the cache directory for plugins / providers.
getPrefixVersionWithV() - Method in ModuleRepository
Indicates whether the version string is prefixed with a v
getPublishTaskNamePrefix() - Method in ModuleSourceSetBase
The name that is used as the prefix for all tasks that publish this module
getPublishTests() - Method in ModuleRepository
Whether to publish test files.
getRecursive() - Method in OtherSources
Whether to recurse down the child directories.
getRelationshipTaskNames(java.lang.String) - Method in SourceSetBase
Names of tasks that are important in inter-source set relationships within a single project.
getRemoteStateMap() - Method in Variables
Provide access to a remote state configuration.
getRemoteStateMap() - Method in VariablesSpec
Provide access to a remote state configuration.
getReportsDir() - Method in AbstractTfStandardTask
getReportsDir() - Method in SourceSetSources
Reports directory.
getReportsDir() - Method in TfSourceSetBase
Reports directory.
getRepositoryByName(java.lang.String) - Method in ModuleSourceSetBase
Returns a repository by name.
getRequiredFilePatterns() - Method in ModuleSourceSetBase
Patterns for required files.
getRequiredPlatforms() - Method in AbstractProviderTask
getRequiresLicense() - Method in ModuleRepository
Indicates whether a repository requires a license file.
getRequiresRollupAdditionalSourceFiles() - Method in ModuleRepository
Indicated whether source files other than {
code:
(outputs|variables).
getResolvedOptionsFor(Iterable<Class<? extends ExecutionConfiguration>>) - Method in ExecutionOptions
Returns a provider that will contain all the resolved options for given combination.
getSchemaOutputFile() - Method in AbstractProvidersSchemaTask
Get the location where the report file needs to be generated.
getSecondarySources() - Method in SourceSetSources
Provides a list of secondary sources.
getSecondarySources() - Method in TfSourceSetBase
Provides a list of secondary sources.
getSecretVariables() - Method in AbstractTfBaseTask
Get a reference to the secret variables.
getSecretVariables() - Method in SecretVariablesProvider
Returns a provider to a set of secret variables.
getSecretVariables() - Method in SourceSetBase
Returns a provider to a set of secret variables.
getSourceDir() - Method in AbstractTfStandardTask
getSourceDir() - Method in ModuleStructureCheck
getSourceDirectories() - Method in OtherSources
The list of toplevel directories to check
getSourceSetContainer() - Method in SourceSetBase
Get access to the container this source set belongs too.
getSourceSetDestroyRelationshipTasks() - Method in SourceSetBase
The important destroy tasks that must be sequenced when there are relationships between source sets.
getSourceSetRelationshipTasks() - Method in SourceSetBase
The important tasks that must be sequenced when there are relationships between source sets.
getSrcDir() - Method in SourceSetSources
Provide for the root directory of the source set,
getSrcDir() - Method in TfSourceSetBase
Provide for the root directory of the source set,
getSsName() - Method in AbstractTestTask
getStateInputFile() - Method in AbstractStatePushTask
getStateNamePrefix() - Method in AbstractIacBackend
Gets a prefix that can be used for the state name.
getStateOutputFile() - Method in AbstractStateListTask
getStateOutputFile() - Method in AbstractStatePullTask
getStatusReportOutputFile() - Method in AbstractOutputTask
Get the location where the report file needs to be generated.
getStatusReportOutputFile() - Method in AbstractShowStateTask
Get the location where the report file needs to be generated.
getTaskContainer() - Method in ModuleRepository
getTestReportHtml() - Method in AbstractTestTask
The directory where the HTML report is generated into.
getTestReportJunitXmlFile() - Method in AbstractTestTask
Get the location where the report file needs to be generated.
getTestReportOutputFile() - Method in AbstractTestTask
Get the location where the report file needs to be generated.
getTestReportRawOutputFile() - Method in AbstractTestTask
Get the location where the report file needs to be generated.
getTestSubdir() - Method in SourceSetSources
Obtain the name of the subdirectory where tests are located.
getTestSubdir() - Method in TfSourceSetBase
Obtain the name of the subdirectory where tests are located.
getTfVars() - Method in ExecutionConfiguration
Returns the list of variables in the form name=value
getTfVars() - Method in Variables
A list of of escaped variables.
getTokenProvider() - Method in AbstractIacBackend
A provider for all the tokens that were set.
getTokenProvider() - Method in IacBackendAttributesSpec
A provider for all the tokens that were set.
getTokenValuesAsMap() - Method in AbstractIacWrapperTask
getUseLockWithTimeout() - Method in AbstractGlobalConfigExtension
getUseLockWithTimeout() - Method in PluginCache
Indicates whether access to the plugin cache dir should be locked between operations that writes to the cache directory
getValue() - Method in TokenValue
getVariableFile() - Method in VariablesCacheGenerator
The location of the variables file.
getVariables() - Method in SourceSetBase
Get all variables applicable to this source set.
getVariablesFile() - Method in SourceSetBase
The file where DSL-defined variables are cached to.
getVariablesFiles() - Method in UsesVariables
The location of the variables files.
getVarsInTfFormat() - Method in VarsFilesPair
Gets all variables in a Terraform file format.
GITLAB_TOKEN - Field in GitlabSecrets
GitlabSecrets - Class in org.ysb33r.gradle.iac.base.secrets
Holds a Gitlab token as environment variables.
GitlabSecrets(java.lang.String, org.gradle.api.Project) - Constructor in GitlabSecrets
GlobalConfigDetailsConsumerBase - Class in org.ysb33r.gradle.iac.base.tf.tasks
Generates repository details to a file.
GlobalConfigDetailsConsumerBase(java.lang.String, java.lang.String, java.lang.String) - Constructor in GlobalConfigDetailsConsumerBase
GlobalConfigDetailsGenerator - Class in org.ysb33r.gradle.iac.base.tf.tasks
Generates repository details to a file.
GlobalConfigDetailsGenerator() - Constructor in GlobalConfigDetailsGenerator
GlobalConfigGenerator - Class in org.ysb33r.gradle.iac.base.tf.tasks
Generates a global configuration file for OpenTofu/Terraform.
GlobalConfigGenerator() - Constructor in GlobalConfigGenerator

H

handleExecResult(org.ysb33r.grolifant5.api.core.runnable.ExecOutput) - Method in AbstractCustomFmtApplyTask
handleExecResult(org.ysb33r.grolifant5.api.core.runnable.ExecOutput) - Method in AbstractCustomFmtBaseTask
handleExecResult(org.ysb33r.grolifant5.api.core.runnable.ExecOutput) - Method in AbstractCustomFmtCheckTask
handleResultCode(org.ysb33r.grolifant5.api.core.runnable.ExecOutput, org.ysb33r.gradle.iac.base.tf.ToolFeatures) - Method in AbstractPlanTask
Handle the exit code from the execution.
handleResultCode(org.ysb33r.grolifant5.api.core.runnable.ExecOutput) - Method in AbstractTestTask
handleResultCode(org.ysb33r.grolifant5.api.core.runnable.ExecOutput, org.ysb33r.gradle.iac.base.tf.ToolFeatures) - Method in AbstractTfBaseTask
Handle the exit code from the execution.
hasTaintedResources() - Method in AbstractTfStandardTask
Reports whether there are any tainted resources.
hasWorkspaces() - Method in SourceSetBase
Flags whether workspaces have been defined.
HclTransformer - Class in org.ysb33r.gradle.iac.base.hcl
A transformer for various HCL entities
hclTransformer - Property in AbstractIacBackend
Helper to translate objects into HCL formats.
HclTransformer(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Constructor in HclTransformer

I

IacBackendAttributesSpec - Interface in org.ysb33r.gradle.iac.base.tf.backends
Attributes that describe a backend.
IacBackendDoesNotSupportWorkspacesException - Class in org.ysb33r.gradle.iac.base.errors
Thrown backend is known to not support workspaces, but a workspace other than the default is configured.
IacBackendDoesNotSupportWorkspacesException() - Constructor in IacBackendDoesNotSupportWorkspacesException
IacBackendSpec - Interface in org.ysb33r.gradle.iac.base.tf.backends
Describes the configuration for a backend.
IacBackendTextTemplate - Interface in org.ysb33r.gradle.iac.base.tf.backends
Represents a text template for creating a backend configuration file.
IacBadFormatException - Class in org.ysb33r.gradle.iac.base.errors
Thrown when content is missing or badly formatted.
IacBadFormatException() - Constructor in IacBadFormatException
IacBasePlugin - Class in org.ysb33r.gradle.iac.base
Base plugin for all IAC plugins.
IacBasePlugin() - Constructor in IacBasePlugin
IacConfigurationException - Class in org.ysb33r.gradle.iac.base.errors
Thrown when there is an issue configuring the infrastructure tool.
IacConfigurationException() - Constructor in IacConfigurationException
IacPlatforms - Interface in org.ysb33r.gradle.iac.base.tf
Defines the platforms that the tool is supported on.
IacSecrets - Class in org.ysb33r.gradle.iac.base.secrets
Base class for implementing secret maintenance.
IacSecrets(java.lang.String, org.gradle.api.Project) - Constructor in IacSecrets
IacSourceFormatViolation - Class in org.ysb33r.gradle.iac.base.errors
Thrown when there is an issue configuring the infrastructure tool.
IacSourceFormatViolation() - Constructor in IacSourceFormatViolation
IacTestExecutionException - Class in org.ysb33r.gradle.iac.base.errors
Thrown when there are test failures.
IacTestExecutionException() - Constructor in IacTestExecutionException
IacTfExecSpec - Class in org.ysb33r.gradle.iac.base.tf.execspec
Base class for execution specification for Terraform and OpenTofu.
IacTfExecSpec(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Constructor in IacTfExecSpec
IacToolExecutionException - Class in org.ysb33r.gradle.iac.base.errors
Thrown when there is an issue executing a tool.
IacToolExecutionException() - Constructor in IacToolExecutionException
IacUnknownBackendException - Class in org.ysb33r.gradle.iac.base.errors
Thrown when an unregistered backend is requested.
IacUnknownBackendException() - Constructor in IacUnknownBackendException
IacUpgradeNotSupportedException - Class in org.ysb33r.gradle.iac.base.errors
Thrown when the specific version of a tool does not support upgrading.
IacUpgradeNotSupportedException() - Constructor in IacUpgradeNotSupportedException
IGNORE_ON_PUBLISH - Field in CopySpecUtils
importantInputFiles(Provider<List<File>>) - Method in AbstractTfStandardTask
include(groovy.lang.Closure) - Method in TfSourceSetBase
initStateFile - Property in AbstractInitTask
The location of the file that provides details about the last run of this task.
inputProperty - Property in CodeFormatting
inputProperty - Property in Lock
inputProperty - Property in ResolvedExecutionsOptions
Returns:
Provider to a special property.
inputProperty - Property in StateOptionsConcurrency
inputProperty - Property in StateOptionsFull
inputProperty - Property in Testing
inputProperty - Property in TestingWithConcurrency
isSatisfiedBy(org.gradle.api.Task) - Method in AbstractApplyTask.1
isSatisfiedBy(org.gradle.api.Task) - Method in AbstractInitTask.1
isSatisfiedBy(org.gradle.api.Task) - Method in AbstractInitTask.2
isSatisfiedBy(org.gradle.api.Task) - Method in AbstractPlanTask.1
isSatisfiedBy(org.gradle.api.Task) - Method in PluginCacheDirGenerator.1
isWorkspaceAware() - Method in AbstractIacBackend
isWorkspaceAware() - Method in IacBackendSpec
Indicates whether the backend supports workspaces.

J

JSON_FORMAT - Field in DefaultArguments
Command-line parameter for JSON output.

K

L

LICENSE_PATTERNS - Field in CopySpecUtils
list(java.lang.String, Iterable<?>) - Method in Variables
Adds a list as a variable.
list(java.lang.String, Iterable<?>) - Method in VariablesSpec
Adds a list as a variable.
listWorkspaces() - Method in AbstractTfStandardTask
Lists the workspaces as currently known to Terraform
loadToolFeatures(java.lang.String) - Method in AbstractPlanTask
Loads features for the tool
Lock - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Allows for lock configurations on a task.
lock - Property in ExecutionOptions
Lock(org.gradle.api.Project) - Constructor in Lock

M

map(java.lang.String, Provider<Map<String, ?>>) - Method in Variables
Adds a map provider as a variable.
map(java.lang.String, Provider<Map<String,?>>) - Method in VariablesSpec
Adds a map provider as a variable.
MAX_VALUE - Field in RemoteStateInjection
MAX_VALUE - Field in StateImpact
maxParallel - Property in StateOptionsFull
Maximum number of parallel connections.
maxParallel - Property in TestingWithConcurrency
Maximum number of parallel test.
MIN_VALUE - Field in RemoteStateInjection
MIN_VALUE - Field in StateImpact
module(java.lang.String, Action<T>) - Method in ModulePublishTarget
Allow a module to be published to this target.
module(java.lang.String) - Method in NoConfigurationModulePublishTarget
ModuleDescription - Interface in org.ysb33r.gradle.iac.base.tf.modules
Description of a module.
moduleName - Property in ModuleSourceSetBase
The name of the module that will be used for publication.
ModulePublisherTaskMethods - Interface in org.ysb33r.gradle.iac.base.tf.tasks
Methods that a task should implement for publishing to a repository.
ModulePublishTarget - Interface in org.ysb33r.gradle.iac.base.tf.modules
Defines a configurable item that is the link between a module repository and a module.
ModuleRepository - Class in org.ysb33r.gradle.iac.base.tf.modules
Base class for implementing module repositories (targets for publishing to).
ModuleRepository(java.lang.String, org.gradle.api.Project) - Constructor in ModuleRepository
ModuleSourceSetBase - Class in org.ysb33r.gradle.iac.base.tf.modules
Base class for a Terraform/OpenTofu module source set.
ModuleSourceSetBase(java.lang.String, java.lang.String, java.lang.String, Iterable<String>, Iterable<String>, org.gradle.api.Project) - Constructor in ModuleSourceSetBase
ModuleStructureCheck - Class in org.ysb33r.gradle.iac.base.tf.tasks
Verifies that a module has the correct structure.
ModuleStructureCheck() - Constructor in ModuleStructureCheck
moduleVersion - Property in ModuleSourceSetBase
The version of the module.
mustRunAfter(java.lang.String) - Method in SourceSetBase
Indicate that if certain tasks of this source set is in the task graph with equivalent tasks from the other source sets, then these tasks must only run when those tasks have completed.

N

name - Property in AbstractIacBackend
Backend name.
name - Property in AbstractIacToolchain
name - Property in IacSecrets
name - Property in TfSourceSetBase
Source set name
name - Property in Workspace
next() - Method in RemoteStateInjection
next() - Method in StateImpact
NO_COLOR - Field in DefaultArguments
Command-line parameter for no colour.
NO_STATE_UPDATE - Enum Constant in StateImpact
This command does not affect state.
NoConfigurationModulePublishTarget - Interface in org.ysb33r.gradle.iac.base.tf.modules
Defines a configurable item that is the link between a module repository and a module.
NONE - Enum Constant in RemoteStateInjection
Do inject remote state as any form of variable.

O

objectFactory - Field in TfSourceSetBase
of(java.lang.Object, org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Method in TokenValue
Creates an instance from an arbitrary value.
OtherSources - Class in org.ysb33r.gradle.iac.base.tf
Configures sources that are not part of a source set, but which can be included or referenced.
OtherSources(org.gradle.api.Project) - Constructor in OtherSources
overrideModuleNamePostfix(java.lang.Object) - Method in ModuleSourceSetBase
Overrides the name of the module postfix.

P

PLAN_FILE_EXTENSION - Field in AbstractTfStandardTask
PLAN_REFRESH_PROPERTY - Field in AbstractTfStandardTask
planHasDetailedExitCode() - Method in ToolFeatures
plan supports {-detailed-exitcode}
planHasGenerateConfigOut() - Method in ToolFeatures
plan supports {-generate-config-out}
planHasRefreshOnly() - Method in ToolFeatures
Whether plan supports -refresh-only
platforms(java.lang.String) - Method in IacPlatforms
Add one or more platforms to support for providers.
PLUGIN_DIR_ENTRY - Field in GlobalConfigDetailsGenerator
PLUGIN_DIR_TIMEOUT_ENTRY - Field in GlobalConfigDetailsGenerator
PluginCache - Interface in org.ysb33r.gradle.iac.base.tf
Plugin Cache methods.
PluginCacheDirGenerator - Class in org.ysb33r.gradle.iac.base.tf.tasks
Creates a directory for caching OpenTofu/Terraform plugins.
PluginCacheDirGenerator.1 - Class in org.ysb33r.gradle.iac.base.tf.tasks
PluginCacheDirGenerator.1() - Constructor in PluginCacheDirGenerator.1
PluginCacheDirGenerator() - Constructor in PluginCacheDirGenerator
PluginCacheManagement - Interface in org.ysb33r.gradle.iac.base.tf
Methods for working with the plugin cache.
previous() - Method in RemoteStateInjection
previous() - Method in StateImpact
processJsonIntoJUnitXml(org.ysb33r.gradle.iac.base.internal.tf.TestReportParser) - Method in AbstractTestTask
Processes the JSON output and create JUnit XML.
producesVariants() - Method in SourceSetBase
This source set produces an outgoing variant that can be consumed by a source set in another subproject
propertiesDescription - Property in AbstractIacCacheBinaryTask
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(java.lang.String, java.lang.String) - Method in SourceSetBase
Returns a provider to a specific output variable.
rawOutputVariables(java.lang.String) - Method in SourceSetBase
Returns a provider which can be used to access output variables from a source set.
RC_ENTRY - Field in GlobalConfigDetailsGenerator
README_PATTERNS - Field in CopySpecUtils
recursive - Property in CodeFormatting
Whether recursive formatting should be enabled
refresh - Property in StateOptionsFull
Whether refresh is required.
registerWithPublishAll(Iterable<String>) - Method in ModuleSourceSetBase
Registers tasks with the relevant PublishAll task.
RemoteStateConfigGenerator - Class in org.ysb33r.gradle.iac.base.tf.tasks
Generates a remote state file containing partial configuration for backend.
RemoteStateConfigGenerator() - Constructor in RemoteStateConfigGenerator
RemoteStateInjection - Enum in org.ysb33r.gradle.iac.base.tf
How to inject a variable of remote state values.
remoteStateMap(Closure<?>) - Method in Variables
Configure the injection of a map for terraform_remote_state usage.
remoteStateMap(Closure<?>) - Method in VariablesSpec
Configure the injection of a map for terraform_remote_state usage.
RemoteStateVarProvider - Interface in org.ysb33r.gradle.iac.base.tf
Manages the injection of a variable containing variables related to remote state, so that they can be used by terraform_remote_state data sources.
removeAllTaintedResources() - Method in AbstractTfStandardTask
Remove all tainted resources.
removeTaintedResource(java.lang.String) - Method in AbstractTfStandardTask
Remove a resource as being tainted.
reqFiles - Field in ModuleSourceSetBase
ResolvedExecutionsOptions - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Resovled execution options for a specific combination.
ResolvedExecutionsOptions(List<String>, List<String>, java.lang.String) - Constructor in ResolvedExecutionsOptions
resolvedFiles - Property in VarsFilesPair
ResourceFilter - Interface in org.ysb33r.gradle.iac.base.tf
Filter resources to be replaced, updated or deleted.
runInternalExecSpec(org.ysb33r.gradle.iac.base.tf.execspec.IacTfExecSpec) - Method in AbstractTfStandardTask
Runs a supplementary execution specification, previously created by createInternalExecSpec.
runWithSecrets(Action<ExecSpec>) - Method in AbstractTfBaseTask
Executes the execution specification after loading the secrets.
runWorkspaceSubcommand(java.lang.String, java.lang.String) - Method in AbstractTfStandardTask
Runs a terraform workspace subcommand.

S

secondarySources(Iterable<Object>) - Method in TfSourceSetBase
Additional sources that affects infrastructure.
secretProperty(java.lang.String, java.lang.String) - Method in SecretVariables
Sets a secret variable that will be injected into the environment at run time.
secretPropertyOrBlank(java.lang.String, java.lang.String) - Method in SecretVariables
Sets a secret variable that will be injected into the environment at run time.
secretVariable(java.lang.String, java.lang.Object) - Method in SecretVariables
Sets a secret variable that will be injected into the environment at run time.
SecretVariables - Interface in org.ysb33r.gradle.iac.base.tf
Methods for adding and accessing secrets.
SecretVariablesProvider - Interface in org.ysb33r.gradle.iac.base.tf
Can supply secret variables.
setAllowDirectories(Provider<List<String>>) - Method in ModuleStructureCheck
setAllowMissing(boolean) - Method in AbstractTaintingTask
setAsReport(boolean) - Method in AbstractStateListTask
setAuthTokens(Provider<Map<String, String>>) - Method in GlobalConfigGenerator
setAutoApprove(java.lang.Boolean) - Method in AbstractDestroyTask
Set auto-approve mode.
setBackendConfigFile(Provider<File>) - Method in AbstractInitTask
Set location of backend configuration file.
setBackendOverrides(Provider<Map<String, TokenValue>>) - Method in AbstractInitTask
Sets tokens which needs to be written to the command-line rather than passes as secrets in the environment or as key-values in a backend file.
setBackendWorkspaceAwareness(Provider<Boolean>) - Method in AbstractTfStandardTask
A special provider that can be set after the fact to indicate that the associated backend is workspace-aware.
setBinaryLocationProvider(Provider<String>) - Method in AbstractIacCacheBinaryTask
setBinaryVersionProvider(Provider<String>) - Method in AbstractIacCacheBinaryTask
setCheckForAllowedDirectories(Provider<Boolean>) - Method in ModuleStructureCheck
setCmdline(java.lang.String) - Method in AbstractRunTask
setConfigLocation(Provider<String>) - Method in AbstractIacCacheBinaryTask
setConfigTokens(Provider<Map<String, String>>) - Method in GlobalConfigGenerator
setContents(org.gradle.api.file.CopySpec) - Method in ModulePublisherTaskMethods
The content that should be published.
setDataDir(Provider<File>) - Method in AbstractTfStandardTask
setDataDir(java.lang.Object) - Method in TfSourceSetBase
Sets the Terraform data directory.
setDestinationDir(java.lang.Object) - Method in RemoteStateConfigGenerator
Override the output directory.
setDestinationPath(java.lang.String) - Method in AbstractStateMvTask
setDirs(Iterable<?>) - Method in OtherSources
Replace existing directories with a new set.
setDisableCheckPoint(boolean) - Method in AbstractGlobalConfigExtension
Disable checkpoint.
setDisableCheckPointSignature(boolean) - Method in AbstractGlobalConfigExtension
Disable checkpoint signature.
setExcludes(Iterable<String>) - Method in TfSourceSetBase
setExecutableLocation(Provider<File>) - Method in AbstractTfBaseTask
Sets the location of the executable
setExecutableLocation(Provider<File>) - Method in TfSourceSetBase
Set the executable location.
setExecutableVersion(Provider<String>) - Method in AbstractTfBaseTask
Sets the version of the executable
setExecutableVersion(Provider<String>) - Method in TfSourceSetBase
Set the executable version.
setFailOnExtraDirectories(boolean) - Method in ModuleSourceSetBase
Whether to fail if subdirectories other than a predefined set of modules, tests & examples are found.
setFailOnMissingLicense(boolean) - Method in ModuleSourceSetBase
Whether to fail if a LICENSE file is not present.
setFilter(List<String>) - Method in AbstractStateListTask
setForce(boolean) - Method in AbstractStatePushTask
setForceCopy(boolean) - Method in AbstractInitTask
setGlobalConfigFile(Provider<File>) - Method in AbstractCustomFmtBaseTask
setId(java.lang.String) - Method in AbstractStateListTask
setIgnoreRemote(boolean) - Method in AbstractTaintingTask
setIncludes(Iterable<String>) - Method in TfSourceSetBase
setIncludeTestsWhenPublishing(boolean) - Method in ModuleSourceSetBase
Whether to include tests when publishing.
setInjectVar(org.ysb33r.gradle.iac.base.tf.RemoteStateInjection) - Method in DefaultRemoteStateVarProvider
Whether tokens should be bundled in an any type variable.
setInjectVar(java.lang.String) - Method in RemoteStateVarProvider
Whether tokens should be bundled in a variable, an environment variable, or not at all (default).
setJson(boolean) - Method in AbstractApplyTask
Output progress in json as per https://www.terraform.io/docs/internals/machine-readable-ui.html
setJson(boolean) - Method in AbstractOutputTask
Whether output should be in JSON
setJson(boolean) - Method in AbstractPlanTask
Where to write the report in human-readable or JSON format.
setJson(boolean) - Method in AbstractShowStateTask
Whether output should be in JSON
setJson(boolean) - Method in AbstractValidateTask
Whether output should be in JSON.
setLocation(Provider<File>) - Method in GlobalConfigDetailsGenerator
setLockPluginDirWithTimeout(Provider<Integer>) - Method in AbstractInitTask
Set whether the plugin directory should be locked whilst this task is running.
setLogDir(Provider<File>) - Method in AbstractTfStandardTask
setLogDir(java.lang.Object) - Method in TfSourceSetBase
Sets the log directory.
setName(java.lang.String) - Method in AbstractOutputTask
Set the list of output names to retrieve.
setOutputFile(Provider<File>) - Method in GlobalConfigDetailsGenerator
setOutputFile(Provider<File>) - Method in GlobalConfigGenerator
setOutputResourceFile(java.lang.String) - Method in AbstractPlanTask
setPluginCacheDir(java.lang.Object) - Method in AbstractGlobalConfigExtension
Sets the location of the plugin cache directory
setPluginCacheDir(Provider<File>) - Method in GlobalConfigDetailsGenerator
setPluginCacheLockTimeout(java.lang.Integer) - Method in AbstractGlobalConfigExtension
Sets the timeout for updating the plugin cache dir.
setPluginCacheMayBreakDependencyLockFile(boolean) - Method in AbstractGlobalConfigExtension
Plugin cache may break dependency lock file.
setPluginCacheTimeout(Provider<Integer>) - Method in GlobalConfigDetailsGenerator
setPluginDir(Provider<File>) - Method in AbstractCustomFmtBaseTask
setPluginDir(Provider<File>) - Method in AbstractInitTask
Sets the plugin directory to use with this task.
setPluginDir(Provider<File>) - Method in PluginCacheDirGenerator
setPrefixVersionWithV(boolean) - Method in ModuleRepository
Whether version string should be prefixed with a v.
setProviderName(java.lang.Object) - Method in ModuleSourceSetBase
Set the name of the main provider associated with this module.
setRaw(boolean) - Method in AbstractOutputTask
Whether output should contain raw variable content.
setReconfigure(boolean) - Method in AbstractInitTask
setRecursive(Provider<Boolean>) - Method in AbstractCustomFmtBaseTask
setRecursive(boolean) - Method in OtherSources
Whether to recursive scan directories below the source directories.
setReplacements(List<String>) - Method in AbstractApplyTask
Mark resources to be replaced.
setReplacements(List<String>) - Method in AbstractPlanTask
Mark resources to be replaces.
setReplacements(List<String>) - Method in ResourceFilter
Mark resources to be replaced.
setReportsDir(Provider<File>) - Method in AbstractTfStandardTask
setReportsDir(java.lang.Object) - Method in TfSourceSetBase
Sets the reports directory.
setRequiredFiles(Provider<List<Pattern>>) - Method in ModuleStructureCheck
setRequiredPlatforms(Provider<Set<String>>) - Method in AbstractProviderTask
setResourceIdentifier(java.lang.String) - Method in AbstractImportTask
setResourcePath(java.lang.String) - Method in AbstractImportTask
setResourcePath(java.lang.String) - Method in AbstractStateRmTask
setResourcePath(java.lang.String) - Method in AbstractTaintingTask
setSecretVariables(Provider<Map<String, SimpleSecureString>>) - Method in AbstractTfBaseTask
Sets all of the secret variables that will be loaded into the environment.
setSingleArgs(List<String>) - Method in AbstractTfStandardTask
Patch in an command-line arguments.
setSkipChildModules(boolean) - Method in AbstractInitTask
Skip initialisation of child modules.
setSkipConfigureBackends(boolean) - Method in AbstractInitTask
Whether backend configuration should be skipped.
setSourceDir(Provider<File>) - Method in AbstractTfStandardTask
setSourceDir(Provider<File>) - Method in ModuleStructureCheck
setSourceDirAsWorkingDir() - Method in AbstractTfStandardTask
Sets the source directory as the working directory.
setSourceDirectories(Provider<Set<File>>) - Method in AbstractCustomFmtBaseTask
setSourcePath(java.lang.String) - Method in AbstractStateMvTask
setSourceSetName(java.lang.String) - Method in AbstractOutputJsonTask
Sets the source set name
setSourceSetName(java.lang.String) - Method in AbstractOutputTask
Sets the source set name
setSourceSetName(java.lang.String) - Method in AbstractPlanTask
Sets the source set name
setSourceSetName(java.lang.String) - Method in AbstractProvidersSchemaTask
Sets the source set name.
setSourceSetName(java.lang.String) - Method in AbstractShowStateTask
Sets the source set name
setSourceSetName(java.lang.String) - Method in AbstractTaintingTask
Sets the source set name.
setSourceSetName(java.lang.String) - Method in AbstractTestTask
Sets the source set name
setSourceSetName(java.lang.String) - Method in UsesSourceSetName
Sets the source set name.
setSpaceSeparateArgs(List<String>) - Method in AbstractTfStandardTask
Patch in an command-line arguments.
setSrcDir(java.lang.Object) - Method in TfSourceSetBase
Sets the source directory.
setStateFile(java.lang.String) - Method in AbstractStatePullTask
setStateFile(java.lang.String) - Method in AbstractStatePushTask
setStateNamePrefix(java.lang.Object) - Method in AbstractIacBackend
Assign the prefix.
setSupportsWorkspaces(boolean) - Method in AbstractIacBackend
Indicates whether the backend supports workspaces.
setTargets(List<String>) - Method in AbstractApplyTask
Select specific resources.
setTargets(List<String>) - Method in AbstractPlanTask
Select specific resources.
setTargets(List<String>) - Method in ResourceFilter
Select specific resources.
setTestDirectory(Provider<String>) - Method in AbstractTestTask
Sets the subdirectory in the source directory where tests are located.
setTests(List<String>) - Method in AbstractTestTask
Select specific tests.
setTestSubdir(java.lang.String) - Method in SourceSetBase
Sets the name of subdirectory where tests are located.
setTokenProvider(Provider<Map<String, TokenValue>>) - Method in RemoteStateConfigGenerator
Adds a provider of tokens.
setTokens(Map<String, ?>) - Method in AbstractIacBackend
Replace all tokens with a new set.
setTokens(Map<String, ?>) - Method in AbstractIacBackend.BackendTokenOverrideProxy
Replace all tokens with a new set.
setTokens(Map<String,?>) - Method in TokenConfiguration
Replace all tokens with a new set.
setUpgrade(boolean) - Method in AbstractInitTask
Whether modules should be upgraded
setUseGlobalConfig(boolean) - Method in AbstractGlobalConfigExtension
Select source of configuration.
setVariables(Provider<List<String>>) - Method in VariablesCacheGenerator
Sets the variables to be cached.
setVariablesFile(Provider<File>) - Method in VariablesCacheGenerator
Sets the location of the variables file.
setVariablesFiles(Provider<List<File>>) - Method in UsesVariables
Sets the location of the variables file.
setVarName(java.lang.String) - Method in DefaultRemoteStateVarProvider
Name of the variable.
setVarName(java.lang.String) - Method in RemoteStateVarProvider
Name of the variable.
setWorkspaces(Provider<List<String>>) - Method in AbstractCleanupWorkspacesTask
skipIfOffline() - Method in AbstractTfBaseTask
Skip this task if Gradle is offline.
sourceDir - Field in TfSourceSetBase
sourceFileExtensions - Property in TfSourceSetBase
Extensions which makes up valid HCL sources.
SourceSetBase - Class in org.ysb33r.gradle.iac.base.tf
A base class for OpenTofu & Terraform source sets.
SourceSetBase(java.lang.String, java.lang.String, java.lang.String, Iterable<String>, Iterable<String>, org.gradle.api.Project) - Constructor in SourceSetBase
sourceSetDestroyRelationshipTaskObjects - Field in SourceSetBase
Holds a list of destroy tasks in this source set that needs to be recognised by other source sets, if they have a dependency on this one.
SourceSetExecutionEnvironment - Interface in org.ysb33r.gradle.iac.base.tf
Provide thew default executable, environment and secrets associated with a source set.
sourceSetRelationshipTaskObjects - Field in SourceSetBase
Holds a list of tasks in this source set that needs to be recognised by other source sets, if they have a dependency on this one.
SourceSetSources - Interface in org.ysb33r.gradle.iac.base.tf
Source set directories and file collections.
sourceSetSpecificBackendTokens(Map<String, Object>) - Method in SourceSetBase
Add additional tokens to the backend that is specific to the source set.
STATE_PULL_PROPERTY - Field in AbstractTfStandardTask
stateFile - Property in AbstractInitTask
The location of the state file
StateImpact - Enum in org.ysb33r.gradle.iac.base.tf.characteristics
Indicates what kind of impact a command has on the state.
stateImpact - Property in TaskAttributes
Whether the task affects state.
stateImpact(org.ysb33r.gradle.iac.base.tf.characteristics.StateImpact) - Method in TaskAttributes.Builder
stateOptions - Property in ExecutionOptions
StateOptionsConcurrency - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Allows for options related to walking the state tree.
StateOptionsConcurrency(org.ysb33r.gradle.iac.base.tf.config.multilevel.StateOptionsFull) - Constructor in StateOptionsConcurrency
StateOptionsFull - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Allows for options related to walking the state tree.
StateOptionsFull(org.gradle.api.Project) - Constructor in StateOptionsFull
statusReportOutputFile - Property in AbstractOutputJsonTask
Get the location where the report file needs to be generated.
supportsAutoApprove(boolean) - Method in DefaultArguments.Builder
The command supports auto-approve
supportsColor(boolean) - Method in DefaultArguments.Builder
To be called from tasks where the command supports no-color.
supportsForce() - Method in DefaultArguments.Builder
The command supports force
supportsInputs() - Method in DefaultArguments.Builder
The command supports input.
supportsYes() - Method in DefaultArguments.Builder
The command supports yes
switchWorkspace() - Method in AbstractTfStandardTask
Switches workspaces to the correct one if the source set has workspaces and the current workspace is not the correct one.

T

TaskAttributes - Class in org.ysb33r.gradle.iac.base.tf.characteristics
Characteristics of specific task types.
TaskAttributes.Builder - Class in org.ysb33r.gradle.iac.base.tf.characteristics
TaskAttributes() - Constructor in TaskAttributes
taskNamesForRawOutputVariables(java.lang.String) - Method in SourceSetBase
Returns the name of the tasks that needs to run in order for raw output variables to be available
taskTools - Field in SourceSetBase
Access to the task container
template(org.ysb33r.gradle.iac.base.tf.backends.IacBackendAttributesSpec) - Method in IacBackendTextTemplate
Returns a template based upon backend attributes.
Testing - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Configuration for tests.
testing - Property in ExecutionOptions
Testing(org.ysb33r.gradle.iac.base.tf.config.multilevel.TestingWithConcurrency) - Constructor in Testing
TestingWithConcurrency - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Configuration for tests which also include concurrency.
TestingWithConcurrency(org.gradle.api.Project) - Constructor in TestingWithConcurrency
testSourceFileExtensions - Property in TfSourceSetBase
Extensions which makes up valid test HCL sources.
testSubDir - Field in TfSourceSetBase
testWithAdditionalToolchains(java.lang.String) - Method in ModuleSourceSetBase
Additional toolchains to be used for module testing.
TfConfig - Interface in org.ysb33r.gradle.iac.base.tf
Global config methods.
TfSourceSetBase - Class in org.ysb33r.gradle.iac.base.tf
Consolidates common functionality for source sets and module source sets.
TfSourceSetBase(java.lang.String, java.lang.String, java.lang.String, java.lang.String, Iterable<String>, Iterable<String>, org.gradle.api.Project) - Constructor in TfSourceSetBase
tfVars - Property in CodeFormatting
tfVars - Property in Lock
tfVars - Property in ResolvedExecutionsOptions
Returns the list of variables in the form name=value
tfVars - Property in StateOptionsConcurrency
tfVars - Property in StateOptionsFull
tfVars - Property in Testing
tfVars - Property in TestingWithConcurrency
timeout - Property in Lock
Timeout in seconds of the lock.
token(java.lang.String, java.lang.Object) - Method in AbstractIacBackend
Set a single token value.
token(java.lang.String, java.lang.Object) - Method in AbstractIacBackend.BackendTokenOverrideProxy
Set a single token value.
token(java.lang.String, java.lang.Object) - Method in TokenConfiguration
Set a single token value.
TokenConfiguration - Interface in org.ysb33r.gradle.iac.base.tf.backends
Configures backend tokens
tokens(Map<String, ?>) - Method in AbstractIacBackend
Adds more tokens.
tokens(Map<String, ?>) - Method in AbstractIacBackend.BackendTokenOverrideProxy
Adds more tokens.
tokens(Map<String,?>) - Method in TokenConfiguration
Adds more tokens.
TokenValue - Interface in org.ysb33r.gradle.iac.base.tf.backends
Describes a token value for a backend.
ToolFeatures - Interface in org.ysb33r.gradle.iac.base.tf
States which features a tool has.
toolPrefix - Field in TfSourceSetBase
toString() - Method in AbstractIacToolchain
toString() - Method in Variables
toString() - Method in VarsFilesPair
Returns a string representation of the object.

U

unwindSecretVariablesInto(org.gradle.process.ExecSpec) - Method in AbstractTfBaseTask
Takes secret variables and places them into the environment of an execution specification.
UPDATES_SERIAL - Enum Constant in StateImpact
This command updates the serial number.
useAccessKeyId(java.lang.Object) - Method in AwsSecrets
useAwsCredentialsFromEnvironment() - Method in AwsSecrets
Sets the default to be to use AWS credentials from the environment and pass as-is to the appropriate tool.
useBackend(java.lang.String) - Method in SourceSetBase
Looks up a backend by name and then set this sourceset to use that backend.
useConfigFile(java.lang.Object) - Method in AwsSecrets
useConfiguredPluginCache() - Method in PluginCacheManagement
Use the plugin cache directory configured in the global configuration of the root project.
useConfiguredPluginCache() - Method in TfSourceSetBase
Use the plugin cache directory that is configured in the global configuration of the root project.
useCustomPluginCache(java.lang.Object, java.lang.Integer) - Method in PluginCacheManagement
Use a custom plugin cache by specifying both a directory and a lock timeout.
useCustomPluginCache(java.lang.Object, java.lang.Integer) - Method in TfSourceSetBase
Use a custom plugin cache by specifying both a directory and a lock timeout.
useGitlabToken(java.lang.Object) - Method in GitlabSecrets
Uses the specified value as a Gitlab token.
useGitlabTokenFromEnvironment() - Method in GitlabSecrets
Sets the default to be to use GITLAB_TOKEN from the environment or the gitlab.token gradle/system property.
useProfile(java.lang.Object) - Method in AwsSecrets
useSecretAccessKey(java.lang.Object) - Method in AwsSecrets
useSharedCredentialsFile(java.lang.Object) - Method in AwsSecrets
UsesSourceSetName - Interface in org.ysb33r.gradle.iac.base.tf
Defines that this task requires a source set name
UsesVariables - Interface in org.ysb33r.gradle.iac.base.tf.config.multilevel
Task interface that indicates the task requires variables.
useThisCustomCacheDir(Provider<File>, Provider<Integer>) - Method in TfSourceSetBase
Use this custom cache directory.
useToolchain(java.lang.String) - Method in TfSourceSetBase
Which toolchain to use.

V

valueOf(java.lang.String) - Method in RemoteStateInjection
valueOf(java.lang.String) - Method in StateImpact
values() - Method in RemoteStateInjection
values() - Method in StateImpact
var(java.lang.String, java.lang.Object) - Method in Variables
Adds one variable.
var(java.lang.String, java.lang.Object) - Method in VariablesSpec
Adds one variable.
VARIABLE - Enum Constant in RemoteStateInjection
Inject remote state configuration as a variable
Variables - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
A configuration building block for tasks that need to pass variables to a terraform/opentofu task.
variables(Action<VariablesSpec>) - Method in SourceSetBase
Sets variables that are applicable to this source set.
Variables(org.ysb33r.gradle.iac.base.tf.config.multilevel.VarsFilesPair, Provider<File>, Provider<Map<String, TokenValue>>, org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Constructor in Variables
Constructs instance from definition of files and variables
VariablesCacheGenerator - Class in org.ysb33r.gradle.iac.base.tf.tasks
Generates the file that stores source set variables
VariablesCacheGenerator() - Constructor in VariablesCacheGenerator
VariablesSpec - Interface in org.ysb33r.gradle.iac.base.tf.config.multilevel
Describes variables for Terraform and OpenTofu.
vars - Property in VarsFilesPair
Variables.
VarsFilesPair - Class in org.ysb33r.gradle.iac.base.tf.config.multilevel
Keeps a collection of variables and variable files.
VarsFilesPair(org.ysb33r.grolifant5.api.core.ConfigCacheSafeOperations) - Constructor in VarsFilesPair
verbose - Property in TestingWithConcurrency
Whether to print out the plan or state for each run block within a test file.

W

whatIsPlanOutputFile(Provider<String>, java.lang.String, java.lang.String, java.lang.String) - Method in AbstractTfStandardTask
Calculates the location of a plan file
withAdditionalParams(java.lang.String) - Method in DefaultArguments.Builder
With arbitrary additional parameters.
Workspace - Class in org.ysb33r.gradle.iac.base.tf
Describes a workspace for OpenTofu or Terraform.
Workspace(java.lang.String) - Constructor in Workspace
workspaceName - Field in AbstractTfStandardTask
workspaceNames - Property in SourceSetBase
List of additional workspaces other than the the default.
workspaces - Field in SourceSetBase

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 _