Skip to content

Latest commit

 

History

History
278 lines (167 loc) · 10.9 KB

API.md

File metadata and controls

278 lines (167 loc) · 10.9 KB
Raw

API Reference

Constructs

ServiceQuotasMetricPublisher

A construct that creates an AWS Lambda function to publish applied service quotas metrics to CloudWatch.

Initializers 

import { ServiceQuotasMetricPublisher } from '@time-loop/cdk-service-quotas-metric-publisher'

new ServiceQuotasMetricPublisher(scope: Construct, id: Namer, props: ServiceQuotasMetricPublisherProps)
Name Type Description
scope constructs.Construct The parent construct.
id multi-convention-namer.Namer The ID of the construct.
props ServiceQuotasMetricPublisherProps The properties of the construct.
scopeRequired
  • Type: constructs.Construct

The parent construct.

idRequired
  • Type: multi-convention-namer.Namer

The ID of the construct.

propsRequired

The properties of the construct.

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 { ServiceQuotasMetricPublisher } from '@time-loop/cdk-service-quotas-metric-publisher'

ServiceQuotasMetricPublisher.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
cwNamespace string No description.
handler aws-cdk-lib.aws_lambda_nodejs.NodejsFunction No description.
publishFrequency number No description.
rule aws-cdk-lib.aws_events.Rule No description.
serviceQuotas IServiceQuota[] No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cwNamespaceRequired 
public readonly cwNamespace: string;
  • Type: string
handlerRequired 
public readonly handler: NodejsFunction;
  • Type: aws-cdk-lib.aws_lambda_nodejs.NodejsFunction
publishFrequencyRequired 
public readonly publishFrequency: number;
  • Type: number
ruleRequired 
public readonly rule: Rule;
  • Type: aws-cdk-lib.aws_events.Rule
serviceQuotasRequired 
public readonly serviceQuotas: IServiceQuota[];

Structs

ServiceQuotasMetricPublisherProps

Initializer 

import { ServiceQuotasMetricPublisherProps } from '@time-loop/cdk-service-quotas-metric-publisher'

const serviceQuotasMetricPublisherProps: ServiceQuotasMetricPublisherProps = { ... }

Properties

Name Type Description
cloudwatchLogsRetention aws-cdk-lib.aws_logs.RetentionDays How long to retain logs published to CloudWatch logs.
cwNamespace string The CloudWatch namespace to publish metrics to.
publishFrequency number Time intervals that Lambda will be triggered to publish metric in CloudWatch.
serviceQuotas IServiceQuota[] The list of service quotas to monitor.
cloudwatchLogsRetentionOptional 
public readonly cloudwatchLogsRetention: RetentionDays;
  • Type: aws-cdk-lib.aws_logs.RetentionDays
  • Default: aws_logs.RetentionDays.THREE_MONTHS

How long to retain logs published to CloudWatch logs.

cwNamespaceOptional 
public readonly cwNamespace: string;
  • Type: string
  • Default: 'AWS/ServiceQuotaLimit'

The CloudWatch namespace to publish metrics to.

publishFrequencyOptional 
public readonly publishFrequency: number;
  • Type: number
  • Default: 1440 (1 day)

Time intervals that Lambda will be triggered to publish metric in CloudWatch.

serviceQuotasOptional 
public readonly serviceQuotas: IServiceQuota[];

The list of service quotas to monitor.

Protocols

IServiceQuota

Properties

Name Type Description
quotaCode string No description.
serviceCode string No description.
quotaCodeRequired 
public readonly quotaCode: string;
  • Type: string
serviceCodeRequired 
public readonly serviceCode: string;
  • Type: string