Skip to content

Latest commit

 

History

History
256 lines (152 loc) · 9.01 KB

API.md

File metadata and controls

256 lines (152 loc) · 9.01 KB

API Reference

Constructs

SlackEventBus

Initializers 

import { SlackEventBus } from '@wisegpt/awscdk-slack-event-bus'

new SlackEventBus(scope: Construct, id: string, props: SlackEventBusProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props SlackEventBusProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

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

Returns a string representation of this construct.

slackEventsRequestUrl 
public slackEventsRequestUrl(appId?: string): string
appIdOptional
  • Type: string

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { SlackEventBus } from '@wisegpt/awscdk-slack-event-bus'

SlackEventBus.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
eventBus aws-cdk-lib.aws_events.EventBus No description.
slackHandlerLambdaAlias aws-cdk-lib.aws_lambda.IFunction No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

eventBusRequired 
public readonly eventBus: EventBus;
  • Type: aws-cdk-lib.aws_events.EventBus
slackHandlerLambdaAliasRequired 
public readonly slackHandlerLambdaAlias: IFunction;
  • Type: aws-cdk-lib.aws_lambda.IFunction

Structs

SlackEventBusProps

Initializer 

import { SlackEventBusProps } from '@wisegpt/awscdk-slack-event-bus'

const slackEventBusProps: SlackEventBusProps = { ... }

Properties

Name Type Description
secret aws-cdk-lib.aws_secretsmanager.ISecret secret is a reference to the Secret parameter that stores the signing-secret and also if oAuth enabled;
eventBusName string eventBusName optional name to override the event bus name.
httpApi @aws-cdk/aws-apigatewayv2-alpha.HttpApi httpApi optional HTTP API to use, instead of Construct creating a new one.
singleApp SlackEventBusSingleAppProps singleApp optionally configure to use a single application with fixed app id and path to use.
secretRequired 
public readonly secret: ISecret;
  • Type: aws-cdk-lib.aws_secretsmanager.ISecret

secret is a reference to the Secret parameter that stores the signing-secret and also if oAuth enabled;

client id / client secret for each individual appId

eventBusNameOptional 
public readonly eventBusName: string;
  • Type: string

eventBusName optional name to override the event bus name.

httpApiOptional 
public readonly httpApi: HttpApi;
  • Type: @aws-cdk/aws-apigatewayv2-alpha.HttpApi

httpApi optional HTTP API to use, instead of Construct creating a new one.

singleAppOptional 
public readonly singleApp: SlackEventBusSingleAppProps;

singleApp optionally configure to use a single application with fixed app id and path to use.

SlackEventBusSingleAppProps

Initializer 

import { SlackEventBusSingleAppProps } from '@wisegpt/awscdk-slack-event-bus'

const slackEventBusSingleAppProps: SlackEventBusSingleAppProps = { ... }

Properties

Name Type Description
appId string appId to use for all request validating.
eventsApiPath string eventsApiPath which would be used for the events path.
appIdRequired 
public readonly appId: string;
  • Type: string

appId to use for all request validating.

eventsApiPathRequired 
public readonly eventsApiPath: string;
  • Type: string

eventsApiPath which would be used for the events path.