Class AWSSNSService

Public Instance Exported.

Hierarchy

AWSSNSService

Implements

CoreSnsService

Index

Constructors

Properties

_arn DEF_SNS_ENDPOINT ENV_SNS_ENDPOINT

Methods

accountID asPayload endpoint hello name publish reportError

Constructors

constructor

new AWSSNSService(arn?: string): AWSSNSService
Parameters
- Optional arn: string
Returns AWSSNSService
- Defined in src/cores/aws/aws-sns-service.ts:50

Properties

`Private` _arn

_arn: string

`Static` DEF_SNS_ENDPOINT

DEF_SNS_ENDPOINT: string = 'lemon-hello-sns'

`Static` ENV_SNS_ENDPOINT

ENV_SNS_ENDPOINT: string = 'MY_SNS_ENDPOINT'

environ name of SNS KEY

for self messaging.

Methods

accountID

accountID(): Promise<string>
get current aws account-id.

refer: https://stackoverflow.com/questions/35563270/finding-my-aws-account-id-using-javascript

Returns Promise<string>
- Defined in src/cores/aws/aws-sns-service.ts:100

asPayload

asPayload(e: any, data: string | object): { error: string; errorss?: any[]; message: string; stack-trace?: any }
convert Error to payload.
Parameters
- e: any
- data: string | object
Returns { error: string; errorss?: any[]; message: string; stack-trace?: any }
- error: string
- Optional errorss?: any[]
- message: string
- Optional stack-trace?: any
- Defined in src/cores/aws/aws-sns-service.ts:195

endpoint

endpoint(target?: string): Promise<string>
get target endpoint by name.
Parameters
- Optional target: string
Returns Promise<string>
- Defined in src/cores/aws/aws-sns-service.ts:67

hello

hello(): string
hello

Returns string
Implementation of CoreSnsService.hello
- Defined in src/cores/aws/aws-sns-service.ts:62

name

name(): string
get name of this

Returns string
- Defined in src/cores/aws/aws-sns-service.ts:57

publish

publish(target: string, subject: string, payload: any): Promise<string>
publish message

Returns
message-id
Parameters
- target: string
- subject: string
- payload: any
Returns Promise<string>
Implementation of CoreSnsService.publish
- Defined in src/cores/aws/aws-sns-service.ts:138

reportError

reportError(e: Error, data: any, target?: string): Promise<string>
report error via SNS with subject 'error'
- default to lemon-hello-sns or using env[REPORT_ERROR_ARN]
Parameters
- e: Error
  
  Error instance
- data: any
  
  simple text message or object to override.
- Optional target: string
  
  (optional) target SNS arn (default is REPORT_ERROR_ARN)
Returns Promise<string>
Implementation of CoreSnsService.reportError
- Defined in src/cores/aws/aws-sns-service.ts:177

Generated using TypeDoc