Show / Hide Table of Contents

Class PulumiRefreshOptions

Options for the pulumi refresh command.

Inheritance
object
BaseOptions
PulumiRefreshOptions
Inherited Members
BaseOptions.WorkDir
BaseOptions.EnvironmentVariables
BaseOptions.OnStandardOutput
BaseOptions.OnStandardError
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Pulumi.Automation.Commands
Assembly: Pulumi.Automation.dll
Syntax
public sealed class PulumiRefreshOptions : BaseOptions

Properties

View Source

ClearPendingCreates

Clear all pending creates, dropping them from the state

Declaration
public bool? ClearPendingCreates { get; set; }
Property Value
Type Description
bool?
View Source

Client

The address of an existing language runtime host to connect to

Declaration
public string? Client { get; set; }
Property Value
Type Description
string
View Source

Color

Colorize output. Choices are: always, never, raw, auto

Declaration
public string? Color { get; set; }
Property Value
Type Description
string
View Source

Config

Config to use during the refresh and save to the stack config file

Declaration
public List<string>? Config { get; set; }
Property Value
Type Description
List<string>
View Source

ConfigFile

Use the configuration values in the specified file rather than detecting the file name

Declaration
public string? ConfigFile { get; set; }
Property Value
Type Description
string
View Source

ConfigPath

Config keys contain a path to a property in a map or list to set

Declaration
public bool? ConfigPath { get; set; }
Property Value
Type Description
bool?
View Source

Copilot

[DEPRECATED] Use --neo instead. Enable Pulumi Neo's assistance for improved CLI experience and insights (can also be set with PULUMI_COPILOT environment variable)

Declaration
public bool? Copilot { get; set; }
Property Value
Type Description
bool?
View Source

Debug

Print detailed debugging output during resource operations

Declaration
public bool? Debug { get; set; }
Property Value
Type Description
bool?
View Source

Diff

Display operation as a rich diff showing the overall change

Declaration
public bool? Diff { get; set; }
Property Value
Type Description
bool?
View Source

DisableIntegrityChecking

Disable integrity checking of checkpoint files

Declaration
public bool? DisableIntegrityChecking { get; set; }
Property Value
Type Description
bool?
View Source

Exclude

Specify a resource URN to ignore. These resources will not be refreshed. Multiple resources can be specified using --exclude urn1 --exclude urn2. Wildcards (*, **) are also supported

Declaration
public List<string>? Exclude { get; set; }
Property Value
Type Description
List<string>
View Source

ExcludeDependents

Allows ignoring of dependent targets discovered but not specified in --exclude list

Declaration
public bool? ExcludeDependents { get; set; }
Property Value
Type Description
bool?
View Source

ExecAgent

Declaration
public string? ExecAgent { get; set; }
Property Value
Type Description
string
View Source

ExecKind

Declaration
public string? ExecKind { get; set; }
Property Value
Type Description
string
View Source

ExpectNoChanges

Return an error if any changes occur during this refresh. This check happens after the refresh is applied

Declaration
public bool? ExpectNoChanges { get; set; }
Property Value
Type Description
bool?
View Source

FullyQualifyStackNames

Show fully-qualified stack names

Declaration
public bool? FullyQualifyStackNames { get; set; }
Property Value
Type Description
bool?
View Source

ImportPendingCreates

A list of form [[URN ID]...] describing the provider IDs of pending creates

Declaration
public List<string>? ImportPendingCreates { get; set; }
Property Value
Type Description
List<string>
View Source

Json

Serialize the refresh diffs, operations, and overall output as JSON

Declaration
public bool? Json { get; set; }
Property Value
Type Description
bool?
View Source

Logflow

Flow log settings to child processes (like plugins)

Declaration
public bool? Logflow { get; set; }
Property Value
Type Description
bool?
View Source

Logtostderr

Log to stderr instead of to files

Declaration
public bool? Logtostderr { get; set; }
Property Value
Type Description
bool?
View Source

Memprofilerate

Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate

Declaration
public int? Memprofilerate { get; set; }
Property Value
Type Description
int?
View Source

Message

Optional message to associate with the update operation

Declaration
public string? Message { get; set; }
Property Value
Type Description
string
View Source

Neo

