Class RemoteWorkspaceStack

Inheritance

object

RemoteWorkspaceStack

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi.Automation

Assembly: Pulumi.Automation.dll

Syntax

public sealed class RemoteWorkspaceStack : IDisposable

Properties

Name

The name identifying the Stack.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Methods

CancelAsync(CancellationToken)

Cancel stops a stack's currently running update. It throws an exception if no update is currently running. Note that this operation is very dangerous, and may leave the stack in an inconsistent state if a resource operation was pending when the update was canceled. This command is not supported for local backends.

Declaration

public Task CancelAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

DestroyAsync(RemoteDestroyOptions?, CancellationToken)

Destroy deletes all resources in a stack, leaving all history and configuration intact. This operation runs remotely.

Declaration

public Task<UpdateResult> DestroyAsync(RemoteDestroyOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RemoteDestroyOptions	options	Options to customize the behavior of the destroy.
CancellationToken	cancellationToken	A cancellation token.

Returns

Type	Description
Task<UpdateResult>

Dispose()

Declaration

public void Dispose()

ExportStackAsync(CancellationToken)

Exports the deployment state of the stack.

This can be combined with ImportStackAsync to edit a stack's state (such as recovery from failed deployments).

Declaration

public Task<StackDeployment> ExportStackAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<StackDeployment>

GetHistoryAsync(HistoryOptions?, CancellationToken)

Returns a list summarizing all previews and current results from Stack lifecycle operations (up/preview/refresh/destroy).

Declaration

public Task<ImmutableList<UpdateSummary>> GetHistoryAsync(HistoryOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
HistoryOptions	options	Options to customize the behavior of the fetch history action.
CancellationToken	cancellationToken	A cancellation token.

Returns

Type	Description
Task<ImmutableList<UpdateSummary>>

GetOutputsAsync(CancellationToken)

Gets the current set of Stack outputs from the last UpAsync(RemoteUpOptions?, CancellationToken).

Declaration

public Task<ImmutableDictionary<string, OutputValue>> GetOutputsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableDictionary<string, OutputValue>>

ImportStackAsync(StackDeployment, CancellationToken)

Imports the specified deployment state into a pre-existing stack.

This can be combined with ExportStackAsync to edit a stack's state (such as recovery from failed deployments).

Declaration

public Task ImportStackAsync(StackDeployment state, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
StackDeployment	state
CancellationToken	cancellationToken

Returns

Type	Description
Task

PreviewAsync(RemotePreviewOptions?, CancellationToken)

Performs a dry-run update to a stack, returning pending changes. This operation runs remotely.

https://www.pulumi.com/docs/reference/cli/pulumi_preview/

Declaration

public Task<PreviewResult> PreviewAsync(RemotePreviewOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RemotePreviewOptions	options	Options to customize the behavior of the update.
CancellationToken	cancellationToken	A cancellation token.

Returns

Type	Description
Task<PreviewResult>

RefreshAsync(RemoteRefreshOptions?, CancellationToken)

Compares the current stack’s resource state with the state known to exist in the actual cloud provider. Any such changes are adopted into the current stack. This operation runs remotely.

Declaration

public Task<UpdateResult> RefreshAsync(RemoteRefreshOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RemoteRefreshOptions	options	Options to customize the behavior of the refresh.
CancellationToken	cancellationToken	A cancellation token.

Returns

Type	Description
Task<UpdateResult>

UpAsync(RemoteUpOptions?, CancellationToken)

Creates or updates the resources in a stack by executing the program in the Workspace. This operation runs remotely.

https://www.pulumi.com/docs/reference/cli/pulumi_up/

Declaration

public Task<UpResult> UpAsync(RemoteUpOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
RemoteUpOptions	options	Options to customize the behavior of the update.
CancellationToken	cancellationToken	A cancellation token.

Returns

Type	Description
Task<UpResult>

Implements

IDisposable