Class Output

Useful static utility methods for both creating and working with Output<T>s.

Inheritance
object
Output
Inherited Members
Namespace: Pulumi
Assembly: Pulumi.dll
Syntax
public static class Output

Methods

View Source

All<T>(params Input<T>[])

Combines all the Input<T> values in inputs into a single Output<T> with an ImmutableArray<T> containing all their underlying values. If any of the Input<T>s are not known, the final result will be not known. Similarly, if any of the Input<T>s are secrets, then the final result will be a secret.

Declaration
public static Output<ImmutableArray<T>> All<T>(params Input<T>[] inputs)
Parameters
Type Name Description
Input<T>[] inputs
Returns
Type Description
Output<ImmutableArray<T>>
Type Parameters
Name Description
T
View Source

All<T>(params Output<T>[])

Combines all the Output<T> values in outputs into a single Output<T> with an ImmutableArray<T> containing all their underlying values. If any of the Output<T>s are not known, the final result will be not known. Similarly, if any of the Output<T>s are secrets, then the final result will be a secret.

Declaration
public static Output<ImmutableArray<T>> All<T>(params Output<T>[] outputs)
Parameters
Type Name Description
Output<T>[] outputs
Returns
Type Description
Output<ImmutableArray<T>>
Type Parameters
Name Description
T
View Source

All<T>(IEnumerable<Input<T>>)

All<T>(params Input<T>[]) for more details.

Declaration
public static Output<ImmutableArray<T>> All<T>(IEnumerable<Input<T>> inputs)
Parameters
Type Name Description
IEnumerable<Input<T>> inputs
Returns
Type Description
Output<ImmutableArray<T>>
Type Parameters
Name Description
T
View Source

All<T>(IEnumerable<Output<T>>)

All<T>(params Output<T>[]) for more details.

Declaration
public static Output<ImmutableArray<T>> All<T>(IEnumerable<Output<T>> outputs)
Parameters
Type Name Description
IEnumerable<Output<T>> outputs
Returns
Type Description
Output<ImmutableArray<T>>
Type Parameters
Name Description
T
View Source

Create<T>(T)

Declaration
public static Output<T> Create<T>(T value)
Parameters
Type Name Description
T value
Returns
Type Description
Output<T>
Type Parameters
Name Description
T
View Source

Create<T>(Task<T>)

Declaration
public static Output<T> Create<T>(Task<T> value)
Parameters
Type Name Description
Task<T> value
Returns
Type Description
Output<T>
Type Parameters
Name Description
T
View Source

CreateSecret<T>(T)

Declaration
public static Output<T> CreateSecret<T>(T value)
Parameters
Type Name Description
T value
Returns
Type Description
Output<T>
Type Parameters
Name Description
T
View Source

CreateSecret<T>(Output<T>)

Declaration
public static Output<T> CreateSecret<T>(Output<T> value)
Parameters
Type Name Description
Output<T> value
Returns
Type Description
Output<T>
Type Parameters
Name Description
T
View Source

CreateSecret<T>(Task<T>)

Declaration
public static Output<T> CreateSecret<T>(Task<T> value)
Parameters
Type Name Description
Task<T> value
Returns
Type Description
Output<T>
Type Parameters
Name Description
T
View Source

Format(FormattableString)

Takes in a FormattableString with potential Input<T>s or Output<T> in the 'placeholder holes'. Conceptually, this method unwraps all the underlying values in the holes, combines them appropriately with the Format string, and produces an Output<T> containing the final result.

If any of the Input<T>s or Output<T>s are not known, the final result will be not known. Similarly, if any of the Input<T>s or Output<T>s are secrets, then the final result will be a secret.
Declaration
public static Output<string> Format(FormattableString formattableString)
Parameters
Type Name Description
FormattableString formattableString
Returns
Type Description
Output<string>
View Source

IsSecretAsync<T>(Output<T>)

Retrieves the secretness status of the given output.

Declaration
public static Task<bool> IsSecretAsync<T>(Output<T> output)
Parameters
Type Name Description
Output<T> output
Returns
Type Description
Task<bool>
Type Parameters
Name Description
T
View Source

JsonDeserialize<T>(Output<string>, JsonSerializerOptions?)

Uses DeserializeAsync<TValue>(Stream, JsonSerializerOptions, CancellationToken) to deserialize the given Output<T> string value into a .

Declaration
public static Output<T> JsonDeserialize<T>(Output<string> json, JsonSerializerOptions? options = null)
Parameters
Type Name Description
Output<string> json
JsonSerializerOptions options
Returns
Type Description
Output<T>
Type Parameters
Name Description
T
View Source

JsonSerialize<T>(Output<T>, JsonSerializerOptions?)

