@makerx/cloudwatch-error-alarms / CloudWatchErrorAlarmLambda
Hierarchy
-
Function
↳
CloudWatchErrorAlarmLambda
Table of contents
Constructors
Properties
- _connections
- _functionUrlInvocationGrants
- _invocationGrants
- _layers
- _skipPermissions
- _warnIfCurrentVersionCalled
- architecture
- canCreatePermissions
- deadLetterQueue
- deadLetterTopic
- env
- functionArn
- functionName
- grantPrincipal
- node
- permissionsNode
- physicalName
- role
- runtime
- stack
- timeout
- _VER_PROPS
Accessors
Methods
- _checkEdgeCompatibility
- _enableCrossEnvironment
- _functionNode
- _isStackAccount
- addAlias
- addEnvironment
- addEventSource
- addEventSourceMapping
- addFunctionUrl
- addLayers
- addPermission
- addToRolePolicy
- applyRemovalPolicy
- configureAsyncInvoke
- considerWarningOnInvokeFunctionPermissions
- generatePhysicalName
- getResourceArnAttribute
- getResourceNameAttribute
- grantInvoke
- grantInvokeUrl
- metric
- metricDuration
- metricErrors
- metricInvocations
- metricThrottles
- toString
- warnInvokeFunctionPermissions
- classifyVersionProperty
- fromFunctionArn
- fromFunctionAttributes
- fromFunctionName
- isConstruct
- isOwnedResource
- isResource
- metricAll
- metricAllConcurrentExecutions
- metricAllDuration
- metricAllErrors
- metricAllInvocations
- metricAllThrottles
- metricAllUnreservedConcurrentExecutions
Constructors
constructor
• new CloudWatchErrorAlarmLambda(scope
, id
, props
)
Parameters
| Name | Type |
| :------ | :------ |
| scope
| Construct
|
| id
| string
|
| props
| CloudWatchErrorAlarmLambdaProps
|
Overrides
Function.constructor
Defined in
Properties
_connections
• Protected
Optional
_connections: Connections
Actual connections object for this Lambda
May be unset, in which case this Lambda is not configured use in a VPC.
Inherited from
Function._connections
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:235
_functionUrlInvocationGrants
• Protected
_functionUrlInvocationGrants: Record
<string
, Grant
>
Mapping of fucntion URL invocation principals to grants. Used to de-dupe grantInvokeUrl()
calls.
Inherited from
Function._functionUrlInvocationGrants
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:251
_invocationGrants
• Protected
_invocationGrants: Record
<string
, Grant
>
Mapping of invocation principals to grants. Used to de-dupe grantInvoke()
calls.
Inherited from
Function._invocationGrants
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:246
_layers
• Readonly
_layers: ILayerVersion
[]
Inherited from
Function._layers
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:450
_skipPermissions
• Protected
Optional
Readonly
_skipPermissions: boolean
Whether the user decides to skip adding permissions. The only use case is for cross-account, imported lambdas where the user commits to modifying the permisssions on the imported lambda outside CDK.
Inherited from
Function._skipPermissions
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:228
_warnIfCurrentVersionCalled
• Protected
_warnIfCurrentVersionCalled: boolean
Flag to delay adding a warning message until current version is invoked.
Inherited from
Function._warnIfCurrentVersionCalled
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:241
architecture
• Readonly
architecture: Architecture
The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).
Inherited from
Function.architecture
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:442
canCreatePermissions
• Protected
Readonly
canCreatePermissions: true
Inherited from
Function.canCreatePermissions
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:448
deadLetterQueue
• Optional
Readonly
deadLetterQueue: IQueue
The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).
Inherited from
Function.deadLetterQueue
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:434
deadLetterTopic
• Optional
Readonly
deadLetterTopic: ITopic
The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).
Inherited from
Function.deadLetterTopic
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:438
env
• Readonly
env: ResourceEnvironment
Inherited from
Function.env
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:111
functionArn
• Readonly
functionArn: string
ARN of this function
Inherited from
Function.functionArn
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:418
functionName
• Readonly
functionName: string
Name of this function
Inherited from
Function.functionName
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:414
grantPrincipal
• Readonly
grantPrincipal: IPrincipal
The principal this Lambda Function is running as
Inherited from
Function.grantPrincipal
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:430
node
• Readonly
node: Node
The tree node.
Inherited from
Function.node
Defined in
node_modules/constructs/lib/construct.d.ts:247
permissionsNode
• Readonly
permissionsNode: Node
Inherited from
Function.permissionsNode
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:447
physicalName
• Protected
Readonly
physicalName: string
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
- a concrete value (e.g.
"my-awesome-bucket"
) undefined
, when a name should be generated by CloudFormation- a concrete name generated automatically during synthesis, in cross-environment scenarios.
Inherited from
Function.physicalName
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:123
role
• Optional
Readonly
role: IRole
Execution role associated with this function
Inherited from
Function.role
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:422
runtime
• Readonly
runtime: Runtime
The runtime configured for this lambda.
Inherited from
Function.runtime
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:426
stack
• Readonly
stack: Stack
Inherited from
Function.stack
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:110
timeout
• Optional
Readonly
timeout: Duration
The timeout configured for this lambda.
Inherited from
Function.timeout
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:446
_VER_PROPS
▪ Static
_VER_PROPS: Object
Index signature
▪ [key: string
]: boolean
Inherited from
Function._VER_PROPS
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:343
Accessors
connections
• get
connections(): Connections
Access the Connections object
Will fail if not a VPC-enabled Lambda Function
Returns
Connections
Inherited from
Function.connections
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:277
currentVersion
• get
currentVersion(): Version
Returns a lambda.Version
which represents the current version of this
Lambda function. A new version will be created every time the function's
configuration changes.
You can specify options for this version using the currentVersionOptions
prop when initializing the lambda.Function
.
Returns
Version
Inherited from
Function.currentVersion
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:340
isBoundToVpc
• get
isBoundToVpc(): boolean
Whether or not this Lambda function was bound to a VPC
If this is is false
, trying to access the connections
object will fail.
Returns
boolean
Inherited from
Function.isBoundToVpc
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:284
latestVersion
• get
latestVersion(): IVersion
Returns
IVersion
Inherited from
Function.latestVersion
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:278
logGroup
• get
logGroup(): ILogGroup
The LogGroup where the Lambda function's logs are made available.
If either logRetention
is set or this property is called, a CloudFormation custom resource is added to the stack that
pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention
period (never expire, by default).
Further, if the log group already exists and the logRetention
is not set, the custom resource will reset the log retention
to never expire even if it was configured with a different value.
Returns
ILogGroup
Inherited from
Function.logGroup
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:509
resourceArnsForGrantInvoke
• get
resourceArnsForGrantInvoke(): string
[]
Returns
string
[]
Inherited from
Function.resourceArnsForGrantInvoke
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:341
Methods
_checkEdgeCompatibility
▸ _checkEdgeCompatibility(): void
Returns
void
Inherited from
Function._checkEdgeCompatibility
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:511
_enableCrossEnvironment
▸ _enableCrossEnvironment(): void
Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through it's absolute name/arn.
Returns
void
Inherited from
Function._enableCrossEnvironment
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:135
_functionNode
▸ Protected
_functionNode(): Node
Returns the construct tree node that corresponds to the lambda function. For use internally for constructs, when the tree is set up in non-standard ways. Ex: SingletonFunction.
Returns
Node
Inherited from
Function._functionNode
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:302
_isStackAccount
▸ Protected
_isStackAccount(): boolean
Given the function arn, check if the account id matches this account
Function ARNs look like this:
arn:aws:lambda:region:account-id:function:function-name
..which means that in order to extract the account-id
component from the ARN, we can
split the ARN using ":" and select the component in index 4.
Returns
boolean
true if account id of function matches the account specified on the stack, false otherwise.
Inherited from
Function._isStackAccount
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:317
addAlias
▸ addAlias(aliasName
, options?
): Alias
Defines an alias for this function.
The alias will automatically be updated to point to the latest version of the function as it is being updated during a deployment.
declare const fn: lambda.Function; fn.addAlias('Live'); // Is equivalent to new lambda.Alias(this, 'AliasLive', { aliasName: 'Live', version: fn.currentVersion, });
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| aliasName
| string
| The name of the alias |
| options?
| AliasOptions
| Alias options |
Returns
Alias
Inherited from
Function.addAlias
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:498
addEnvironment
▸ addEnvironment(key
, value
, options?
): CloudWatchErrorAlarmLambda
Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op.
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| key
| string
| The environment variable key. |
| value
| string
| The environment variable's value. |
| options?
| EnvironmentOptions
| Environment variable options. |
Returns
Inherited from
Function.addEnvironment
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:467
addEventSource
▸ addEventSource(source
): void
Parameters
| Name | Type |
| :------ | :------ |
| source
| IEventSource
|
Returns
void
Inherited from
Function.addEventSource
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:294
addEventSourceMapping
▸ addEventSourceMapping(id
, options
): EventSourceMapping
Parameters
| Name | Type |
| :------ | :------ |
| id
| string
|
| options
| EventSourceMappingOptions
|
Returns
EventSourceMapping
Inherited from
Function.addEventSourceMapping
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:285
addFunctionUrl
▸ addFunctionUrl(options?
): FunctionUrl
Parameters
| Name | Type |
| :------ | :------ |
| options?
| FunctionUrlOptions
|
Returns
FunctionUrl
Inherited from
Function.addFunctionUrl
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:296
addLayers
▸ addLayers(...layers
): void
Adds one or more Lambda Layers to this Lambda function.
Throws
if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| ...layers
| ILayerVersion
[] | the layers to be added. |
Returns
void
Inherited from
Function.addLayers
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:475
addPermission
▸ addPermission(id
, permission
): void
Adds a permission to the Lambda resource policy.
See
Permission for details.
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| id
| string
| The id for the permission construct |
| permission
| Permission
| The permission to grant to this Lambda function. |
Returns
void
Inherited from
Function.addPermission
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:267
addToRolePolicy
▸ addToRolePolicy(statement
): void
Adds a statement to the IAM role assumed by the instance.
Parameters
| Name | Type |
| :------ | :------ |
| statement
| PolicyStatement
|
Returns
void
Inherited from
Function.addToRolePolicy
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:271
applyRemovalPolicy
▸ applyRemovalPolicy(policy
): void
Apply the given removal policy to this resource
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
Parameters
| Name | Type |
| :------ | :------ |
| policy
| RemovalPolicy
|
Returns
void
Inherited from
Function.applyRemovalPolicy
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:147
configureAsyncInvoke
▸ configureAsyncInvoke(options
): void
Parameters
| Name | Type |
| :------ | :------ |
| options
| EventInvokeConfigOptions
|
Returns
void
Inherited from
Function.configureAsyncInvoke
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:295
considerWarningOnInvokeFunctionPermissions
▸ considerWarningOnInvokeFunctionPermissions(scope
, action
): void
A warning will be added to functions under the following conditions:
- permissions that include
lambda:InvokeFunction
are added to the unqualified function. - function.currentVersion is invoked before or after the permission is created.
This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase.
Parameters
| Name | Type |
| :------ | :------ |
| scope
| Construct
|
| action
| string
|
Returns
void
Inherited from
Function.considerWarningOnInvokeFunctionPermissions
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:260
generatePhysicalName
▸ Protected
generatePhysicalName(): string
Returns
string
Inherited from
Function.generatePhysicalName
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:148
getResourceArnAttribute
▸ Protected
getResourceArnAttribute(arnAttr
, arnComponents
): string
Returns an environment-sensitive token that should be used for the
resource's "ARN" attribute (e.g. bucket.bucketArn
).
Normally, this token will resolve to arnAttr
, but if the resource is
referenced across environments, arnComponents
will be used to synthesize
a concrete ARN with the resource's physical name. Make sure to reference
this.physicalName
in arnComponents
.
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| arnAttr
| string
| The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn
), but sometimes it's the CFN resource's ref
. |
| arnComponents
| ArnComponents
| The format of the ARN of this resource. You must reference this.physicalName
somewhere within the ARN in order for cross-environment references to work. |
Returns
string
Inherited from
Function.getResourceArnAttribute
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:178
getResourceNameAttribute
▸ Protected
getResourceNameAttribute(nameAttr
): string
Returns an environment-sensitive token that should be used for the
resource's "name" attribute (e.g. bucket.bucketName
).
Normally, this token will resolve to nameAttr
, but if the resource is
referenced across environments, it will be resolved to this.physicalName
,
which will be a concrete name.
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| nameAttr
| string
| The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref
. |
Returns
string
Inherited from
Function.getResourceNameAttribute
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:160
grantInvoke
▸ grantInvoke(grantee
): Grant
Grant the given identity permissions to invoke this Lambda
Parameters
| Name | Type |
| :------ | :------ |
| grantee
| IGrantable
|
Returns
Grant
Inherited from
Function.grantInvoke
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:289
grantInvokeUrl
▸ grantInvokeUrl(grantee
): Grant
Grant the given identity permissions to invoke this Lambda Function URL
Parameters
| Name | Type |
| :------ | :------ |
| grantee
| IGrantable
|
Returns
Grant
Inherited from
Function.grantInvokeUrl
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:293
metric
▸ metric(metricName
, props?
): Metric
Return the given named metric for this Function
Parameters
| Name | Type |
| :------ | :------ |
| metricName
| string
|
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metric
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/lambda-augmentations.generated.d.ts:37
metricDuration
▸ metricDuration(props?
): Metric
How long execution of this Lambda takes
Average over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricDuration
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/lambda-augmentations.generated.d.ts:61
metricErrors
▸ metricErrors(props?
): Metric
How many invocations of this Lambda fail
Sum over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricErrors
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/lambda-augmentations.generated.d.ts:55
metricInvocations
▸ metricInvocations(props?
): Metric
How often this Lambda is invoked
Sum over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricInvocations
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/lambda-augmentations.generated.d.ts:49
metricThrottles
▸ metricThrottles(props?
): Metric
How often this Lambda is throttled
Sum over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricThrottles
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/lambda-augmentations.generated.d.ts:43
toString
▸ toString(): string
Returns a string representation of this construct.
Returns
string
Inherited from
Function.toString
Defined in
node_modules/constructs/lib/construct.d.ts:260
warnInvokeFunctionPermissions
▸ Protected
warnInvokeFunctionPermissions(scope
): void
Parameters
| Name | Type |
| :------ | :------ |
| scope
| Construct
|
Returns
void
Inherited from
Function.warnInvokeFunctionPermissions
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function-base.d.ts:261
classifyVersionProperty
▸ Static
classifyVersionProperty(propertyName
, locked
): void
Record whether specific properties in the AWS::Lambda::Function
resource should
also be associated to the Version resource.
See 'currentVersion' section in the module README for more details.
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| propertyName
| string
| The property to classify |
| locked
| boolean
| whether the property should be associated to the version or not. |
Returns
void
Inherited from
Function.classifyVersionProperty
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:353
fromFunctionArn
▸ Static
fromFunctionArn(scope
, id
, functionArn
): IFunction
Import a lambda function into the CDK using its ARN
Parameters
| Name | Type |
| :------ | :------ |
| scope
| Construct
|
| id
| string
|
| functionArn
| string
|
Returns
IFunction
Inherited from
Function.fromFunctionArn
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:361
fromFunctionAttributes
▸ Static
fromFunctionAttributes(scope
, id
, attrs
): IFunction
Creates a Lambda function object which represents a function not defined within this stack.
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| scope
| Construct
| The parent construct |
| id
| string
| The name of the lambda construct |
| attrs
| FunctionAttributes
| the attributes of the function to import |
Returns
IFunction
Inherited from
Function.fromFunctionAttributes
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:370
fromFunctionName
▸ Static
fromFunctionName(scope
, id
, functionName
): IFunction
Import a lambda function into the CDK using its name
Parameters
| Name | Type |
| :------ | :------ |
| scope
| Construct
|
| id
| string
|
| functionName
| string
|
Returns
IFunction
Inherited from
Function.fromFunctionName
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:357
isConstruct
▸ Static
isConstruct(x
): x is Construct
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| x
| any
| Any object |
Returns
x is Construct
true if x
is an object created from a class which extends Construct
.
Inherited from
Function.isConstruct
Defined in
node_modules/constructs/lib/construct.d.ts:243
isOwnedResource
▸ Static
isOwnedResource(construct
): boolean
Returns true if the construct was created by CDK, and false otherwise
Parameters
| Name | Type |
| :------ | :------ |
| construct
| IConstruct
|
Returns
boolean
Inherited from
Function.isOwnedResource
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:109
isResource
▸ Static
isResource(construct
): construct is Resource
Check whether the given construct is a Resource
Parameters
| Name | Type |
| :------ | :------ |
| construct
| IConstruct
|
Returns
construct is Resource
Inherited from
Function.isResource
Defined in
node_modules/aws-cdk-lib/core/lib/resource.d.ts:105
metricAll
▸ Static
metricAll(metricName
, props?
): Metric
Return the given named metric for this Lambda
Parameters
| Name | Type |
| :------ | :------ |
| metricName
| string
|
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricAll
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:374
metricAllConcurrentExecutions
▸ Static
metricAllConcurrentExecutions(props?
): Metric
Metric for the number of concurrent executions across all Lambdas
Default
max over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricAllConcurrentExecutions
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:404
metricAllDuration
▸ Static
metricAllDuration(props?
): Metric
Metric for the Duration executing all Lambdas
Default
average over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricAllDuration
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:386
metricAllErrors
▸ Static
metricAllErrors(props?
): Metric
Metric for the number of Errors executing all Lambdas
Default
sum over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricAllErrors
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:380
metricAllInvocations
▸ Static
metricAllInvocations(props?
): Metric
Metric for the number of invocations of all Lambdas
Default
sum over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricAllInvocations
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:392
metricAllThrottles
▸ Static
metricAllThrottles(props?
): Metric
Metric for the number of throttled invocations of all Lambdas
Default
sum over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricAllThrottles
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:398
metricAllUnreservedConcurrentExecutions
▸ Static
metricAllUnreservedConcurrentExecutions(props?
): Metric
Metric for the number of unreserved concurrent executions across all Lambdas
Default
max over 5 minutes
Parameters
| Name | Type |
| :------ | :------ |
| props?
| MetricOptions
|
Returns
Metric
Inherited from
Function.metricAllUnreservedConcurrentExecutions
Defined in
node_modules/aws-cdk-lib/aws-lambda/lib/function.d.ts:410