Stack class

Automation stack handle scoped to a LocalWorkspace.

Constructors

Stack(String name, LocalWorkspace workspace)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

name ↔ String

Stack name.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

workspace → LocalWorkspace

Parent workspace used to execute commands.

final

Methods

addEnvironments(Iterable<String> environments, {bool yes = true}) → Future<PulumiCommandResult>

Adds one or more ESC environments to this stack.

cancel({bool yes = true}) → Future<PulumiCommandResult>

Cancels the currently running update for this stack.

destroy({bool yes = true, bool skipPreview = true, bool nonInteractive = true, bool check = true, List<String> extraArgs = const <String>[]}) → Future<PulumiCommandResult>

Runs pulumi destroy for this stack.

destroyResult({bool yes = true, bool skipPreview = true, bool nonInteractive = true, bool check = true, bool captureEvents = true, bool includeSummary = true, bool showSummarySecrets = false, AutomationEngineEventHandler? onEvent, List<String> extraArgs = const <String>[]}) → Future<AutomationDestroyResult>

Runs pulumi destroy and returns a typed operation result.

exportStack({bool showSecrets = true}) → Future<Map<String, dynamic>>

Exports deployment state for this stack.

getAllConfig() → Future<Map<String, AutomationConfigValue>>

Reads all config values for this stack.

getConfig(String key, {bool path = false}) → Future<AutomationConfigValue>

Reads a single config value from this stack.

getTag(String key) → Future<String>

Returns a stack tag value by key.

history({int? pageSize, int? page, bool showSecrets = false}) → Future<List<Map<String, dynamic>>>

Returns stack update history.

importResources({String? message, List<AutomationImportResource>? resources, Map<String, String>? nameTable, bool? protect, bool generateCode = true, String? converter, List<String>? converterArgs, bool check = true, bool includeSummary = true, bool showSummarySecrets = false, bool captureEvents = false, AutomationEngineEventHandler? onEvent, List<String> extraArgs = const <String>[]}) → Future<AutomationImportResult>

Imports resources into this stack and returns a typed operation result.

importStack(Map<String, dynamic> state) → Future<void>

Imports deployment state into this stack.

info({bool showSecrets = false}) → Future<Map<String, dynamic>?>

Returns the most recent stack update summary if one exists.

infoSummary({bool showSecrets = false}) → Future<AutomationUpdateSummary?>

Returns the most recent stack update summary as a typed model.

listEnvironments() → Future<List<String>>

Lists ESC environments imported by this stack.

listTags() → Future<Map<String, String>>

Lists all tags for this stack.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

outputs({bool showSecrets = false}) → Future<Map<String, dynamic>>

Returns stack outputs from the last successful update.

outputsWithMetadata() → Future<Map<String, AutomationOutputValue>>

Returns stack outputs with secret metadata.

preview({bool nonInteractive = true, bool check = true, List<String> extraArgs = const <String>[]}) → Future<PulumiCommandResult>

Runs pulumi preview for this stack.

previewDestroyResult({bool nonInteractive = true, bool check = true, bool captureEvents = true, AutomationEngineEventHandler? onEvent, List<String> extraArgs = const <String>[]}) → Future<AutomationPreviewResult>

Runs pulumi destroy --preview-only and returns a typed preview result.

previewRefreshResult({bool nonInteractive = true, bool check = true, bool captureEvents = true, AutomationEngineEventHandler? onEvent, List<String> extraArgs = const <String>[]}) → Future<AutomationPreviewResult>

Runs pulumi refresh --preview-only and returns a typed preview result.

previewResult({bool nonInteractive = true, bool check = true, bool captureEvents = true, AutomationEngineEventHandler? onEvent, List<String> extraArgs = const <String>[]}) → Future<AutomationPreviewResult>

Runs pulumi preview and returns a typed operation result.

refresh({bool yes = true, bool nonInteractive = true, bool check = true, List<String> extraArgs = const <String>[]}) → Future<PulumiCommandResult>

Runs pulumi refresh for this stack.

refreshConfig() → Future<Map<String, AutomationConfigValue>>

Refreshes stack config from backend and returns the resulting config map.

refreshResult({bool yes = true, bool nonInteractive = true, bool check = true, bool captureEvents = true, bool includeSummary = true, bool showSummarySecrets = false, AutomationEngineEventHandler? onEvent, List<String> extraArgs = const <String>[]}) → Future<AutomationRefreshResult>

Runs pulumi refresh and returns a typed operation result.

removeAllConfig(Iterable<String> keys, {bool path = false}) → Future<PulumiCommandResult>

Removes multiple config values from this stack.

removeConfig(String key, {bool path = false}) → Future<PulumiCommandResult>

Removes a config value from this stack.

removeEnvironment(String environment, {bool yes = true}) → Future<PulumiCommandResult>

Removes an ESC environment from this stack.

removeTag(String key) → Future<PulumiCommandResult>

Removes a stack tag by key.

rename(String stackName, {bool check = true, List<String> extraArgs = const <String>[]}) → Future<PulumiCommandResult>

Renames this stack.

renameResult(String stackName, {bool check = true, bool includeSummary = true, bool showSummarySecrets = false, bool captureEvents = false, AutomationEngineEventHandler? onEvent, List<String> extraArgs = const <String>[]}) → Future<AutomationRenameResult>

Renames this stack and returns a typed operation result.

setAllConfig(Map<String, AutomationConfigValue> config, {bool path = false}) → Future<PulumiCommandResult>

Sets multiple config values on this stack in one command.

setAllConfigJson(String configJson) → Future<PulumiCommandResult>

Sets all config values from a JSON string for this stack.

setConfig(String key, String value, {bool path = false, bool secret = false}) → Future<PulumiCommandResult>

Sets a stack configuration value.

setTag(String key, String value) → Future<PulumiCommandResult>

Sets a stack tag key-value pair.

toString() → String

A string representation of this object.

inherited

up({bool yes = true, bool skipPreview = true, bool nonInteractive = true, bool check = true, List<String> extraArgs = const <String>[]}) → Future<PulumiCommandResult>

Runs pulumi up for this stack.

upResult({bool yes = true, bool skipPreview = true, bool nonInteractive = true, bool check = true, bool captureEvents = true, bool includeOutputs = true, bool includeSummary = true, bool showSummarySecrets = false, AutomationEngineEventHandler? onEvent, List<String> extraArgs = const <String>[]}) → Future<AutomationUpResult>

Runs pulumi up and returns a typed operation result.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create(String stackName, LocalWorkspace workspace) → Future<Stack>

Creates a new stack.

createOrSelect(String stackName, LocalWorkspace workspace) → Future<Stack>

Creates the stack when missing, otherwise selects it.

select(String stackName, LocalWorkspace workspace) → Future<Stack>

Selects an existing stack.