Uses SerializeAsync<TValue>(Stream, TValue, JsonSerializerOptions, CancellationToken) to serialize the given Output<T> value into a JSON string.

Declaration
public static Output<string> JsonSerialize<T>(Output<T> value, JsonSerializerOptions? options = null)
Parameters
Type Name Description
Output<T> value
JsonSerializerOptions options
Returns
Type Description
Output<string>
Type Parameters
Name Description
T
View Source

Tuple<T1, T2>(Input<T1>, Input<T2>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2)> Tuple<T1, T2>(Input<T1> item1, Input<T2> item2)
Parameters
Type Name Description
Input<T1> item1
Input<T2> item2
Returns
Type Description
Output<(T1, T2)>
Type Parameters
Name Description
T1
T2
View Source

Tuple<T1, T2>(Output<T1>, Output<T2>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2)> Tuple<T1, T2>(Output<T1> item1, Output<T2> item2)
Parameters
Type Name Description
Output<T1> item1
Output<T2> item2
Returns
Type Description
Output<(T1, T2)>
Type Parameters
Name Description
T1
T2
View Source

Tuple<T1, T2, T3>(Input<T1>, Input<T2>, Input<T3>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3)> Tuple<T1, T2, T3>(Input<T1> item1, Input<T2> item2, Input<T3> item3)
Parameters
Type Name Description
Input<T1> item1
Input<T2> item2
Input<T3> item3
Returns
Type Description
Output<(T1, T2, T3)>
Type Parameters
Name Description
T1
T2
T3
View Source

Tuple<T1, T2, T3>(Output<T1>, Output<T2>, Output<T3>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3)> Tuple<T1, T2, T3>(Output<T1> item1, Output<T2> item2, Output<T3> item3)
Parameters
Type Name Description
Output<T1> item1
Output<T2> item2
Output<T3> item3
Returns
Type Description
Output<(T1, T2, T3)>
Type Parameters
Name Description
T1
T2
T3
View Source

Tuple<T1, T2, T3, T4>(Input<T1>, Input<T2>, Input<T3>, Input<T4>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4)> Tuple<T1, T2, T3, T4>(Input<T1> item1, Input<T2> item2, Input<T3> item3, Input<T4> item4)
Parameters
Type Name Description
Input<T1> item1
Input<T2> item2
Input<T3> item3
Input<T4> item4
Returns
Type Description
Output<(T1, T2, T3, T4)>
Type Parameters
Name Description
T1
T2
T3
T4
View Source

Tuple<T1, T2, T3, T4>(Output<T1>, Output<T2>, Output<T3>, Output<T4>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4)> Tuple<T1, T2, T3, T4>(Output<T1> item1, Output<T2> item2, Output<T3> item3, Output<T4> item4)
Parameters
Type Name Description
Output<T1> item1
Output<T2> item2
Output<T3> item3
Output<T4> item4
Returns
Type Description
Output<(T1, T2, T3, T4)>
Type Parameters
Name Description
T1
T2
T3
T4
View Source

Tuple<T1, T2, T3, T4, T5>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4, T5)> Tuple<T1, T2, T3, T4, T5>(Input<T1> item1, Input<T2> item2, Input<T3> item3, Input<T4> item4, Input<T5> item5)
Parameters
Type Name Description
Input<T1> item1
Input<T2> item2
Input<T3> item3
Input<T4> item4
Input<T5> item5
Returns
Type Description
Output<(T1, T2, T3, T4, T5)>
Type Parameters
Name Description
T1
T2
T3
T4
T5
View Source

Tuple<T1, T2, T3, T4, T5>(Output<T1>, Output<T2>, Output<T3>, Output<T4>, Output<T5>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4, T5)> Tuple<T1, T2, T3, T4, T5>(Output<T1> item1, Output<T2> item2, Output<T3> item3, Output<T4> item4, Output<T5> item5)
Parameters
Type Name Description
Output<T1> item1
Output<T2> item2
Output<T3> item3
Output<T4> item4
Output<T5> item5
Returns
Type Description
Output<(T1, T2, T3, T4, T5)>
Type Parameters
Name Description
T1
T2
T3
T4
T5
View Source

Tuple<T1, T2, T3, T4, T5, T6>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4, T5, T6)> Tuple<T1, T2, T3, T4, T5, T6>(Input<T1> item1, Input<T2> item2, Input<T3> item3, Input<T4> item4, Input<T5> item5, Input<T6> item6)
Parameters
Type Name Description
Input<T1> item1
Input<T2> item2
Input<T3> item3
Input<T4> item4
Input<T5> item5
Input<T6> item6
Returns
Type Description
Output<(T1, T2, T3, T4, T5, T6)>
Type Parameters
Name Description
T1
T2
T3
T4
T5
T6
View Source

Tuple<T1, T2, T3, T4, T5, T6>(Output<T1>, Output<T2>, Output<T3>, Output<T4>, Output<T5>, Output<T6>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4, T5, T6)> Tuple<T1, T2, T3, T4, T5, T6>(Output<T1> item1, Output<T2> item2, Output<T3> item3, Output<T4> item4, Output<T5> item5, Output<T6> item6)
Parameters
Type Name Description
Output<T1> item1
Output<T2> item2
Output<T3> item3
Output<T4> item4
Output<T5> item5
Output<T6> item6
Returns
Type Description
Output<(T1, T2, T3, T4, T5, T6)>
Type Parameters
Name Description
T1
T2
T3
T4
T5
T6
View Source

Tuple<T1, T2, T3, T4, T5, T6, T7>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4, T5, T6, T7)> Tuple<T1, T2, T3, T4, T5, T6, T7>(Input<T1> item1, Input<T2> item2, Input<T3> item3, Input<T4> item4, Input<T5> item5, Input<T6> item6, Input<T7> item7)
Parameters
Type Name Description
Input<T1> item1
Input<T2> item2
Input<T3> item3
Input<T4> item4
Input<T5> item5
Input<T6> item6
Input<T7> item7
Returns
Type Description
Output<(T1, T2, T3, T4, T5, T6, T7)>
Type Parameters
Name Description
T1
T2
T3
T4
T5
T6
T7
View Source

Tuple<T1, T2, T3, T4, T5, T6, T7>(Output<T1>, Output<T2>, Output<T3>, Output<T4>, Output<T5>, Output<T6>, Output<T7>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4, T5, T6, T7)> Tuple<T1, T2, T3, T4, T5, T6, T7>(Output<T1> item1, Output<T2> item2, Output<T3> item3, Output<T4> item4, Output<T5> item5, Output<T6> item6, Output<T7> item7)
Parameters
Type Name Description
Output<T1> item1
Output<T2> item2
Output<T3> item3
Output<T4> item4
Output<T5> item5
Output<T6> item6
Output<T7> item7
Returns
Type Description
Output<(T1, T2, T3, T4, T5, T6, T7)>
Type Parameters
Name Description
T1
T2
T3
T4
T5
T6
T7
View Source

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Combines all the Input<T> values in the provided parameters and combines them all into a single tuple containing each of their underlying values. If any of the Input<T>s are not known, the final result will be not known. Similarly, if any of the Input<T>s are secrets, then the final result will be a secret.

Declaration
public static Output<(T1, T2, T3, T4, T5, T6, T7, T8)> Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1> item1, Input<T2> item2, Input<T3> item3, Input<T4> item4, Input<T5> item5, Input<T6> item6, Input<T7> item7, Input<T8> item8)
Parameters
Type Name Description
Input<T1> item1
Input<T2> item2
Input<T3> item3
Input<T4> item4
Input<T5> item5
Input<T6> item6
Input<T7> item7
Input<T8> item8
Returns
Type Description
Output<(T1, T2, T3, T4, T5, T6, T7, T8)>
Type Parameters
Name Description
T1
T2
T3
T4
T5
T6
T7
T8
View Source

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Output<T1>, Output<T2>, Output<T3>, Output<T4>, Output<T5>, Output<T6>, Output<T7>, Output<T8>)

Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Input<T1>, Input<T2>, Input<T3>, Input<T4>, Input<T5>, Input<T6>, Input<T7>, Input<T8>)

Declaration
public static Output<(T1, T2, T3, T4, T5, T6, T7, T8)> Tuple<T1, T2, T3, T4, T5, T6, T7, T8>(Output<T1> item1, Output<T2> item2, Output<T3> item3, Output<T4> item4, Output<T5> item5, Output<T6> item6, Output<T7> item7, Output<T8> item8)
Parameters
Type Name Description
Output<T1> item1
Output<T2> item2
Output<T3> item3
Output<T4> item4
Output<T5> item5
Output<T6> item6
Output<T7> item7
Output<T8> item8
Returns
Type Description
Output<(T1, T2, T3, T4, T5, T6, T7, T8)>
Type Parameters
Name Description
T1
T2
T3
T4
T5
T6
T7
T8
View Source

Unsecret<T>(Output<T>)

Returns a new Output<T> which is a copy of the existing output but marked as a non-secret. The original output is not modified in any way.

Declaration
public static Output<T> Unsecret<T>(Output<T> output)
Parameters
Type Name Description
Output<T> output
Returns
Type Description
Output<T>
Type Parameters
Name Description
T