Show / Hide Table of Contents

Class ResourceOptions

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

Inheritance
System.Object
ResourceOptions
ComponentResourceOptions
CustomResourceOptions
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi
Assembly: Pulumi.dll
Syntax
public abstract class ResourceOptions

Properties

View Source

Aliases

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

Declaration
public List<Input<Alias>> Aliases { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Input<Alias>>
View Source

CustomTimeouts

An optional CustomTimeouts configuration block.

Declaration
public CustomTimeouts CustomTimeouts { get; set; }
Property Value
Type Description
CustomTimeouts
View Source

DependsOn

Optional additional explicit dependencies on other resources.

Declaration
public InputList<Resource> DependsOn { get; set; }
Property Value
Type Description
InputList<Resource>
View Source

Id

An optional existing ID to load, rather than create.

Declaration
public Input<string> Id { get; set; }
Property Value
Type Description
Input<System.String>
View Source

IgnoreChanges

Ignore changes to any of the specified properties.

Declaration
public List<string> IgnoreChanges { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
View Source

Parent

An optional parent resource to which this resource belongs.

Declaration
public Resource Parent { get; set; }
Property Value
Type Description
Resource
View Source

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
System.String
View Source

Protect

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

Declaration
public bool? Protect { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
View Source

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
View Source

ReplaceOnChanges

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

Declaration
public List<string> ReplaceOnChanges { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
View Source

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
System.Collections.Generic.List<ResourceTransformation>
View Source

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
System.Nullable<System.Boolean>
View Source

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
System.String
View Source

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
System.String
  • View Source
Back to top Copyright 2016-2022, Pulumi Corporation.