1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. Resource

Resource

    Resource is the shape of a Pulumi-managed resource as exposed from the Pulumi Service. This type wraps pulumi/pulumi’s pkg/apitype ResourceV1 and ResourceV2 types, which are sent from the CLI to the Service as part of performing updates. Those types wrap pulumi/pulumi’s pkg/resource State type, which is the engine-internal representation.

    Properties

    • id string optional
      ID is the provider-assigned resource ID, if any, for custom resources.
    • type string required
      Type is the resource’s full type token.
    • urn string required
      URN uniquely identifying this resource within a stack. (But not globally across all stacks.)
    • custom boolean required
      Custom is true when the resource is managed by a plugin.
    • delete boolean required
      Delete is true when the resource should be deleted during the next update.
    • dependencies array[string] required
      Dependencies contains the URN dependency edges to other resources that this depends on.
    • parent string optional
      Parent is an optional parent URN if this resource is a child of it.
    • protect boolean optional
      Protect is set to true when this resource is “protected” and may not be deleted.
    • external boolean optional
      External is set to true when the lifecycle of this resource is not managed by Pulumi.
    • retainOnDelete boolean optional
      If set to True, the providers Delete method will not be called for this resource. Pulumi simply stops tracking the deleted resource.
    • additionalSecretOutputs array[string] optional
      AdditionalSecretOutputs is a list of outputs that were explicitly marked as secret when the resource was created.
    • aliases array[string] optional
      Aliases is a list of previous URNs that this resource may have had in previous deployments.
    • deletedWith string optional
      If set, the providers Delete method will not be called for this resource if specified resource is being deleted as well.
    • initErrors array[string] optional
      InitErrors is the set of errors encountered in the process of initializing resource (i.e., during create or update).
    • inputs map[string]object optional
      Inputs are the input properties supplied to the provider.
    • outputs map[string]object optional
      Outputs are the output properties returned by the provider after provisioning.
    • providerInputs map[string]object optional
      The inputs to the provider which created this resource. This can be used when generating console links (e.g. the value of aws:region will be in this property bag with the key “region” and the value of whatever region was set on the provider that created this resource).