Class DeploymentInstance

Metadata of the deployment that is currently running. Accessible via Instance.

Inheritance

object

DeploymentInstance

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 DeploymentInstance

Properties

IsDryRun

Whether or not the application is currently being previewed or actually applied.

Declaration

public bool IsDryRun { get; }

Property Value

Type	Description
bool

OrganizationName

Returns the current organization name.

Declaration

public string OrganizationName { get; }

Property Value

Type	Description
string

ProjectName

Returns the current project name.

Declaration

public string ProjectName { get; }

Property Value

Type	Description
string

RootDirectory

Root directory, that is the location of the Pulumi.yaml file.

Declaration

public string RootDirectory { get; }

Property Value

Type	Description
string

StackName

Returns the current stack name.

Declaration

public string StackName { get; }

Property Value

Type	Description
string

Methods

Call(string, CallArgs, Resource?, CallOptions?)

Same as Call<T>(string, CallArgs, Resource, CallOptions), however the return value is ignored.

Declaration

public void Call(string token, CallArgs args, Resource? self = null, CallOptions? options = null)

Parameters

Type	Name	Description
string	token
CallArgs	args
Resource	self
CallOptions	options

Call(string, CallArgs, Resource?, CallOptions?, RegisterPackageRequest?)

Same as Call<T>(string, CallArgs, Resource, CallOptions, RegisterPackageRequest), however the return value is ignored.

Declaration

