Package com.pulumi.resources

Class ResourceOptions

java.lang.Object

com.pulumi.resources.ResourceOptions

Direct Known Subclasses:

ComponentResourceOptions, CustomResourceOptions

public abstract class ResourceOptions
extends java.lang.Object

ResourceOptions is a bag of optional settings that control a resource's behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ResourceOptions.Builder<T extends ResourceOptions,B extends ResourceOptions.Builder<T,B>>

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<Output<Alias>>	aliases
protected CustomTimeouts	customTimeouts
protected Output<java.util.List<Resource>>	dependsOn
protected Output<java.lang.String>	id
protected java.util.List<java.lang.String>	ignoreChanges
protected Resource	parent
protected java.lang.String	pluginDownloadURL
protected boolean	protect
protected ProviderResource	provider
protected java.util.List<java.lang.String>	replaceOnChanges
protected java.util.List<ResourceTransformation>	resourceTransformations
protected boolean	retainOnDelete
protected java.lang.String	urn
protected java.lang.String	version

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResourceOptions()
protected	ResourceOptions(Output<java.lang.String> id, Resource parent, Output<java.util.List<Resource>> dependsOn, boolean protect, java.util.List<java.lang.String> ignoreChanges, java.lang.String version, ProviderResource provider, CustomTimeouts customTimeouts, java.util.List<ResourceTransformation> resourceTransformations, java.util.List<Output<Alias>> aliases, java.lang.String urn, java.util.List<java.lang.String> replaceOnChanges, boolean retainOnDelete, java.lang.String pluginDownloadURL)

Method Summary

Modifier and Type	Method	Description
java.util.List<Output<Alias>>	getAliases()	An optional list of aliases to treat this resource as matching.
java.util.Optional<CustomTimeouts>	getCustomTimeouts()	An optional CustomTimeouts configuration.
Output<java.util.List<Resource>>	getDependsOn()	Optional additional explicit dependencies on other resources.
java.util.Optional<Output<java.lang.String>>	getId()	An optional existing ID to load, rather than create.
java.util.List<java.lang.String>	getIgnoreChanges()	Ignore changes to any of the specified properties.
java.util.Optional<Resource>	getParent()	An optional parent resource to which this resource belongs.
java.util.Optional<java.lang.String>	getPluginDownloadURL()	An optional URL, corresponding to the url from which the provider plugin that should be used when operating on this resource is downloaded from.
java.util.Optional<ProviderResource>	getProvider()	An optional provider to use for this resource's CRUD operations.
java.util.List<java.lang.String>	getReplaceOnChanges()	Changes to any of these property paths will force a replacement.
java.util.List<ResourceTransformation>	getResourceTransformations()	Optional list of transformations to apply to this resource during construction.
java.util.Optional<java.lang.String>	getUrn()	The URN of a previously-registered resource of this type to read from the engine.
java.util.Optional<java.lang.String>	getVersion()	An optional version, corresponding to the version of the provider plugin that should be used when operating on this resource.
boolean	isProtect()	When set to true, protect ensures this resource cannot be deleted.
boolean	isRetainOnDelete()	If set to True, the providers Delete method will not be called for this resource.
protected static <T extends ResourceOptions> T	mergeSharedOptions(T options1, T options2)
protected static <T extends ResourceOptions> T	mergeSharedOptions(T options1, T options2, Output<java.lang.String> id)

Methods inherited from class java.lang.Object

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

Field Detail

id

@Nullable
protected Output<java.lang.String> id

parent

@Nullable
protected Resource parent

dependsOn

@Nullable
protected Output<java.util.List<Resource>> dependsOn

protect

protected boolean protect

ignoreChanges

@Nullable
protected java.util.List<java.lang.String> ignoreChanges

version

@Nullable
protected java.lang.String version

provider

@Nullable
protected ProviderResource provider

customTimeouts

@Nullable
protected CustomTimeouts customTimeouts

