Package com.pulumi.resources

Class ResourceOptions.Builder<T extends ResourceOptions,B extends ResourceOptions.Builder<T,B>>

java.lang.Object

com.pulumi.resources.ResourceOptions.Builder<T,B>

Direct Known Subclasses:

ComponentResourceOptions.Builder, CustomResourceOptions.Builder

Enclosing class:

ResourceOptions

protected abstract static class ResourceOptions.Builder<T extends ResourceOptions,B extends ResourceOptions.Builder<T,B>>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected T	options

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(T options)

Method Summary

Modifier and Type	Method	Description
B	aliases(Alias... aliases)	An optional list of aliases to treat this resource as matching.
B	aliases(Output<Alias>... aliases)
B	aliases(java.util.List<Output<Alias>> aliases)
B	customTimeouts(CustomTimeouts customTimeouts)	An optional CustomTimeouts configuration.
B	dependsOn(Output<java.util.List<Resource>> dependsOn)
B	dependsOn(Resource... dependsOn)	Optional additional explicit dependencies on other resources.
B	dependsOn(java.util.List<Resource> dependsOn)
B	id(Output<java.lang.String> id)
B	id(java.lang.String id)	An optional existing ID to load, rather than create.
B	ignoreChanges(java.lang.String... ignoreChanges)	Ignore changes to any of the specified properties.
B	ignoreChanges(java.util.List<java.lang.String> ignoreChanges)	Ignore changes to any of the specified properties.
B	parent(Resource parent)	An optional parent resource to which this resource belongs.
B	pluginDownloadURL(java.lang.String pluginDownloadURL)	An optional URL, corresponding to the url from which the provider plugin that should be used when operating on this resource is downloaded from.
B	protect(boolean protect)	When set to true, protect ensures this resource cannot be deleted.
B	provider(ProviderResource provider)	An optional provider to use for this resource's CRUD operations.
B	replaceOnChanges(java.lang.String... replaceOnChanges)	Changes to any of these property paths will force a replacement.
B	replaceOnChanges(java.util.List<java.lang.String> replaceOnChanges)
B	resourceTransformations(ResourceTransformation... resourceTransformations)	Optional list of transformations to apply to this resource during construction.
B	resourceTransformations(java.util.List<ResourceTransformation> resourceTransformations)
B	retainOnDelete(boolean retainOnDelete)	If set to True, the providers Delete method will not be called for this resource.
B	urn(java.lang.String urn)	The URN of a previously-registered resource of this type to read from the engine.
B	version(java.lang.String version)	An optional version, corresponding to the version of the provider plugin that should be used when operating on this resource.

Methods inherited from class java.lang.Object

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

Field Detail

options

protected final T extends ResourceOptions options

Constructor Detail

Builder

protected Builder(T options)

Method Detail

id

public B id(@Nullable
            Output<java.lang.String> id)

See Also:

id(String)

id

public B id(@Nullable
            java.lang.String id)

An optional existing ID to load, rather than create.

parent

public B parent(@Nullable
                Resource parent)

An optional parent resource to which this resource belongs.

dependsOn

public B dependsOn(Resource... dependsOn)

Optional additional explicit dependencies on other resources.

dependsOn

public B dependsOn(@Nullable
                   Output<java.util.List<Resource>> dependsOn)

See Also:

dependsOn(Resource...)

dependsOn

public B dependsOn(@Nullable
                   java.util.List<Resource> dependsOn)

See Also:

dependsOn(Resource...)

protect

public B protect(boolean protect)

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

ignoreChanges

public B ignoreChanges(java.lang.String... ignoreChanges)

Ignore changes to any of the specified properties.

ignoreChanges

public B ignoreChanges(@Nullable
                       java.util.List<java.lang.String> ignoreChanges)

Ignore changes to any of the specified properties.

version

public B version(@Nullable
                 java.lang.String version)

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.

provider

public B provider(@Nullable
                  ProviderResource provider)

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(com.pulumi.resources.ProviderResource) and @see ComponentResourceOptions.getProviders().

customTimeouts

public B customTimeouts(@Nullable
                        CustomTimeouts customTimeouts)

An optional CustomTimeouts configuration.

resourceTransformations

public B resourceTransformations(ResourceTransformation... resourceTransformations)

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.

resourceTransformations

public B resourceTransformations(@Nullable
                                 java.util.List<ResourceTransformation> resourceTransformations)

See Also:

resourceTransformations(ResourceTransformation...)

aliases

public B aliases(Alias... aliases)

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

aliases

@SafeVarargs
public final B aliases(Output<Alias>... aliases)

See Also:

aliases(Alias...)

aliases

public B aliases(@Nullable
                 java.util.List<Output<Alias>> aliases)

See Also:

aliases(Alias...)

urn

public B urn(@Nullable
             java.lang.String urn)

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

replaceOnChanges

public B replaceOnChanges(java.lang.String... replaceOnChanges)

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.

replaceOnChanges

public B replaceOnChanges(@Nullable
                          java.util.List<java.lang.String> replaceOnChanges)

See Also:

replaceOnChanges(String...)

retainOnDelete

public B retainOnDelete(boolean retainOnDelete)

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

pluginDownloadURL

public B pluginDownloadURL(@Nullable
                           java.lang.String pluginDownloadURL)

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.