public void Call(string token, CallArgs args, Resource? self, CallOptions? options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
CallArgs	args
Resource	self
CallOptions	options
RegisterPackageRequest	registerPackageRequest

Call<T>(string, CallArgs, Resource?, CallOptions?)

Dynamically calls the function 'token', which is offered by a provider plugin. Call<T>(string, CallArgs, Resource, CallOptions) returns immediately while the operation takes place asynchronously in the background, similar to Resource constructors.

The result of Call<T>(string, CallArgs, Resource, CallOptions) will be a Output<T> resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> Call<T>(string token, CallArgs args, Resource? self = null, CallOptions? options = null)

Parameters

Type	Name	Description
string	token
CallArgs	args
Resource	self
CallOptions	options

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

Call<T>(string, CallArgs, Resource?, CallOptions?, RegisterPackageRequest?)

Dynamically calls the function 'token', which is offered by a provider plugin. Call<T>(string, CallArgs, Resource, CallOptions, RegisterPackageRequest) returns immediately while the operation takes place asynchronously in the background, similar to Resource constructors.

The result of Call<T>(string, CallArgs, Resource, CallOptions, RegisterPackageRequest) will be a Output<T> resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> Call<T>(string token, CallArgs args, Resource? self, CallOptions? options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
CallArgs	args
Resource	self
CallOptions	options
RegisterPackageRequest	registerPackageRequest

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

InvokeAsync(string, InvokeArgs, InvokeOptions?)

Same as InvokeAsync<T>(string, InvokeArgs, InvokeOptions?, RegisterPackageRequest?), however the return value is ignored.

Declaration

public Task InvokeAsync(string token, InvokeArgs args, InvokeOptions? options = null)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options

Returns

Type	Description
Task

InvokeAsync(string, InvokeArgs, InvokeOptions?, RegisterPackageRequest?)

Same as InvokeAsync<T>(string, InvokeArgs, InvokeOptions?, RegisterPackageRequest?), however the return value is ignored.

Declaration

public Task InvokeAsync(string token, InvokeArgs args, InvokeOptions? options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options
RegisterPackageRequest	registerPackageRequest

Returns

Type	Description
Task

InvokeAsync<T>(string, InvokeArgs, InvokeOptions?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of InvokeAsync(string, InvokeArgs, InvokeOptions) will be a Task resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Task<T> InvokeAsync<T>(string token, InvokeArgs args, InvokeOptions? options = null)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

InvokeAsync<T>(string, InvokeArgs, InvokeOptions?, RegisterPackageRequest?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of InvokeAsync(string, InvokeArgs, InvokeOptions, RegisterPackageRequest) will be a Task resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Task<T> InvokeAsync<T>(string token, InvokeArgs args, InvokeOptions? options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options
RegisterPackageRequest	registerPackageRequest

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

InvokeSingleAsync<T>(string, InvokeArgs, InvokeOptions?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of InvokeSingleAsync<T>(string, InvokeArgs, InvokeOptions) will be a Task resolved to the result value of the provider plugin that returns a bag of properties with a single value that is returned.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Task<T> InvokeSingleAsync<T>(string token, InvokeArgs args, InvokeOptions? options = null)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

InvokeSingleAsync<T>(string, InvokeArgs, InvokeOptions?, RegisterPackageRequest?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of InvokeSingleAsync<T>(string, InvokeArgs, InvokeOptions, RegisterPackageRequest) will be a Task resolved to the result value of the provider plugin that returns a bag of properties with a single value that is returned.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Task<T> InvokeSingleAsync<T>(string token, InvokeArgs args, InvokeOptions? options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options
RegisterPackageRequest	registerPackageRequest

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

InvokeSingle<T>(string, InvokeArgs, InvokeOptions?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of InvokeSingle<T>(string, InvokeArgs, InvokeOptions) will be a Output resolved to the result value of the provider plugin that returns a bag of properties with a single value that is returned.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> InvokeSingle<T>(string token, InvokeArgs args, InvokeOptions? options = null)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

InvokeSingle<T>(string, InvokeArgs, InvokeOptions?, RegisterPackageRequest?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of InvokeSingle<T>(string, InvokeArgs, InvokeOptions, RegisterPackageRequest) will be a Output resolved to the result value of the provider plugin that returns a bag of properties with a single value that is returned.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> InvokeSingle<T>(string token, InvokeArgs args, InvokeOptions? options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options
RegisterPackageRequest	registerPackageRequest

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

InvokeSingle<T>(string, InvokeArgs, InvokeOutputOptions)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of InvokeSingle<T>(string, InvokeArgs, InvokeOutputOptions) will be a Output resolved to the result value of the provider plugin that returns a bag of properties with a single value that is returned.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> InvokeSingle<T>(string token, InvokeArgs args, InvokeOutputOptions options)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOutputOptions	options

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

InvokeSingle<T>(string, InvokeArgs, InvokeOutputOptions, RegisterPackageRequest?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of InvokeSingle<T>(string, InvokeArgs, InvokeOutputOptions, RegisterPackageRequest) will be a Output resolved to the result value of the provider plugin that returns a bag of properties with a single value that is returned.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> InvokeSingle<T>(string token, InvokeArgs args, InvokeOutputOptions options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOutputOptions	options
RegisterPackageRequest	registerPackageRequest

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

Invoke<T>(string, InvokeArgs, InvokeOptions?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of Invoke<T>(string, InvokeArgs, InvokeOptions) will be a Output resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> Invoke<T>(string token, InvokeArgs args, InvokeOptions? options = null)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

Invoke<T>(string, InvokeArgs, InvokeOptions?, RegisterPackageRequest?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of Invoke<T>(string, InvokeArgs, InvokeOptions, RegisterPackageRequest) will be a Output resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> Invoke<T>(string token, InvokeArgs args, InvokeOptions? options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOptions	options
RegisterPackageRequest	registerPackageRequest

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

Invoke<T>(string, InvokeArgs, InvokeOutputOptions)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of Invoke<T>(string, InvokeArgs, InvokeOptions) will be a Output resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> Invoke<T>(string token, InvokeArgs args, InvokeOutputOptions options)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOutputOptions	options

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

Invoke<T>(string, InvokeArgs, InvokeOutputOptions, RegisterPackageRequest?)

Dynamically invokes the function 'token', which is offered by a provider plugin.

The result of Invoke<T>(string, InvokeArgs, InvokeOutputOptions, RegisterPackageRequest) will be a Output resolved to the result value of the provider plugin.

The args inputs can be a bag of computed values(including, Ts, Task<TResult>s, Output<T>s etc.).

Declaration

public Output<T> Invoke<T>(string token, InvokeArgs args, InvokeOutputOptions options, RegisterPackageRequest? registerPackageRequest)

Parameters

Type	Name	Description
string	token
InvokeArgs	args
InvokeOutputOptions	options
RegisterPackageRequest	registerPackageRequest

Returns

Type	Description
Output<T>

Type Parameters

Name	Description
T

RegisterInvokeTransform(InvokeTransform)

Register an invoke transform to run when invoke calls are made.

Declaration

public void RegisterInvokeTransform(InvokeTransform transform)

Parameters

Type	Name	Description
InvokeTransform	transform