Interface CustomResourceEventHandlerProps<TOptions, TData>

interface CustomResourceEventHandlerProps<
    TOptions,
    TData extends Record<string, any> = never,
> {
    noEcho?: boolean;
    onCreateEvent: (
        event: CloudFormationCustomResourceCreateEventTyped<TOptions>,
    ) => Promise<EventResult<TData>>;
    onDeleteEvent?: (
        event: CloudFormationCustomResourceDeleteEventTyped<TOptions>,
    ) => Promise<void>;
    onUpdateEvent: (
        event: CloudFormationCustomResourceUpdateEventTyped<TOptions>,
    ) => Promise<EventResult<TData>>;
}

Type Parameters

TOptions
TData extends Record<string, any> = never

Index

Properties

noEcho? onCreateEvent onDeleteEvent? onUpdateEvent

Properties

`Optional`noEcho

noEcho?: boolean

Disable echoing CustomResource return values at CloudFormation level to protect secrets from being accidentally exposed

onCreateEvent

onCreateEvent: (
event: CloudFormationCustomResourceCreateEventTyped<TOptions>,
) => Promise<EventResult<TData>>

CustomResource Create event handler

Type Declaration

- (
  event: CloudFormationCustomResourceCreateEventTyped<TOptions>,
  ): Promise<EventResult<TData>>
- Parameters
  - event: CloudFormationCustomResourceCreateEventTyped<TOptions>
    CloudFormation Create event
  Returns Promise<EventResult<TData>>

`Optional`onDeleteEvent

onDeleteEvent?: (
event: CloudFormationCustomResourceDeleteEventTyped<TOptions>,
) => Promise<void>

CustomResource Delete event handler. Defaults to a no-op if omitted.

Type Declaration

- (event: CloudFormationCustomResourceDeleteEventTyped<TOptions>): Promise<void>
- Parameters
  - event: CloudFormationCustomResourceDeleteEventTyped<TOptions>
    CloudFormation Delete event
  Returns Promise<void>

onUpdateEvent

onUpdateEvent: (
event: CloudFormationCustomResourceUpdateEventTyped<TOptions>,
) => Promise<EventResult<TData>>

CustomResource Update event handler

Type Declaration

- (
  event: CloudFormationCustomResourceUpdateEventTyped<TOptions>,
  ): Promise<EventResult<TData>>
- Parameters
  - event: CloudFormationCustomResourceUpdateEventTyped<TOptions>
    CloudFormation Update event
  Returns Promise<EventResult<TData>>