Interface PlanResourcesInput

Input to a PlanResources invocation.

interface PlanResourcesInput {
    action: string;
    actions: string[];
    auxData: DecodedAuxData | undefined;
    principal: Required<Omit<Principal, "attributes">>;
    requestId: string;
    resource: Required<Omit<ResourceQuery, "attributes">>;
}

Properties

action: string

The action for which the plan was made.

Use actions instead.

actions: string[]

The actions for which the plan was made.

Requires the Cerbos policy decision point server to be at least v0.44.

auxData: DecodedAuxData | undefined

Auxiliary data that was used in the plan.

principal: Required<Omit<Principal, "attributes">>

The principal for whom the plan was made.

requestId: string

An identifier for tracing the request.

resource: Required<Omit<ResourceQuery, "attributes">>

Partial details of the resources for which the plan was made.