Class CustomResourceAbstract

CustomResource is a resource whose create, read, update, and delete (CRUD) operations are managed by performing external operations on some physical entity. The engine understands how to diff and perform partial updates of them, and these CRUD operations are implemented in a dynamically loaded plugin for the defining package.

Hierarchy (view full)





  • Creates and registers a new managed resource. t is the fully qualified type token and name is the "name" part to use in creating a stable and globally unique URN for the object. dependsOn is an optional list of other resources that this resource depends on, controlling the order in which we perform resource operations. Creating an instance does not necessarily perform a create on the physical entity which it represents, and instead, this is dependent upon the diffing of the new goal state compared to the current known resource state.


    • t: string

      The type of the resource.

    • name: string

      The unique name of the resource.

    • Optional props: Inputs

      The arguments to use to populate the new resource.

    • opts: CustomResourceOptions = {}

      A bag of options that control this resource's behavior.

    • dependency: boolean = false

      True if this is a synthetic resource used internally for dependency tracking.

    Returns CustomResource


id: Output<string>

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

urn: Output<string>

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.


Generated using TypeDoc