@aws-cdk/aws-lambda

  • Version 1.174.0
  • Published
  • 3.21 MB
  • 20 dependencies
  • Apache-2.0 license

Install

npm i @aws-cdk/aws-lambda
yarn add @aws-cdk/aws-lambda
pnpm add @aws-cdk/aws-lambda

Overview

The CDK Construct Library for AWS::Lambda

Index

Functions

Classes

Interfaces

Enums

Namespaces

Functions

function extractQualifierFromArn

extractQualifierFromArn: (arn: string) => string;
  • Given an opaque (token) ARN, returns a CloudFormation expression that extracts the qualifier (= version or alias) from the ARN.

    Version ARNs look like this:

    arn:aws:lambda:region:account-id:function:function-name:qualifier

    ..which means that in order to extract the qualifier component from the ARN, we can split the ARN using ":" and select the component in index 7.

    Returns

    FnSelect(7, FnSplit(':', arn))

function verifyCodeConfig

verifyCodeConfig: (code: CodeConfig, props: FunctionProps) => void;

    Classes

    class Alias

    class Alias extends QualifiedFunctionBase implements IAlias {}
    • A new alias to a particular version of a Lambda function.

    constructor

    constructor(scope: Construct, id: string, props: AliasProps);

      property aliasName

      readonly aliasName: string;
      • Name of this alias.

      property architecture

      readonly architecture: Architecture;

        property canCreatePermissions

        protected readonly canCreatePermissions: boolean;

          property functionArn

          readonly functionArn: string;
          • ARN of this alias

            Used to be able to use Alias in place of a regular Lambda. Lambda accepts ARNs everywhere it accepts function names.

          property functionName

          readonly functionName: string;
          • ARN of this alias

            Used to be able to use Alias in place of a regular Lambda. Lambda accepts ARNs everywhere it accepts function names.

          property grantPrincipal

          readonly grantPrincipal: iam.IPrincipal;

            property lambda

            readonly lambda: IFunction;

              property qualifier

              protected readonly qualifier: string;

                property role

                readonly role: any;

                  property version

                  readonly version: IVersion;

                    method addAutoScaling

                    addAutoScaling: (options: AutoScalingOptions) => IScalableFunctionAttribute;
                    • Configure provisioned concurrency autoscaling on a function alias. Returns a scalable attribute that can call scaleOnUtilization() and scaleOnSchedule().

                      Parameter options

                      Autoscaling options

                    method fromAliasAttributes

                    static fromAliasAttributes: (
                    scope: Construct,
                    id: string,
                    attrs: AliasAttributes
                    ) => IAlias;

                      method metric

                      metric: (
                      metricName: string,
                      props?: cloudwatch.MetricOptions
                      ) => cloudwatch.Metric;

                        class Architecture

                        class Architecture {}
                        • Architectures supported by AWS Lambda

                        property ARM_64

                        static readonly ARM_64: Architecture;
                        • 64 bit architecture with the ARM instruction set.

                        property dockerPlatform

                        readonly dockerPlatform: string;
                        • The platform to use for this architecture when building with Docker.

                        property name

                        readonly name: string;
                        • The name of the architecture as recognized by the AWS Lambda service APIs.

                        property X86_64

                        static readonly X86_64: Architecture;
                        • 64 bit architecture with x86 instruction set.

                        method custom

                        static custom: (name: string, dockerPlatform?: string) => Architecture;
                        • Used to specify a custom architecture name. Use this if the architecture name is not yet supported by the CDK.

                          Parameter name

                          the architecture name as recognized by AWS Lambda.

                          Parameter dockerPlatform

                          the platform to use for this architecture when building with Docker

                        class AssetCode

                        class AssetCode extends Code {}
                        • Lambda code from a local directory.

                        constructor

                        constructor(path: string, options?: s3_assets.AssetOptions);
                        • Parameter path

                          The path to the asset file or directory.

                        property isInline

                        readonly isInline: boolean;

                          property path

                          readonly path: string;

                            method bind

                            bind: (scope: Construct) => CodeConfig;

                              method bindToResource

                              bindToResource: (
                              resource: cdk.CfnResource,
                              options?: ResourceBindOptions
                              ) => void;

                                class AssetImageCode

                                class AssetImageCode extends Code {}
                                • Represents an ECR image that will be constructed from the specified asset and can be bound as Lambda code.

                                constructor

                                constructor(directory: string, props: AssetImageCodeProps);

                                  property isInline

                                  readonly isInline: boolean;

                                    method bind

                                    bind: (scope: Construct) => CodeConfig;

                                      method bindToResource

                                      bindToResource: (
                                      resource: cdk.CfnResource,
                                      options?: ResourceBindOptions
                                      ) => void;

                                        class CfnAlias

                                        class CfnAlias extends cdk.CfnResource implements cdk.IInspectable {}
                                        • A CloudFormation AWS::Lambda::Alias

                                          The AWS::Lambda::Alias resource creates an [alias](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

                                          You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

                                          AWS::Lambda::Alias external

                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html

                                        constructor

                                        constructor(scope: cdk.Construct, id: string, props: CfnAliasProps);
                                        • Create a new AWS::Lambda::Alias.

                                          Parameter scope

                                          scope in which this resource is defined

                                          Parameter id

                                          scoped id of the resource

                                          Parameter props

                                          resource properties

                                        property CFN_RESOURCE_TYPE_NAME

                                        static readonly CFN_RESOURCE_TYPE_NAME: string;
                                        • The CloudFormation resource type name for this resource class.

                                        property cfnProperties

                                        readonly cfnProperties: { [key: string]: any };

                                          property description

                                          description: string;
                                          • A description of the alias.

                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description

                                          property functionName

                                          functionName: string;
                                          • The name of the Lambda function.

                                            **Name formats** - *Function name* - MyFunction . - *Function ARN* - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . - *Partial ARN* - 123456789012:function:MyFunction .

                                            The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname

                                          property functionVersion

                                          functionVersion: string;
                                          • The function version that the alias invokes.

                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion

                                          property name

                                          name: string;
                                          • The name of the alias.

                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name

                                          property provisionedConcurrencyConfig

                                          provisionedConcurrencyConfig: any;
                                          • Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.

                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig

                                          property routingConfig

                                          routingConfig: any;
                                          • The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.

                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig

                                          method inspect

                                          inspect: (inspector: cdk.TreeInspector) => void;
                                          • Examines the CloudFormation resource and discloses attributes.

                                            Parameter inspector

                                            tree inspector to collect and process attributes

                                          method renderProperties

                                          protected renderProperties: (props: { [key: string]: any }) => {
                                          [key: string]: any;
                                          };

                                            class CfnCodeSigningConfig

                                            class CfnCodeSigningConfig extends cdk.CfnResource implements cdk.IInspectable {}
                                            • A CloudFormation AWS::Lambda::CodeSigningConfig

                                              Details about a [Code signing configuration](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) .

                                              AWS::Lambda::CodeSigningConfig external

                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html

                                            constructor

                                            constructor(scope: cdk.Construct, id: string, props: CfnCodeSigningConfigProps);
                                            • Create a new AWS::Lambda::CodeSigningConfig.

                                              Parameter scope

                                              scope in which this resource is defined

                                              Parameter id

                                              scoped id of the resource

                                              Parameter props

                                              resource properties

                                            property allowedPublishers

                                            allowedPublishers: any;
                                            • List of allowed publishers.

                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-allowedpublishers

                                            property attrCodeSigningConfigArn

                                            readonly attrCodeSigningConfigArn: string;
                                            • The Amazon Resource Name (ARN) of the code signing configuration. CodeSigningConfigArn

                                            property attrCodeSigningConfigId

                                            readonly attrCodeSigningConfigId: string;
                                            • The code signing configuration ID. CodeSigningConfigId

                                            property CFN_RESOURCE_TYPE_NAME

                                            static readonly CFN_RESOURCE_TYPE_NAME: string;
                                            • The CloudFormation resource type name for this resource class.

                                            property cfnProperties

                                            readonly cfnProperties: { [key: string]: any };

                                              property codeSigningPolicies

                                              codeSigningPolicies: any;
                                              • The code signing policy controls the validation failure action for signature mismatch or expiry.

                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-codesigningpolicies

                                              property description

                                              description: string;
                                              • Code signing configuration description.

                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-description

                                              method inspect

                                              inspect: (inspector: cdk.TreeInspector) => void;
                                              • Examines the CloudFormation resource and discloses attributes.

                                                Parameter inspector

                                                tree inspector to collect and process attributes

                                              method renderProperties

                                              protected renderProperties: (props: { [key: string]: any }) => {
                                              [key: string]: any;
                                              };

                                                class CfnEventInvokeConfig

                                                class CfnEventInvokeConfig extends cdk.CfnResource implements cdk.IInspectable {}
                                                • A CloudFormation AWS::Lambda::EventInvokeConfig

                                                  The AWS::Lambda::EventInvokeConfig resource configures options for [asynchronous invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) on a version or an alias.

                                                  By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it.

                                                  AWS::Lambda::EventInvokeConfig external

                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html

                                                constructor

                                                constructor(scope: cdk.Construct, id: string, props: CfnEventInvokeConfigProps);
                                                • Create a new AWS::Lambda::EventInvokeConfig.

                                                  Parameter scope

                                                  scope in which this resource is defined

                                                  Parameter id

                                                  scoped id of the resource

                                                  Parameter props

                                                  resource properties

                                                property CFN_RESOURCE_TYPE_NAME

                                                static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                • The CloudFormation resource type name for this resource class.

                                                property cfnProperties

                                                readonly cfnProperties: { [key: string]: any };

                                                  property destinationConfig

                                                  destinationConfig: any;
                                                  • A destination for events after they have been sent to a function for processing.

                                                    **Destinations** - *Function* - The Amazon Resource Name (ARN) of a Lambda function. - *Queue* - The ARN of an SQS queue. - *Topic* - The ARN of an SNS topic. - *Event Bus* - The ARN of an Amazon EventBridge event bus.

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig

                                                  property functionName

                                                  functionName: string;
                                                  • The name of the Lambda function.

                                                    *Minimum* : 1

                                                    *Maximum* : 64

                                                    *Pattern* : ([a-zA-Z0-9-_]+)

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname

                                                  property maximumEventAgeInSeconds

                                                  maximumEventAgeInSeconds: number;
                                                  • The maximum age of a request that Lambda sends to a function for processing.

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds

                                                  property maximumRetryAttempts

                                                  maximumRetryAttempts: number;
                                                  • The maximum number of times to retry when the function returns an error.

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts

                                                  property qualifier

                                                  qualifier: string;
                                                  • The identifier of a version or alias.

                                                    - *Version* - A version number. - *Alias* - An alias name. - *Latest* - To specify the unpublished version, use $LATEST .

                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier

                                                  method inspect

                                                  inspect: (inspector: cdk.TreeInspector) => void;
                                                  • Examines the CloudFormation resource and discloses attributes.

                                                    Parameter inspector

                                                    tree inspector to collect and process attributes

                                                  method renderProperties

                                                  protected renderProperties: (props: { [key: string]: any }) => {
                                                  [key: string]: any;
                                                  };

                                                    class CfnEventSourceMapping

                                                    class CfnEventSourceMapping extends cdk.CfnResource implements cdk.IInspectable {}
                                                    • A CloudFormation AWS::Lambda::EventSourceMapping

                                                      The AWS::Lambda::EventSourceMapping resource creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.

                                                      For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

                                                      - [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) - [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) - [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) - [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) - [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) - [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)

                                                      AWS::Lambda::EventSourceMapping external

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                    constructor

                                                    constructor(scope: cdk.Construct, id: string, props: CfnEventSourceMappingProps);
                                                    • Create a new AWS::Lambda::EventSourceMapping.

                                                      Parameter scope

                                                      scope in which this resource is defined

                                                      Parameter id

                                                      scoped id of the resource

                                                      Parameter props

                                                      resource properties

                                                    property amazonManagedKafkaEventSourceConfig

                                                    amazonManagedKafkaEventSourceConfig: any;
                                                    • AWS::Lambda::EventSourceMapping.AmazonManagedKafkaEventSourceConfig

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig

                                                    property attrId

                                                    readonly attrId: string;
                                                    • The event source mapping's ID. Id

                                                    property batchSize

                                                    batchSize: number;
                                                    • The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

                                                      - *Amazon Kinesis* - Default 100. Max 10,000. - *Amazon DynamoDB Streams* - Default 100. Max 10,000. - *Amazon Simple Queue Service* - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. - *Amazon Managed Streaming for Apache Kafka* - Default 100. Max 10,000. - *Self-Managed Apache Kafka* - Default 100. Max 10,000. - *Amazon MQ (ActiveMQ and RabbitMQ)* - Default 100. Max 10,000.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize

                                                    property bisectBatchOnFunctionError

                                                    bisectBatchOnFunctionError: any;
                                                    • (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror

                                                    property CFN_RESOURCE_TYPE_NAME

                                                    static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                    • The CloudFormation resource type name for this resource class.

                                                    property cfnProperties

                                                    readonly cfnProperties: { [key: string]: any };

                                                      property destinationConfig

                                                      destinationConfig: any;
                                                      • (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig

                                                      property enabled

                                                      enabled: any;
                                                      • When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

                                                        Default: True

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled

                                                      property eventSourceArn

                                                      eventSourceArn: string;
                                                      • The Amazon Resource Name (ARN) of the event source.

                                                        - *Amazon Kinesis* - The ARN of the data stream or a stream consumer. - *Amazon DynamoDB Streams* - The ARN of the stream. - *Amazon Simple Queue Service* - The ARN of the queue. - *Amazon Managed Streaming for Apache Kafka* - The ARN of the cluster.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn

                                                      property filterCriteria

                                                      filterCriteria: any;
                                                      • (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) .

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria

                                                      property functionName

                                                      functionName: string;
                                                      • The name of the Lambda function.

                                                        **Name formats** - *Function name* - MyFunction . - *Function ARN* - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . - *Version or Alias ARN* - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD . - *Partial ARN* - 123456789012:function:MyFunction .

                                                        The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname

                                                      property functionResponseTypes

                                                      functionResponseTypes: string[];
                                                      • (Streams and SQS) A list of current response type enums applied to the event source mapping.

                                                        Valid Values: ReportBatchItemFailures

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes

                                                      property maximumBatchingWindowInSeconds

                                                      maximumBatchingWindowInSeconds: number;
                                                      • The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

                                                        *Default ( Kinesis , DynamoDB , Amazon SQS event sources)* : 0

                                                        *Default ( Amazon MSK , Kafka, Amazon MQ event sources)* : 500 ms

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds

                                                      property maximumRecordAgeInSeconds

                                                      maximumRecordAgeInSeconds: number;
                                                      • (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds

                                                      property maximumRetryAttempts

                                                      maximumRetryAttempts: number;
                                                      • (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts

                                                      property parallelizationFactor

                                                      parallelizationFactor: number;
                                                      • (Streams only) The number of batches to process concurrently from each shard. The default value is 1.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor

                                                      property queues

                                                      queues: string[];
                                                      • (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues

                                                      property selfManagedEventSource

                                                      selfManagedEventSource: any;
                                                      • The self-managed Apache Kafka cluster for your event source.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource

                                                      property selfManagedKafkaEventSourceConfig

                                                      selfManagedKafkaEventSourceConfig: any;
                                                      • AWS::Lambda::EventSourceMapping.SelfManagedKafkaEventSourceConfig

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig

                                                      property sourceAccessConfigurations

                                                      sourceAccessConfigurations: any;
                                                      • An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations

                                                      property startingPosition

                                                      startingPosition: string;
                                                      • The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.

                                                        - *LATEST* - Read only new records. - *TRIM_HORIZON* - Process all available records. - *AT_TIMESTAMP* - Specify a time from which to start reading records.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition

                                                      property startingPositionTimestamp

                                                      startingPositionTimestamp: number;
                                                      • With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp

                                                      property topics

                                                      topics: string[];
                                                      • The name of the Kafka topic.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics

                                                      property tumblingWindowInSeconds

                                                      tumblingWindowInSeconds: number;
                                                      • (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds

                                                      method inspect

                                                      inspect: (inspector: cdk.TreeInspector) => void;
                                                      • Examines the CloudFormation resource and discloses attributes.

                                                        Parameter inspector

                                                        tree inspector to collect and process attributes

                                                      method renderProperties

                                                      protected renderProperties: (props: { [key: string]: any }) => {
                                                      [key: string]: any;
                                                      };

                                                        class CfnFunction

                                                        class CfnFunction extends cdk.CfnResource implements cdk.IInspectable {}
                                                        • A CloudFormation AWS::Lambda::Function

                                                          The AWS::Lambda::Function resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html) . The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.

                                                          You set the package type to Image if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) . For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

                                                          You set the package type to Zip if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip) . For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html) .

                                                          You can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode , Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

                                                          Note that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) on a AWS::Lambda::Version or a AWS::Lambda::Alias .

                                                          For a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*

                                                          AWS::Lambda::Function external

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html

                                                        constructor

                                                        constructor(scope: cdk.Construct, id: string, props: CfnFunctionProps);
                                                        • Create a new AWS::Lambda::Function.

                                                          Parameter scope

                                                          scope in which this resource is defined

                                                          Parameter id

                                                          scoped id of the resource

                                                          Parameter props

                                                          resource properties

                                                        property architectures

                                                        architectures: string[];
                                                        • The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64 .

                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures

                                                        property attrArn

                                                        readonly attrArn: string;
                                                        • The Amazon Resource Name (ARN) of the function. Arn

                                                        property CFN_RESOURCE_TYPE_NAME

                                                        static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                        • The CloudFormation resource type name for this resource class.

                                                        property cfnProperties

                                                        readonly cfnProperties: { [key: string]: any };

                                                          property code

                                                          code: any;
                                                          • The code for the function.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code

                                                          property codeSigningConfigArn

                                                          codeSigningConfigArn: string;
                                                          • To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn

                                                          property deadLetterConfig

                                                          deadLetterConfig: any;
                                                          • A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead Letter Queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) .

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig

                                                          property description

                                                          description: string;
                                                          • A description of the function.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description

                                                          property environment

                                                          environment: any;
                                                          • Environment variables that are accessible from function code during execution.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment

                                                          property ephemeralStorage

                                                          ephemeralStorage: any;
                                                          • The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage

                                                          property fileSystemConfigs

                                                          fileSystemConfigs: any;
                                                          • Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.

                                                            For more information about using the DependsOn attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) .

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs

                                                          property functionName

                                                          functionName: string;
                                                          • The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

                                                            If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname

                                                          property handler

                                                          handler: string;
                                                          • The name of the method within your code that Lambda calls to execute your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Programming Model](https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html) .

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler

                                                          property imageConfig

                                                          imageConfig: any;
                                                          • Configuration values that override the container image Dockerfile settings. See [Container settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms) .

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig

                                                          property kmsKeyArn

                                                          kmsKeyArn: string;
                                                          • The ARN of the AWS Key Management Service ( AWS KMS ) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn

                                                          property layers

                                                          layers: string[];
                                                          • A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers

                                                          property memorySize

                                                          memorySize: number;
                                                          • The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize

                                                          property packageType

                                                          packageType: string;
                                                          • The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype

                                                          property reservedConcurrentExecutions

                                                          reservedConcurrentExecutions: number;
                                                          • The number of simultaneous executions to reserve for the function.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions

                                                          property role

                                                          role: string;
                                                          • The Amazon Resource Name (ARN) of the function's execution role.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role

                                                          property runtime

                                                          runtime: string;
                                                          • The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Runtime is required if the deployment package is a .zip file archive.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime

                                                          property tags

                                                          readonly tags: cdk.TagManager;
                                                          • A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags

                                                          property timeout

                                                          timeout: number;
                                                          • The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) .

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout

                                                          property tracingConfig

                                                          tracingConfig: any;
                                                          • Set Mode to Active to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) .

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig

                                                          property vpcConfig

                                                          vpcConfig: any;
                                                          • For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC.

                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig

                                                          method inspect

                                                          inspect: (inspector: cdk.TreeInspector) => void;
                                                          • Examines the CloudFormation resource and discloses attributes.

                                                            Parameter inspector

                                                            tree inspector to collect and process attributes

                                                          method renderProperties

                                                          protected renderProperties: (props: { [key: string]: any }) => {
                                                          [key: string]: any;
                                                          };

                                                            class CfnLayerVersion

                                                            class CfnLayerVersion extends cdk.CfnResource implements cdk.IInspectable {}
                                                            • A CloudFormation AWS::Lambda::LayerVersion

                                                              The AWS::Lambda::LayerVersion resource creates a [Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) from a ZIP archive.

                                                              AWS::Lambda::LayerVersion external

                                                              http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html

                                                            constructor

                                                            constructor(scope: cdk.Construct, id: string, props: CfnLayerVersionProps);
                                                            • Create a new AWS::Lambda::LayerVersion.

                                                              Parameter scope

                                                              scope in which this resource is defined

                                                              Parameter id

                                                              scoped id of the resource

                                                              Parameter props

                                                              resource properties

                                                            property CFN_RESOURCE_TYPE_NAME

                                                            static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                            • The CloudFormation resource type name for this resource class.

                                                            property cfnProperties

                                                            readonly cfnProperties: { [key: string]: any };

                                                              property compatibleArchitectures

                                                              compatibleArchitectures: string[];
                                                              • A list of compatible [instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) .

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatiblearchitectures

                                                              property compatibleRuntimes

                                                              compatibleRuntimes: string[];
                                                              • A list of compatible [function runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Used for filtering with [ListLayers](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayers.html) and [ListLayerVersions](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayerVersions.html) .

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes

                                                              property content

                                                              content: any;
                                                              • The function layer archive.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content

                                                              property description

                                                              description: string;
                                                              • The description of the version.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description

                                                              property layerName

                                                              layerName: string;
                                                              • The name or Amazon Resource Name (ARN) of the layer.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername

                                                              property licenseInfo

                                                              licenseInfo: string;
                                                              • The layer's software license. It can be any of the following:

                                                                - An [SPDX license identifier](https://docs.aws.amazon.com/https://spdx.org/licenses/) . For example, MIT . - The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT . - The full text of the license.

                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo

                                                              method inspect

                                                              inspect: (inspector: cdk.TreeInspector) => void;
                                                              • Examines the CloudFormation resource and discloses attributes.

                                                                Parameter inspector

                                                                tree inspector to collect and process attributes

                                                              method renderProperties

                                                              protected renderProperties: (props: { [key: string]: any }) => {
                                                              [key: string]: any;
                                                              };

                                                                class CfnLayerVersionPermission

                                                                class CfnLayerVersionPermission
                                                                extends cdk.CfnResource
                                                                implements cdk.IInspectable {}
                                                                • A CloudFormation AWS::Lambda::LayerVersionPermission

                                                                  The AWS::Lambda::LayerVersionPermission resource adds permissions to the resource-based policy of a version of an [Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) . Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.

                                                                  > Since the release of the [UpdateReplacePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) both UpdateReplacePolicy and DeletionPolicy are required to protect your Resources/LayerPermissions from deletion.

                                                                  AWS::Lambda::LayerVersionPermission external

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html

                                                                constructor

                                                                constructor(
                                                                scope: cdk.Construct,
                                                                id: string,
                                                                props: CfnLayerVersionPermissionProps
                                                                );
                                                                • Create a new AWS::Lambda::LayerVersionPermission.

                                                                  Parameter scope

                                                                  scope in which this resource is defined

                                                                  Parameter id

                                                                  scoped id of the resource

                                                                  Parameter props

                                                                  resource properties

                                                                property action

                                                                action: string;
                                                                • The API action that grants access to the layer. For example, lambda:GetLayerVersion .

                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-action

                                                                property CFN_RESOURCE_TYPE_NAME

                                                                static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                                • The CloudFormation resource type name for this resource class.

                                                                property cfnProperties

                                                                readonly cfnProperties: { [key: string]: any };

                                                                  property layerVersionArn

                                                                  layerVersionArn: string;
                                                                  • The name or Amazon Resource Name (ARN) of the layer.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-layerversionarn

                                                                  property organizationId

                                                                  organizationId: string;
                                                                  • With the principal set to * , grant permission to all accounts in the specified organization.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-organizationid

                                                                  property principal

                                                                  principal: string;
                                                                  • An account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified). For the last case, make sure that you really do want all AWS accounts to have usage permission to this layer.

                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-principal

                                                                  method inspect

                                                                  inspect: (inspector: cdk.TreeInspector) => void;
                                                                  • Examines the CloudFormation resource and discloses attributes.

                                                                    Parameter inspector

                                                                    tree inspector to collect and process attributes

                                                                  method renderProperties

                                                                  protected renderProperties: (props: { [key: string]: any }) => {
                                                                  [key: string]: any;
                                                                  };

                                                                    class CfnParametersCode

                                                                    class CfnParametersCode extends Code {}
                                                                    • Lambda code defined using 2 CloudFormation parameters. Useful when you don't have access to the code of your Lambda from your CDK code, so you can't use Assets, and you want to deploy the Lambda in a CodePipeline, using CloudFormation Actions - you can fill the parameters using the method.

                                                                    constructor

                                                                    constructor(props?: CfnParametersCodeProps);

                                                                      property bucketNameParam

                                                                      readonly bucketNameParam: string;

                                                                        property isInline

                                                                        readonly isInline: boolean;

                                                                          property objectKeyParam

                                                                          readonly objectKeyParam: string;

                                                                            method assign

                                                                            assign: (location: s3.Location) => { [name: string]: any };
                                                                            • Create a parameters map from this instance's CloudFormation parameters.

                                                                              It returns a map with 2 keys that correspond to the names of the parameters defined in this Lambda code, and as values it contains the appropriate expressions pointing at the provided S3 location (most likely, obtained from a CodePipeline Artifact by calling the artifact.s3Location method). The result should be provided to the CloudFormation Action that is deploying the Stack that the Lambda with this code is part of, in the parameterOverrides property.

                                                                              Parameter location

                                                                              the location of the object in S3 that represents the Lambda code

                                                                            method bind

                                                                            bind: (scope: Construct) => CodeConfig;

                                                                              class CfnPermission

                                                                              class CfnPermission extends cdk.CfnResource implements cdk.IInspectable {}
                                                                              • A CloudFormation AWS::Lambda::Permission

                                                                                The AWS::Lambda::Permission resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.

                                                                                To grant permission to another account, specify the account ID as the Principal . To grant permission to an organization defined in AWS Organizations , specify the organization ID as the PrincipalOrgID . For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com . For AWS services, you can also specify the ARN of the associated resource as the SourceArn . If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

                                                                                If your function has a function URL, you can specify the FunctionUrlAuthType parameter. This adds a condition to your permission that only applies when your function URL's AuthType matches the specified FunctionUrlAuthType . For more information about the AuthType parameter, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .

                                                                                This resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) .

                                                                                AWS::Lambda::Permission external

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html

                                                                              constructor

                                                                              constructor(scope: cdk.Construct, id: string, props: CfnPermissionProps);
                                                                              • Create a new AWS::Lambda::Permission.

                                                                                Parameter scope

                                                                                scope in which this resource is defined

                                                                                Parameter id

                                                                                scoped id of the resource

                                                                                Parameter props

                                                                                resource properties

                                                                              property action

                                                                              action: string;
                                                                              • The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction .

                                                                                http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action

                                                                              property CFN_RESOURCE_TYPE_NAME

                                                                              static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                                              • The CloudFormation resource type name for this resource class.

                                                                              property cfnProperties

                                                                              readonly cfnProperties: { [key: string]: any };

                                                                                property eventSourceToken

                                                                                eventSourceToken: string;
                                                                                • For Alexa Smart Home functions, a token that must be supplied by the invoker.

                                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken

                                                                                property functionName

                                                                                functionName: string;
                                                                                • The name of the Lambda function, version, or alias.

                                                                                  **Name formats** - *Function name* - my-function (name-only), my-function:v1 (with alias). - *Function ARN* - arn:aws:lambda:us-west-2:123456789012:function:my-function . - *Partial ARN* - 123456789012:function:my-function .

                                                                                  You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

                                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname

                                                                                property functionUrlAuthType

                                                                                functionUrlAuthType: string;
                                                                                • The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated IAM users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .

                                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionurlauthtype

                                                                                property principal

                                                                                principal: string;
                                                                                • The AWS service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

                                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal

                                                                                property principalOrgId

                                                                                principalOrgId: string;
                                                                                • The identifier for your organization in AWS Organizations . Use this to grant permissions to all the AWS accounts under this organization.

                                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principalorgid

                                                                                property sourceAccount

                                                                                sourceAccount: string;
                                                                                • For Amazon S3, the ID of the account that owns the resource. Use this together with SourceArn to ensure that the resource is owned by the specified account. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.

                                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount

                                                                                property sourceArn

                                                                                sourceArn: string;
                                                                                • For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

                                                                                  Note that Lambda configures the comparison using the StringLike operator.

                                                                                  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn

                                                                                method inspect

                                                                                inspect: (inspector: cdk.TreeInspector) => void;
                                                                                • Examines the CloudFormation resource and discloses attributes.

                                                                                  Parameter inspector

                                                                                  tree inspector to collect and process attributes

                                                                                method renderProperties

                                                                                protected renderProperties: (props: { [key: string]: any }) => {
                                                                                [key: string]: any;
                                                                                };

                                                                                  class CfnUrl

                                                                                  class CfnUrl extends cdk.CfnResource implements cdk.IInspectable {}
                                                                                  • A CloudFormation AWS::Lambda::Url

                                                                                    The AWS::Lambda::Url resource creates a function URL with the specified configuration parameters. A [function URL](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) is a dedicated HTTP(S) endpoint that you can use to invoke your function.

                                                                                    AWS::Lambda::Url external

                                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html

                                                                                  constructor

                                                                                  constructor(scope: cdk.Construct, id: string, props: CfnUrlProps);
                                                                                  • Create a new AWS::Lambda::Url.

                                                                                    Parameter scope

                                                                                    scope in which this resource is defined

                                                                                    Parameter id

                                                                                    scoped id of the resource

                                                                                    Parameter props

                                                                                    resource properties

                                                                                  property attrFunctionArn

                                                                                  readonly attrFunctionArn: string;
                                                                                  • The Amazon Resource Name (ARN) of the function. FunctionArn

                                                                                  property attrFunctionUrl

                                                                                  readonly attrFunctionUrl: string;
                                                                                  • The HTTP URL endpoint for your function. FunctionUrl

                                                                                  property authType

                                                                                  authType: string;
                                                                                  • The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated IAM users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .

                                                                                    http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype

                                                                                  property CFN_RESOURCE_TYPE_NAME

                                                                                  static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                                                  • The CloudFormation resource type name for this resource class.

                                                                                  property cfnProperties

                                                                                  readonly cfnProperties: { [key: string]: any };

                                                                                    property cors

                                                                                    cors: any;
                                                                                    • The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL.

                                                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-cors

                                                                                    property invokeMode

                                                                                    invokeMode: string;
                                                                                    • AWS::Lambda::Url.InvokeMode

                                                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode

                                                                                    property qualifier

                                                                                    qualifier: string;
                                                                                    • The alias name.

                                                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-qualifier

                                                                                    property targetFunctionArn

                                                                                    targetFunctionArn: string;
                                                                                    • The name of the Lambda function.

                                                                                      **Name formats** - *Function name* - my-function . - *Function ARN* - arn:aws:lambda:us-west-2:123456789012:function:my-function . - *Partial ARN* - 123456789012:function:my-function .

                                                                                      The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

                                                                                      http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-targetfunctionarn

                                                                                    method inspect

                                                                                    inspect: (inspector: cdk.TreeInspector) => void;
                                                                                    • Examines the CloudFormation resource and discloses attributes.

                                                                                      Parameter inspector

                                                                                      tree inspector to collect and process attributes

                                                                                    method renderProperties

                                                                                    protected renderProperties: (props: { [key: string]: any }) => {
                                                                                    [key: string]: any;
                                                                                    };

                                                                                      class CfnVersion

                                                                                      class CfnVersion extends cdk.CfnResource implements cdk.IInspectable {}
                                                                                      • A CloudFormation AWS::Lambda::Version

                                                                                        The AWS::Lambda::Version resource creates a [version](https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.

                                                                                        AWS::Lambda::Version external

                                                                                        http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html

                                                                                      constructor

                                                                                      constructor(scope: cdk.Construct, id: string, props: CfnVersionProps);
                                                                                      • Create a new AWS::Lambda::Version.

                                                                                        Parameter scope

                                                                                        scope in which this resource is defined

                                                                                        Parameter id

                                                                                        scoped id of the resource

                                                                                        Parameter props

                                                                                        resource properties

                                                                                      property attrVersion

                                                                                      readonly attrVersion: string;
                                                                                      • The version number. Version

                                                                                      property CFN_RESOURCE_TYPE_NAME

                                                                                      static readonly CFN_RESOURCE_TYPE_NAME: string;
                                                                                      • The CloudFormation resource type name for this resource class.

                                                                                      property cfnProperties

                                                                                      readonly cfnProperties: { [key: string]: any };

                                                                                        property codeSha256

                                                                                        codeSha256: string;
                                                                                        • Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.

                                                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256

                                                                                        property description

                                                                                        description: string;
                                                                                        • A description for the version to override the description in the function configuration. Updates are not supported for this property.

                                                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description

                                                                                        property functionName

                                                                                        functionName: string;
                                                                                        • The name of the Lambda function.

                                                                                          **Name formats** - *Function name* - MyFunction . - *Function ARN* - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . - *Partial ARN* - 123456789012:function:MyFunction .

                                                                                          The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

                                                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionname

                                                                                        property provisionedConcurrencyConfig

                                                                                        provisionedConcurrencyConfig: any;
                                                                                        • Specifies a provisioned concurrency configuration for a function's version. Updates are not supported for this property.

                                                                                          http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-provisionedconcurrencyconfig

                                                                                        method inspect

                                                                                        inspect: (inspector: cdk.TreeInspector) => void;
                                                                                        • Examines the CloudFormation resource and discloses attributes.

                                                                                          Parameter inspector

                                                                                          tree inspector to collect and process attributes

                                                                                        method renderProperties

                                                                                        protected renderProperties: (props: { [key: string]: any }) => {
                                                                                        [key: string]: any;
                                                                                        };

                                                                                          class Code

                                                                                          abstract class Code {}
                                                                                          • Represents the Lambda Handler Code.

                                                                                          property isInline

                                                                                          abstract readonly isInline: boolean;
                                                                                          • Determines whether this Code is inline code or not.

                                                                                            Deprecated

                                                                                            this value is ignored since inline is now determined based on the the inlineCode field of CodeConfig returned from bind().

                                                                                          method asset

                                                                                          static asset: (path: string) => AssetCode;
                                                                                          • DEPRECATED

                                                                                            Deprecated

                                                                                            use fromAsset

                                                                                          method bind

                                                                                          abstract bind: (scope: Construct) => CodeConfig;
                                                                                          • Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun.

                                                                                            Parameter scope

                                                                                            The binding scope. Don't be smart about trying to down-cast or assume it's initialized. You may just use it as a construct scope.

                                                                                          method bindToResource

                                                                                          bindToResource: (
                                                                                          _resource: cdk.CfnResource,
                                                                                          _options?: ResourceBindOptions
                                                                                          ) => void;
                                                                                          • Called after the CFN function resource has been created to allow the code class to bind to it. Specifically it's required to allow assets to add metadata for tooling like SAM CLI to be able to find their origins.

                                                                                          method bucket

                                                                                          static bucket: (
                                                                                          bucket: s3.IBucket,
                                                                                          key: string,
                                                                                          objectVersion?: string
                                                                                          ) => S3Code;
                                                                                          • DEPRECATED

                                                                                            Deprecated

                                                                                            use fromBucket

                                                                                          method cfnParameters

                                                                                          static cfnParameters: (props?: CfnParametersCodeProps) => CfnParametersCode;
                                                                                          • DEPRECATED

                                                                                            Deprecated

                                                                                            use fromCfnParameters

                                                                                          method fromAsset

                                                                                          static fromAsset: (path: string, options?: s3_assets.AssetOptions) => AssetCode;
                                                                                          • Loads the function code from a local disk path.

                                                                                            Parameter path

                                                                                            Either a directory with the Lambda code bundle or a .zip file

                                                                                          method fromAssetImage

                                                                                          static fromAssetImage: (
                                                                                          directory: string,
                                                                                          props?: AssetImageCodeProps
                                                                                          ) => AssetImageCode;
                                                                                          • Create an ECR image from the specified asset and bind it as the Lambda code.

                                                                                            Parameter directory

                                                                                            the directory from which the asset must be created

                                                                                            Parameter props

                                                                                            properties to further configure the selected image

                                                                                          method fromBucket

                                                                                          static fromBucket: (
                                                                                          bucket: s3.IBucket,
                                                                                          key: string,
                                                                                          objectVersion?: string
                                                                                          ) => S3Code;
                                                                                          • Lambda handler code as an S3 object.

                                                                                            Parameter bucket

                                                                                            The S3 bucket

                                                                                            Parameter key

                                                                                            The object key

                                                                                            Parameter objectVersion

                                                                                            Optional S3 object version

                                                                                          method fromCfnParameters

                                                                                          static fromCfnParameters: (props?: CfnParametersCodeProps) => CfnParametersCode;
                                                                                          • Creates a new Lambda source defined using CloudFormation parameters.

                                                                                            Parameter props

                                                                                            optional construction properties of CfnParametersCode

                                                                                            Returns

                                                                                            a new instance of CfnParametersCode

                                                                                          method fromDockerBuild

                                                                                          static fromDockerBuild: (
                                                                                          path: string,
                                                                                          options?: DockerBuildAssetOptions
                                                                                          ) => AssetCode;
                                                                                          • Loads the function code from an asset created by a Docker build.

                                                                                            By default, the asset is expected to be located at /asset in the image.

                                                                                            Parameter path

                                                                                            The path to the directory containing the Docker file

                                                                                            Parameter options

                                                                                            Docker build options

                                                                                          method fromEcrImage

                                                                                          static fromEcrImage: (
                                                                                          repository: ecr.IRepository,
                                                                                          props?: EcrImageCodeProps
                                                                                          ) => EcrImageCode;
                                                                                          • Use an existing ECR image as the Lambda code.

                                                                                            Parameter repository

                                                                                            the ECR repository that the image is in

                                                                                            Parameter props

                                                                                            properties to further configure the selected image

                                                                                          method fromInline

                                                                                          static fromInline: (code: string) => InlineCode;
                                                                                          • Inline code for Lambda handler

                                                                                            Parameter code

                                                                                            The actual handler code (limited to 4KiB)

                                                                                            Returns

                                                                                            LambdaInlineCode with inline code.

                                                                                          method inline

                                                                                          static inline: (code: string) => InlineCode;
                                                                                          • DEPRECATED

                                                                                            Deprecated

                                                                                            use fromInline

                                                                                          class CodeSigningConfig

                                                                                          class CodeSigningConfig extends Resource implements ICodeSigningConfig {}
                                                                                          • Defines a Code Signing Config.

                                                                                            AWS::Lambda::CodeSigningConfig

                                                                                          constructor

                                                                                          constructor(scope: Construct, id: string, props: CodeSigningConfigProps);

                                                                                            property codeSigningConfigArn

                                                                                            readonly codeSigningConfigArn: string;

                                                                                              property codeSigningConfigId

                                                                                              readonly codeSigningConfigId: string;

                                                                                                method fromCodeSigningConfigArn

                                                                                                static fromCodeSigningConfigArn: (
                                                                                                scope: Construct,
                                                                                                id: string,
                                                                                                codeSigningConfigArn: string
                                                                                                ) => ICodeSigningConfig;
                                                                                                • Creates a Signing Profile construct that represents an external Signing Profile.

                                                                                                  Parameter scope

                                                                                                  The parent creating construct (usually this).

                                                                                                  Parameter id

                                                                                                  The construct's name.

                                                                                                  Parameter codeSigningConfigArn

                                                                                                  The ARN of code signing config.

                                                                                                class DockerImageCode

                                                                                                abstract class DockerImageCode {}
                                                                                                • Code property for the DockerImageFunction construct

                                                                                                method fromEcr

                                                                                                static fromEcr: (
                                                                                                repository: ecr.IRepository,
                                                                                                props?: EcrImageCodeProps
                                                                                                ) => DockerImageCode;
                                                                                                • Use an existing ECR image as the Lambda code.

                                                                                                  Parameter repository

                                                                                                  the ECR repository that the image is in

                                                                                                  Parameter props

                                                                                                  properties to further configure the selected image

                                                                                                method fromImageAsset

                                                                                                static fromImageAsset: (
                                                                                                directory: string,
                                                                                                props?: AssetImageCodeProps
                                                                                                ) => DockerImageCode;
                                                                                                • Create an ECR image from the specified asset and bind it as the Lambda code.

                                                                                                  Parameter directory

                                                                                                  the directory from which the asset must be created

                                                                                                  Parameter props

                                                                                                  properties to further configure the selected image

                                                                                                class DockerImageFunction

                                                                                                class DockerImageFunction extends Function {}
                                                                                                • Create a lambda function where the handler is a docker image

                                                                                                constructor

                                                                                                constructor(scope: Construct, id: string, props: DockerImageFunctionProps);

                                                                                                  class EcrImageCode

                                                                                                  class EcrImageCode extends Code {}
                                                                                                  • Represents a Docker image in ECR that can be bound as Lambda Code.

                                                                                                  constructor

                                                                                                  constructor(repository: ecr.IRepository, props?: EcrImageCodeProps);

                                                                                                    property isInline

                                                                                                    readonly isInline: boolean;

                                                                                                      method bind

                                                                                                      bind: (_: Construct) => CodeConfig;

                                                                                                        class EventInvokeConfig

                                                                                                        class EventInvokeConfig extends Resource {}
                                                                                                        • Configure options for asynchronous invocation on a version or an alias

                                                                                                          By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it.

                                                                                                        constructor

                                                                                                        constructor(scope: Construct, id: string, props: EventInvokeConfigProps);

                                                                                                          class EventSourceMapping

                                                                                                          class EventSourceMapping extends cdk.Resource implements IEventSourceMapping {}
                                                                                                          • Defines a Lambda EventSourceMapping resource.

                                                                                                            Usually, you won't need to define the mapping yourself. This will usually be done by event sources. For example, to add an SQS event source to a function:

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

                                                                                                            The SqsEventSource class will automatically create the mapping, and will also modify the Lambda's execution role so it can consume messages from the queue.

                                                                                                          constructor

                                                                                                          constructor(scope: Construct, id: string, props: EventSourceMappingProps);

                                                                                                            property eventSourceMappingId

                                                                                                            readonly eventSourceMappingId: string;

                                                                                                              method fromEventSourceMappingId

                                                                                                              static fromEventSourceMappingId: (
                                                                                                              scope: Construct,
                                                                                                              id: string,
                                                                                                              eventSourceMappingId: string
                                                                                                              ) => IEventSourceMapping;
                                                                                                              • Import an event source into this stack from its event source id.

                                                                                                              class FileSystem

                                                                                                              class FileSystem {}
                                                                                                              • Represents the filesystem for the Lambda function

                                                                                                              constructor

                                                                                                              protected constructor(config: FileSystemConfig);
                                                                                                              • Parameter config

                                                                                                                the FileSystem configurations for the Lambda function

                                                                                                              property config

                                                                                                              readonly config: FileSystemConfig;

                                                                                                                method fromEfsAccessPoint

                                                                                                                static fromEfsAccessPoint: (
                                                                                                                ap: efs.IAccessPoint,
                                                                                                                mountPath: string
                                                                                                                ) => FileSystem;
                                                                                                                • mount the filesystem from Amazon EFS

                                                                                                                  Parameter ap

                                                                                                                  the Amazon EFS access point

                                                                                                                  Parameter mountPath

                                                                                                                  the target path in the lambda runtime environment

                                                                                                                class Function

                                                                                                                class Function extends FunctionBase {}
                                                                                                                • Deploys a file from inside the construct library as a function.

                                                                                                                  The supplied file is subject to the 4096 bytes limit of being embedded in a CloudFormation template.

                                                                                                                  The construct includes an associated role with the lambda.

                                                                                                                  This construct does not yet reproduce all features from the underlying resource library.

                                                                                                                constructor

                                                                                                                constructor(scope: Construct, id: string, props: FunctionProps);

                                                                                                                  property architecture

                                                                                                                  readonly architecture: Architecture;
                                                                                                                  • The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64).

                                                                                                                  property canCreatePermissions

                                                                                                                  protected readonly canCreatePermissions: boolean;

                                                                                                                    property currentVersion

                                                                                                                    readonly 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.

                                                                                                                    property deadLetterQueue

                                                                                                                    readonly deadLetterQueue?: sqs.IQueue;
                                                                                                                    • The DLQ (as queue) associated with this Lambda Function (this is an optional attribute).

                                                                                                                    property deadLetterTopic

                                                                                                                    readonly deadLetterTopic?: sns.ITopic;
                                                                                                                    • The DLQ (as topic) associated with this Lambda Function (this is an optional attribute).

                                                                                                                    property functionArn

                                                                                                                    readonly functionArn: string;
                                                                                                                    • ARN of this function

                                                                                                                    property functionName

                                                                                                                    readonly functionName: string;
                                                                                                                    • Name of this function

                                                                                                                    property grantPrincipal

                                                                                                                    readonly grantPrincipal: iam.IPrincipal;
                                                                                                                    • The principal this Lambda Function is running as

                                                                                                                    property logGroup

                                                                                                                    readonly logGroup: logs.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.

                                                                                                                    property permissionsNode

                                                                                                                    readonly permissionsNode: any;

                                                                                                                      property resourceArnsForGrantInvoke

                                                                                                                      readonly resourceArnsForGrantInvoke: string[];

                                                                                                                        property role

                                                                                                                        readonly role?: iam.IRole;
                                                                                                                        • Execution role associated with this function

                                                                                                                        property runtime

                                                                                                                        readonly runtime: Runtime;
                                                                                                                        • The runtime configured for this lambda.

                                                                                                                        property timeout

                                                                                                                        readonly timeout?: Duration;
                                                                                                                        • The timeout configured for this lambda.

                                                                                                                        method addAlias

                                                                                                                        addAlias: (aliasName: string, options?: AliasOptions) => 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.

                                                                                                                          ```ts declare const fn: lambda.Function;

                                                                                                                          fn.addAlias('Live');

                                                                                                                          // Is equivalent to

                                                                                                                          new lambda.Alias(this, 'AliasLive', { aliasName: 'Live', version: fn.currentVersion, });

                                                                                                                          Parameter aliasName

                                                                                                                          The name of the alias

                                                                                                                          Parameter options

                                                                                                                          Alias options

                                                                                                                        method addEnvironment

                                                                                                                        addEnvironment: (
                                                                                                                        key: string,
                                                                                                                        value: string,
                                                                                                                        options?: EnvironmentOptions
                                                                                                                        ) => this;
                                                                                                                        • Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op.

                                                                                                                          Parameter key

                                                                                                                          The environment variable key.

                                                                                                                          Parameter value

                                                                                                                          The environment variable's value.

                                                                                                                          Parameter options

                                                                                                                          Environment variable options.

                                                                                                                        method addLayers

                                                                                                                        addLayers: (...layers: ILayerVersion[]) => void;
                                                                                                                        • Adds one or more Lambda Layers to this Lambda function.

                                                                                                                          Parameter layers

                                                                                                                          the layers to be added.

                                                                                                                          Throws

                                                                                                                          if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.

                                                                                                                        method addVersion

                                                                                                                        addVersion: (
                                                                                                                        name: string,
                                                                                                                        codeSha256?: string,
                                                                                                                        description?: string,
                                                                                                                        provisionedExecutions?: number,
                                                                                                                        asyncInvokeConfig?: EventInvokeConfigOptions
                                                                                                                        ) => Version;
                                                                                                                        • Add a new version for this Lambda

                                                                                                                          If you want to deploy through CloudFormation and use aliases, you need to add a new version (with a new name) to your Lambda every time you want to deploy an update. An alias can then refer to the newly created Version.

                                                                                                                          All versions should have distinct names, and you should not delete versions as long as your Alias needs to refer to them.

                                                                                                                          Parameter name

                                                                                                                          A unique name for this version.

                                                                                                                          Parameter codeSha256

                                                                                                                          The SHA-256 hash of the most recently deployed Lambda source code, or omit to skip validation.

                                                                                                                          Parameter description

                                                                                                                          A description for this version.

                                                                                                                          Parameter provisionedExecutions

                                                                                                                          A provisioned concurrency configuration for a function's version.

                                                                                                                          Parameter asyncInvokeConfig

                                                                                                                          configuration for this version when it is invoked asynchronously.

                                                                                                                          Returns

                                                                                                                          A new Version object.

                                                                                                                          Deprecated

                                                                                                                          This method will create an AWS::Lambda::Version resource which snapshots the AWS Lambda function *at the time of its creation* and it won't get updated when the function changes. Instead, use this.currentVersion to obtain a reference to a version resource that gets automatically recreated when the function configuration (or code) changes.

                                                                                                                        method classifyVersionProperty

                                                                                                                        static classifyVersionProperty: (propertyName: string, locked: boolean) => 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.

                                                                                                                          Parameter propertyName

                                                                                                                          The property to classify

                                                                                                                          Parameter locked

                                                                                                                          whether the property should be associated to the version or not.

                                                                                                                        method fromFunctionArn

                                                                                                                        static fromFunctionArn: (
                                                                                                                        scope: Construct,
                                                                                                                        id: string,
                                                                                                                        functionArn: string
                                                                                                                        ) => IFunction;
                                                                                                                        • Import a lambda function into the CDK using its ARN

                                                                                                                        method fromFunctionAttributes

                                                                                                                        static fromFunctionAttributes: (
                                                                                                                        scope: Construct,
                                                                                                                        id: string,
                                                                                                                        attrs: FunctionAttributes
                                                                                                                        ) => IFunction;
                                                                                                                        • Creates a Lambda function object which represents a function not defined within this stack.

                                                                                                                          Parameter scope

                                                                                                                          The parent construct

                                                                                                                          Parameter id

                                                                                                                          The name of the lambda construct

                                                                                                                          Parameter attrs

                                                                                                                          the attributes of the function to import

                                                                                                                        method fromFunctionName

                                                                                                                        static fromFunctionName: (
                                                                                                                        scope: Construct,
                                                                                                                        id: string,
                                                                                                                        functionName: string
                                                                                                                        ) => IFunction;
                                                                                                                        • Import a lambda function into the CDK using its name

                                                                                                                        method metricAll

                                                                                                                        static metricAll: (
                                                                                                                        metricName: string,
                                                                                                                        props?: cloudwatch.MetricOptions
                                                                                                                        ) => cloudwatch.Metric;
                                                                                                                        • Return the given named metric for this Lambda

                                                                                                                        method metricAllConcurrentExecutions

                                                                                                                        static metricAllConcurrentExecutions: (
                                                                                                                        props?: cloudwatch.MetricOptions
                                                                                                                        ) => cloudwatch.Metric;
                                                                                                                        • Metric for the number of concurrent executions across all Lambdas

                                                                                                                          max over 5 minutes

                                                                                                                        method metricAllDuration

                                                                                                                        static metricAllDuration: (
                                                                                                                        props?: cloudwatch.MetricOptions
                                                                                                                        ) => cloudwatch.Metric;
                                                                                                                        • Metric for the Duration executing all Lambdas

                                                                                                                          average over 5 minutes

                                                                                                                        method metricAllErrors

                                                                                                                        static metricAllErrors: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
                                                                                                                        • Metric for the number of Errors executing all Lambdas

                                                                                                                          sum over 5 minutes

                                                                                                                        method metricAllInvocations

                                                                                                                        static metricAllInvocations: (
                                                                                                                        props?: cloudwatch.MetricOptions
                                                                                                                        ) => cloudwatch.Metric;
                                                                                                                        • Metric for the number of invocations of all Lambdas

                                                                                                                          sum over 5 minutes

                                                                                                                        method metricAllThrottles

                                                                                                                        static metricAllThrottles: (
                                                                                                                        props?: cloudwatch.MetricOptions
                                                                                                                        ) => cloudwatch.Metric;
                                                                                                                        • Metric for the number of throttled invocations of all Lambdas

                                                                                                                          sum over 5 minutes

                                                                                                                        method metricAllUnreservedConcurrentExecutions

                                                                                                                        static metricAllUnreservedConcurrentExecutions: (
                                                                                                                        props?: cloudwatch.MetricOptions
                                                                                                                        ) => cloudwatch.Metric;
                                                                                                                        • Metric for the number of unreserved concurrent executions across all Lambdas

                                                                                                                          max over 5 minutes

                                                                                                                        class FunctionBase

                                                                                                                        abstract class FunctionBase
                                                                                                                        extends Resource
                                                                                                                        implements IFunction, ec2.IClientVpnConnectionHandler {}

                                                                                                                          property architecture

                                                                                                                          abstract readonly architecture: Architecture;
                                                                                                                          • The architecture of this Lambda Function.

                                                                                                                          property canCreatePermissions

                                                                                                                          protected abstract readonly canCreatePermissions: boolean;
                                                                                                                          • Whether the addPermission() call adds any permissions

                                                                                                                            True for new Lambdas, false for version $LATEST and imported Lambdas from different accounts.

                                                                                                                          property connections

                                                                                                                          readonly connections: ec2.Connections;
                                                                                                                          • Access the Connections object

                                                                                                                            Will fail if not a VPC-enabled Lambda Function

                                                                                                                          property functionArn

                                                                                                                          abstract readonly functionArn: string;
                                                                                                                          • The ARN fo the function.

                                                                                                                          property functionName

                                                                                                                          abstract readonly functionName: string;
                                                                                                                          • The name of the function.

                                                                                                                          property grantPrincipal

                                                                                                                          abstract readonly grantPrincipal: iam.IPrincipal;
                                                                                                                          • The principal this Lambda Function is running as

                                                                                                                          property isBoundToVpc

                                                                                                                          readonly 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.

                                                                                                                          property latestVersion

                                                                                                                          readonly latestVersion: IVersion;

                                                                                                                            property permissionsNode

                                                                                                                            abstract readonly permissionsNode: ConstructNode;
                                                                                                                            • The construct node where permissions are attached.

                                                                                                                            property resourceArnsForGrantInvoke

                                                                                                                            abstract readonly resourceArnsForGrantInvoke: string[];
                                                                                                                            • The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()

                                                                                                                            property role

                                                                                                                            abstract readonly role?: iam.IRole;
                                                                                                                            • The IAM role associated with this function.

                                                                                                                              Undefined if the function was imported without a role.

                                                                                                                            method addEventSource

                                                                                                                            addEventSource: (source: IEventSource) => void;

                                                                                                                              method addEventSourceMapping

                                                                                                                              addEventSourceMapping: (
                                                                                                                              id: string,
                                                                                                                              options: EventSourceMappingOptions
                                                                                                                              ) => EventSourceMapping;

                                                                                                                                method addFunctionUrl

                                                                                                                                addFunctionUrl: (options?: FunctionUrlOptions) => FunctionUrl;

                                                                                                                                  method addPermission

                                                                                                                                  addPermission: (id: string, permission: Permission) => void;
                                                                                                                                  • Adds a permission to the Lambda resource policy.

                                                                                                                                    Parameter id

                                                                                                                                    The id for the permission construct

                                                                                                                                    Parameter permission

                                                                                                                                    The permission to grant to this Lambda function.

                                                                                                                                    See Also

                                                                                                                                    • Permission for details.

                                                                                                                                  method addToRolePolicy

                                                                                                                                  addToRolePolicy: (statement: iam.PolicyStatement) => void;
                                                                                                                                  • Adds a statement to the IAM role assumed by the instance.

                                                                                                                                  method configureAsyncInvoke

                                                                                                                                  configureAsyncInvoke: (options: EventInvokeConfigOptions) => void;

                                                                                                                                    method considerWarningOnInvokeFunctionPermissions

                                                                                                                                    considerWarningOnInvokeFunctionPermissions: (
                                                                                                                                    scope: Construct,
                                                                                                                                    action: string
                                                                                                                                    ) => 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.

                                                                                                                                    method grantInvoke

                                                                                                                                    grantInvoke: (grantee: iam.IGrantable) => iam.Grant;
                                                                                                                                    • Grant the given identity permissions to invoke this Lambda

                                                                                                                                    method grantInvokeUrl

                                                                                                                                    grantInvokeUrl: (grantee: iam.IGrantable) => iam.Grant;
                                                                                                                                    • Grant the given identity permissions to invoke this Lambda Function URL

                                                                                                                                    method warnInvokeFunctionPermissions

                                                                                                                                    protected warnInvokeFunctionPermissions: (scope: Construct) => void;

                                                                                                                                      class FunctionUrl

                                                                                                                                      class FunctionUrl extends Resource implements IFunctionUrl {}
                                                                                                                                      • Defines a Lambda function url

                                                                                                                                        AWS::Lambda::Url

                                                                                                                                      constructor

                                                                                                                                      constructor(scope: Construct, id: string, props: FunctionUrlProps);

                                                                                                                                        property functionArn

                                                                                                                                        readonly functionArn: string;
                                                                                                                                        • The ARN of the function this URL refers to

                                                                                                                                        property url

                                                                                                                                        readonly url: string;
                                                                                                                                        • The url of the Lambda function.

                                                                                                                                        method grantInvokeUrl

                                                                                                                                        grantInvokeUrl: (grantee: iam.IGrantable) => iam.Grant;

                                                                                                                                          class FunctionVersionUpgrade

                                                                                                                                          class FunctionVersionUpgrade implements IAspect {}
                                                                                                                                          • Aspect for upgrading function versions when the feature flag provided feature flag present. This can be necessary when the feature flag changes the function hash, as such changes must be associated with a new version. This aspect will change the function description in these cases, which "validates" the new function hash.

                                                                                                                                          constructor

                                                                                                                                          constructor(featureFlag: string, enabled?: boolean);

                                                                                                                                            method visit

                                                                                                                                            visit: (node: IConstruct) => void;

                                                                                                                                              class Handler

                                                                                                                                              class Handler {}
                                                                                                                                              • Lambda function handler

                                                                                                                                              property FROM_IMAGE

                                                                                                                                              static readonly FROM_IMAGE: string;
                                                                                                                                              • A special handler when the function handler is part of a Docker image.

                                                                                                                                              class InlineCode

                                                                                                                                              class InlineCode extends Code {}
                                                                                                                                              • Lambda code from an inline string (limited to 4KiB).

                                                                                                                                              constructor

                                                                                                                                              constructor(code: string);

                                                                                                                                                property isInline

                                                                                                                                                readonly isInline: boolean;

                                                                                                                                                  method bind

                                                                                                                                                  bind: (_scope: Construct) => CodeConfig;

                                                                                                                                                    class LambdaInsightsVersion

                                                                                                                                                    abstract class LambdaInsightsVersion {}
                                                                                                                                                    • Version of CloudWatch Lambda Insights

                                                                                                                                                    property layerVersionArn

                                                                                                                                                    readonly layerVersionArn: string;
                                                                                                                                                    • The arn of the Lambda Insights extension

                                                                                                                                                    property VERSION_1_0_119_0

                                                                                                                                                    static readonly VERSION_1_0_119_0: LambdaInsightsVersion;
                                                                                                                                                    • Version 1.0.119.0

                                                                                                                                                    property VERSION_1_0_135_0

                                                                                                                                                    static readonly VERSION_1_0_135_0: LambdaInsightsVersion;
                                                                                                                                                    • Version 1.0.135.0

                                                                                                                                                    property VERSION_1_0_54_0

                                                                                                                                                    static readonly VERSION_1_0_54_0: LambdaInsightsVersion;
                                                                                                                                                    • Version 1.0.54.0

                                                                                                                                                    property VERSION_1_0_86_0

                                                                                                                                                    static readonly VERSION_1_0_86_0: LambdaInsightsVersion;
                                                                                                                                                    • Version 1.0.86.0

                                                                                                                                                    property VERSION_1_0_89_0

                                                                                                                                                    static readonly VERSION_1_0_89_0: LambdaInsightsVersion;
                                                                                                                                                    • Version 1.0.89.0

                                                                                                                                                    property VERSION_1_0_98_0

                                                                                                                                                    static readonly VERSION_1_0_98_0: LambdaInsightsVersion;
                                                                                                                                                    • Version 1.0.98.0

                                                                                                                                                    method fromInsightVersionArn

                                                                                                                                                    static fromInsightVersionArn: (arn: string) => LambdaInsightsVersion;
                                                                                                                                                    • Use the insights extension associated with the provided ARN. Make sure the ARN is associated with same region as your function

                                                                                                                                                      See Also

                                                                                                                                                      • https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-extension-versions.html

                                                                                                                                                    class LayerVersion

                                                                                                                                                    class LayerVersion extends LayerVersionBase {}
                                                                                                                                                    • Defines a new Lambda Layer version.

                                                                                                                                                    constructor

                                                                                                                                                    constructor(scope: Construct, id: string, props: LayerVersionProps);

                                                                                                                                                      property compatibleRuntimes

                                                                                                                                                      readonly compatibleRuntimes?: Runtime[];

                                                                                                                                                        property layerVersionArn

                                                                                                                                                        readonly layerVersionArn: string;

                                                                                                                                                          method fromLayerVersionArn

                                                                                                                                                          static fromLayerVersionArn: (
                                                                                                                                                          scope: Construct,
                                                                                                                                                          id: string,
                                                                                                                                                          layerVersionArn: string
                                                                                                                                                          ) => ILayerVersion;
                                                                                                                                                          • Imports a layer version by ARN. Assumes it is compatible with all Lambda runtimes.

                                                                                                                                                          method fromLayerVersionAttributes

                                                                                                                                                          static fromLayerVersionAttributes: (
                                                                                                                                                          scope: Construct,
                                                                                                                                                          id: string,
                                                                                                                                                          attrs: LayerVersionAttributes
                                                                                                                                                          ) => ILayerVersion;
                                                                                                                                                          • Imports a Layer that has been defined externally.

                                                                                                                                                            Parameter scope

                                                                                                                                                            the parent Construct that will use the imported layer.

                                                                                                                                                            Parameter id

                                                                                                                                                            the id of the imported layer in the construct tree.

                                                                                                                                                            Parameter attrs

                                                                                                                                                            the properties of the imported layer.

                                                                                                                                                          class LogRetention

                                                                                                                                                          class LogRetention extends logs.LogRetention {}
                                                                                                                                                          • Creates a custom resource to control the retention policy of a CloudWatch Logs log group. The log group is created if it doesn't already exist. The policy is removed when retentionDays is undefined or equal to Infinity.

                                                                                                                                                            Deprecated

                                                                                                                                                            use LogRetention from '@aws-cdk/aws-logs' instead

                                                                                                                                                          constructor

                                                                                                                                                          constructor(scope: Construct, id: string, props: LogRetentionProps);

                                                                                                                                                            class QualifiedFunctionBase

                                                                                                                                                            abstract class QualifiedFunctionBase extends FunctionBase {}

                                                                                                                                                              property lambda

                                                                                                                                                              abstract readonly lambda: IFunction;

                                                                                                                                                                property latestVersion

                                                                                                                                                                readonly latestVersion: IVersion;

                                                                                                                                                                  property permissionsNode

                                                                                                                                                                  readonly permissionsNode: ConstructNode;

                                                                                                                                                                    property qualifier

                                                                                                                                                                    protected abstract readonly qualifier: string;
                                                                                                                                                                    • The qualifier of the version or alias of this function. A qualifier is the identifier that's appended to a version or alias ARN.

                                                                                                                                                                      See Also

                                                                                                                                                                      • https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#API_GetFunctionConfiguration_RequestParameters

                                                                                                                                                                    property resourceArnsForGrantInvoke

                                                                                                                                                                    readonly resourceArnsForGrantInvoke: string[];

                                                                                                                                                                      method configureAsyncInvoke

                                                                                                                                                                      configureAsyncInvoke: (options: EventInvokeConfigOptions) => void;

                                                                                                                                                                        method considerWarningOnInvokeFunctionPermissions

                                                                                                                                                                        considerWarningOnInvokeFunctionPermissions: (
                                                                                                                                                                        _scope: Construct,
                                                                                                                                                                        _action: string
                                                                                                                                                                        ) => void;

                                                                                                                                                                          class Runtime

                                                                                                                                                                          class Runtime {}
                                                                                                                                                                          • Lambda function runtime environment.

                                                                                                                                                                            If you need to use a runtime name that doesn't exist as a static member, you can instantiate a Runtime object, e.g: new Runtime('nodejs99.99').

                                                                                                                                                                          constructor

                                                                                                                                                                          constructor(name: string, family?: RuntimeFamily, props?: LambdaRuntimeProps);

                                                                                                                                                                            property ALL

                                                                                                                                                                            static readonly ALL: Runtime[];
                                                                                                                                                                            • A list of all known Runtime's.

                                                                                                                                                                            property bundlingDockerImage

                                                                                                                                                                            readonly bundlingDockerImage: BundlingDockerImage;
                                                                                                                                                                            • DEPRECATED

                                                                                                                                                                              Deprecated

                                                                                                                                                                              use bundlingImage

                                                                                                                                                                            property bundlingImage

                                                                                                                                                                            readonly bundlingImage: DockerImage;
                                                                                                                                                                            • The bundling Docker image for this runtime.

                                                                                                                                                                            property DOTNET_6

                                                                                                                                                                            static readonly DOTNET_6: Runtime;
                                                                                                                                                                            • The .NET 6 runtime (dotnet6)

                                                                                                                                                                            property DOTNET_CORE_1

                                                                                                                                                                            static readonly DOTNET_CORE_1: Runtime;
                                                                                                                                                                            • The .NET Core 1.0 runtime (dotnetcore1.0) Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.

                                                                                                                                                                            property DOTNET_CORE_2

                                                                                                                                                                            static readonly DOTNET_CORE_2: Runtime;
                                                                                                                                                                            • The .NET Core 2.0 runtime (dotnetcore2.0) Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.

                                                                                                                                                                            property DOTNET_CORE_2_1

                                                                                                                                                                            static readonly DOTNET_CORE_2_1: Runtime;
                                                                                                                                                                            • The .NET Core 2.1 runtime (dotnetcore2.1) Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime.

                                                                                                                                                                            property DOTNET_CORE_3_1

                                                                                                                                                                            static readonly DOTNET_CORE_3_1: Runtime;
                                                                                                                                                                            • The .NET Core 3.1 runtime (dotnetcore3.1)

                                                                                                                                                                            property family

                                                                                                                                                                            readonly family?: RuntimeFamily;
                                                                                                                                                                            • The runtime family.

                                                                                                                                                                            property FROM_IMAGE

                                                                                                                                                                            static readonly FROM_IMAGE: Runtime;
                                                                                                                                                                            • A special runtime entry to be used when function is using a docker image.

                                                                                                                                                                            property GO_1_X

                                                                                                                                                                            static readonly GO_1_X: Runtime;
                                                                                                                                                                            • The Go 1.x runtime (go1.x)

                                                                                                                                                                            property JAVA_11

                                                                                                                                                                            static readonly JAVA_11: Runtime;
                                                                                                                                                                            • The Java 11 runtime (java11)

                                                                                                                                                                            property JAVA_8

                                                                                                                                                                            static readonly JAVA_8: Runtime;
                                                                                                                                                                            • The Java 8 runtime (java8)

                                                                                                                                                                            property JAVA_8_CORRETTO

                                                                                                                                                                            static readonly JAVA_8_CORRETTO: Runtime;
                                                                                                                                                                            • The Java 8 Corretto runtime (java8.al2)

                                                                                                                                                                            property name

                                                                                                                                                                            readonly name: string;
                                                                                                                                                                            • The name of this runtime, as expected by the Lambda resource.

                                                                                                                                                                            property NODEJS

                                                                                                                                                                            static readonly NODEJS: Runtime;
                                                                                                                                                                            • The NodeJS runtime (nodejs)

                                                                                                                                                                              Deprecated

                                                                                                                                                                              Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

                                                                                                                                                                            property NODEJS_10_X

                                                                                                                                                                            static readonly NODEJS_10_X: Runtime;
                                                                                                                                                                            • The NodeJS 10.x runtime (nodejs10.x)

                                                                                                                                                                              Deprecated

                                                                                                                                                                              Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

                                                                                                                                                                            property NODEJS_12_X

                                                                                                                                                                            static readonly NODEJS_12_X: Runtime;
                                                                                                                                                                            • The NodeJS 12.x runtime (nodejs12.x)

                                                                                                                                                                            property NODEJS_14_X

                                                                                                                                                                            static readonly NODEJS_14_X: Runtime;
                                                                                                                                                                            • The NodeJS 14.x runtime (nodejs14.x)

                                                                                                                                                                            property NODEJS_16_X

                                                                                                                                                                            static readonly NODEJS_16_X: Runtime;
                                                                                                                                                                            • The NodeJS 16.x runtime (nodejs16.x)

                                                                                                                                                                            property NODEJS_4_3

                                                                                                                                                                            static readonly NODEJS_4_3: Runtime;
                                                                                                                                                                            • The NodeJS 4.3 runtime (nodejs4.3)

                                                                                                                                                                              Deprecated

                                                                                                                                                                              Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

                                                                                                                                                                            property NODEJS_6_10

                                                                                                                                                                            static readonly NODEJS_6_10: Runtime;
                                                                                                                                                                            • The NodeJS 6.10 runtime (nodejs6.10)

                                                                                                                                                                              Deprecated

                                                                                                                                                                              Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

                                                                                                                                                                            property NODEJS_8_10

                                                                                                                                                                            static readonly NODEJS_8_10: Runtime;
                                                                                                                                                                            • The NodeJS 8.10 runtime (nodejs8.10)

                                                                                                                                                                              Deprecated

                                                                                                                                                                              Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.

                                                                                                                                                                            property PROVIDED

                                                                                                                                                                            static readonly PROVIDED: Runtime;
                                                                                                                                                                            • The custom provided runtime (provided)

                                                                                                                                                                            property PROVIDED_AL2

                                                                                                                                                                            static readonly PROVIDED_AL2: Runtime;
                                                                                                                                                                            • The custom provided runtime (provided)

                                                                                                                                                                            property PYTHON_2_7

                                                                                                                                                                            static readonly PYTHON_2_7: Runtime;
                                                                                                                                                                            • The Python 2.7 runtime (python2.7)

                                                                                                                                                                              Deprecated

                                                                                                                                                                              Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.

                                                                                                                                                                            property PYTHON_3_6

                                                                                                                                                                            static readonly PYTHON_3_6: Runtime;
                                                                                                                                                                            • The Python 3.6 runtime (python3.6) (not recommended)

                                                                                                                                                                              The Python 3.6 runtime is deprecated as of July 2022.

                                                                                                                                                                              Deprecated

                                                                                                                                                                              Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.

                                                                                                                                                                            property PYTHON_3_7

                                                                                                                                                                            static readonly PYTHON_3_7: Runtime;
                                                                                                                                                                            • The Python 3.7 runtime (python3.7)

                                                                                                                                                                            property PYTHON_3_8

                                                                                                                                                                            static readonly PYTHON_3_8: Runtime;
                                                                                                                                                                            • The Python 3.8 runtime (python3.8)

                                                                                                                                                                            property PYTHON_3_9

                                                                                                                                                                            static readonly PYTHON_3_9: Runtime;
                                                                                                                                                                            • The Python 3.9 runtime (python3.9)

                                                                                                                                                                            property RUBY_2_5

                                                                                                                                                                            static readonly RUBY_2_5: Runtime;
                                                                                                                                                                            • The Ruby 2.5 runtime (ruby2.5) Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Ruby runtime.

                                                                                                                                                                            property RUBY_2_7

                                                                                                                                                                            static readonly RUBY_2_7: Runtime;
                                                                                                                                                                            • The Ruby 2.7 runtime (ruby2.7)

                                                                                                                                                                            property supportsCodeGuruProfiling

                                                                                                                                                                            readonly supportsCodeGuruProfiling: boolean;
                                                                                                                                                                            • Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler.

                                                                                                                                                                            property supportsInlineCode

                                                                                                                                                                            readonly supportsInlineCode: boolean;
                                                                                                                                                                            • Whether the ``ZipFile`` (aka inline code) property can be used with this runtime.

                                                                                                                                                                            method runtimeEquals

                                                                                                                                                                            runtimeEquals: (other: Runtime) => boolean;

                                                                                                                                                                              method toString

                                                                                                                                                                              toString: () => string;

                                                                                                                                                                                class S3Code

                                                                                                                                                                                class S3Code extends Code {}
                                                                                                                                                                                • Lambda code from an S3 archive.

                                                                                                                                                                                constructor

                                                                                                                                                                                constructor(bucket: s3.IBucket, key: string, objectVersion?: string);

                                                                                                                                                                                  property isInline

                                                                                                                                                                                  readonly isInline: boolean;

                                                                                                                                                                                    method bind

                                                                                                                                                                                    bind: (_scope: Construct) => CodeConfig;

                                                                                                                                                                                      class SingletonFunction

                                                                                                                                                                                      class SingletonFunction extends FunctionBase {}
                                                                                                                                                                                      • A Lambda that will only ever be added to a stack once.

                                                                                                                                                                                        This construct is a way to guarantee that the lambda function will be guaranteed to be part of the stack, once and only once, irrespective of how many times the construct is declared to be part of the stack. This is guaranteed as long as the uuid property and the optional lambdaPurpose property stay the same whenever they're declared into the stack.

                                                                                                                                                                                        AWS::Lambda::Function

                                                                                                                                                                                      constructor

                                                                                                                                                                                      constructor(scope: Construct, id: string, props: SingletonFunctionProps);

                                                                                                                                                                                        property architecture

                                                                                                                                                                                        readonly architecture: Architecture;

                                                                                                                                                                                          property canCreatePermissions

                                                                                                                                                                                          protected readonly canCreatePermissions: boolean;

                                                                                                                                                                                            property connections

                                                                                                                                                                                            readonly connections: ec2.Connections;

                                                                                                                                                                                            property currentVersion

                                                                                                                                                                                            readonly currentVersion: Version;
                                                                                                                                                                                            • Returns a lambda.Version which represents the current version of this singleton 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.SingletonFunction.

                                                                                                                                                                                            property functionArn

                                                                                                                                                                                            readonly functionArn: string;

                                                                                                                                                                                              property functionName

                                                                                                                                                                                              readonly functionName: string;

                                                                                                                                                                                                property grantPrincipal

                                                                                                                                                                                                readonly grantPrincipal: iam.IPrincipal;

                                                                                                                                                                                                  property isBoundToVpc

                                                                                                                                                                                                  readonly isBoundToVpc: boolean;

                                                                                                                                                                                                  property logGroup

                                                                                                                                                                                                  readonly logGroup: logs.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.

                                                                                                                                                                                                  property permissionsNode

                                                                                                                                                                                                  readonly permissionsNode: cdk.ConstructNode;

                                                                                                                                                                                                    property resourceArnsForGrantInvoke

                                                                                                                                                                                                    readonly resourceArnsForGrantInvoke: string[];

                                                                                                                                                                                                      property role

                                                                                                                                                                                                      readonly role?: iam.IRole;

                                                                                                                                                                                                        property runtime

                                                                                                                                                                                                        readonly runtime: Runtime;
                                                                                                                                                                                                        • The runtime environment for the Lambda function.

                                                                                                                                                                                                        method addDependency

                                                                                                                                                                                                        addDependency: (...up: cdk.IDependable[]) => void;
                                                                                                                                                                                                        • Using node.addDependency() does not work on this method as the underlying lambda function is modeled as a singleton across the stack. Use this method instead to declare dependencies.

                                                                                                                                                                                                        method addEnvironment

                                                                                                                                                                                                        addEnvironment: (
                                                                                                                                                                                                        key: string,
                                                                                                                                                                                                        value: string,
                                                                                                                                                                                                        options?: EnvironmentOptions
                                                                                                                                                                                                        ) => LambdaFunction;
                                                                                                                                                                                                        • Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op.

                                                                                                                                                                                                          Parameter key

                                                                                                                                                                                                          The environment variable key.

                                                                                                                                                                                                          Parameter value

                                                                                                                                                                                                          The environment variable's value.

                                                                                                                                                                                                          Parameter options

                                                                                                                                                                                                          Environment variable options.

                                                                                                                                                                                                        method addLayers

                                                                                                                                                                                                        addLayers: (...layers: ILayerVersion[]) => void;
                                                                                                                                                                                                        • Adds one or more Lambda Layers to this Lambda function.

                                                                                                                                                                                                          Parameter layers

                                                                                                                                                                                                          the layers to be added.

                                                                                                                                                                                                          Throws

                                                                                                                                                                                                          if there are already 5 layers on this function, or the layer is incompatible with this function's runtime.

                                                                                                                                                                                                        method addPermission

                                                                                                                                                                                                        addPermission: (name: string, permission: Permission) => void;

                                                                                                                                                                                                          method dependOn

                                                                                                                                                                                                          dependOn: (down: cdk.IConstruct) => void;
                                                                                                                                                                                                          • The SingletonFunction construct cannot be added as a dependency of another construct using node.addDependency(). Use this method instead to declare this as a dependency of another construct.

                                                                                                                                                                                                          class SourceAccessConfigurationType

                                                                                                                                                                                                          class SourceAccessConfigurationType {}
                                                                                                                                                                                                          • The type of authentication protocol or the VPC components for your event source's SourceAccessConfiguration

                                                                                                                                                                                                            See Also

                                                                                                                                                                                                            • https://docs.aws.amazon.com/lambda/latest/dg/API_SourceAccessConfiguration.html#SSS-Type-SourceAccessConfiguration-Type

                                                                                                                                                                                                          property BASIC_AUTH

                                                                                                                                                                                                          static readonly BASIC_AUTH: SourceAccessConfigurationType;
                                                                                                                                                                                                          • (MQ) The Secrets Manager secret that stores your broker credentials.

                                                                                                                                                                                                          property CLIENT_CERTIFICATE_TLS_AUTH

                                                                                                                                                                                                          static readonly CLIENT_CERTIFICATE_TLS_AUTH: SourceAccessConfigurationType;
                                                                                                                                                                                                          • The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.

                                                                                                                                                                                                          property SASL_SCRAM_256_AUTH

                                                                                                                                                                                                          static readonly SASL_SCRAM_256_AUTH: SourceAccessConfigurationType;
                                                                                                                                                                                                          • The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your Self-Managed Apache Kafka brokers.

                                                                                                                                                                                                          property SASL_SCRAM_512_AUTH

                                                                                                                                                                                                          static readonly SASL_SCRAM_512_AUTH: SourceAccessConfigurationType;
                                                                                                                                                                                                          • The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers.

                                                                                                                                                                                                          property type

                                                                                                                                                                                                          readonly type: string;
                                                                                                                                                                                                          • The key to use in SourceAccessConfigurationProperty.Type property in CloudFormation

                                                                                                                                                                                                            See Also

                                                                                                                                                                                                            • https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html#cfn-lambda-eventsourcemapping-sourceaccessconfiguration-type

                                                                                                                                                                                                          property VPC_SECURITY_GROUP

                                                                                                                                                                                                          static readonly VPC_SECURITY_GROUP: SourceAccessConfigurationType;
                                                                                                                                                                                                          • The VPC security group used to manage access to your Self-Managed Apache Kafka brokers.

                                                                                                                                                                                                          property VPC_SUBNET

                                                                                                                                                                                                          static readonly VPC_SUBNET: SourceAccessConfigurationType;
                                                                                                                                                                                                          • The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your Self-Managed Apache Kafka cluster.

                                                                                                                                                                                                          method of

                                                                                                                                                                                                          static of: (name: string) => SourceAccessConfigurationType;
                                                                                                                                                                                                          • A custom source access configuration property

                                                                                                                                                                                                          class Version

                                                                                                                                                                                                          class Version extends QualifiedFunctionBase implements IVersion {}
                                                                                                                                                                                                          • Tag the current state of a Function with a Version number

                                                                                                                                                                                                            Avoid using this resource directly. If you need a Version object, use function.currentVersion instead. That will add a Version object to your template, and make sure the Version is invalidated whenever the Function object changes. If you use the Version resource directly, you are responsible for making sure it is invalidated (by changing its logical ID) whenever necessary.

                                                                                                                                                                                                            Version resources can then be used in Alias resources to refer to a particular deployment of a Lambda.

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

                                                                                                                                                                                                          constructor

                                                                                                                                                                                                          constructor(scope: Construct, id: string, props: VersionProps);

                                                                                                                                                                                                            property architecture

                                                                                                                                                                                                            readonly architecture: Architecture;

                                                                                                                                                                                                              property canCreatePermissions

                                                                                                                                                                                                              protected readonly canCreatePermissions: boolean;

                                                                                                                                                                                                                property edgeArn

                                                                                                                                                                                                                readonly edgeArn: string;

                                                                                                                                                                                                                  property functionArn

                                                                                                                                                                                                                  readonly functionArn: string;

                                                                                                                                                                                                                    property functionName

                                                                                                                                                                                                                    readonly functionName: string;

                                                                                                                                                                                                                      property grantPrincipal

                                                                                                                                                                                                                      readonly grantPrincipal: any;

                                                                                                                                                                                                                        property lambda

                                                                                                                                                                                                                        readonly lambda: IFunction;

                                                                                                                                                                                                                          property qualifier

                                                                                                                                                                                                                          protected readonly qualifier: string;

                                                                                                                                                                                                                            property role

                                                                                                                                                                                                                            readonly role: any;

                                                                                                                                                                                                                              property version

                                                                                                                                                                                                                              readonly version: string;

                                                                                                                                                                                                                                method addAlias

                                                                                                                                                                                                                                addAlias: (aliasName: string, options?: AliasOptions) => Alias;
                                                                                                                                                                                                                                • Defines an alias for this version.

                                                                                                                                                                                                                                  Parameter aliasName

                                                                                                                                                                                                                                  The name of the alias (e.g. "live")

                                                                                                                                                                                                                                  Parameter options

                                                                                                                                                                                                                                  Alias options

                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                  Calling addAlias on a Version object will cause the Alias to be replaced on every function update. Call function.addAlias() or new Alias() instead.

                                                                                                                                                                                                                                method fromVersionArn

                                                                                                                                                                                                                                static fromVersionArn: (
                                                                                                                                                                                                                                scope: Construct,
                                                                                                                                                                                                                                id: string,
                                                                                                                                                                                                                                versionArn: string
                                                                                                                                                                                                                                ) => IVersion;
                                                                                                                                                                                                                                • Construct a Version object from a Version ARN.

                                                                                                                                                                                                                                  Parameter scope

                                                                                                                                                                                                                                  The cdk scope creating this resource

                                                                                                                                                                                                                                  Parameter id

                                                                                                                                                                                                                                  The cdk id of this resource

                                                                                                                                                                                                                                  Parameter versionArn

                                                                                                                                                                                                                                  The version ARN to create this version from

                                                                                                                                                                                                                                method fromVersionAttributes

                                                                                                                                                                                                                                static fromVersionAttributes: (
                                                                                                                                                                                                                                scope: Construct,
                                                                                                                                                                                                                                id: string,
                                                                                                                                                                                                                                attrs: VersionAttributes
                                                                                                                                                                                                                                ) => IVersion;

                                                                                                                                                                                                                                  method metric

                                                                                                                                                                                                                                  metric: (
                                                                                                                                                                                                                                  metricName: string,
                                                                                                                                                                                                                                  props?: cloudwatch.MetricOptions
                                                                                                                                                                                                                                  ) => cloudwatch.Metric;

                                                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                                                    interface AliasAttributes

                                                                                                                                                                                                                                    interface AliasAttributes {}

                                                                                                                                                                                                                                      property aliasName

                                                                                                                                                                                                                                      readonly aliasName: string;

                                                                                                                                                                                                                                        property aliasVersion

                                                                                                                                                                                                                                        readonly aliasVersion: IVersion;

                                                                                                                                                                                                                                          interface AliasOptions

                                                                                                                                                                                                                                          interface AliasOptions extends EventInvokeConfigOptions {}
                                                                                                                                                                                                                                          • Options for lambda.Alias.

                                                                                                                                                                                                                                          property additionalVersions

                                                                                                                                                                                                                                          readonly additionalVersions?: 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

                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                            No additional versions

                                                                                                                                                                                                                                          property description

                                                                                                                                                                                                                                          readonly description?: string;
                                                                                                                                                                                                                                          • Description for the alias

                                                                                                                                                                                                                                            No description

                                                                                                                                                                                                                                          property provisionedConcurrentExecutions

                                                                                                                                                                                                                                          readonly provisionedConcurrentExecutions?: number;
                                                                                                                                                                                                                                          • Specifies a provisioned concurrency configuration for a function's alias.

                                                                                                                                                                                                                                            No provisioned concurrency

                                                                                                                                                                                                                                          interface AliasProps

                                                                                                                                                                                                                                          interface AliasProps extends AliasOptions {}
                                                                                                                                                                                                                                          • Properties for a new Lambda alias

                                                                                                                                                                                                                                          property aliasName

                                                                                                                                                                                                                                          readonly aliasName: string;
                                                                                                                                                                                                                                          • Name of this alias

                                                                                                                                                                                                                                          property version

                                                                                                                                                                                                                                          readonly version: IVersion;
                                                                                                                                                                                                                                          • Function version this alias refers to

                                                                                                                                                                                                                                            Use lambda.currentVersion to reference a version with your latest changes.

                                                                                                                                                                                                                                          interface AssetImageCodeProps

                                                                                                                                                                                                                                          interface AssetImageCodeProps extends ecr_assets.DockerImageAssetOptions {}
                                                                                                                                                                                                                                          • Properties to initialize a new AssetImage

                                                                                                                                                                                                                                          property cmd

                                                                                                                                                                                                                                          readonly cmd?: string[];
                                                                                                                                                                                                                                          • Specify or override the CMD on the specified Docker image or Dockerfile. This needs to be in the 'exec form', viz., [ 'executable', 'param1', 'param2' ].

                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                            • https://docs.docker.com/engine/reference/builder/#cmd - use the CMD specified in the docker image or Dockerfile.

                                                                                                                                                                                                                                          property entrypoint

                                                                                                                                                                                                                                          readonly entrypoint?: string[];
                                                                                                                                                                                                                                          • Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile. An ENTRYPOINT allows you to configure a container that will run as an executable. This needs to be in the 'exec form', viz., [ 'executable', 'param1', 'param2' ].

                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                            • https://docs.docker.com/engine/reference/builder/#entrypoint - use the ENTRYPOINT in the docker image or Dockerfile.

                                                                                                                                                                                                                                          property workingDirectory

                                                                                                                                                                                                                                          readonly workingDirectory?: string;
                                                                                                                                                                                                                                          • Specify or override the WORKDIR on the specified Docker image or Dockerfile. A WORKDIR allows you to configure the working directory the container will use.

                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                            • https://docs.docker.com/engine/reference/builder/#workdir - use the WORKDIR in the docker image or Dockerfile.

                                                                                                                                                                                                                                          interface AutoScalingOptions

                                                                                                                                                                                                                                          interface AutoScalingOptions {}
                                                                                                                                                                                                                                          • Properties for enabling Lambda autoscaling

                                                                                                                                                                                                                                          property maxCapacity

                                                                                                                                                                                                                                          readonly maxCapacity: number;
                                                                                                                                                                                                                                          • Maximum capacity to scale to

                                                                                                                                                                                                                                          property minCapacity

                                                                                                                                                                                                                                          readonly minCapacity?: number;
                                                                                                                                                                                                                                          • Minimum capacity to scale to

                                                                                                                                                                                                                                            1

                                                                                                                                                                                                                                          interface CfnAliasProps

                                                                                                                                                                                                                                          interface CfnAliasProps {}
                                                                                                                                                                                                                                          • Properties for defining a CfnAlias

                                                                                                                                                                                                                                            external

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html

                                                                                                                                                                                                                                          property description

                                                                                                                                                                                                                                          readonly description?: string;
                                                                                                                                                                                                                                          • A description of the alias.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description

                                                                                                                                                                                                                                          property functionName

                                                                                                                                                                                                                                          readonly functionName: string;
                                                                                                                                                                                                                                          • The name of the Lambda function.

                                                                                                                                                                                                                                            **Name formats** - *Function name* - MyFunction . - *Function ARN* - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . - *Partial ARN* - 123456789012:function:MyFunction .

                                                                                                                                                                                                                                            The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname

                                                                                                                                                                                                                                          property functionVersion

                                                                                                                                                                                                                                          readonly functionVersion: string;
                                                                                                                                                                                                                                          • The function version that the alias invokes.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion

                                                                                                                                                                                                                                          property name

                                                                                                                                                                                                                                          readonly name: string;
                                                                                                                                                                                                                                          • The name of the alias.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name

                                                                                                                                                                                                                                          property provisionedConcurrencyConfig

                                                                                                                                                                                                                                          readonly provisionedConcurrencyConfig?:
                                                                                                                                                                                                                                          | CfnAlias.ProvisionedConcurrencyConfigurationProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig

                                                                                                                                                                                                                                          property routingConfig

                                                                                                                                                                                                                                          readonly routingConfig?:
                                                                                                                                                                                                                                          | CfnAlias.AliasRoutingConfigurationProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig

                                                                                                                                                                                                                                          interface CfnCodeSigningConfigProps

                                                                                                                                                                                                                                          interface CfnCodeSigningConfigProps {}
                                                                                                                                                                                                                                          • Properties for defining a CfnCodeSigningConfig

                                                                                                                                                                                                                                            external

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html

                                                                                                                                                                                                                                          property allowedPublishers

                                                                                                                                                                                                                                          readonly allowedPublishers:
                                                                                                                                                                                                                                          | CfnCodeSigningConfig.AllowedPublishersProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • List of allowed publishers.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-allowedpublishers

                                                                                                                                                                                                                                          property codeSigningPolicies

                                                                                                                                                                                                                                          readonly codeSigningPolicies?:
                                                                                                                                                                                                                                          | CfnCodeSigningConfig.CodeSigningPoliciesProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • The code signing policy controls the validation failure action for signature mismatch or expiry.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-codesigningpolicies

                                                                                                                                                                                                                                          property description

                                                                                                                                                                                                                                          readonly description?: string;
                                                                                                                                                                                                                                          • Code signing configuration description.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-description

                                                                                                                                                                                                                                          interface CfnEventInvokeConfigProps

                                                                                                                                                                                                                                          interface CfnEventInvokeConfigProps {}
                                                                                                                                                                                                                                          • Properties for defining a CfnEventInvokeConfig

                                                                                                                                                                                                                                            external

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html

                                                                                                                                                                                                                                          property destinationConfig

                                                                                                                                                                                                                                          readonly destinationConfig?:
                                                                                                                                                                                                                                          | CfnEventInvokeConfig.DestinationConfigProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • A destination for events after they have been sent to a function for processing.

                                                                                                                                                                                                                                            **Destinations** - *Function* - The Amazon Resource Name (ARN) of a Lambda function. - *Queue* - The ARN of an SQS queue. - *Topic* - The ARN of an SNS topic. - *Event Bus* - The ARN of an Amazon EventBridge event bus.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig

                                                                                                                                                                                                                                          property functionName

                                                                                                                                                                                                                                          readonly functionName: string;
                                                                                                                                                                                                                                          • The name of the Lambda function.

                                                                                                                                                                                                                                            *Minimum* : 1

                                                                                                                                                                                                                                            *Maximum* : 64

                                                                                                                                                                                                                                            *Pattern* : ([a-zA-Z0-9-_]+)

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname

                                                                                                                                                                                                                                          property maximumEventAgeInSeconds

                                                                                                                                                                                                                                          readonly maximumEventAgeInSeconds?: number;
                                                                                                                                                                                                                                          • The maximum age of a request that Lambda sends to a function for processing.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds

                                                                                                                                                                                                                                          property maximumRetryAttempts

                                                                                                                                                                                                                                          readonly maximumRetryAttempts?: number;
                                                                                                                                                                                                                                          • The maximum number of times to retry when the function returns an error.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts

                                                                                                                                                                                                                                          property qualifier

                                                                                                                                                                                                                                          readonly qualifier: string;
                                                                                                                                                                                                                                          • The identifier of a version or alias.

                                                                                                                                                                                                                                            - *Version* - A version number. - *Alias* - An alias name. - *Latest* - To specify the unpublished version, use $LATEST .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier

                                                                                                                                                                                                                                          interface CfnEventSourceMappingProps

                                                                                                                                                                                                                                          interface CfnEventSourceMappingProps {}
                                                                                                                                                                                                                                          • Properties for defining a CfnEventSourceMapping

                                                                                                                                                                                                                                            external

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html

                                                                                                                                                                                                                                          property amazonManagedKafkaEventSourceConfig

                                                                                                                                                                                                                                          readonly amazonManagedKafkaEventSourceConfig?:
                                                                                                                                                                                                                                          | CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • AWS::Lambda::EventSourceMapping.AmazonManagedKafkaEventSourceConfig

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig

                                                                                                                                                                                                                                          property batchSize

                                                                                                                                                                                                                                          readonly batchSize?: number;
                                                                                                                                                                                                                                          • The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

                                                                                                                                                                                                                                            - *Amazon Kinesis* - Default 100. Max 10,000. - *Amazon DynamoDB Streams* - Default 100. Max 10,000. - *Amazon Simple Queue Service* - Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10. - *Amazon Managed Streaming for Apache Kafka* - Default 100. Max 10,000. - *Self-Managed Apache Kafka* - Default 100. Max 10,000. - *Amazon MQ (ActiveMQ and RabbitMQ)* - Default 100. Max 10,000.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize

                                                                                                                                                                                                                                          property bisectBatchOnFunctionError

                                                                                                                                                                                                                                          readonly bisectBatchOnFunctionError?: boolean | cdk.IResolvable;
                                                                                                                                                                                                                                          • (Streams only) If the function returns an error, split the batch in two and retry. The default value is false.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror

                                                                                                                                                                                                                                          property destinationConfig

                                                                                                                                                                                                                                          readonly destinationConfig?:
                                                                                                                                                                                                                                          | CfnEventSourceMapping.DestinationConfigProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • (Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig

                                                                                                                                                                                                                                          property enabled

                                                                                                                                                                                                                                          readonly enabled?: boolean | cdk.IResolvable;
                                                                                                                                                                                                                                          • When true, the event source mapping is active. When false, Lambda pauses polling and invocation.

                                                                                                                                                                                                                                            Default: True

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled

                                                                                                                                                                                                                                          property eventSourceArn

                                                                                                                                                                                                                                          readonly eventSourceArn?: string;
                                                                                                                                                                                                                                          • The Amazon Resource Name (ARN) of the event source.

                                                                                                                                                                                                                                            - *Amazon Kinesis* - The ARN of the data stream or a stream consumer. - *Amazon DynamoDB Streams* - The ARN of the stream. - *Amazon Simple Queue Service* - The ARN of the queue. - *Amazon Managed Streaming for Apache Kafka* - The ARN of the cluster.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn

                                                                                                                                                                                                                                          property filterCriteria

                                                                                                                                                                                                                                          readonly filterCriteria?:
                                                                                                                                                                                                                                          | CfnEventSourceMapping.FilterCriteriaProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • (Streams and Amazon SQS) An object that defines the filter criteria that determine whether Lambda should process an event. For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria

                                                                                                                                                                                                                                          property functionName

                                                                                                                                                                                                                                          readonly functionName: string;
                                                                                                                                                                                                                                          • The name of the Lambda function.

                                                                                                                                                                                                                                            **Name formats** - *Function name* - MyFunction . - *Function ARN* - arn:aws:lambda:us-west-2:123456789012:function:MyFunction . - *Version or Alias ARN* - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD . - *Partial ARN* - 123456789012:function:MyFunction .

                                                                                                                                                                                                                                            The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname

                                                                                                                                                                                                                                          property functionResponseTypes

                                                                                                                                                                                                                                          readonly functionResponseTypes?: string[];
                                                                                                                                                                                                                                          • (Streams and SQS) A list of current response type enums applied to the event source mapping.

                                                                                                                                                                                                                                            Valid Values: ReportBatchItemFailures

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes

                                                                                                                                                                                                                                          property maximumBatchingWindowInSeconds

                                                                                                                                                                                                                                          readonly maximumBatchingWindowInSeconds?: number;
                                                                                                                                                                                                                                          • The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function.

                                                                                                                                                                                                                                            *Default ( Kinesis , DynamoDB , Amazon SQS event sources)* : 0

                                                                                                                                                                                                                                            *Default ( Amazon MSK , Kafka, Amazon MQ event sources)* : 500 ms

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds

                                                                                                                                                                                                                                          property maximumRecordAgeInSeconds

                                                                                                                                                                                                                                          readonly maximumRecordAgeInSeconds?: number;
                                                                                                                                                                                                                                          • (Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds

                                                                                                                                                                                                                                          property maximumRetryAttempts

                                                                                                                                                                                                                                          readonly maximumRetryAttempts?: number;
                                                                                                                                                                                                                                          • (Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts

                                                                                                                                                                                                                                          property parallelizationFactor

                                                                                                                                                                                                                                          readonly parallelizationFactor?: number;
                                                                                                                                                                                                                                          • (Streams only) The number of batches to process concurrently from each shard. The default value is 1.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor

                                                                                                                                                                                                                                          property queues

                                                                                                                                                                                                                                          readonly queues?: string[];
                                                                                                                                                                                                                                          • (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues

                                                                                                                                                                                                                                          property selfManagedEventSource

                                                                                                                                                                                                                                          readonly selfManagedEventSource?:
                                                                                                                                                                                                                                          | CfnEventSourceMapping.SelfManagedEventSourceProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • The self-managed Apache Kafka cluster for your event source.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource

                                                                                                                                                                                                                                          property selfManagedKafkaEventSourceConfig

                                                                                                                                                                                                                                          readonly selfManagedKafkaEventSourceConfig?:
                                                                                                                                                                                                                                          | CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • AWS::Lambda::EventSourceMapping.SelfManagedKafkaEventSourceConfig

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig

                                                                                                                                                                                                                                          property sourceAccessConfigurations

                                                                                                                                                                                                                                          readonly sourceAccessConfigurations?:
                                                                                                                                                                                                                                          | Array<
                                                                                                                                                                                                                                          | CfnEventSourceMapping.SourceAccessConfigurationProperty
                                                                                                                                                                                                                                          | cdk.IResolvable
                                                                                                                                                                                                                                          >
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations

                                                                                                                                                                                                                                          property startingPosition

                                                                                                                                                                                                                                          readonly startingPosition?: string;
                                                                                                                                                                                                                                          • The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB.

                                                                                                                                                                                                                                            - *LATEST* - Read only new records. - *TRIM_HORIZON* - Process all available records. - *AT_TIMESTAMP* - Specify a time from which to start reading records.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition

                                                                                                                                                                                                                                          property startingPositionTimestamp

                                                                                                                                                                                                                                          readonly startingPositionTimestamp?: number;
                                                                                                                                                                                                                                          • With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp

                                                                                                                                                                                                                                          property topics

                                                                                                                                                                                                                                          readonly topics?: string[];
                                                                                                                                                                                                                                          • The name of the Kafka topic.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics

                                                                                                                                                                                                                                          property tumblingWindowInSeconds

                                                                                                                                                                                                                                          readonly tumblingWindowInSeconds?: number;
                                                                                                                                                                                                                                          • (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds

                                                                                                                                                                                                                                          interface CfnFunctionProps

                                                                                                                                                                                                                                          interface CfnFunctionProps {}
                                                                                                                                                                                                                                          • Properties for defining a CfnFunction

                                                                                                                                                                                                                                            external

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html

                                                                                                                                                                                                                                          property architectures

                                                                                                                                                                                                                                          readonly architectures?: string[];
                                                                                                                                                                                                                                          • The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64 .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures

                                                                                                                                                                                                                                          property code

                                                                                                                                                                                                                                          readonly code: CfnFunction.CodeProperty | cdk.IResolvable;
                                                                                                                                                                                                                                          • The code for the function.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code

                                                                                                                                                                                                                                          property codeSigningConfigArn

                                                                                                                                                                                                                                          readonly codeSigningConfigArn?: string;
                                                                                                                                                                                                                                          • To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn

                                                                                                                                                                                                                                          property deadLetterConfig

                                                                                                                                                                                                                                          readonly deadLetterConfig?:
                                                                                                                                                                                                                                          | CfnFunction.DeadLetterConfigProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead Letter Queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig

                                                                                                                                                                                                                                          property description

                                                                                                                                                                                                                                          readonly description?: string;
                                                                                                                                                                                                                                          • A description of the function.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description

                                                                                                                                                                                                                                          property environment

                                                                                                                                                                                                                                          readonly environment?: CfnFunction.EnvironmentProperty | cdk.IResolvable;
                                                                                                                                                                                                                                          • Environment variables that are accessible from function code during execution.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment

                                                                                                                                                                                                                                          property ephemeralStorage

                                                                                                                                                                                                                                          readonly ephemeralStorage?:
                                                                                                                                                                                                                                          | CfnFunction.EphemeralStorageProperty
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • The size of the function’s /tmp directory in MB. The default value is 512, but can be any whole number between 512 and 10240 MB.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage

                                                                                                                                                                                                                                          property fileSystemConfigs

                                                                                                                                                                                                                                          readonly fileSystemConfigs?:
                                                                                                                                                                                                                                          | Array<CfnFunction.FileSystemConfigProperty | cdk.IResolvable>
                                                                                                                                                                                                                                          | cdk.IResolvable;
                                                                                                                                                                                                                                          • Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a DependsOn attribute to ensure that the mount target is created or updated before the function.

                                                                                                                                                                                                                                            For more information about using the DependsOn attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs

                                                                                                                                                                                                                                          property functionName

                                                                                                                                                                                                                                          readonly functionName?: string;
                                                                                                                                                                                                                                          • The name of the Lambda function, up to 64 characters in length. If you don't specify a name, AWS CloudFormation generates one.

                                                                                                                                                                                                                                            If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname

                                                                                                                                                                                                                                          property handler

                                                                                                                                                                                                                                          readonly handler?: string;
                                                                                                                                                                                                                                          • The name of the method within your code that Lambda calls to execute your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Programming Model](https://docs.aws.amazon.com/lambda/latest/dg/programming-model-v2.html) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler

                                                                                                                                                                                                                                          property imageConfig

                                                                                                                                                                                                                                          readonly imageConfig?: CfnFunction.ImageConfigProperty | cdk.IResolvable;
                                                                                                                                                                                                                                          • Configuration values that override the container image Dockerfile settings. See [Container settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig

                                                                                                                                                                                                                                          property kmsKeyArn

                                                                                                                                                                                                                                          readonly kmsKeyArn?: string;
                                                                                                                                                                                                                                          • The ARN of the AWS Key Management Service ( AWS KMS ) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn

                                                                                                                                                                                                                                          property layers

                                                                                                                                                                                                                                          readonly layers?: string[];
                                                                                                                                                                                                                                          • A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers

                                                                                                                                                                                                                                          property memorySize

                                                                                                                                                                                                                                          readonly memorySize?: number;
                                                                                                                                                                                                                                          • The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize

                                                                                                                                                                                                                                          property packageType

                                                                                                                                                                                                                                          readonly packageType?: string;
                                                                                                                                                                                                                                          • The type of deployment package. Set to Image for container image and set Zip for .zip file archive.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype

                                                                                                                                                                                                                                          property reservedConcurrentExecutions

                                                                                                                                                                                                                                          readonly reservedConcurrentExecutions?: number;
                                                                                                                                                                                                                                          • The number of simultaneous executions to reserve for the function.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions

                                                                                                                                                                                                                                          property role

                                                                                                                                                                                                                                          readonly role: string;
                                                                                                                                                                                                                                          • The Amazon Resource Name (ARN) of the function's execution role.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role

                                                                                                                                                                                                                                          property runtime

                                                                                                                                                                                                                                          readonly runtime?: string;
                                                                                                                                                                                                                                          • The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Runtime is required if the deployment package is a .zip file archive.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime

                                                                                                                                                                                                                                          property tags

                                                                                                                                                                                                                                          readonly tags?: cdk.CfnTag[];
                                                                                                                                                                                                                                          • A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags

                                                                                                                                                                                                                                          property timeout

                                                                                                                                                                                                                                          readonly timeout?: number;
                                                                                                                                                                                                                                          • The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout

                                                                                                                                                                                                                                          property tracingConfig

                                                                                                                                                                                                                                          readonly tracingConfig?: CfnFunction.TracingConfigProperty | cdk.IResolvable;
                                                                                                                                                                                                                                          • Set Mode to Active to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig

                                                                                                                                                                                                                                          property vpcConfig

                                                                                                                                                                                                                                          readonly vpcConfig?: CfnFunction.VpcConfigProperty | cdk.IResolvable;
                                                                                                                                                                                                                                          • For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig

                                                                                                                                                                                                                                          interface CfnLayerVersionPermissionProps

                                                                                                                                                                                                                                          interface CfnLayerVersionPermissionProps {}
                                                                                                                                                                                                                                          • Properties for defining a CfnLayerVersionPermission

                                                                                                                                                                                                                                            external

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html

                                                                                                                                                                                                                                          property action

                                                                                                                                                                                                                                          readonly action: string;
                                                                                                                                                                                                                                          • The API action that grants access to the layer. For example, lambda:GetLayerVersion .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-action

                                                                                                                                                                                                                                          property layerVersionArn

                                                                                                                                                                                                                                          readonly layerVersionArn: string;
                                                                                                                                                                                                                                          • The name or Amazon Resource Name (ARN) of the layer.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-layerversionarn

                                                                                                                                                                                                                                          property organizationId

                                                                                                                                                                                                                                          readonly organizationId?: string;
                                                                                                                                                                                                                                          • With the principal set to * , grant permission to all accounts in the specified organization.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-organizationid

                                                                                                                                                                                                                                          property principal

                                                                                                                                                                                                                                          readonly principal: string;
                                                                                                                                                                                                                                          • An account ID, or * to grant layer usage permission to all accounts in an organization, or all AWS accounts (if organizationId is not specified). For the last case, make sure that you really do want all AWS accounts to have usage permission to this layer.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-principal

                                                                                                                                                                                                                                          interface CfnLayerVersionProps

                                                                                                                                                                                                                                          interface CfnLayerVersionProps {}
                                                                                                                                                                                                                                          • Properties for defining a CfnLayerVersion

                                                                                                                                                                                                                                            external

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html

                                                                                                                                                                                                                                          property compatibleArchitectures

                                                                                                                                                                                                                                          readonly compatibleArchitectures?: string[];
                                                                                                                                                                                                                                          • A list of compatible [instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatiblearchitectures

                                                                                                                                                                                                                                          property compatibleRuntimes

                                                                                                                                                                                                                                          readonly compatibleRuntimes?: string[];
                                                                                                                                                                                                                                          • A list of compatible [function runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Used for filtering with [ListLayers](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayers.html) and [ListLayerVersions](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayerVersions.html) .

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes

                                                                                                                                                                                                                                          property content

                                                                                                                                                                                                                                          readonly content: CfnLayerVersion.ContentProperty | cdk.IResolvable;
                                                                                                                                                                                                                                          • The function layer archive.

                                                                                                                                                                                                                                            http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content

                                                                                                                                                                                                                                          property description