Class ResourceOptions

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

Inheritance

object

ResourceOptions

ComponentResourceOptions

CustomResourceOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi

Assembly: Pulumi.dll

Syntax

public abstract class ResourceOptions

Properties

Aliases

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

Declaration

public List<Input<Alias>> Aliases { get; set; }

Property Value

Type	Description
List<Input<Alias>>

CustomTimeouts

An optional CustomTimeouts configuration block.

Declaration

public CustomTimeouts? CustomTimeouts { get; set; }

Property Value

Type	Description
CustomTimeouts

DeletedWith

If set, the providers Delete method will not be called for this resource if specified resource is being deleted as well.

Declaration

public Resource? DeletedWith { get; set; }

Property Value

Type	Description
Resource

DependsOn

Optional additional explicit dependencies on other resources.

Declaration

public InputList<Resource> DependsOn { get; set; }

Property Value

Type	Description
InputList<Resource>

HideDiffs

If set, diffs from the included property paths will not be shown. This only affects the diff display, and does not affect update behavior.

Declaration

public List<string> HideDiffs { get; set; }

Property Value

Type	Description
List<string>

Hooks

Optional resource hooks to bind to this resource. The hooks will be invoked during the lifecycle of the resource.

Declaration

public ResourceHookBinding Hooks { get; set; }

Property Value

Type	Description
ResourceHookBinding

Id

An optional existing ID to load, rather than create.

Declaration

public Input<string>? Id { get; set; }

Property Value

Type	Description
Input<string>

IgnoreChanges

Ignore changes to any of the specified properties.

Declaration

public List<string> IgnoreChanges { get; set; }

Property Value

Type	Description
List<string>

Parent

An optional parent resource to which this resource belongs.

Declaration

public Resource? Parent { get; set; }

Property Value

Type	Description
Resource

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.

Declaration

public string? PluginDownloadURL { get; set; }

Property Value

Type	Description
string

Protect

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

Declaration

public bool? Protect { get; set; }

Property Value

Type	Description
bool?

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 also ComponentResourceOptions.providers).

If this is a ComponentResourceOptions do not provide both Provider and Providers.

Declaration

public ProviderResource? Provider { get; set; }

Property Value

Type	Description
ProviderResource

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.

Declaration

public List<string> ReplaceOnChanges { get; set; }

Property Value

Type	Description
List<string>

ReplaceWith

If set, the resource will be replaced if one of the specified resources is replaced.

Declaration

public InputList<Resource> ReplaceWith { get; set; }

Property Value

Type	Description
InputList<Resource>

ReplacementTrigger

If set, the engine will diff this with the last recorded value, and trigger a replace if they are not equal. Note that if either value is null, no comparison is done and no replacement is triggered. This means that the replacement trigger only applies to two subsequent deployments with defined triggers.

Declaration

public Input<object>? ReplacementTrigger { get; set; }

Property Value

Type	Description
Input<object>

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 parents walking from the resource up to the stack.

Declaration

public List<ResourceTransformation> ResourceTransformations { get; set; }

Property Value

Type	Description
List<ResourceTransformation>

ResourceTransforms

Optional list of transforms to apply to this resource during construction.The transforms are applied in order, and are applied prior to transform applied to parents walking from the resource up to the stack.

Declaration

public List<ResourceTransform> ResourceTransforms { get; set; }

Property Value

Type	Description
List<ResourceTransform>

RetainOnDelete

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

Declaration

public bool? RetainOnDelete { get; set; }

Property Value

Type	Description
bool?

Urn

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

Declaration

public string? Urn { get; set; }

Property Value

Type	Description
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.

Declaration

public string? Version { get; set; }

Property Value

Type	Description
string