Class InputList<T>

A list of values that can be passed in as the arguments to a Resource. The individual values are themselves Input<T>s. i.e. the individual values can be concrete values or Output<T>s.

InputList<T> differs from a normal IList<T> in that it is itself an Input<T>. For example, a Resource that accepts an InputList<T> will accept not just a list but an Output<T> of a list. This is important for cases where the Output<T> list from some Resource needs to be passed into another Resource. Or for cases where creating the list invariably produces an Output<T> because its resultant value is dependent on other Output<T>s.

This benefit of InputList<T> is also a limitation. Because it represents a list of values that may eventually be created, there is no way to simply iterate over, or access the elements of the list synchronously.

InputList<T> is designed to be easily used in object and collection initializers. For example, a resource that accepts a list of inputs can be written in either of these forms:

    new SomeResource("name", new SomeResourceArgs {
        ListProperty = { Value1, Value2, Value3 },
    });

or

    new SomeResource("name", new SomeResourceArgs {
        ListProperty = new [] { Value1, Value2, Value3 },
    });

Inheritance

object

Input<ImmutableArray<T>>

InputList<T>

Implements

IEnumerable

IAsyncEnumerable<Input<T>>

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 InputList<T> : Input<ImmutableArray<T>>, IEnumerable, IAsyncEnumerable<Input<T>>

Type Parameters

Name	Description
T

Constructors

InputList()

Declaration

public InputList()

Methods

Add(params Input<T>[])

Declaration

public void Add(params Input<T>[] inputs)

Parameters

Type	Name	Description
Input<T>[]	inputs

Add(InputList<T>)

Note: this is non-standard convenience for use with collection initializers.

Declaration

public void Add(InputList<T> inputs)

Parameters

Type	Name	Description
InputList<T>	inputs

AddRange(InputList<T>)

Declaration

public void AddRange(InputList<T> inputs)

Parameters

Type	Name	Description
InputList<T>	inputs

Concat(InputList<T>)

Concatenates the values in this list with the values in other, returning the concatenated sequence in a new InputList<T>.

Declaration

public InputList<T> Concat(InputList<T> other)

Parameters

Type	Name	Description
InputList<T>	other

Returns

Type	Description
InputList<T>

GetAsyncEnumerator(CancellationToken)

Declaration

public IAsyncEnumerator<Input<T>> GetAsyncEnumerator(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
IAsyncEnumerator<Input<T>>

Operators

implicit operator InputList<T>(T)

Declaration

public static implicit operator InputList<T>(T value)

Parameters

Type	Name	Description
T	value

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(T[])

Declaration

public static implicit operator InputList<T>(T[] values)

Parameters

Type	Name	Description
T[]	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(Input<T>)

Declaration

public static implicit operator InputList<T>(Input<T> value)

Parameters

Type	Name	Description
Input<T>	value

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(Input<T>[])

Declaration

public static implicit operator InputList<T>(Input<T>[] values)

Parameters

Type	Name	Description
Input<T>[]	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(Output<T[]>)

Declaration

public static implicit operator InputList<T>(Output<T[]> values)

Parameters

Type	Name	Description
Output<T[]>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(Output<T>)

Declaration

public static implicit operator InputList<T>(Output<T> value)

Parameters

Type	Name	Description
Output<T>	value

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(Output<T>[])

Declaration

public static implicit operator InputList<T>(Output<T>[] values)

Parameters

Type	Name	Description
Output<T>[]	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(Output<IEnumerable<T>>)

Declaration

public static implicit operator InputList<T>(Output<IEnumerable<T>> values)

Parameters

Type	Name	Description
Output<IEnumerable<T>>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(Output<List<T>>)

Declaration

public static implicit operator InputList<T>(Output<List<T>> values)

Parameters

Type	Name	Description
Output<List<T>>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(Output<ImmutableArray<T>>)

Declaration

public static implicit operator InputList<T>(Output<ImmutableArray<T>> values)

Parameters

Type	Name	Description
Output<ImmutableArray<T>>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(List<T>)

Declaration

public static implicit operator InputList<T>(List<T> values)

Parameters

Type	Name	Description
List<T>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(List<Input<T>>)

Declaration

public static implicit operator InputList<T>(List<Input<T>> values)

Parameters

Type	Name	Description
List<Input<T>>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(List<Output<T>>)

Declaration

public static implicit operator InputList<T>(List<Output<T>> values)

Parameters

Type	Name	Description
List<Output<T>>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(ImmutableArray<T>)

Declaration

public static implicit operator InputList<T>(ImmutableArray<T> values)

Parameters

Type	Name	Description
ImmutableArray<T>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(ImmutableArray<Input<T>>)

Declaration

public static implicit operator InputList<T>(ImmutableArray<Input<T>> values)

Parameters

Type	Name	Description
ImmutableArray<Input<T>>	values

Returns

Type	Description
InputList<T>

implicit operator InputList<T>(ImmutableArray<Output<T>>)

Declaration

public static implicit operator InputList<T>(ImmutableArray<Output<T>> values)

Parameters

Type	Name	Description
ImmutableArray<Output<T>>	values

Returns

Type	Description
InputList<T>

Implements

IEnumerable

IAsyncEnumerable<T>

Extension Methods

InputExtensions.Apply<T, U>(Input<T>?, Func<T, U>)

InputExtensions.Apply<T, U>(Input<T>?, Func<T, Input<U>?>)

InputExtensions.Apply<T, U>(Input<T>?, Func<T, Output<U>?>)

InputExtensions.Apply<T, U>(Input<T>?, Func<T, Task<U>>)

InputExtensions.ToOutput<T>(Input<T>?)