Class ResourceHandler<TProps, TState, TSdk>`Abstract`

Type Parameters

TProps
TState
TSdk

Index

Constructors

Methods

assertExists buildCrn create delete get update waitUntilStabilized

Constructors

constructor

new ResourceHandler<TProps, TState, TSdk>(): ResourceHandler<
    TProps,
    TState,
    TSdk,
>
Type Parameters
- TProps
- TState
- TSdk
Returns ResourceHandler<TProps, TState, TSdk>

Methods

`Protected`assertExists

assertExists<T>(value: T | null | undefined, msg?: string): T
Type Parameters
- T
Parameters
- value: T | null | undefined
- Optionalmsg: string
Returns T
- Defined in packages/core/src/lib/runtime/resource-handler.ts:64

`Abstract`buildCrn

buildCrn(props: TProps, state: TState): string
Build the CRN (Cloud Resource Name) for this resource. Called by the RuntimeAdapter after create() to include the CRN in CreateResult.
Parameters
- props: TProps
  The resource properties (includes typeName for parsing)
- state: TState
  The resource state returned by create() (includes resourceId)
Returns string
The CRN string in format: crn:cdkx::[:][:]:/
- Defined in packages/core/src/lib/runtime/resource-handler.ts:26

`Abstract`create

create(ctx: RuntimeContext<TSdk>, props: TProps): Promise<TState>
Parameters
- ctx: RuntimeContext<TSdk>
- props: TProps
Returns Promise<TState>
- Defined in packages/core/src/lib/runtime/resource-handler.ts:9

`Abstract`delete

delete(ctx: RuntimeContext<TSdk>, state: TState): Promise<void>
Parameters
- ctx: RuntimeContext<TSdk>
- state: TState
Returns Promise<void>
- Defined in packages/core/src/lib/runtime/resource-handler.ts:15

`Abstract`get

get(ctx: RuntimeContext<TSdk>, props: TProps): Promise<TState>
Parameters
- ctx: RuntimeContext<TSdk>
- props: TProps
Returns Promise<TState>
- Defined in packages/core/src/lib/runtime/resource-handler.ts:16

`Abstract`update

update(ctx: RuntimeContext<TSdk>, props: TProps, state: TState): Promise<TState>
Parameters
- ctx: RuntimeContext<TSdk>
- props: TProps
- state: TState
Returns Promise<TState>
- Defined in packages/core/src/lib/runtime/resource-handler.ts:10

`Protected`waitUntilStabilized

waitUntilStabilized(
check: () => Promise<StabilizeStatus>,
config: StabilizeConfig,
): Promise<void>
Poll check until the resource reaches a stable, usable state.

Returns immediately when check returns { status: 'ready' }. Throws the supplied reason when check returns { status: 'failed' }. Throws StabilizationTimeoutError when config.timeoutMs elapses before a ready response is received.

Calls check at approximately config.intervalMs intervals.
Parameters
- check: () => Promise<StabilizeStatus>
- config: StabilizeConfig
Returns Promise<void>
- Defined in packages/core/src/lib/runtime/resource-handler.ts:38