pulumi_terraform

class pulumi_terraform.Provider(resource_name: str, opts: pulumi.ResourceOptions | None = None, __props__=None)
class pulumi_terraform.Provider(resource_name: str, args: ProviderArgs | None = None, opts: pulumi.ResourceOptions | None = None)
Parameters:

  • pkg (str) – The package type of this provider resource.

  • name (str) – The name of this resource.

  • props (Optional[dict]) – An optional list of input properties to use as inputs for the resource.

  • opts (Optional[ResourceOptions]) – Optional set of pulumi.ResourceOptions to use for this resource.

  • dependency (bool) – True if this is a synthetic resource used internally for dependency tracking.

  • package_ref (Optional[Awaitable[Optional[str]]]) – The package reference for this resource.

class pulumi_terraform.state.AwaitableGetLocalReferenceResult(outputs=None)
class pulumi_terraform.state.AwaitableGetRemoteReferenceResult(outputs=None)
class pulumi_terraform.state.GetLocalReferenceResult(outputs=None)

The result of fetching from a Terraform state store.

property outputs: Mapping[str, Any]

The outputs displayed from Terraform state.

class pulumi_terraform.state.GetRemoteReferenceResult(outputs=None)

The result of fetching from a Terraform state store.

property outputs: Mapping[str, Any]

The outputs displayed from Terraform state.

class pulumi_terraform.state.WorkspacesDict
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.

pulumi_terraform.state.get_local_reference(path: str | None = None, workspace_dir: str | None = None, opts: InvokeOptions | None = None) → AwaitableGetLocalReferenceResult

Access state from the local filesystem.

Parameters:

  • path (builtins.str) – The path to the tfstate file. This defaults to “terraform.tfstate” relative to the root module by default.

  • workspace_dir (builtins.str) – The path to non-default workspaces.

pulumi_terraform.state.get_local_reference_output(path: str | None | Awaitable[str | None] | Output[T] = None, workspace_dir: str | None | Awaitable[str | None] | Output[T] = None, opts: InvokeOptions | InvokeOutputOptions | None = None) → Output[GetLocalReferenceResult]

Access state from the local filesystem.

Parameters:

  • path (builtins.str) – The path to the tfstate file. This defaults to “terraform.tfstate” relative to the root module by default.

  • workspace_dir (builtins.str) – The path to non-default workspaces.

pulumi_terraform.state.get_remote_reference(hostname: str | None = None, organization: str | None = None, token: str | None = None, workspaces: Workspaces | WorkspacesDict | None = None, opts: InvokeOptions | None = None) → AwaitableGetRemoteReferenceResult

Access state from a remote backend.

Parameters:

  • hostname (builtins.str) – The remote backend hostname to connect to.

  • organization (builtins.str) – The name of the organization containing the targeted workspace(s).

  • token (builtins.str) – The token used to authenticate with the remote backend.

pulumi_terraform.state.get_remote_reference_output(hostname: str | None | Awaitable[str | None] | Output[T] = None, organization: str | Awaitable[str] | Output[T] | None = None, token: str | None | Awaitable[str | None] | Output[T] = None, workspaces: Workspaces | WorkspacesDict | Awaitable[Workspaces | WorkspacesDict] | Output[T] | None = None, opts: InvokeOptions | InvokeOutputOptions | None = None) → Output[GetRemoteReferenceResult]

Access state from a remote backend.

Parameters:

  • hostname (builtins.str) – The remote backend hostname to connect to.

  • organization (builtins.str) – The name of the organization containing the targeted workspace(s).

  • token (builtins.str) – The token used to authenticate with the remote backend.