Package com.pulumi.resources

Class CustomResourceOptions

java.lang.Object

com.pulumi.resources.ResourceOptions

com.pulumi.resources.CustomResourceOptions

All Implemented Interfaces:

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

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomResourceOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static CustomResourceOptions	Empty

Fields inherited from class com.pulumi.resources.ResourceOptions

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

Method Summary

Modifier and Type	Method	Description
static CustomResourceOptions.Builder	builder()
CustomResourceOptions	copy()
java.util.List<java.lang.String>	getAdditionalSecretOutputs()	The names of outputs for this resource that should be treated as secrets.
boolean	getDeleteBeforeReplace()	When set to "true", indicates that this resource should be deleted before its replacement is created when replacement is necessary.
java.util.Optional<java.lang.String>	getImportId()	When provided with a resource ID, import indicates that this resource's provider should import its state from the cloud resource with the given ID.The inputs to the resource's constructor must align with the resource's current state.Once a resource has been imported, the import property must be removed from the resource's options.
static CustomResourceOptions	merge(CustomResourceOptions options1, CustomResourceOptions options2)	Takes two @see CustomResourceOptions values and produces a new @see CustomResourceOptions with the respective properties of "options2" merged over the same properties in "options1".
static CustomResourceOptions	merge(CustomResourceOptions options1, CustomResourceOptions options2, Output<java.lang.String> id)

Methods inherited from class com.pulumi.resources.ResourceOptions

getAliases, getCustomTimeouts, getDependsOn, getId, getIgnoreChanges, getParent, getPluginDownloadURL, getProvider, getReplaceOnChanges, getResourceTransformations, 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 Detail

Empty

public static final CustomResourceOptions Empty

Method Detail

builder

public static CustomResourceOptions.Builder builder()

getDeleteBeforeReplace

public boolean getDeleteBeforeReplace()

When set to "true", indicates that this resource should be deleted before its replacement is created when replacement is necessary.

getAdditionalSecretOutputs

public java.util.List<java.lang.String> getAdditionalSecretOutputs()

The names of outputs for this resource that should be treated as secrets. This augments the list that the resource provider and pulumi engine already determine based on inputs to your resource. It can be used to mark certain outputs as a secrets on a per resource basis.

getImportId

public java.util.Optional<java.lang.String> getImportId()

When provided with a resource ID, import indicates that this resource's provider should import its state from the cloud resource with the given ID.The inputs to the resource's constructor must align with the resource's current state.Once a resource has been imported, the import property must be removed from the resource's options.

copy

public CustomResourceOptions copy()

Specified by:

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

merge

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

Takes two @see CustomResourceOptions values and produces a new @see CustomResourceOptions 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: - If the property is a collection, the final value will be a collection containing the values from each options object. - Simple scalar values from "options2" (i.e. "string", "int", "bool") will replace the values of "options1". - "null" values in "options2" will be ignored.

merge

public static CustomResourceOptions merge(@Nullable
                                          CustomResourceOptions options1,
                                          @Nullable
                                          CustomResourceOptions options2,
                                          @Nullable
                                          Output<java.lang.String> id)