Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Terraform
  3. API Docs
  4. state
  5. getRemoteReference
Terraform v6.0.1 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-terraform

terraform.state.getRemoteReference

Explore with Pulumi AI

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

    Access state from a remote backend.

    Using getRemoteReference

    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 getRemoteReference(args: GetRemoteReferenceArgs, opts?: InvokeOptions): Promise<GetRemoteReferenceResult>
function getRemoteReferenceOutput(args: GetRemoteReferenceOutputArgs, opts?: InvokeOptions): Output<GetRemoteReferenceResult>
    def get_remote_reference(hostname: Optional[str] = None,
                         organization: Optional[str] = None,
                         token: Optional[str] = None,
                         workspaces: Optional[Workspaces] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRemoteReferenceResult
def get_remote_reference_output(hostname: Optional[pulumi.Input[str]] = None,
                         organization: Optional[pulumi.Input[str]] = None,
                         token: Optional[pulumi.Input[str]] = None,
                         workspaces: Optional[pulumi.Input[WorkspacesArgs]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRemoteReferenceResult]
    func GetRemoteReference(ctx *Context, args *GetRemoteReferenceArgs, opts ...InvokeOption) (*GetRemoteReferenceResult, error)
func GetRemoteReferenceOutput(ctx *Context, args *GetRemoteReferenceOutputArgs, opts ...InvokeOption) GetRemoteReferenceResultOutput

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

    public static class GetRemoteReference 
{
    public static Task<GetRemoteReferenceResult> InvokeAsync(GetRemoteReferenceArgs args, InvokeOptions? opts = null)
    public static Output<GetRemoteReferenceResult> Invoke(GetRemoteReferenceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRemoteReferenceResult> getRemoteReference(GetRemoteReferenceArgs args, InvokeOptions options)
public static Output<GetRemoteReferenceResult> getRemoteReference(GetRemoteReferenceArgs args, InvokeOptions options)

    fn::invoke:
  function: terraform:state:getRemoteReference
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Organization string
    The name of the organization containing the targeted workspace(s).
    Workspaces Workspaces
    Hostname string
    The remote backend hostname to connect to.
    Token string
    The token used to authenticate with the remote backend.
    Organization string
    The name of the organization containing the targeted workspace(s).
    Workspaces Workspaces
    Hostname string
    The remote backend hostname to connect to.
    Token string
    The token used to authenticate with the remote backend.
    organization String
    The name of the organization containing the targeted workspace(s).
    workspaces Workspaces
    hostname String
    The remote backend hostname to connect to.
    token String
    The token used to authenticate with the remote backend.
    organization string
    The name of the organization containing the targeted workspace(s).
    workspaces Workspaces
    hostname string
    The remote backend hostname to connect to.
    token string
    The token used to authenticate with the remote backend.
    organization str
    The name of the organization containing the targeted workspace(s).
    workspaces Workspaces
    hostname str
    The remote backend hostname to connect to.
    token str
    The token used to authenticate with the remote backend.
    organization String
    The name of the organization containing the targeted workspace(s).
    workspaces Property Map
    hostname String
    The remote backend hostname to connect to.
    token String
    The token used to authenticate with the remote backend.

    getRemoteReference 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.

    Supporting Types

    Workspaces

    Name string
    The full name of one remote workspace. When configured, only the default workspace can be used. This option conflicts with prefix.
    Prefix string
    A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration. The full workspace names are used in HCP Terraform, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. If omitted, only the default workspace can be used. This option conflicts with name.
    Name string
    The full name of one remote workspace. When configured, only the default workspace can be used. This option conflicts with prefix.
    Prefix string
    A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration. The full workspace names are used in HCP Terraform, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. If omitted, only the default workspace can be used. This option conflicts with name.
    name String
    The full name of one remote workspace. When configured, only the default workspace can be used. This option conflicts with prefix.
    prefix String
    A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration. The full workspace names are used in HCP Terraform, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. If omitted, only the default workspace can be used. This option conflicts with name.
    name string
    The full name of one remote workspace. When configured, only the default workspace can be used. This option conflicts with prefix.
    prefix string
    A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration. The full workspace names are used in HCP Terraform, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. If omitted, only the default workspace can be used. This option conflicts with name.
    name str
    The full name of one remote workspace. When configured, only the default workspace can be used. This option conflicts with prefix.
    prefix str
    A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration. The full workspace names are used in HCP Terraform, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. If omitted, only the default workspace can be used. This option conflicts with name.
    name String
    The full name of one remote workspace. When configured, only the default workspace can be used. This option conflicts with prefix.
    prefix String
    A prefix used in the names of one or more remote workspaces, all of which can be used with this configuration. The full workspace names are used in HCP Terraform, and the short names (minus the prefix) are used on the command line for Terraform CLI workspaces. If omitted, only the default workspace can be used. This option conflicts with name.

    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
    pulumi/pulumi-terraform