Skip to content

Latest commit

 

History

History
197 lines (115 loc) · 5.7 KB

API.md

File metadata and controls

197 lines (115 loc) · 5.7 KB
Raw

API Reference

Constructs

EventNotify

Event Notfiy Construct Class.

Initializers 

import { EventNotify } from 'cdk-events-notify'

new EventNotify(scope: Construct, id: string, props?: EventNotifyProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props EventNotifyProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsOptional

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { EventNotify } from 'cdk-events-notify'

EventNotify.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Structs

EventNotifyProps

event notify interface.

Initializer 

import { EventNotifyProps } from 'cdk-events-notify'

const eventNotifyProps: EventNotifyProps = { ... }

Properties

Name Type Description
lineNotifyToken string Line Notify Token for Lambda send notify permission.
slack ISlackEventNotify Notify target to Slack channel.
lineNotifyTokenOptional 
public readonly lineNotifyToken: string;
  • Type: string
  • Default: none

Line Notify Token for Lambda send notify permission.

slackOptional 
public readonly slack: ISlackEventNotify;

Notify target to Slack channel.

Protocols

ISlackEventNotify

slack event notify interface.

Properties

Name Type Description
slackChannelName string slack Channel Name for Lambda send message to slack.
slackWebhookUrl string slack Webhook Url for Lambda send message to slack.
slackChannelNameRequired 
public readonly slackChannelName: string;
  • Type: string

slack Channel Name for Lambda send message to slack.

slackWebhookUrlRequired 
public readonly slackWebhookUrl: string;
  • Type: string

slack Webhook Url for Lambda send message to slack.