Class ComponentResource

A Resource that aggregates one or more other child resources into a higher level abstraction. The component resource itself is a resource, but does not require custom CRUD operations for provisioning.

Inheritance

object

Resource

ComponentResource

Stack

Inherited Members

Resource.Urn

Resource.GetResourceType()

Resource.GetResourceName()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi

Assembly: Pulumi.dll

Syntax

public class ComponentResource : Resource

Constructors

ComponentResource(string, string, ComponentResourceOptions?)

Creates and registers a new component resource. type is the fully qualified type token and name is the "name" part to use in creating a stable and globally unique URN for the object. options.parent is the optional parent for this component, and [options.dependsOn] is an optional list of other resources that this resource depends on, controlling the order in which we perform resource operations.

Declaration

public ComponentResource(string type, string name, ComponentResourceOptions? options = null)

Parameters

Type	Name	Description
string	type	The type of the resource.
string	name	The unique name of the resource.
ComponentResourceOptions	options	A bag of options that control this resource's behavior.

ComponentResource(string, string, ResourceArgs?, ComponentResourceOptions?, bool)

Creates and registers a new component resource. type is the fully qualified type token and name is the "name" part to use in creating a stable and globally unique URN for the object. options.parent is the optional parent for this component, and [options.dependsOn] is an optional list of other resources that this resource depends on, controlling the order in which we perform resource operations.

Declaration

public ComponentResource(string type, string name, ResourceArgs? args, ComponentResourceOptions? options = null, bool remote = false)

Parameters

Type	Name	Description
string	type	The type of the resource.
string	name	The unique name of the resource.
ResourceArgs	args	The arguments to use to populate the new resource.
ComponentResourceOptions	options	A bag of options that control this resource's behavior.
bool	remote	True if this is a remote component resource.

Methods

RegisterOutputs()

RegisterOutputs registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values. ComponentResources should always call this at the end of their constructor to indicate that they are done creating child resources. While not strictly necessary, this helps the experience by ensuring the UI transitions the ComponentResource to the 'complete' state as quickly as possible (instead of waiting until the entire application completes).

Declaration

protected void RegisterOutputs()

RegisterOutputs(Output<IDictionary<string, object?>>)

Declaration

protected void RegisterOutputs(Output<IDictionary<string, object?>> outputs)

Parameters

Type	Name	Description
Output<IDictionary<string, object>>	outputs

RegisterOutputs(IDictionary<string, object?>)

Declaration

protected void RegisterOutputs(IDictionary<string, object?> outputs)

Parameters

Type	Name	Description
IDictionary<string, object>	outputs

RegisterOutputs(Task<IDictionary<string, object?>>)

Declaration

protected void RegisterOutputs(Task<IDictionary<string, object?>> outputs)

Parameters

Type	Name	Description
Task<IDictionary<string, object>>	outputs