Class LogManager

Provides operations on AWS CloudWatch.

A new instance of this class is injected into CommonConstruct constructor.
If a custom construct extends CommonConstruct, an instance is available within the context.

Example

import { CommonConstruct } from '@gradientedge/cdk-utils'

class CustomConstruct extends CommonConstruct {
  constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
    super(parent, id, props)
    this.props = props
    this.logsManager.createMetricFilter('MyMetricFilter', this, logGroup)
  }
}

See

[CDK CloudWatch Module]https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html

Index

Constructors

constructor

Methods

createCfnLogGroup createLogGroup createMetricFilter

Constructors

constructor

new LogManager(): LogManager
Returns LogManager

Methods

createCfnLogGroup

createCfnLogGroup(
    id: string,
    scope: CommonConstruct,
    props: LogProps,
): CfnLogGroup
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: LogProps
  the log group properties
Returns CfnLogGroup
- Defined in packages/aws/src/services/cloudwatch/logs.ts:64

createLogGroup

createLogGroup(id: string, scope: CommonConstruct, props: LogProps): LogGroup
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: LogProps
  the log group properties
Returns LogGroup
- Defined in packages/aws/src/services/cloudwatch/logs.ts:91

createMetricFilter

createMetricFilter(
    id: string,
    scope: CommonConstruct,
    props: MetricFilterProps,
    logGroup: ILogGroup,
): { metric: Metric; metricFilter: MetricFilter }
Parameters
- id: string
  scoped id of the resource
- scope: CommonConstruct
  scope in which this resource is defined
- props: MetricFilterProps
  the metric filter properties
- logGroup: ILogGroup
  the log group to apply the metric filter to
Returns { metric: Metric; metricFilter: MetricFilter }
- Defined in packages/aws/src/services/cloudwatch/logs.ts:35

Class LogManager

Example

See

Index

Constructors

Methods

Constructors

constructor

Returns LogManager

Methods

createCfnLogGroup

Parameters

Returns CfnLogGroup

createLogGroup

Parameters

Returns LogGroup

createMetricFilter

Parameters

Returns { metric: Metric; metricFilter: MetricFilter }

Settings

On This Page