Package com.pulumi.resources

Class ComponentResource

java.lang.Object

com.pulumi.resources.Resource

com.pulumi.resources.ComponentResource

public class ComponentResource
extends Resource

A @see 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComponentResource.ComponentResourceInternal

Nested classes/interfaces inherited from class com.pulumi.resources.Resource

Resource.LazyField<T>, Resource.LazyFields, Resource.ResourceInternal

Field Summary

Fields inherited from class com.pulumi.resources.Resource

childResources, remote

Constructor Summary

Constructors

Constructor	Description
ComponentResource(String type, String name)	Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).
ComponentResource(String type, String name, ComponentResourceOptions options)	Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).
ComponentResource(String type, String name, ComponentResourceOptions options, boolean remote)	Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).
ComponentResource(String type, String name, ResourceArgs args, ComponentResourceOptions options)	Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).
ComponentResource(String type, String name, ResourceArgs args, ComponentResourceOptions options, boolean remote)	Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).
ComponentResource(String type, String name, ResourceArgs args, ComponentResourceOptions options, boolean remote, CompletableFuture<String> packageRef)	Creates and registers a new component resource.

Method Summary

Modifier and Type	Method	Description
protected void	registerOutputs(Output<Map<String,Output<?>>> outputs)
protected void	registerOutputs(CompletableFuture<Map<String,Output<?>>> outputs)
protected void	registerOutputs(Map<String,Output<?>> outputs)

Methods inherited from class com.pulumi.resources.Resource

idFuture, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ComponentResource

public ComponentResource(String type,
 String name)

Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).

Parameters:

type - The type of the resource

name - The unique name of the resource

ComponentResource

public ComponentResource(String type,
 String name,
 @Nullable
 ComponentResourceOptions options)

Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).

Parameters:

type - The type of the resource

name - The unique name of the resource

options - A bag of options that control this resource's behavior

ComponentResource

public ComponentResource(String type,
 String name,
 @Nullable
 ComponentResourceOptions options,
 boolean remote)

Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).

Parameters:

type - The type of the resource

name - The unique name of the resource

options - A bag of options that control this resource's behavior

remote - This parameter is intended for use by code-generated component SDKs; end users authoring their own ComponentResource subclasses should leave this at its default (false). When true, the component's children are constructed by the engine rather than in this process, and the constructor skips local child registration accordingly.

ComponentResource

public ComponentResource(String type,
 String name,
 @Nullable
 ResourceArgs args,
 @Nullable
 ComponentResourceOptions options)

Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).

Parameters:

type - The type of the resource

name - The unique name of the resource

args - The arguments to use to populate the new resource

options - A bag of options that control this resource's behavior

ComponentResource

public ComponentResource(String type,
 String name,
 @Nullable
 ResourceArgs args,
 @Nullable
 ComponentResourceOptions options,
 boolean remote)

Creates and registers a new component resource, @see ComponentResource(String, String, ResourceArgs, ComponentResourceOptions, boolean, CompletableFuture).

Parameters:

type - The type of the resource

name - The unique name of the resource

args - The arguments to use to populate the new resource

remote - This parameter is intended for use by code-generated component SDKs; end users authoring their own ComponentResource subclasses should leave this at its default (false). When true, the component's children are constructed by the engine rather than in this process, and the constructor skips local child registration accordingly.

options - A bag of options that control this resource's behavior

ComponentResource

public ComponentResource(String type,
 String name,
 @Nullable
 ResourceArgs args,
 @Nullable
 ComponentResourceOptions options,
 boolean remote,
 CompletableFuture<String> packageRef)

Creates and registers a new component resource. Given "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. The "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.

Parameters:

type - The type of the resource

name - The unique name of the resource

args - The arguments to use to populate the new resource

options - A bag of options that control this resource's behavior

remote - This parameter is intended for use by code-generated component SDKs; end users authoring their own ComponentResource subclasses should leave this at its default (false). When true, the component's children are constructed by the engine rather than in this process, and the constructor skips local child registration accordingly.

packageRef - The package reference to use for this resource

Method Details

registerOutputs

protected void registerOutputs(Map<String,Output<?>> outputs)

registerOutputs

protected void registerOutputs(CompletableFuture<Map<String,Output<?>>> outputs)

registerOutputs

protected void registerOutputs(Output<Map<String,Output<?>>> outputs)