Class CustomResourceOptions

CustomResourceOptions is a bag of optional settings that control a CustomResource's behavior.

Inheritance

object

ResourceOptions

CustomResourceOptions

Inherited Members

ResourceOptions.Id

ResourceOptions.Parent

ResourceOptions.DependsOn

ResourceOptions.Protect

ResourceOptions.IgnoreChanges

ResourceOptions.Version

ResourceOptions.Provider

ResourceOptions.CustomTimeouts

ResourceOptions.ResourceTransformations

ResourceOptions.Aliases

ResourceOptions.Urn

ResourceOptions.ReplaceOnChanges

ResourceOptions.PluginDownloadURL

ResourceOptions.RetainOnDelete

ResourceOptions.DeletedWith

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi

Assembly: Pulumi.dll

Syntax

public sealed class CustomResourceOptions : ResourceOptions

Properties

AdditionalSecretOutputs

The names of outputs for this resource that should be treated as secrets. This augments the list that the resource provider and pulumi engine already determine based on inputs to your resource. It can be used to mark certain outputs as a secrets on a per resource basis.

Declaration

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

Property Value

Type	Description
List<string>

DeleteBeforeReplace

When set to true, indicates that this resource should be deleted before its replacement is created when replacement is necessary.

Declaration

public bool? DeleteBeforeReplace { get; set; }

Property Value

Type	Description
bool?

ImportId

When provided with a resource ID, import indicates that this resource's provider should import its state from the cloud resource with the given ID.The inputs to the resource's constructor must align with the resource's current state.Once a resource has been imported, the import property must be removed from the resource's options.

Declaration

public string? ImportId { get; set; }

Property Value

Type	Description
string

Methods

Merge(CustomResourceOptions?, CustomResourceOptions?)

Takes two CustomResourceOptions values and produces a new CustomResourceOptions with the respective properties of options2 merged over the same properties in options1. The original options objects will be unchanged.

A new instance will always be returned.

Conceptually property merging follows these basic rules:

1. If the property is a collection, the final value will be a collection containing the values from each options object.
2. Simple scalar values from options2 (i.e. strings, ints, bools) will replace the values of options1.
3. null values in options2 will be ignored.

Declaration

public static CustomResourceOptions Merge(CustomResourceOptions? options1, CustomResourceOptions? options2)

Parameters

Type	Name	Description
CustomResourceOptions	options1
CustomResourceOptions	options2

Returns

Type	Description
CustomResourceOptions