Interface StepEventStateMetadata

StepEventStateMetadata is the more detailed state information for a resource as it relates to a step(s) being performed.

interface StepEventStateMetadata {
    custom?: boolean;
    delete?: boolean;
    id: string;
    initErrors?: string[];
    inputs: Record<string, any>;
    outputs: Record<string, any>;
    parent: string;
    protect?: boolean;
    provider: string;
    retainOnDelete?: boolean;
    type: string;
    urn: string;
}

Properties

custom? delete? id initErrors? inputs outputs parent protect? provider retainOnDelete? type urn

Properties

Optional custom

custom?: boolean

Custom indicates if the resource is managed by a plugin.

Optional delete

delete?: boolean

Delete is true when the resource is pending deletion due to a replacement.

id

id: string

ID is the resource's unique ID, assigned by the resource provider (or blank if none/uncreated).

Optional initErrors

initErrors?: string[]

InitErrors is the set of errors encountered in the process of initializing resource.

inputs

inputs: Record<string, any>

Inputs contains the resource's input properties (as specified by the program). Secrets have filtered out, and large assets have been replaced by hashes as applicable.

outputs

outputs: Record<string, any>

Outputs contains the resource's complete output state (as returned by the resource provider).

parent

parent: string

Parent is an optional parent URN that this resource belongs to.

Optional protect

protect?: boolean

Protect is true to "protect" this resource (protected resources cannot be deleted).

provider

provider: string

Provider is the resource's provider reference

Optional retainOnDelete

retainOnDelete?: boolean

RetainOnDelete is true if the resource is not physically deleted when it is logically deleted.

type

type: string

The type of the resource being operated on.

urn

urn: string

The URN of the resource being operated on.

Settings

Member Visibility

Theme

On This Page

customdeleteidinitErrorsinputsoutputsparentprotectproviderretainOnDeletetypeurn

Generated using TypeDoc