Enable Pulumi Neo's assistance for improved CLI experience and insights (can also be set with PULUMI_NEO environment variable)

Declaration
public bool? Neo { get; set; }
Property Value
Type Description
bool?
View Source

OtelTraces

Export OpenTelemetry traces to the specified endpoint. Use file:// for local JSON files, grpc:// or https:// for remote collectors

Declaration
public string? OtelTraces { get; set; }
Property Value
Type Description
string
View Source

Output

Output format. Supported values are: default, json

Declaration
public string? Output { get; set; }
Property Value
Type Description
string
View Source

OverrideEnv

[EXPERIMENTAL] Override an imported environment for this run only, as <env>=<replacement>; repeatable

Declaration
public List<string>? OverrideEnv { get; set; }
Property Value
Type Description
List<string>
View Source

Parallel

Allow P resource operations to run in parallel at once (1 for no parallelism).

Declaration
public int? Parallel { get; set; }
Property Value
Type Description
int?
View Source

PreviewOnly

Only show a preview of the refresh, but don't perform the refresh itself

Declaration
public bool? PreviewOnly { get; set; }
Property Value
Type Description
bool?
View Source

Profiling

Emit CPU and memory profiles and an execution trace to '[filename].[pid].{cpu,mem,trace}', respectively

Declaration
public string? Profiling { get; set; }
Property Value
Type Description
string
View Source

RunProgram

Run the program to determine up-to-date state for providers to refresh resources

Declaration
public bool? RunProgram { get; set; }
Property Value
Type Description
bool?
View Source

ShowReplacementSteps

Show detailed resource replacement creates and deletes instead of a single step

Declaration
public bool? ShowReplacementSteps { get; set; }
Property Value
Type Description
bool?
View Source

ShowSames

Show resources that needn't be updated because they haven't changed, alongside those that do

Declaration
public bool? ShowSames { get; set; }
Property Value
Type Description
bool?
View Source

SkipConfigValidation

Skip validation of stack config values against the project config schema. Config validation is skipped automatically when --run-program is not set.

Declaration
public bool? SkipConfigValidation { get; set; }
Property Value
Type Description
bool?
View Source

SkipPendingCreates

Skip importing pending creates in interactive mode

Declaration
public bool? SkipPendingCreates { get; set; }
Property Value
Type Description
bool?
View Source

SkipPluginPreInstall

Skip the up-front provider plugin install step; missing plugins are installed lazily by the engine

Declaration
public bool? SkipPluginPreInstall { get; set; }
Property Value
Type Description
bool?
View Source

Stack

The name of the stack to operate on. Defaults to the current stack

Declaration
public string? Stack { get; set; }
Property Value
Type Description
string
View Source

SuppressOutputs

Suppress display of stack outputs (in case they contain sensitive values)

Declaration
public bool? SuppressOutputs { get; set; }
Property Value
Type Description
bool?
View Source

SuppressPermalink

Suppress display of the state permalink

Declaration
public string? SuppressPermalink { get; set; }
Property Value
Type Description
string
View Source

SuppressProgress

Suppress display of periodic progress dots

Declaration
public bool? SuppressProgress { get; set; }
Property Value
Type Description
bool?
View Source

Target

Specify a single resource URN to refresh. Multiple resource can be specified using: --target urn1 --target urn2

Declaration
public List<string>? Target { get; set; }
Property Value
Type Description
List<string>
View Source

TargetDependents

Allows updating of dependent targets discovered but not specified in --target list

Declaration
public bool? TargetDependents { get; set; }
Property Value
Type Description
bool?
View Source

Tracing

Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file

Declaration
public string? Tracing { get; set; }
Property Value
Type Description
string
View Source

TracingHeader

Include the tracing header with the given contents.

Declaration
public string? TracingHeader { get; set; }
Property Value
Type Description
string
View Source

Urns

Display full URNs instead of short resource names

Declaration
public bool? Urns { get; set; }
Property Value
Type Description
bool?
View Source

Verbose

Enable verbose logging (e.g., v=3); anything >3 is very verbose

Declaration
public int? Verbose { get; set; }
Property Value
Type Description
int?

Version 3.116.1

  • View Source
Back to top Copyright 2016-2023, Pulumi Corporation.