Sanity Library Reference Docs
    Preparing search index...

    Interface DefineWorkflowsOptions

    interface DefineWorkflowsOptions {
        lifecycle?: WorkflowsResourceLifecycle;
        name?: string;
    }
    Index

    Properties

    Properties

    Blueprint lifecycle policy. Defaults to {deletionPolicy: 'retain'}: destroying its stack detaches the resource without deleting definitions; removing the resource from a deployed blueprint fails. Definitions are retain-only through blueprints — a deletionPolicy that promises deletion (allow, replace) and every unsupported key (including ownershipAction) are rejected here and at the provider boundary. protect is accepted (stricter than retain).

    name?: string

    Blueprint resource name — the identity blueprints matches deploys on. Defaults to workflows-<deployment name> (the deployment's name is unique per config; its tag may repeat, so a tag-derived default could collide). Keep the name stable after deployment: a retained resource cannot be renamed because removing the old name is rejected.