Package com.pulumi.resources

Class ResourceOptions

java.lang.Object

com.pulumi.resources.ResourceOptions

Direct Known Subclasses:

ComponentResourceOptions, CustomResourceOptions

public abstract class ResourceOptions
extends 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 List<Output<Alias>>	aliases
protected CustomTimeouts	customTimeouts
protected Output<List<Resource>>	dependsOn
protected List<String>	hideDiffs
protected Output<String>	id
protected List<String>	ignoreChanges
protected Resource	parent
protected String	pluginDownloadURL
protected Boolean	protect
protected ProviderResource	provider
protected Output<?>	replacementTrigger
protected List<String>	replaceOnChanges
protected List<Resource>	replaceWith
protected List<ResourceTransformation>	resourceTransformations
protected Boolean	retainOnDelete
protected String	urn
protected String	version

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ResourceOptions()
protected	ResourceOptions(Output<String> id, Resource parent, Output<List<Resource>> dependsOn, Boolean protect, List<String> ignoreChanges, String version, ProviderResource provider, CustomTimeouts customTimeouts, List<ResourceTransformation> resourceTransformations, List<Output<Alias>> aliases, String urn, List<String> replaceOnChanges, Boolean retainOnDelete, String pluginDownloadURL, List<String> hideDiffs, List<Resource> replaceWith, Output<?> replacementTrigger)

Method Summary

Modifier and Type	Method	Description
List<Output<Alias>>	getAliases()
Optional<CustomTimeouts>	getCustomTimeouts()
Output<List<Resource>>	getDependsOn()
List<String>	getHideDiffs()
Optional<Output<String>>	getId()
List<String>	getIgnoreChanges()
Optional<Resource>	getParent()
Optional<String>	getPluginDownloadURL()
Optional<Boolean>	getProtect()
Optional<ProviderResource>	getProvider()
Optional<Output<?>>	getReplacementTrigger()
List<String>	getReplaceOnChanges()
List<Resource>	getReplaceWith()
List<ResourceTransformation>	getResourceTransformations()
Optional<Boolean>	getRetainOnDelete()
Optional<String>	getUrn()
Optional<String>	getVersion()
boolean	isProtect()
boolean	isRetainOnDelete()
protected static <T extends ResourceOptions> T	mergeSharedOptions(T options1, T options2)
protected static <T extends ResourceOptions> T	mergeSharedOptions(T options1, T options2, Output<String> id)

Methods inherited from class java.lang.Object

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

Field Details

id

@Nullable
protected Output<String> id

parent

@Nullable
protected Resource parent

dependsOn

@Nullable
protected Output<List<Resource>> dependsOn

protect

@Nullable
protected Boolean protect

ignoreChanges

@Nullable
protected List<String> ignoreChanges

version

@Nullable
protected String version

provider

@Nullable
protected ProviderResource provider

customTimeouts

@Nullable
protected CustomTimeouts customTimeouts

resourceTransformations

@Nullable
protected List<ResourceTransformation> resourceTransformations

aliases

@Nullable
protected List<Output<Alias>> aliases

urn

@Nullable
protected String urn

replaceOnChanges

@Nullable
protected List<String> replaceOnChanges

retainOnDelete

@Nullable
protected Boolean retainOnDelete

pluginDownloadURL

@Nullable
protected String pluginDownloadURL

hideDiffs

@Nullable
protected List<String> hideDiffs

replaceWith

@Nullable
protected List<Resource> replaceWith

replacementTrigger

@Nullable
protected Output<?> replacementTrigger

Constructor Details

ResourceOptions

protected ResourceOptions()

ResourceOptions

protected ResourceOptions(@Nullable
 Output<String> id,
 @Nullable
 Resource parent,
 @Nullable
 Output<List<Resource>> dependsOn,
 @Nullable
 Boolean protect,
 @Nullable
 List<String> ignoreChanges,
 @Nullable
 String version,
 @Nullable
 ProviderResource provider,
 @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<Resource> replaceWith,
 @Nullable
 Output<?> replacementTrigger)

Method Details

getId

public Optional<Output<String>> getId()

See Also:

• ResourceOptions.Builder.id(String)

getParent

public Optional<Resource> getParent()

See Also:

• ResourceOptions.Builder.parent(Resource)

getDependsOn

public Output<List<Resource>> getDependsOn()

See Also:

• ResourceOptions.Builder.dependsOn(Resource...)

isProtect

public boolean isProtect()

See Also:

• ResourceOptions.Builder.protect(boolean)

getProtect

public Optional<Boolean> getProtect()

See Also:

• ResourceOptions.Builder.protect(Boolean)

getIgnoreChanges

public List<String> getIgnoreChanges()

See Also:

• ResourceOptions.Builder.ignoreChanges(String...)

getVersion

public Optional<String> getVersion()

See Also:

• ResourceOptions.Builder.version(String)

getProvider

public Optional<ProviderResource> getProvider()

See Also:

• ResourceOptions.Builder.provider(ProviderResource)

getCustomTimeouts

public Optional<CustomTimeouts> getCustomTimeouts()

See Also:

• ResourceOptions.Builder.customTimeouts(CustomTimeouts)

getResourceTransformations

public List<ResourceTransformation> getResourceTransformations()

See Also:

• ResourceOptions.Builder.resourceTransformations(ResourceTransformation...)

getAliases

public List<Output<Alias>> getAliases()

See Also:

• ResourceOptions.Builder.aliases(Alias...)

getUrn

public Optional<String> getUrn()

See Also:

• ResourceOptions.Builder.urn(String)

getReplaceOnChanges

public List<String> getReplaceOnChanges()

See Also:

• ResourceOptions.Builder.replaceOnChanges(String...)

isRetainOnDelete

public boolean isRetainOnDelete()

See Also:

• ResourceOptions.Builder.retainOnDelete(boolean)

getRetainOnDelete

public Optional<Boolean> getRetainOnDelete()

See Also:

• ResourceOptions.Builder.retainOnDelete(Boolean)

getPluginDownloadURL

public Optional<String> getPluginDownloadURL()

See Also:

• ResourceOptions.Builder.pluginDownloadURL(String)

getHideDiffs

public List<String> getHideDiffs()

See Also:

• ResourceOptions.Builder.hideDiffs(String...)

getReplaceWith

public List<Resource> getReplaceWith()

See Also:

• ResourceOptions.Builder.replaceWith(Resource...)

getReplacementTrigger

public Optional<Output<?>> getReplacementTrigger()

See Also:

• ResourceOptions.Builder.replacementTrigger(Output)

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<String> id)