Class StateMigrationResult

StateMigrationResult is returned by a state migration callback when it changes the state. Every resource present in the old state must either be returned in NewState under the same URN or have an entry in Successors, but not both.

This API is experimental and may change.

Inheritance

object

StateMigrationResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi

Assembly: Pulumi.dll

Syntax

public sealed class StateMigrationResult

Constructors

StateMigrationResult(JsonArray, IReadOnlyDictionary<string, string>?)

Declaration

public StateMigrationResult(JsonArray newState, IReadOnlyDictionary<string, string>? successors = null)

Parameters

Type	Name	Description
JsonArray	newState
IReadOnlyDictionary<string, string>	successors

Properties

NewState

The complete migrated subtree in checkpoint resource format, including unchanged resources. This replaces OldState.

Declaration

public JsonArray NewState { get; }

Property Value

Type	Description
JsonArray

Successors

Maps each old URN removed from the state to the URN in NewState that succeeds it. Multiple old URNs may map to the same successor. A resource cannot be removed without a successor. The engine uses these mappings to rewrite resource references.

Declaration

public IReadOnlyDictionary<string, string> Successors { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, string>