Skip to main content

CloudWatchLoggerParameters

@webda/aws


Class: CloudWatchLoggerParameters

Defined in: aws/src/services/cloudwatchlogger.service.ts:11

Send webda log to CloudWatch

Extends​

  • ServiceParameters

Implements​

Constructors​

Constructor​

new CloudWatchLoggerParameters(): CloudWatchLoggerParameters

Returns​

CloudWatchLoggerParameters

Inherited from​

ServiceParameters.constructor

Properties​

CloudFormation?​

optional CloudFormation?: any

Defined in: aws/src/services/cloudwatchlogger.service.ts:54

CloudFormation customization


CloudFormationSkip?​

optional CloudFormationSkip?: boolean

Defined in: aws/src/services/cloudwatchlogger.service.ts:58

Skip CloudFormation on deploy


credentials?​

optional credentials?: object

Defined in: aws/src/services/cloudwatchlogger.service.ts:19

Static credentials, default to the AWS environment variables

accessKeyId​

accessKeyId: string

secretAccessKey​

secretAccessKey: string

sessionToken?​

optional sessionToken?: string

Implementation of​

AWSServiceParameters.credentials


endpoint?​

optional endpoint?: string

Defined in: aws/src/services/cloudwatchlogger.service.ts:15

Custom endpoint (localstack, minio, ...)

Implementation of​

AWSServiceParameters.endpoint


kmsKeyId?​

optional kmsKeyId?: string

Defined in: aws/src/services/cloudwatchlogger.service.ts:37

KMS key to use when creating the log group


logGroupName​

logGroupName: string

Defined in: aws/src/services/cloudwatchlogger.service.ts:29

logGroupName to send logStream to


logLevel?​

optional logLevel?: WorkerLogLevel

Defined in: aws/src/services/cloudwatchlogger.service.ts:46

Minimum level of logs to send

Default​

"INFO"

logStreamNamePrefix?​

optional logStreamNamePrefix?: string

Defined in: aws/src/services/cloudwatchlogger.service.ts:33

Prefix of the log stream name, a random uuid is appended


region?​

optional region?: string

Defined in: aws/src/services/cloudwatchlogger.service.ts:24

AWS region

Default​

"us-east-1"

Implementation of​

AWSServiceParameters.region


singlePush?​

optional singlePush?: boolean

Defined in: aws/src/services/cloudwatchlogger.service.ts:50

Send each log line as soon as it is produced


tags?​

optional tags?: any

Defined in: aws/src/services/cloudwatchlogger.service.ts:41

Tags to add when creating the log group


type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: aws/src/services/cloudwatchlogger.service.ts:65

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load


update()​

update(params, delta): this

Defined in: core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update


with()​

with(callback): this

Defined in: core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with