Interface Provider

Provider represents an object that implements the resources and functions for a particular Pulumi package.

interface Provider {
    call?: ((token, inputs) => Promise<InvokeResult>);
    check?: ((urn, olds, news) => Promise<provider.CheckResult>);
    construct?: ((name, type, inputs, options) => Promise<ConstructResult>);
    create?: ((urn, inputs) => Promise<provider.CreateResult>);
    delete?: ((id, urn, props) => Promise<void>);
    diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>);
    invoke?: ((token, inputs) => Promise<InvokeResult>);
    read?: ((id, urn, props?) => Promise<provider.ReadResult>);
    schema?: string;
    update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>);
    version: string;
}

Properties

call? check? construct? create? delete? diff? invoke? read? schema? update? version

Properties

Optional call

call?: ((token, inputs) => Promise<InvokeResult>)

Call calls the indicated method.

Type declaration

    • (token, inputs): Promise<InvokeResult>

    • Parameters

      • token: string

        The token of the method to call.

      • inputs: Inputs

        The inputs to the method.

      Returns Promise<InvokeResult>

Optional check

check?: ((urn, olds, news) => Promise<provider.CheckResult>)

Check validates that the given property bag is valid for a resource of the given type.

Type declaration

    • (urn, olds, news): Promise<provider.CheckResult>

    • Parameters

      • urn: string
      • olds: any

        The old input properties to use for validation.

      • news: any

        The new input properties to use for validation.

      Returns Promise<provider.CheckResult>

Optional construct

construct?: ((name, type, inputs, options) => Promise<ConstructResult>)

Construct creates a new component resource.

Type declaration

Optional create

create?: ((urn, inputs) => Promise<provider.CreateResult>)

Create allocates a new instance of the provided resource and returns its unique ID afterwards. If this call fails, the resource must not have been created (i.e., it is "transactional").

Type declaration

Optional delete

delete?: ((id, urn, props) => Promise<void>)

Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

Type declaration

    • (id, urn, props): Promise<void>

    • Parameters

      • id: string

        The ID of the resource to delete.

      • urn: string
      • props: any

        The current properties on the resource.

      Returns Promise<void>

Optional diff

diff?: ((id, urn, olds, news) => Promise<provider.DiffResult>)

Diff checks what impacts a hypothetical update will have on the resource's properties.

Type declaration

    • (id, urn, olds, news): Promise<provider.DiffResult>

    • Parameters

      • id: string

        The ID of the resource to diff.

      • urn: string
      • olds: any

        The old values of properties to diff.

      • news: any

        The new values of properties to diff.

      Returns Promise<provider.DiffResult>

Optional invoke

invoke?: ((token, inputs) => Promise<InvokeResult>)

Invoke calls the indicated function.

Type declaration

    • (token, inputs): Promise<InvokeResult>

    • Parameters

      • token: string

        The token of the function to call.

      • inputs: any

        The inputs to the function.

      Returns Promise<InvokeResult>

Optional read

read?: ((id, urn, props?) => Promise<provider.ReadResult>)

Reads the current live state associated with a resource. Enough state must be included in the inputs to uniquely identify the resource; this is typically just the resource ID, but it may also include some properties.

Type declaration

Optional schema

schema?: string

The JSON-encoded schema for this provider's package.

Optional update

update?: ((id, urn, olds, news) => Promise<provider.UpdateResult>)

Update updates an existing resource with new values.

Type declaration

    • (id, urn, olds, news): Promise<provider.UpdateResult>

    • Parameters

      • id: string

        The ID of the resource to update.

      • urn: string
      • olds: any

        The old values of properties to update.

      • news: any

        The new values of properties to update.

      Returns Promise<provider.UpdateResult>

version

version: string

The version of the provider. Must be valid semver.

Settings

Member Visibility

Theme

On This Page

callcheckconstructcreatedeletediffinvokereadschemaupdateversion

Generated using TypeDoc