resourceTransformations

@Nullable
protected java.util.List<ResourceTransformation> resourceTransformations

aliases

@Nullable
protected java.util.List<Output<Alias>> aliases

urn

@Nullable
protected java.lang.String urn

replaceOnChanges

@Nullable
protected java.util.List<java.lang.String> replaceOnChanges

retainOnDelete

protected boolean retainOnDelete

pluginDownloadURL

@Nullable
protected java.lang.String pluginDownloadURL

Constructor Detail

ResourceOptions

protected ResourceOptions()

ResourceOptions

protected ResourceOptions(@Nullable
                          Output<java.lang.String> id,
                          @Nullable
                          Resource parent,
                          @Nullable
                          Output<java.util.List<Resource>> dependsOn,
                          boolean protect,
                          @Nullable
                          java.util.List<java.lang.String> ignoreChanges,
                          @Nullable
                          java.lang.String version,
                          @Nullable
                          ProviderResource provider,
                          @Nullable
                          CustomTimeouts customTimeouts,
                          @Nullable
                          java.util.List<ResourceTransformation> resourceTransformations,
                          @Nullable
                          java.util.List<Output<Alias>> aliases,
                          @Nullable
                          java.lang.String urn,
                          @Nullable
                          java.util.List<java.lang.String> replaceOnChanges,
                          boolean retainOnDelete,
                          @Nullable
                          java.lang.String pluginDownloadURL)

Method Detail

getId

public java.util.Optional<Output<java.lang.String>> getId()

An optional existing ID to load, rather than create.

getParent

public java.util.Optional<Resource> getParent()

An optional parent resource to which this resource belongs.

getDependsOn

public Output<java.util.List<Resource>> getDependsOn()

Optional additional explicit dependencies on other resources.

isProtect

public boolean isProtect()

When set to true, protect ensures this resource cannot be deleted.

getIgnoreChanges

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

Ignore changes to any of the specified properties.

getVersion

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

An optional version, corresponding to the version of the provider plugin that should be used when operating on this resource. This version overrides the version information inferred from the current package and should rarely be used.

getProvider

public java.util.Optional<ProviderResource> getProvider()

An optional provider to use for this resource's CRUD operations. If no provider is supplied, the default provider for the resource's package will be used. The default provider is pulled from the parent's provider bag (@see ComponentResourceOptions.getProviders()).

If this is a @see ComponentResourceOptions do not provide both @see provider and @see ComponentResourceOptions.getProviders().

getCustomTimeouts

public java.util.Optional<CustomTimeouts> getCustomTimeouts()

An optional CustomTimeouts configuration.

getResourceTransformations

public java.util.List<ResourceTransformation> getResourceTransformations()

Optional list of transformations to apply to this resource during construction. The transformations are applied in order, and are applied prior to transformation applied to parent walking from the resource up to the stack.

getAliases

public java.util.List<Output<Alias>> getAliases()

An optional list of aliases to treat this resource as matching.

getUrn

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

The URN of a previously-registered resource of this type to read from the engine.

getReplaceOnChanges

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

Changes to any of these property paths will force a replacement. If this list includes `"*"`, changes to any properties will force a replacement. Initialization errors from previous deployments will require replacement instead of update only if `"*"` is passed.

isRetainOnDelete

public boolean isRetainOnDelete()

If set to True, the providers Delete method will not be called for this resource.

getPluginDownloadURL

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

An optional URL, corresponding to the url from which the provider plugin that should be used when operating on this resource is downloaded from. This URL overrides the download URL inferred from the current package and should rarely be used.

mergeSharedOptions

@InternalUse
protected static <T extends ResourceOptions> T mergeSharedOptions(T options1,
                                                                  T options2)

mergeSharedOptions

@InternalUse
protected static <T extends ResourceOptions> T mergeSharedOptions(T options1,
                                                                  T options2,
                                                                  @Nullable
                                                                  Output<java.lang.String> id)