Package org.ysb33r.gradle.iac.base.tf

Interface RemoteStateVarProvider

  • public interface RemoteStateVarProvider
    Manages the injection of a variable containing variables related to remote state, so that they can be used by terraform_remote_state data sources.
    Since:
    2.0

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.gradle.api.provider.Provider<java.util.Map<java.lang.String,​java.lang.String>> getAsEnvTfVar()
      A provider for TF variables when configured for RemoteStateInjection.ENVIRONMENT.
      org.gradle.api.provider.Provider<java.util.List<java.lang.String>> getAsTfVar()
      A provider for TF variables when configured for RemoteStateInjection.VARIABLE.
      org.gradle.api.provider.Provider<org.ysb33r.gradle.iac.base.tf.RemoteStateInjection> getInjectVar()
      A provider to indicate whether remote state tokens should be injected.
      default void setInjectVar​(java.lang.String asVar)
      Whether tokens should be bundled in a variable, an environment variable, or not at all (default).
      void setInjectVar​(org.ysb33r.gradle.iac.base.tf.RemoteStateInjection asVar)
      Whether tokens should be bundled in a variable, an environment variable, or not at all (default).
      void setVarName​(java.lang.String varName)
      Name of the variable.

    • Method Detail

      • setVarName

        void setVarName​(java.lang.String varName)
        Name of the variable.

        The default is remote_state

        Parameters:
        varName - Override name.

      • setInjectVar

        void setInjectVar​(org.ysb33r.gradle.iac.base.tf.RemoteStateInjection asVar)
        Whether tokens should be bundled in a variable, an environment variable, or not at all (default).
        Parameters:
        asVar - How to inject the variable

      • setInjectVar

        default void setInjectVar​(java.lang.String asVar)
        Whether tokens should be bundled in a variable, an environment variable, or not at all (default).
        Parameters:
        asVar - How to inject the variable

      • getInjectVar

        org.gradle.api.provider.Provider<org.ysb33r.gradle.iac.base.tf.RemoteStateInjection> getInjectVar()
        A provider to indicate whether remote state tokens should be injected.
        Returns:
        Decision provider.

      • getAsTfVar

        org.gradle.api.provider.Provider<java.util.List<java.lang.String>> getAsTfVar()
        A provider for TF variables when configured for RemoteStateInjection.VARIABLE.
        Returns:
        If not configured for variables the provider will be an empty list, otherwise it will contain a single entry that can ber written to a .tfvars file.

      • getAsEnvTfVar

        org.gradle.api.provider.Provider<java.util.Map<java.lang.String,​java.lang.String>> getAsEnvTfVar()
        A provider for TF variables when configured for RemoteStateInjection.ENVIRONMENT.
        Returns:
        If not configured for variables the provider will be an empty map, otherwise it will contain a single entry that can be injected into the environment.