class FunctionBase
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Lambda.FunctionBase |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awslambda#FunctionBase |
![]() | software.amazon.awscdk.services.lambda.FunctionBase |
![]() | aws_cdk.aws_lambda.FunctionBase |
![]() | aws-cdk-lib » aws_lambda » FunctionBase |
Implements
IConstruct
, IDependable
, IResource
, IFunction
, IConnectable
, IGrantable
, IClient
Extends
Resource
Implemented by
Alias
, Docker
, Function
, Singleton
, Version
, Nodejs
, Trigger
, Go
, Python
Initializer
new FunctionBase(scope: Construct, id: string, props?: ResourceProps)
Parameters
- scope
Construct
- id
string
- props
Resource
Props
Properties
Name | Type | Description |
---|---|---|
architecture | Architecture | The architecture of this Lambda Function. |
can | boolean | Whether the addPermission() call adds any permissions. |
connections | Connections | Access the Connections object. |
env | Resource | The environment this resource belongs to. |
function | string | The ARN fo the function. |
function | string | The name of the function. |
grant | IPrincipal | The principal this Lambda Function is running as. |
is | boolean | Whether or not this Lambda function was bound to a VPC. |
latest | IVersion | The $LATEST version of this function. |
node | Node | The tree node. |
permissions | Node | The construct node where permissions are attached. |
resource | string[] | The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke(). |
stack | Stack | The stack in which this resource is defined. |
role? | IRole | The IAM role associated with this function. |
architecture
Type:
Architecture
The architecture of this Lambda Function.
canCreatePermissions
Type:
boolean
Whether the addPermission() call adds any permissions.
True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.
connections
Type:
Connections
Access the Connections object.
Will fail if not a VPC-enabled Lambda Function
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
functionArn
Type:
string
The ARN fo the function.
functionName
Type:
string
The name of the function.
grantPrincipal
Type:
IPrincipal
The principal this Lambda Function is running as.
isBoundToVpc
Type:
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.
latestVersion
Type:
IVersion
The $LATEST
version of this function.
Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations.
To obtain a reference to an explicit version which references the current
function configuration, use lambdaFunction.currentVersion
instead.
node
Type:
Node
The tree node.
permissionsNode
Type:
Node
The construct node where permissions are attached.
resourceArnsForGrantInvoke
Type:
string[]
The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke().
stack
Type:
Stack
The stack in which this resource is defined.
role?
Type:
IRole
(optional)
The IAM role associated with this function.
Undefined if the function was imported without a role.
Methods
Name | Description |
---|---|
add | Adds an event source to this function. |
add | Adds an event source that maps to this AWS Lambda function. |
add | Adds a url to this lambda function. |
add | Adds a permission to the Lambda resource policy. |
add | Adds a statement to the IAM role assumed by the instance. |
apply | Apply the given removal policy to this resource. |
configure | Configures options for asynchronous invocation. |
consider | A warning will be added to functions under the following conditions: - permissions that include lambda:InvokeFunction are added to the unqualified function. |
grant | Grant the given identity permissions to invoke this Lambda. |
grant | Grant multiple principals the ability to invoke this Lambda via CompositePrincipal. |
grant | Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda. |
grant | Grant the given identity permissions to invoke this Lambda Function URL. |
grant | Grant the given identity permissions to invoke the given version of this Lambda. |
metric(metricName, props?) | Return the given named metric for this Function. |
metric | How long execution of this Lambda takes. |
metric | How many invocations of this Lambda fail. |
metric | How often this Lambda is invoked. |
metric | How often this Lambda is throttled. |
to | Returns a string representation of this construct. |
protected warn |
addEventSource(source)
public addEventSource(source: IEventSource): void
Parameters
- source
IEvent
Source
Adds an event source to this function.
Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module.
The following example adds an SQS Queue as an event source:
import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources';
myFunction.addEventSource(new SqsEventSource(myQueue));
addEventSourceMapping(id, options)
public addEventSourceMapping(id: string, options: EventSourceMappingOptions): EventSourceMapping
Parameters
- id
string
- options
Event
Source Mapping Options
Returns
Adds an event source that maps to this AWS Lambda function.
addFunctionUrl(options?)
public addFunctionUrl(options?: FunctionUrlOptions): FunctionUrl
Parameters
- options
Function
Url Options
Returns
Adds a url to this lambda function.
addPermission(id, permission)
public addPermission(id: string, permission: Permission): void
Parameters
- id
string
— The id for the permission construct. - permission
Permission
— The permission to grant to this Lambda function.
Adds a permission to the Lambda resource policy.
See also: [Permission for details.](Permission for details.)
addToRolePolicy(statement)
public addToRolePolicy(statement: PolicyStatement): void
Parameters
- statement
Policy
Statement
Adds a statement to the IAM role assumed by the instance.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
configureAsyncInvoke(options)
public configureAsyncInvoke(options: EventInvokeConfigOptions): void
Parameters
- options
Event
Invoke Config Options
Configures options for asynchronous invocation.
considerWarningOnInvokeFunctionPermissions(scope, action)
public considerWarningOnInvokeFunctionPermissions(scope: Construct, action: string): void
Parameters
- scope
Construct
- action
string
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.
grantInvoke(grantee)
public grantInvoke(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permissions to invoke this Lambda.
grantInvokeCompositePrincipal(compositePrincipal)
public grantInvokeCompositePrincipal(compositePrincipal: CompositePrincipal): Grant[]
Parameters
- compositePrincipal
Composite
Principal
Returns
Grant
[]
Grant multiple principals the ability to invoke this Lambda via CompositePrincipal.
grantInvokeLatestVersion(grantee)
public grantInvokeLatestVersion(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda.
grantInvokeUrl(grantee)
public grantInvokeUrl(grantee: IGrantable): Grant
Parameters
- grantee
IGrantable
Returns
Grant the given identity permissions to invoke this Lambda Function URL.
grantInvokeVersion(grantee, version)
public grantInvokeVersion(grantee: IGrantable, version: IVersion): Grant
Parameters
- grantee
IGrantable
- version
IVersion
Returns
Grant the given identity permissions to invoke the given version of this Lambda.
metric(metricName, props?)
public metric(metricName: string, props?: MetricOptions): Metric
Parameters
- metricName
string
- props
Metric
Options
Returns
Return the given named metric for this Function.
metricDuration(props?)
public metricDuration(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
How long execution of this Lambda takes.
Average over 5 minutes
metricErrors(props?)
public metricErrors(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
How many invocations of this Lambda fail.
Sum over 5 minutes
metricInvocations(props?)
public metricInvocations(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
How often this Lambda is invoked.
Sum over 5 minutes
metricThrottles(props?)
public metricThrottles(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
How often this Lambda is throttled.
Sum over 5 minutes
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected warnInvokeFunctionPermissions(scope)
protected warnInvokeFunctionPermissions(scope: Construct): void
Parameters
- scope
Construct