1. Packages
  2. Terraform
  3. API Docs
  4. state
  5. getLocalReference
Terraform v6.0.1 published on Friday, Apr 18, 2025 by Pulumi

terraform.state.getLocalReference

Explore with Pulumi AI

terraform logo
Terraform v6.0.1 published on Friday, Apr 18, 2025 by Pulumi

    Access state from the local filesystem.

    Using getLocalReference

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLocalReference(args: GetLocalReferenceArgs, opts?: InvokeOptions): Promise<GetLocalReferenceResult>
    function getLocalReferenceOutput(args: GetLocalReferenceOutputArgs, opts?: InvokeOptions): Output<GetLocalReferenceResult>
    def get_local_reference(path: Optional[str] = None,
                            workspace_dir: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetLocalReferenceResult
    def get_local_reference_output(path: Optional[pulumi.Input[str]] = None,
                            workspace_dir: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetLocalReferenceResult]
    func GetLocalReference(ctx *Context, args *GetLocalReferenceArgs, opts ...InvokeOption) (*GetLocalReferenceResult, error)
    func GetLocalReferenceOutput(ctx *Context, args *GetLocalReferenceOutputArgs, opts ...InvokeOption) GetLocalReferenceResultOutput

    > Note: This function is named GetLocalReference in the Go SDK.

    public static class GetLocalReference 
    {
        public static Task<GetLocalReferenceResult> InvokeAsync(GetLocalReferenceArgs args, InvokeOptions? opts = null)
        public static Output<GetLocalReferenceResult> Invoke(GetLocalReferenceInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLocalReferenceResult> getLocalReference(GetLocalReferenceArgs args, InvokeOptions options)
    public static Output<GetLocalReferenceResult> getLocalReference(GetLocalReferenceArgs args, InvokeOptions options)
    
    fn::invoke:
      function: terraform:state:getLocalReference
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Path string
    The path to the tfstate file. This defaults to "terraform.tfstate" relative to the root module by default.
    WorkspaceDir string
    The path to non-default workspaces.
    Path string
    The path to the tfstate file. This defaults to "terraform.tfstate" relative to the root module by default.
    WorkspaceDir string
    The path to non-default workspaces.
    path String
    The path to the tfstate file. This defaults to "terraform.tfstate" relative to the root module by default.
    workspaceDir String
    The path to non-default workspaces.
    path string
    The path to the tfstate file. This defaults to "terraform.tfstate" relative to the root module by default.
    workspaceDir string
    The path to non-default workspaces.
    path str
    The path to the tfstate file. This defaults to "terraform.tfstate" relative to the root module by default.
    workspace_dir str
    The path to non-default workspaces.
    path String
    The path to the tfstate file. This defaults to "terraform.tfstate" relative to the root module by default.
    workspaceDir String
    The path to non-default workspaces.

    getLocalReference Result

    The following output properties are available:

    Outputs Dictionary<string, object>
    The outputs displayed from Terraform state.
    Outputs map[string]interface{}
    The outputs displayed from Terraform state.
    outputs Map<String,Object>
    The outputs displayed from Terraform state.
    outputs {[key: string]: any}
    The outputs displayed from Terraform state.
    outputs Mapping[str, Any]
    The outputs displayed from Terraform state.
    outputs Map<Any>
    The outputs displayed from Terraform state.

    Package Details

    Repository
    terraform pulumi/pulumi-terraform
    License
    Apache-2.0
    terraform logo
    Terraform v6.0.1 published on Friday, Apr 18, 2025 by Pulumi