Package com.pulumi.resources

Class ComponentResourceOptions

java.lang.Object

com.pulumi.resources.ResourceOptions

com.pulumi.resources.ComponentResourceOptions

All Implemented Interfaces:

com.pulumi.core.internal.Copyable<ComponentResourceOptions>

public final class ComponentResourceOptions
extends ResourceOptions
implements com.pulumi.core.internal.Copyable<ComponentResourceOptions>

A bag of optional settings that control a @see ComponentResource behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ComponentResourceOptions.Builder	The ComponentResourceOptions builder.

Field Summary

Fields

Modifier and Type	Field	Description
static final ComponentResourceOptions	Empty

Fields inherited from class com.pulumi.resources.ResourceOptions

aliases, customTimeouts, dependsOn, hideDiffs, id, ignoreChanges, parent, pluginDownloadURL, protect, provider, replacementTrigger, replaceOnChanges, replaceWith, resourceTransformations, retainOnDelete, urn, version

Constructor Summary

Constructors

Constructor

Description

ComponentResourceOptions(Output<String> id, Resource parent, Output<List<Resource>> dependsOn, Boolean protect, List<String> ignoreChanges, String version, CustomTimeouts customTimeouts, List<ResourceTransformation> resourceTransformations, List<Output<Alias>> aliases, String urn, List<String> replaceOnChanges, Boolean retainOnDelete, String pluginDownloadURL, List<String> hideDiffs, List<ProviderResource> providers, List<Resource> replaceWith, Output<?> replacementTrigger)

Method Summary

Modifier and Type	Method	Description
static ComponentResourceOptions.Builder	builder()
ComponentResourceOptions	copy()
List<ProviderResource>	getProviders()	An optional list of providers to use for child resources.
static ComponentResourceOptions	merge(ComponentResourceOptions options1, ComponentResourceOptions options2)	Takes two "ComponentResourceOptions" values and produces a new "ComponentResourceOptions" with the respective properties of "options2" merged over the same properties in "options1".
static ComponentResourceOptions	merge(ComponentResourceOptions options1, ComponentResourceOptions options2, Output<String> id)

Methods inherited from class com.pulumi.resources.ResourceOptions

getAliases, getCustomTimeouts, getDependsOn, getHideDiffs, getId, getIgnoreChanges, getParent, getPluginDownloadURL, getProtect, getProvider, getReplacementTrigger, getReplaceOnChanges, getReplaceWith, getResourceTransformations, getRetainOnDelete, getUrn, getVersion, isProtect, isRetainOnDelete, mergeSharedOptions, mergeSharedOptions

Methods inherited from class java.lang.Object

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

Field Details

Empty

public static final ComponentResourceOptions Empty

Constructor Details

ComponentResourceOptions

public ComponentResourceOptions(@Nullable
 Output<String> id,
 @Nullable
 Resource parent,
 @Nullable
 Output<List<Resource>> dependsOn,
 @Nullable
 Boolean protect,
 @Nullable
 List<String> ignoreChanges,
 @Nullable
 String version,
 @Nullable
 CustomTimeouts customTimeouts,
 @Nullable
 List<ResourceTransformation> resourceTransformations,
 @Nullable
 List<Output<Alias>> aliases,
 @Nullable
 String urn,
 @Nullable
 List<String> replaceOnChanges,
 @Nullable
 Boolean retainOnDelete,
 @Nullable
 String pluginDownloadURL,
 @Nullable
 List<String> hideDiffs,
 @Nullable
 List<ProviderResource> providers,
 @Nullable
 List<Resource> replaceWith,
 @Nullable
 Output<?> replacementTrigger)

Method Details

builder

public static ComponentResourceOptions.Builder builder()

getProviders

public List<ProviderResource> getProviders()

An optional list of providers to use for child resources.

Returns:

list of providers or empty

copy

public ComponentResourceOptions copy()

Specified by:

copy in interface com.pulumi.core.internal.Copyable<ComponentResourceOptions>

merge

public static ComponentResourceOptions merge(@Nullable
 ComponentResourceOptions options1,
 @Nullable
 ComponentResourceOptions options2)

Takes two "ComponentResourceOptions" values and produces a new "ComponentResourceOptions" with the respective properties of "options2" merged over the same properties in "options1".

The original options objects will be unchanged. A new instance will always be returned.

Conceptually property merging follows these basic rules: 1. If the property is a collection, the final value will be a collection containing the values from each options object. 2. Simple scalar values from "options2" (i.e. Strings, Integers, Booleans) will replace the values of "options1". 3. "null" values in "options2" will be ignored.

merge

public static ComponentResourceOptions merge(@Nullable
 ComponentResourceOptions options1,
 @Nullable
 ComponentResourceOptions options2,
 @Nullable
 Output<String> id)