CustomResourceOptions

class CustomResourceOptions : ConvertibleToJava<CustomResourceOptions>

A bag of optional settings that control a KotlinResource behavior.

Constructors

Link copied to clipboard

Functions

Link copied to clipboard
open override fun toJava(): CustomResourceOptions

Properties

Link copied to clipboard

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.

Link copied to clipboard
val aliases: List<Output<Alias>>?

List of aliases for a resource or component resource. If you're changing the name, type, or parent path of a resource or component resource, you can add the old name to the list of aliases for a resource to ensure that existing resources will be migrated to the new name instead of being deleted and replaced with the new named resource.

Link copied to clipboard

Set of custom timeouts for create, update, and delete operations on a resource. These timeouts are specified using a duration string such as “5m” (5 minutes), “40s” (40 seconds), or “1d” (1 day). Supported duration units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, and “h” (nanoseconds, microseconds, milliseconds, seconds, minutes, and hours, respectively).

Link copied to clipboard

A resource may need to be replaced if an immutable property changes. In these cases, cloud providers do not support updating an existing resource so a new instance will be created and the old one deleted. By default, to minimize downtime, Pulumi creates new instances of resources before deleting old ones.

Link copied to clipboard

The dependsOn resource option creates a list of explicit dependencies between resources.

Link copied to clipboard
val id: Output<String>?

An optional existing ID to load, rather than create.

Link copied to clipboard

The ignoreChanges resource option specifies a list of properties that Pulumi will ignore when it updates existing resources. Any properties specified in this list that are also specified in the resource's arguments will only be used when creating the resource.

Link copied to clipboard

The importId resource option imports an existing cloud resource so that Pulumi can manage it. Imported resources can have been provisioned by any other method, including manually in the cloud console or with the cloud CLI.

Link copied to clipboard

Specifies a parent for a resource. It is used to associate children with the parents that encapsulate or are responsible for them.

Link copied to clipboard

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.

Link copied to clipboard

Marks a resource as protected. A protected resource cannot be deleted directly, and it will be an error to do a Pulumi deployment which tries to delete a protected resource for any reason.

Link copied to clipboard

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.

Link copied to clipboard

Indicates that changes to certain properties on a resource should force a replacement of the resource instead of an in-place update.

Link copied to clipboard

Provides a list of transformations to apply to a resource and all of its children. This option is used to override or modify the inputs to the child resources of a component resource. One example is to use the option to add other resource options (such as ignoreChanges or protect). Another example is to modify an input property (such as adding to tags or changing a property that is not directly configurable).

Link copied to clipboard

Marks a resource to be retained. If this option is set then Pulumi will not call through to the resource provider's Delete method when deleting or replacing the resource during pulumi up or pulumi destroy. As a result, the resource will not be deleted from the backing cloud provider, but will be removed from the Pulumi state.

Link copied to clipboard
val urn: String?

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

Link copied to clipboard

Specifies a provider version to use when operating on a resource. This version overrides the version information inferred from the current package. This option should be used rarely.