Version¶

class aws_cdk.aws_lambda.Version(scope, id, *, lambda_, code_sha256=None, description=None, provisioned_concurrent_executions=None, removal_policy=None, max_event_age=None, on_failure=None, on_success=None, retry_attempts=None)¶

Bases: aws_cdk.aws_lambda.QualifiedFunctionBase

A single newly-deployed version of a Lambda function.

This object exists to–at deploy time–query the “then-current” version of the Lambda function that it refers to. This Version object can then be used in Alias to refer to a particular deployment of a Lambda.

This means that for every new update you deploy to your Lambda (using the CDK and Aliases), you must always create a new Version object. In particular, it must have a different name, so that a new resource is created.

If you want to ensure that you’re associating the right version with the right deployment, specify the codeSha256 property while creating the `Version.

__init__(scope, id, *, lambda_, code_sha256=None, description=None, provisioned_concurrent_executions=None, removal_policy=None, max_event_age=None, on_failure=None, on_success=None, retry_attempts=None)¶

Parameters

scope (Construct) –
id (str) –
lambda – Function to get the value of.
code_sha256 (Optional[str]) – SHA256 of the version of the Lambda source code. Specify to validate that you’re deploying the right version. Default: No validation is performed
description (Optional[str]) – Description of the version. Default: Description of the Lambda
provisioned_concurrent_executions (Union[int, float, None]) – Specifies a provisioned concurrency configuration for a function’s version. Default: No provisioned concurrency
removal_policy (Optional[RemovalPolicy]) – Whether to retain old versions of this function when a new version is created. Default: RemovalPolicy.DESTROY
max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours Default: Duration.hours(6)
on_failure (Optional[IDestination]) – The destination for failed invocations. Default: - no destination
on_success (Optional[IDestination]) – The destination for successful invocations. Default: - no destination
retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2 Default: 2

Return type

None

Methods

add_alias(alias_name, *, additional_versions=None, description=None, provisioned_concurrent_executions=None, max_event_age=None, on_failure=None, on_success=None, retry_attempts=None)¶

Defines an alias for this version.

Parameters

alias_name (str) – The name of the alias (e.g. “live”).
additional_versions (Optional[List[VersionWeight]]) – Additional versions with individual weights this alias points to. Individual additional version weights specified here should add up to (less than) one. All remaining weight is routed to the default version. For example, the config is Example:: version: “1” additionalVersions: [{ version: “2”, weight: 0.05 }] Then 5% of traffic will be routed to function version 2, while the remaining 95% of traffic will be routed to function version 1. Default: No additional versions
description (Optional[str]) – Description for the alias. Default: No description
provisioned_concurrent_executions (Union[int, float, None]) – Specifies a provisioned concurrency configuration for a function’s alias. Default: No provisioned concurrency
max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours Default: Duration.hours(6)
on_failure (Optional[IDestination]) – The destination for failed invocations. Default: - no destination
on_success (Optional[IDestination]) – The destination for successful invocations. Default: - no destination
retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2 Default: 2

Return type

Alias

add_event_source(source)¶

Adds an event source to this function.

Event sources are implemented in the @aws-cdk/aws-lambda-event-sources module.

The following example adds an SQS Queue as an event source:

import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';
myFunction.addEventSource(new SqsEventSource(myQueue));

Parameters: source (IEventSource) – The event source to bind to this function.
Return type: None

add_event_source_mapping(id, *, event_source_arn, batch_size=None, bisect_batch_on_error=None, enabled=None, max_batching_window=None, max_record_age=None, on_failure=None, parallelization_factor=None, retry_attempts=None, starting_position=None)¶

Adds an event source that maps to this AWS Lambda function.

Parameters

id (str) –
event_source_arn (str) – The Amazon Resource Name (ARN) of the event source. Any record added to this stream can invoke the Lambda function.
batch_size (Union[int, float, None]) – The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. Valid Range: Minimum value of 1. Maximum value of 10000. Default: - Amazon Kinesis and Amazon DynamoDB is 100 records. Both the default and maximum for Amazon SQS are 10 messages.
bisect_batch_on_error (Optional[bool]) – If the function returns an error, split the batch in two and retry. Default: false
enabled (Optional[bool]) – Set to false to disable the event source upon creation. Default: true
max_batching_window (Optional[Duration]) – The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5) Default: Duration.seconds(0)
max_record_age (Optional[Duration]) – The maximum age of a record that Lambda sends to a function for processing. Valid Range: - Minimum value of 60 seconds - Maximum value of 7 days Default: Duration.days(7)
on_failure (Optional[IEventSourceDlq]) – An Amazon SQS queue or Amazon SNS topic destination for discarded records. Default: discarded records are ignored
parallelization_factor (Union[int, float, None]) – The number of batches to process from each shard concurrently. Valid Range: - Minimum value of 1 - Maximum value of 10 Default: 1
retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Valid Range: - Minimum value of 0 - Maximum value of 10000 Default: 10000
starting_position (Optional[StartingPosition]) – The position in the DynamoDB or Kinesis stream where AWS Lambda should start reading. Default: - Required for Amazon Kinesis and Amazon DynamoDB Streams sources.

Return type

EventSourceMapping

add_permission(id, *, principal, action=None, event_source_token=None, scope=None, source_account=None, source_arn=None)¶

Adds a permission to the Lambda resource policy.

Parameters

id (str) – The id ƒor the permission construct.
principal (IPrincipal) – The entity for which you are granting permission to invoke the Lambda function. This entity can be any valid AWS service principal, such as s3.amazonaws.com or sns.amazonaws.com, or, if you are granting cross-account permission, an AWS account ID. For example, you might want to allow a custom application in another AWS account to push events to Lambda by invoking your function. The principal can be either an AccountPrincipal or a ServicePrincipal.
action (Optional[str]) – The Lambda actions that you want to allow in this statement. For example, you can specify lambda:CreateFunction to specify a certain action, or use a wildcard (lambda:*) to grant permission to all Lambda actions. For a list of actions, see Actions and Condition Context Keys for AWS Lambda in the IAM User Guide. Default: ‘lambda:InvokeFunction’
event_source_token (Optional[str]) – A unique token that must be supplied by the principal invoking the function. Default: The caller would not need to present a token.
scope (Optional[Construct]) – The scope to which the permission constructs be attached. The default is the Lambda function construct itself, but this would need to be different in cases such as cross-stack references where the Permissions would need to sit closer to the consumer of this permission (i.e., the caller). Default: - The instance of lambda.IFunction
source_account (Optional[str]) – The AWS account ID (without hyphens) of the source owner. For example, if you specify an S3 bucket in the SourceArn property, this value is the bucket owner’s account ID. You can use this property to ensure that all source principals are owned by a specific account.
source_arn (Optional[str]) – The ARN of a resource that is invoking your function. When granting Amazon Simple Storage Service (Amazon S3) permission to invoke your function, specify this property with the bucket ARN as its value. This ensures that events generated only from the specified bucket, not just any bucket from any AWS account that creates a mapping to your function, can invoke the function.

see :see: Permission for details.

Return type: None

add_to_role_policy(statement)¶

Adds a statement to the IAM role assumed by the instance.

Parameters

statement (PolicyStatement) –

Return type

None

configure_async_invoke(*, max_event_age=None, on_failure=None, on_success=None, retry_attempts=None)¶

Configures options for asynchronous invocation.

Parameters

max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum: 60 seconds Maximum: 6 hours Default: Duration.hours(6)
on_failure (Optional[IDestination]) – The destination for failed invocations. Default: - no destination
on_success (Optional[IDestination]) – The destination for successful invocations. Default: - no destination
retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum: 0 Maximum: 2 Default: 2

Return type

None

grant_invoke(grantee)¶

Grant the given identity permissions to invoke this Lambda.

Parameters

grantee (IGrantable) –

Return type

Grant

metric(metric_name, *, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

Return the given named metric for this Function.

Parameters

metric_name (str) –
account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Return type

Metric

metric_duration(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

How long execution of this Lambda takes.

Average over 5 minutes

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Return type

Metric

metric_errors(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

How many invocations of this Lambda fail.

Sum over 5 minutes

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Return type

Metric

metric_invocations(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

How often this Lambda is invoked.

Sum over 5 minutes

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Return type

Metric

metric_throttles(*, account=None, color=None, dimensions=None, label=None, period=None, region=None, statistic=None, unit=None)¶

How often this Lambda is throttled.

Sum over 5 minutes

Parameters

account (Optional[str]) – Account which this metric comes from. Default: - Deployment account.
color (Optional[str]) – The hex color code, prefixed with ‘#’ (e.g. ‘#00ff00’), to use when this metric is rendered on a graph. The Color class has a set of standard colors that can be used here. Default: - Automatic color
dimensions (Optional[Mapping[str, Any]]) – Dimensions of the metric. Default: - No dimensions.
label (Optional[str]) – Label for this metric when added to a Graph in a Dashboard. Default: - No label
period (Optional[Duration]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)
region (Optional[str]) – Region which this metric comes from. Default: - Deployment region.
statistic (Optional[str]) – What function to use for aggregating. Can be one of the following: - “Minimum” | “min” - “Maximum” | “max” - “Average” | “avg” - “Sum” | “sum” - “SampleCount | “n” - “pNN.NN” Default: Average
unit (Optional[Unit]) – Unit used to filter the metric stream. Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units. The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases. CloudWatch does not honor this property for graphs. Default: - All metric datums in the given metric stream

Return type

Metric

to_string()¶

Returns a string representation of this construct.

Return type: str

Attributes

connections¶

Access the Connections object.

Will fail if not a VPC-enabled Lambda Function

Return type: Connections

function_arn¶

The ARN fo the function.

Return type: str

function_name¶

The name of the function.

Return type: str

grant_principal¶

The principal this Lambda Function is running as.

Return type: IPrincipal

is_bound_to_vpc¶

Whether or not this Lambda function was bound to a VPC.

If this is is false, trying to access the connections object will fail.

Return type: bool

lambda_¶

The underlying AWS Lambda function.

Return type: IFunction

latest_version¶

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.

Return type: IVersion

node¶

The construct tree node associated with this construct.

Return type: ConstructNode

permissions_node¶

The construct node where permissions are attached.

Return type: ConstructNode

role¶

The IAM role associated with this function.

Undefined if the function was imported without a role.

Return type: Optional[IRole]

stack¶

The stack in which this resource is defined.

Return type: Stack

version¶

The most recently deployed version of this function.

Return type: str

Static Methods

classmethod from_version_arn(scope, id, version_arn)¶

Construct a Version object from a Version ARN.

Parameters

scope (Construct) – The cdk scope creating this resource.
id (str) – The cdk id of this resource.
version_arn (str) – The version ARN to create this version from.

Return type

IVersion

classmethod from_version_attributes(scope, id, *, lambda_, version)¶

Parameters

scope (Construct) –
id (str) –
lambda – The lambda function.
version (str) – The version.

Return type

IVersion

classmethod is_construct(x)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool