{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-applicationautoscaling": "1.61.0", "@aws-cdk/aws-cloudwatch": "1.61.0", "@aws-cdk/aws-codeguruprofiler": "1.61.0", "@aws-cdk/aws-ec2": "1.61.0", "@aws-cdk/aws-efs": "1.61.0", "@aws-cdk/aws-events": "1.61.0", "@aws-cdk/aws-iam": "1.61.0", "@aws-cdk/aws-logs": "1.61.0", "@aws-cdk/aws-s3": "1.61.0", "@aws-cdk/aws-s3-assets": "1.61.0", "@aws-cdk/aws-sqs": "1.61.0", "@aws-cdk/core": "1.61.0", "@aws-cdk/cx-api": "1.61.0", "constructs": "^3.0.4" }, "dependencyClosure": { "@aws-cdk/assets": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.Assets", "packageId": "Amazon.CDK.Assets", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.assets" }, "js": { "npm": "@aws-cdk/assets" }, "python": { "distName": "aws-cdk.assets", "module": "aws_cdk.assets" } } }, "@aws-cdk/aws-applicationautoscaling": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling", "packageId": "Amazon.CDK.AWS.ApplicationAutoScaling", "signAssembly": true }, "java": { "maven": { "artifactId": "applicationautoscaling", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.applicationautoscaling" }, "js": { "npm": "@aws-cdk/aws-applicationautoscaling" }, "python": { "distName": "aws-cdk.aws-applicationautoscaling", "module": "aws_cdk.aws_applicationautoscaling" } } }, "@aws-cdk/aws-autoscaling-common": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.AutoScaling.Common", "packageId": "Amazon.CDK.AWS.AutoScaling.Common", "signAssembly": true }, "java": { "maven": { "artifactId": "autoscaling-common", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.autoscaling.common" }, "js": { "npm": "@aws-cdk/aws-autoscaling-common" }, "python": { "distName": "aws-cdk.aws-autoscaling-common", "module": "aws_cdk.aws_autoscaling_common" } } }, "@aws-cdk/aws-cloudwatch": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudWatch", "packageId": "Amazon.CDK.AWS.CloudWatch", "signAssembly": true }, "java": { "maven": { "artifactId": "cloudwatch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudwatch" }, "js": { "npm": "@aws-cdk/aws-cloudwatch" }, "python": { "distName": "aws-cdk.aws-cloudwatch", "module": "aws_cdk.aws_cloudwatch" } } }, "@aws-cdk/aws-codeguruprofiler": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeGuruProfiler", "packageId": "Amazon.CDK.AWS.CodeGuruProfiler", "signAssembly": true }, "java": { "maven": { "artifactId": "codeguruprofiler", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codeguruprofiler" }, "js": { "npm": "@aws-cdk/aws-codeguruprofiler" }, "python": { "distName": "aws-cdk.aws-codeguruprofiler", "module": "aws_cdk.aws_codeguruprofiler" } } }, "@aws-cdk/aws-ec2": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EC2", "packageId": "Amazon.CDK.AWS.EC2", "signAssembly": true }, "java": { "maven": { "artifactId": "ec2", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ec2" }, "js": { "npm": "@aws-cdk/aws-ec2" }, "python": { "distName": "aws-cdk.aws-ec2", "module": "aws_cdk.aws_ec2" } } }, "@aws-cdk/aws-efs": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EFS", "packageId": "Amazon.CDK.AWS.EFS", "signAssembly": true }, "java": { "maven": { "artifactId": "efs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.efs" }, "js": { "npm": "@aws-cdk/aws-efs" }, "python": { "distName": "aws-cdk.aws-efs", "module": "aws_cdk.aws_efs" } } }, "@aws-cdk/aws-events": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events", "signAssembly": true }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } } }, "@aws-cdk/aws-iam": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM", "signAssembly": true }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS", "signAssembly": true }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/aws-logs": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Logs", "packageId": "Amazon.CDK.AWS.Logs", "signAssembly": true }, "java": { "maven": { "artifactId": "logs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.logs" }, "js": { "npm": "@aws-cdk/aws-logs" }, "python": { "distName": "aws-cdk.aws-logs", "module": "aws_cdk.aws_logs" } } }, "@aws-cdk/aws-s3": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3", "packageId": "Amazon.CDK.AWS.S3", "signAssembly": true }, "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" }, "python": { "distName": "aws-cdk.aws-s3", "module": "aws_cdk.aws_s3" } } }, "@aws-cdk/aws-s3-assets": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3.Assets", "packageId": "Amazon.CDK.AWS.S3.Assets", "signAssembly": true }, "java": { "maven": { "artifactId": "s3-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.assets" }, "js": { "npm": "@aws-cdk/aws-s3-assets" }, "python": { "distName": "aws-cdk.aws-s3-assets", "module": "aws_cdk.aws_s3_assets" } } }, "@aws-cdk/aws-sqs": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SQS", "packageId": "Amazon.CDK.AWS.SQS", "signAssembly": true }, "java": { "maven": { "artifactId": "sqs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sqs" }, "js": { "npm": "@aws-cdk/aws-sqs" }, "python": { "distName": "aws-cdk.aws-sqs", "module": "aws_cdk.aws_sqs" } } }, "@aws-cdk/aws-ssm": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SSM", "packageId": "Amazon.CDK.AWS.SSM", "signAssembly": true }, "java": { "maven": { "artifactId": "ssm", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ssm" }, "js": { "npm": "@aws-cdk/aws-ssm" }, "python": { "distName": "aws-cdk.aws-ssm", "module": "aws_cdk.aws_ssm" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK", "signAssembly": true }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo", "signAssembly": true }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "CDK Constructs for AWS Lambda", "docs": { "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.11.0 (build 1e9b8e1)", "keywords": [ "aws", "cdk", "constructs", "lambda" ], "license": "Apache-2.0", "name": "@aws-cdk/aws-lambda", "readme": { "markdown": "## AWS Lambda Construct Library\n\n---\n\n![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)\n\n![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)\n\n---\n\n\nThis construct library allows you to define AWS Lambda Functions.\n\n```ts\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as path from 'path';\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_10_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});\n```\n\n### Handler Code\n\nThe `lambda.Code` class includes static convenience methods for various types of\nruntime code.\n\n * `lambda.Code.fromBucket(bucket, key[, objectVersion])` - specify an S3 object\n that contains the archive of your runtime code.\n * `lambda.Code.fromInline(code)` - inline the handle code as a string. This is\n limited to supported runtimes and the code cannot exceed 4KiB.\n * `lambda.Code.fromAsset(path)` - specify a directory or a .zip file in the local\n filesystem which will be zipped and uploaded to S3 before deployment. See also\n [bundling asset code](#Bundling-Asset-Code).\n\nThe following example shows how to define a Python function and deploy the code\nfrom the local directory `my-lambda-handler` to it:\n\n```ts lit=test/integ.assets.lit.ts\nnew lambda.Function(this, 'MyLambda', {\n code: lambda.Code.fromAsset(path.join(__dirname, 'my-lambda-handler')),\n handler: 'index.main',\n runtime: lambda.Runtime.PYTHON_3_6,\n});\n```\n\nWhen deploying a stack that contains this code, the directory will be zip\narchived and then uploaded to an S3 bucket, then the exact location of the S3\nobjects will be passed when the stack is deployed.\n\nDuring synthesis, the CDK expects to find a directory on disk at the asset\ndirectory specified. Note that we are referencing the asset directory relatively\nto our CDK project directory. This is especially important when we want to share\nthis construct through a library. Different programming languages will have\ndifferent techniques for bundling resources into libraries.\n\n### Execution Role\n\nLambda functions assume an IAM role during execution. In CDK by default, Lambda\nfunctions will use an autogenerated Role if one is not provided.\n\nThe autogenerated Role is automatically given permissions to execute the Lambda\nfunction. To reference the autogenerated Role:\n\n```ts\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_10_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n\nfn.role // the Role\n```\n\nYou can also provide your own IAM role. Provided IAM roles will not automatically\nbe given permissions to execute the Lambda function. To provide a role and grant\nit appropriate permissions:\n\n```ts\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_10_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n role: myRole // user-provided role\n});\n\nmyRole.addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(\"service-role/AWSLambdaBasicExecutionRole\"));\nmyRole.addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(\"service-role/AWSLambdaVPCAccessExecutionRole\")); // only required if your function lives in a VPC\n```\n\n### Versions and Aliases\n\nYou can use\n[versions](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html)\nto manage the deployment of your AWS Lambda functions. For example, you can\npublish a new version of a function for beta testing without affecting users of\nthe stable production version.\n\nThe function version includes the following information:\n\n- The function code and all associated dependencies.\n- The Lambda runtime that executes the function.\n- All of the function settings, including the environment variables.\n- A unique Amazon Resource Name (ARN) to identify this version of the function.\n\nYou can define one or more\n[aliases](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)\nfor your AWS Lambda function. A Lambda alias is like a pointer to a specific\nLambda function version. Users can access the function version using the alias\nARN.\n\nThe `fn.currentVersion` property can be used to obtain a `lambda.Version`\nresource that represents the AWS Lambda function defined in your application.\nAny change to your function's code or configuration will result in the creation\nof a new version resource. You can specify options for this version through the\n`currentVersionOptions` property.\n\n> The `currentVersion` property is only supported when your AWS Lambda function\n> uses either `lambda.Code.fromAsset` or `lambda.Code.fromInline`. Other types\n> of code providers (such as `lambda.Code.fromBucket`) require that you define a\n> `lambda.Version` resource directly since the CDK is unable to determine if\n> their contents had changed.\n\nThe `version.addAlias()` method can be used to define an AWS Lambda alias that\npoints to a specific version.\n\nThe following example defines an alias named `live` which will always point to a\nversion that represents the function as defined in your CDK app. When you change\nyour lambda code or configuration, a new resource will be created. You can\nspecify options for the current version through the `currentVersionOptions`\nproperty.\n\n```ts\nconst fn = new lambda.Function(this, 'MyFunction', {\n currentVersionOptions: {\n removalPolicy: RemovalPolicy.RETAIN, // retain old versions\n retryAttempts: 1 // async retry attempts\n }\n});\n\nfn.currentVersion.addAlias('live');\n```\n\n> NOTE: The `fn.latestVersion` property returns a `lambda.IVersion` which\n> represents the `$LATEST` pseudo-version. Most AWS services require a specific\n> AWS Lambda version, and won't allow you to use `$LATEST`. Therefore, you would\n> normally want to use `lambda.currentVersion`.\n\n### Layers\n\nThe `lambda.LayerVersion` class can be used to define Lambda layers and manage\ngranting permissions to other AWS accounts or organizations.\n\n```ts lit=test/integ.layer-version.lit.ts\nconst layer = new lambda.LayerVersion(stack, 'MyLayer', {\n code: lambda.Code.fromAsset(path.join(__dirname, 'layer-code')),\n compatibleRuntimes: [lambda.Runtime.NODEJS_10_X],\n license: 'Apache-2.0',\n description: 'A layer to test the L2 construct',\n});\n\n// To grant usage by other AWS accounts\nlayer.addPermission('remote-account-grant', { accountId: awsAccountId });\n\n// To grant usage to all accounts in some AWS Ogranization\n// layer.grantUsage({ accountId: '*', organizationId });\n\nnew lambda.Function(stack, 'MyLayeredLambda', {\n code: new lambda.InlineCode('foo'),\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_10_X,\n layers: [layer],\n});\n```\n\n### Event Rule Target\n\nYou can use an AWS Lambda function as a target for an Amazon CloudWatch event\nrule:\n\n```ts\nimport * as targets from '@aws-cdk/aws-events-targets';\nrule.addTarget(new targets.LambdaFunction(myFunction));\n```\n\n### Event Sources\n\nAWS Lambda supports a [variety of event sources](https://docs.aws.amazon.com/lambda/latest/dg/invoking-lambda-function.html).\n\nIn most cases, it is possible to trigger a function as a result of an event by\nusing one of the `addNotification` methods on the source construct. For\nexample, the `s3.Bucket` construct has an `onEvent` method which can be used to\ntrigger a Lambda when an event, such as PutObject occurs on an S3 bucket.\n\nAn alternative way to add event sources to a function is to use `function.addEventSource(source)`.\nThis method accepts an `IEventSource` object. The module __@aws-cdk/aws-lambda-event-sources__\nincludes classes for the various event sources supported by AWS Lambda.\n\nFor example, the following code adds an SQS queue as an event source for a function:\n\n```ts\nimport { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';\nfn.addEventSource(new SqsEventSource(queue));\n```\n\nThe following code adds an S3 bucket notification as an event source:\n\n```ts\nimport { S3EventSource } from '@aws-cdk/aws-lambda-event-sources';\nfn.addEventSource(new S3EventSource(bucket, {\n events: [ s3.EventType.OBJECT_CREATED, s3.EventType.OBJECT_DELETED ],\n filters: [ { prefix: 'subdir/' } ] // optional\n}));\n```\n\nSee the documentation for the __@aws-cdk/aws-lambda-event-sources__ module for more details.\n\n### Lambda with DLQ\n\nA dead-letter queue can be automatically created for a Lambda function by\nsetting the `deadLetterQueueEnabled: true` configuration.\n\n```ts\nimport * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_10_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, \"hi\"); }'),\n deadLetterQueueEnabled: true\n});\n```\n\nIt is also possible to provide a dead-letter queue instead of getting a new queue created:\n\n```ts\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as sqs from '@aws-cdk/aws-sqs';\n\nconst dlq = new sqs.Queue(this, 'DLQ');\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_10_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, \"hi\"); }'),\n deadLetterQueue: dlq\n});\n```\n\nSee [the AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/dlq.html)\nto learn more about AWS Lambdas and DLQs.\n\n### Lambda with X-Ray Tracing\n\n```ts\nimport * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_10_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, \"hi\"); }'),\n tracing: lambda.Tracing.ACTIVE\n});\n```\n\nSee [the AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-x-ray.html)\nto learn more about AWS Lambda's X-Ray support.\n\n### Lambda with Profiling\n\n```ts\nimport * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_10_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, \"hi\"); }'),\n profiling: true\n});\n```\n\nSee [the AWS documentation](https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html)\nto learn more about AWS Lambda's Profiling support.\n\n### Lambda with Reserved Concurrent Executions\n\n```ts\nimport * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_10_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('exports.handler = function(event, ctx, cb) { return cb(null, \"hi\"); }'),\n reservedConcurrentExecutions: 100\n});\n```\n\nSee [the AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html)\nmanaging concurrency.\n\n### AutoScaling\n\nYou can use Application AutoScaling to automatically configure the provisioned concurrency for your functions. AutoScaling can be set to track utilization or be based on a schedule. To configure AutoScaling on a function alias:\n\n```ts\nconst alias = new lambda.Alias(stack, 'Alias', {\n aliasName: 'prod',\n version,\n});\n\n// Create AutoScaling target\nconst as = alias.addAutoScaling({ maxCapacity: 50 })\n\n// Configure Target Tracking\nas.scaleOnUtilization({\n utilizationTarget: 0.5,\n});\n\n// Configure Scheduled Scaling\nas.scaleOnSchedule('ScaleUpInTheMorning', {\n schedule: appscaling.Schedule.cron({ hour: '8', minute: '0'}),\n minCapacity: 20,\n});\n```\n\n```ts lit=test/integ.autoscaling.lit.ts\nimport * as appscaling from '@aws-cdk/aws-applicationautoscaling';\nimport * as cdk from '@aws-cdk/core';\nimport * as lambda from '../lib';\n\n/**\n* Stack verification steps:\n* aws application-autoscaling describe-scalable-targets --service-namespace lambda --resource-ids function::prod\n* has a minCapacity of 3 and maxCapacity of 50\n*/\nclass TestStack extends cdk.Stack {\n constructor(scope: cdk.App, id: string) {\n super(scope, id);\n\n const fn = new lambda.Function(this, 'MyLambda', {\n code: new lambda.InlineCode('exports.handler = async () => {\\nconsole.log(\\'hello world\\');\\n};'),\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_10_X,\n });\n\n const version = fn.addVersion('1', undefined, 'integ-test');\n\n const alias = new lambda.Alias(this, 'Alias', {\n aliasName: 'prod',\n version,\n });\n\n const scalingTarget = alias.addAutoScaling({ minCapacity: 3, maxCapacity: 50 });\n\n scalingTarget.scaleOnUtilization({\n utilizationTarget: 0.5,\n });\n\n scalingTarget.scaleOnSchedule('ScaleUpInTheMorning', {\n schedule: appscaling.Schedule.cron({ hour: '8', minute: '0' }),\n minCapacity: 20,\n });\n\n scalingTarget.scaleOnSchedule('ScaleDownAtNight', {\n schedule: appscaling.Schedule.cron({ hour: '20', minute: '0' }),\n maxCapacity: 20,\n });\n\n new cdk.CfnOutput(this, 'FunctionName', {\n value: fn.functionName,\n });\n }\n}\n\nconst app = new cdk.App();\n\nnew TestStack(app, 'aws-lambda-autoscaling');\n\napp.synth();\n```\n\nSee [the AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-scaling.html) on autoscaling lambda functions.\n\n### Log Group\n\nLambda functions automatically create a log group with the name `/aws/lambda/` upon first execution with\nlog data set to never expire.\n\nThe `logRetention` property can be used to set a different expiration period.\n\nIt is possible to obtain the function's log group as a `logs.ILogGroup` by calling the `logGroup` property of the\n`Function` construct.\n\nBy default, CDK uses the AWS SDK retry options when creating a log group. The `logRetentionRetryOptions` property\nallows you to customize the maximum number of retries and base backoff duration.\n\n*Note* that, if either `logRetention` is set or `logGroup` property is called, a [CloudFormation custom\nresource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cfn-customresource.html) is added\nto the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the\ncorrect log retention period (never expire, by default).\n\n*Further note* that, if the log group already exists and the `logRetention` is not set, the custom resource will reset\nthe log retention to never expire even if it was configured with a different value.\n\n### FileSystem Access\n\nYou can configure a function to mount an Amazon Elastic File System (Amazon EFS) to a\ndirectory in your runtime environment with the `filesystem` property. To access Amazon EFS\nfrom lambda function, the Amazon EFS access point will be required.\n\nThe following sample allows the lambda function to mount the Amazon EFS access point to `/mnt/msg` in the runtime environment and access the filesystem with the POSIX identity defined in `posixUser`.\n\n```ts\n// create a new Amazon EFS filesystem\nconst fileSystem = new efs.FileSystem(stack, 'Efs', { vpc });\n\n// create a new access point from the filesystem\nconst accessPoint = fileSystem.addAccessPoint('AccessPoint', {\n // set /export/lambda as the root of the access point\n path: '/export/lambda',\n // as /export/lambda does not exist in a new efs filesystem, the efs will create the directory with the following createAcl\n createAcl: {\n ownerUid: '1001',\n ownerGid: '1001',\n permissions: '750',\n },\n // enforce the POSIX identity so lambda function will access with this identity\n posixUser: {\n uid: '1001',\n gid: '1001',\n },\n});\n\nconst fn = new lambda.Function(stack, 'MyLambda', {\n code,\n handler,\n runtime,\n vpc,\n // mount the access point to /mnt/msg in the lambda runtime enironment\n filesystem: lambda.FileSystem.fromEfsAccessPoint(accessPoint, '/mnt/msg'),\n});\n```\n\n\n### Singleton Function\n\nThe `SingletonFunction` construct is a way to guarantee that a lambda function will be guaranteed to be part of the stack,\nonce and only once, irrespective of how many times the construct is declared to be part of the stack. This is guaranteed\nas long as the `uuid` property and the optional `lambdaPurpose` property stay the same whenever they're declared into the\nstack.\n\nA typical use case of this function is when a higher level construct needs to declare a Lambda function as part of it but\nneeds to guarantee that the function is declared once. However, a user of this higher level construct can declare it any\nnumber of times and with different properties. Using `SingletonFunction` here with a fixed `uuid` will guarantee this.\n\nFor example, the `LogRetention` construct requires only one single lambda function for all different log groups whose\nretention it seeks to manage.\n\n### Bundling Asset Code\nWhen using `lambda.Code.fromAsset(path)` it is possible to bundle the code by running a\ncommand in a Docker container. The asset path will be mounted at `/asset-input`. The\nDocker container is responsible for putting content at `/asset-output`. The content at\n`/asset-output` will be zipped and used as Lambda code.\n\nExample with Python:\n```ts\nnew lambda.Function(this, 'Function', {\n code: lambda.Code.fromAsset(path.join(__dirname, 'my-python-handler'), {\n bundling: {\n image: lambda.Runtime.PYTHON_3_6.bundlingDockerImage,\n command: [\n 'bash', '-c', `\n pip install -r requirements.txt -t /asset-output &&\n cp -au . /asset-output\n `,\n ],\n },\n }),\n runtime: lambda.Runtime.PYTHON_3_6,\n handler: 'index.handler',\n});\n```\nRuntimes expose a `bundlingDockerImage` property that points to the [AWS SAM](https://github.com/awslabs/aws-sam-cli) build image.\n\nUse `cdk.BundlingDockerImage.fromRegistry(image)` to use an existing image or\n`cdk.BundlingDockerImage.fromAsset(path)` to build a specific image:\n\n```ts\nimport * as cdk from '@aws-cdk/core';\n\nnew lambda.Function(this, 'Function', {\n code: lambda.Code.fromAsset('/path/to/handler', {\n bundling: {\n image: cdk.BundlingDockerImage.fromAsset('/path/to/dir/with/DockerFile', {\n buildArgs: {\n ARG1: 'value1',\n },\n }),\n command: ['my', 'cool', 'command'],\n },\n }),\n // ...\n});\n```\n\n### Language-specific APIs\nLanguage-specific higher level constructs are provided in separate modules:\n\n* Node.js: [`@aws-cdk/aws-lambda-nodejs`](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-lambda-nodejs)\n* Python: [`@aws-cdk/aws-lambda-python`](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-lambda-python)\n" }, "repository": { "directory": "packages/@aws-cdk/aws-lambda", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "assemblyOriginatorKeyFile": "../../key.snk", "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Lambda", "packageId": "Amazon.CDK.AWS.Lambda", "signAssembly": true }, "java": { "maven": { "artifactId": "lambda", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.lambda" }, "js": { "npm": "@aws-cdk/aws-lambda" }, "python": { "distName": "aws-cdk.aws-lambda", "module": "aws_cdk.aws_lambda" } }, "types": { "@aws-cdk/aws-lambda.Alias": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.QualifiedFunctionBase", "docs": { "stability": "stable", "summary": "A new alias to a particular version of a Lambda function." }, "fqn": "@aws-cdk/aws-lambda.Alias", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/alias.ts", "line": 139 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.AliasProps" } } ] }, "interfaces": [ "@aws-cdk/aws-lambda.IAlias" ], "kind": "class", "locationInModule": { "filename": "lib/alias.ts", "line": 89 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/alias.ts", "line": 90 }, "name": "fromAliasAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-lambda.AliasAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.IAlias" } }, "static": true }, { "docs": { "remarks": "Returns a scalable attribute that can call\n`scaleOnUtilization()` and `scaleOnSchedule()`.", "stability": "stable", "summary": "Configure provisioned concurrency autoscaling on a function alias." }, "locationInModule": { "filename": "lib/alias.ts", "line": 218 }, "name": "addAutoScaling", "parameters": [ { "docs": { "summary": "Autoscaling options." }, "name": "options", "type": { "fqn": "@aws-cdk/aws-lambda.AutoScalingOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.IScalableFunctionAttribute" } } }, { "docs": { "stability": "stable", "summary": "Return the given named metric for this Function." }, "locationInModule": { "filename": "lib/alias.ts", "line": 198 }, "name": "metric", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "Alias", "properties": [ { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Name of this alias." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 111 }, "name": "aliasName", "overrides": "@aws-cdk/aws-lambda.IAlias", "type": { "primitive": "string" } }, { "docs": { "remarks": "True for new Lambdas, false for imported Lambdas (they might live in different accounts).", "stability": "stable", "summary": "Whether the addPermission() call adds any permissions." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 134 }, "name": "canCreatePermissions", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "remarks": "Used to be able to use Alias in place of a regular Lambda. Lambda accepts\nARNs everywhere it accepts function names.", "stability": "stable", "summary": "ARN of this alias." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 130 }, "name": "functionArn", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "primitive": "string" } }, { "docs": { "remarks": "Used to be able to use Alias in place of a regular Lambda. Lambda accepts\nARNs everywhere it accepts function names.", "stability": "stable", "summary": "ARN of this alias." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 118 }, "name": "functionName", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The principal this Lambda Function is running as." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 190 }, "name": "grantPrincipal", "overrides": "@aws-cdk/aws-iam.IGrantable", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 120 }, "name": "lambda", "overrides": "@aws-cdk/aws-lambda.QualifiedFunctionBase", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "docs": { "remarks": "A qualifier is the identifier that's appended to a version or alias ARN.", "stability": "stable", "summary": "The qualifier of the version or alias of this function." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 132 }, "name": "qualifier", "overrides": "@aws-cdk/aws-lambda.QualifiedFunctionBase", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The underlying Lambda function version." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 122 }, "name": "version", "overrides": "@aws-cdk/aws-lambda.IAlias", "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } }, { "docs": { "remarks": "Undefined if the function was imported without a role.", "stability": "stable", "summary": "The IAM role associated with this function." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 194 }, "name": "role", "optional": true, "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ] }, "@aws-cdk/aws-lambda.AliasAttributes": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.AliasAttributes", "kind": "interface", "locationInModule": { "filename": "lib/alias.ts", "line": 81 }, "name": "AliasAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 82 }, "name": "aliasName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 83 }, "name": "aliasVersion", "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } } ] }, "@aws-cdk/aws-lambda.AliasOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `lambda.Alias`." }, "fqn": "@aws-cdk/aws-lambda.AliasOptions", "interfaces": [ "@aws-cdk/aws-lambda.EventInvokeConfigOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/alias.ts", "line": 29 }, "name": "AliasOptions", "properties": [ { "abstract": true, "docs": { "default": "No additional versions", "remarks": "Individual additional version weights specified here should add up to\n(less than) one. All remaining weight is routed to the default\nversion.\n\nFor example, the config is\n\n version: \"1\"\n additionalVersions: [{ version: \"2\", weight: 0.05 }]\n\nThen 5% of traffic will be routed to function version 2, while\nthe remaining 95% of traffic will be routed to function version 1.", "stability": "stable", "summary": "Additional versions with individual weights this alias points to." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 54 }, "name": "additionalVersions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-lambda.VersionWeight" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "No description", "stability": "stable", "summary": "Description for the alias." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 35 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "No provisioned concurrency", "stability": "stable", "summary": "Specifies a provisioned concurrency configuration for a function's alias." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 61 }, "name": "provisionedConcurrentExecutions", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.AliasProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a new Lambda alias." }, "fqn": "@aws-cdk/aws-lambda.AliasProps", "interfaces": [ "@aws-cdk/aws-lambda.AliasOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/alias.ts", "line": 67 }, "name": "AliasProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Name of this alias." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 71 }, "name": "aliasName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Use lambda.addVersion() to obtain a new lambda version to refer to.", "stability": "stable", "summary": "Function version this alias refers to." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 78 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } } ] }, "@aws-cdk/aws-lambda.AssetCode": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.Code", "docs": { "stability": "stable", "summary": "Lambda code from a local directory." }, "fqn": "@aws-cdk/aws-lambda.AssetCode", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/code.ts", "line": 173 }, "parameters": [ { "docs": { "summary": "The path to the asset file or directory." }, "name": "path", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3-assets.AssetOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 166 }, "methods": [ { "docs": { "stability": "stable", "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 177 }, "name": "bind", "overrides": "@aws-cdk/aws-lambda.Code", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.CodeConfig" } } }, { "docs": { "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.", "stability": "stable", "summary": "Called after the CFN function resource has been created to allow the code class to bind to it." }, "locationInModule": { "filename": "lib/code.ts", "line": 198 }, "name": "bindToResource", "overrides": "@aws-cdk/aws-lambda.Code", "parameters": [ { "name": "resource", "type": { "fqn": "@aws-cdk/core.CfnResource" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.ResourceBindOptions" } } ] } ], "name": "AssetCode", "properties": [ { "docs": { "stability": "stable", "summary": "Determines whether this Code is inline code or not." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 167 }, "name": "isInline", "overrides": "@aws-cdk/aws-lambda.Code", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "The path to the asset file or directory." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 173 }, "name": "path", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.AutoScalingOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for enabling Lambda autoscaling." }, "fqn": "@aws-cdk/aws-lambda.AutoScalingOptions", "kind": "interface", "locationInModule": { "filename": "lib/scalable-attribute-api.ts", "line": 34 }, "name": "AutoScalingOptions", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Maximum capacity to scale to." }, "immutable": true, "locationInModule": { "filename": "lib/scalable-attribute-api.ts", "line": 45 }, "name": "maxCapacity", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "1", "stability": "stable", "summary": "Minimum capacity to scale to." }, "immutable": true, "locationInModule": { "filename": "lib/scalable-attribute-api.ts", "line": 40 }, "name": "minCapacity", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.CfnAlias": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Lambda::Alias" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html", "stability": "external", "summary": "A CloudFormation `AWS::Lambda::Alias`." }, "fqn": "@aws-cdk/aws-lambda.CfnAlias", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Lambda::Alias`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 184 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.CfnAliasProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 119 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 205 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 220 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnAlias", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 123 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 210 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname", "stability": "external", "summary": "`AWS::Lambda::Alias.FunctionName`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 145 }, "name": "functionName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion", "stability": "external", "summary": "`AWS::Lambda::Alias.FunctionVersion`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 151 }, "name": "functionVersion", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name", "stability": "external", "summary": "`AWS::Lambda::Alias.Name`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 157 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description", "stability": "external", "summary": "`AWS::Lambda::Alias.Description`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 163 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig", "stability": "external", "summary": "`AWS::Lambda::Alias.ProvisionedConcurrencyConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 169 }, "name": "provisionedConcurrencyConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig", "stability": "external", "summary": "`AWS::Lambda::Alias.RoutingConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 175 }, "name": "routingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnAlias.AliasRoutingConfigurationProperty" } ] } } } ] }, "@aws-cdk/aws-lambda.CfnAlias.AliasRoutingConfigurationProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnAlias.AliasRoutingConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 230 }, "name": "AliasRoutingConfigurationProperty", "namespace": "CfnAlias", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html#cfn-lambda-alias-aliasroutingconfiguration-additionalversionweights", "stability": "external", "summary": "`CfnAlias.AliasRoutingConfigurationProperty.AdditionalVersionWeights`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 235 }, "name": "additionalVersionWeights", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnAlias.VersionWeightProperty" } ] } }, "kind": "array" } } ] } } } ] }, "@aws-cdk/aws-lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 286 }, "name": "ProvisionedConcurrencyConfigurationProperty", "namespace": "CfnAlias", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html#cfn-lambda-alias-provisionedconcurrencyconfiguration-provisionedconcurrentexecutions", "stability": "external", "summary": "`CfnAlias.ProvisionedConcurrencyConfigurationProperty.ProvisionedConcurrentExecutions`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 291 }, "name": "provisionedConcurrentExecutions", "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.CfnAlias.VersionWeightProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnAlias.VersionWeightProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 342 }, "name": "VersionWeightProperty", "namespace": "CfnAlias", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionversion", "stability": "external", "summary": "`CfnAlias.VersionWeightProperty.FunctionVersion`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 347 }, "name": "functionVersion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionweight", "stability": "external", "summary": "`CfnAlias.VersionWeightProperty.FunctionWeight`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 352 }, "name": "functionWeight", "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.CfnAliasProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html", "stability": "external", "summary": "Properties for defining a `AWS::Lambda::Alias`." }, "fqn": "@aws-cdk/aws-lambda.CfnAliasProps", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 17 }, "name": "CfnAliasProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname", "stability": "external", "summary": "`AWS::Lambda::Alias.FunctionName`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 23 }, "name": "functionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion", "stability": "external", "summary": "`AWS::Lambda::Alias.FunctionVersion`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 29 }, "name": "functionVersion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name", "stability": "external", "summary": "`AWS::Lambda::Alias.Name`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 35 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description", "stability": "external", "summary": "`AWS::Lambda::Alias.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 41 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig", "stability": "external", "summary": "`AWS::Lambda::Alias.ProvisionedConcurrencyConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 47 }, "name": "provisionedConcurrencyConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig", "stability": "external", "summary": "`AWS::Lambda::Alias.RoutingConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 53 }, "name": "routingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnAlias.AliasRoutingConfigurationProperty" } ] } } } ] }, "@aws-cdk/aws-lambda.CfnEventInvokeConfig": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Lambda::EventInvokeConfig" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html", "stability": "external", "summary": "A CloudFormation `AWS::Lambda::EventInvokeConfig`." }, "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Lambda::EventInvokeConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 559 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfigProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 500 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 578 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 592 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnEventInvokeConfig", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 504 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 583 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.FunctionName`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 526 }, "name": "functionName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.Qualifier`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 532 }, "name": "qualifier", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.DestinationConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 538 }, "name": "destinationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.DestinationConfigProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.MaximumEventAgeInSeconds`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 544 }, "name": "maximumEventAgeInSeconds", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.MaximumRetryAttempts`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 550 }, "name": "maximumRetryAttempts", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.CfnEventInvokeConfig.DestinationConfigProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.DestinationConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 602 }, "name": "DestinationConfigProperty", "namespace": "CfnEventInvokeConfig", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onfailure", "stability": "external", "summary": "`CfnEventInvokeConfig.DestinationConfigProperty.OnFailure`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 607 }, "name": "onFailure", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnFailureProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onsuccess", "stability": "external", "summary": "`CfnEventInvokeConfig.DestinationConfigProperty.OnSuccess`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 612 }, "name": "onSuccess", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnSuccessProperty" } ] } } } ] }, "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnFailureProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onfailure.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnFailureProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 665 }, "name": "OnFailureProperty", "namespace": "CfnEventInvokeConfig", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onfailure.html#cfn-lambda-eventinvokeconfig-destinationconfig-onfailure-destination", "stability": "external", "summary": "`CfnEventInvokeConfig.OnFailureProperty.Destination`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 670 }, "name": "destination", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnSuccessProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onsuccess.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnSuccessProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 721 }, "name": "OnSuccessProperty", "namespace": "CfnEventInvokeConfig", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onsuccess.html#cfn-lambda-eventinvokeconfig-destinationconfig-onsuccess-destination", "stability": "external", "summary": "`CfnEventInvokeConfig.OnSuccessProperty.Destination`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 726 }, "name": "destination", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnEventInvokeConfigProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html", "stability": "external", "summary": "Properties for defining a `AWS::Lambda::EventInvokeConfig`." }, "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfigProps", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 408 }, "name": "CfnEventInvokeConfigProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.FunctionName`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 414 }, "name": "functionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.Qualifier`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 420 }, "name": "qualifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.DestinationConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 426 }, "name": "destinationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.DestinationConfigProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.MaximumEventAgeInSeconds`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 432 }, "name": "maximumEventAgeInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts", "stability": "external", "summary": "`AWS::Lambda::EventInvokeConfig.MaximumRetryAttempts`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 438 }, "name": "maximumRetryAttempts", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.CfnEventSourceMapping": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Lambda::EventSourceMapping" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html", "stability": "external", "summary": "A CloudFormation `AWS::Lambda::EventSourceMapping`." }, "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Lambda::EventSourceMapping`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1019 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMappingProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 924 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1044 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1064 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnEventSourceMapping", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 928 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1049 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.EventSourceArn`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 950 }, "name": "eventSourceArn", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.FunctionName`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 956 }, "name": "functionName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.BatchSize`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 962 }, "name": "batchSize", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.BisectBatchOnFunctionError`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 968 }, "name": "bisectBatchOnFunctionError", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.DestinationConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 974 }, "name": "destinationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.DestinationConfigProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.Enabled`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 980 }, "name": "enabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.MaximumBatchingWindowInSeconds`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 986 }, "name": "maximumBatchingWindowInSeconds", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.MaximumRecordAgeInSeconds`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 992 }, "name": "maximumRecordAgeInSeconds", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.MaximumRetryAttempts`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 998 }, "name": "maximumRetryAttempts", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.ParallelizationFactor`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1004 }, "name": "parallelizationFactor", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.StartingPosition`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1010 }, "name": "startingPosition", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnEventSourceMapping.DestinationConfigProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.DestinationConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1074 }, "name": "DestinationConfigProperty", "namespace": "CfnEventSourceMapping", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html#cfn-lambda-eventsourcemapping-destinationconfig-onfailure", "stability": "external", "summary": "`CfnEventSourceMapping.DestinationConfigProperty.OnFailure`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1079 }, "name": "onFailure", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.OnFailureProperty" } ] } } } ] }, "@aws-cdk/aws-lambda.CfnEventSourceMapping.OnFailureProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.OnFailureProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1130 }, "name": "OnFailureProperty", "namespace": "CfnEventSourceMapping", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html#cfn-lambda-eventsourcemapping-onfailure-destination", "stability": "external", "summary": "`CfnEventSourceMapping.OnFailureProperty.Destination`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1135 }, "name": "destination", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnEventSourceMappingProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html", "stability": "external", "summary": "Properties for defining a `AWS::Lambda::EventSourceMapping`." }, "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMappingProps", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 778 }, "name": "CfnEventSourceMappingProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.EventSourceArn`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 784 }, "name": "eventSourceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.FunctionName`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 790 }, "name": "functionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.BatchSize`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 796 }, "name": "batchSize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.BisectBatchOnFunctionError`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 802 }, "name": "bisectBatchOnFunctionError", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.DestinationConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 808 }, "name": "destinationConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.DestinationConfigProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.Enabled`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 814 }, "name": "enabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.MaximumBatchingWindowInSeconds`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 820 }, "name": "maximumBatchingWindowInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.MaximumRecordAgeInSeconds`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 826 }, "name": "maximumRecordAgeInSeconds", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.MaximumRetryAttempts`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 832 }, "name": "maximumRetryAttempts", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.ParallelizationFactor`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 838 }, "name": "parallelizationFactor", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition", "stability": "external", "summary": "`AWS::Lambda::EventSourceMapping.StartingPosition`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 844 }, "name": "startingPosition", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnFunction": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Lambda::Function" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html", "stability": "external", "summary": "A CloudFormation `AWS::Lambda::Function`." }, "fqn": "@aws-cdk/aws-lambda.CfnFunction", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Lambda::Function`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1525 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.CfnFunctionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1389 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1559 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1585 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnFunction", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1393 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Arn" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1414 }, "name": "attrArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1564 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags", "stability": "external", "summary": "`AWS::Lambda::Function.Tags`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1498 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code", "stability": "external", "summary": "`AWS::Lambda::Function.Code`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1420 }, "name": "code", "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-lambda.CfnFunction.CodeProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler", "stability": "external", "summary": "`AWS::Lambda::Function.Handler`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1426 }, "name": "handler", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role", "stability": "external", "summary": "`AWS::Lambda::Function.Role`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1432 }, "name": "role", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime", "stability": "external", "summary": "`AWS::Lambda::Function.Runtime`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1438 }, "name": "runtime", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig", "stability": "external", "summary": "`AWS::Lambda::Function.DeadLetterConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1444 }, "name": "deadLetterConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.DeadLetterConfigProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description", "stability": "external", "summary": "`AWS::Lambda::Function.Description`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1450 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment", "stability": "external", "summary": "`AWS::Lambda::Function.Environment`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1456 }, "name": "environment", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.EnvironmentProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs", "stability": "external", "summary": "`AWS::Lambda::Function.FileSystemConfigs`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1462 }, "name": "fileSystemConfigs", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.FileSystemConfigProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname", "stability": "external", "summary": "`AWS::Lambda::Function.FunctionName`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1468 }, "name": "functionName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn", "stability": "external", "summary": "`AWS::Lambda::Function.KmsKeyArn`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1474 }, "name": "kmsKeyArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers", "stability": "external", "summary": "`AWS::Lambda::Function.Layers`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1480 }, "name": "layers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize", "stability": "external", "summary": "`AWS::Lambda::Function.MemorySize`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1486 }, "name": "memorySize", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions", "stability": "external", "summary": "`AWS::Lambda::Function.ReservedConcurrentExecutions`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1492 }, "name": "reservedConcurrentExecutions", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout", "stability": "external", "summary": "`AWS::Lambda::Function.Timeout`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1504 }, "name": "timeout", "optional": true, "type": { "primitive": "number" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig", "stability": "external", "summary": "`AWS::Lambda::Function.TracingConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1510 }, "name": "tracingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.TracingConfigProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig", "stability": "external", "summary": "`AWS::Lambda::Function.VpcConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1516 }, "name": "vpcConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.VpcConfigProperty" } ] } } } ] }, "@aws-cdk/aws-lambda.CfnFunction.CodeProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnFunction.CodeProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1595 }, "name": "CodeProperty", "namespace": "CfnFunction", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket", "stability": "external", "summary": "`CfnFunction.CodeProperty.S3Bucket`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1600 }, "name": "s3Bucket", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key", "stability": "external", "summary": "`CfnFunction.CodeProperty.S3Key`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1605 }, "name": "s3Key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion", "stability": "external", "summary": "`CfnFunction.CodeProperty.S3ObjectVersion`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1610 }, "name": "s3ObjectVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile", "stability": "external", "summary": "`CfnFunction.CodeProperty.ZipFile`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1615 }, "name": "zipFile", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnFunction.DeadLetterConfigProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnFunction.DeadLetterConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1674 }, "name": "DeadLetterConfigProperty", "namespace": "CfnFunction", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn", "stability": "external", "summary": "`CfnFunction.DeadLetterConfigProperty.TargetArn`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1679 }, "name": "targetArn", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnFunction.EnvironmentProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnFunction.EnvironmentProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1729 }, "name": "EnvironmentProperty", "namespace": "CfnFunction", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html#cfn-lambda-function-environment-variables", "stability": "external", "summary": "`CfnFunction.EnvironmentProperty.Variables`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1734 }, "name": "variables", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } ] } } } ] }, "@aws-cdk/aws-lambda.CfnFunction.FileSystemConfigProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnFunction.FileSystemConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1784 }, "name": "FileSystemConfigProperty", "namespace": "CfnFunction", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html#cfn-lambda-function-filesystemconfig-arn", "stability": "external", "summary": "`CfnFunction.FileSystemConfigProperty.Arn`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1789 }, "name": "arn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html#cfn-lambda-function-filesystemconfig-localmountpath", "stability": "external", "summary": "`CfnFunction.FileSystemConfigProperty.LocalMountPath`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1794 }, "name": "localMountPath", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnFunction.TracingConfigProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnFunction.TracingConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1849 }, "name": "TracingConfigProperty", "namespace": "CfnFunction", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html#cfn-lambda-function-tracingconfig-mode", "stability": "external", "summary": "`CfnFunction.TracingConfigProperty.Mode`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1854 }, "name": "mode", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnFunction.VpcConfigProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnFunction.VpcConfigProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1904 }, "name": "VpcConfigProperty", "namespace": "CfnFunction", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-securitygroupids", "stability": "external", "summary": "`CfnFunction.VpcConfigProperty.SecurityGroupIds`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1909 }, "name": "securityGroupIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-subnetids", "stability": "external", "summary": "`CfnFunction.VpcConfigProperty.SubnetIds`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1914 }, "name": "subnetIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ] }, "@aws-cdk/aws-lambda.CfnFunctionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html", "stability": "external", "summary": "Properties for defining a `AWS::Lambda::Function`." }, "fqn": "@aws-cdk/aws-lambda.CfnFunctionProps", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1187 }, "name": "CfnFunctionProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code", "stability": "external", "summary": "`AWS::Lambda::Function.Code`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1193 }, "name": "code", "type": { "union": { "types": [ { "fqn": "@aws-cdk/aws-lambda.CfnFunction.CodeProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler", "stability": "external", "summary": "`AWS::Lambda::Function.Handler`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1199 }, "name": "handler", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role", "stability": "external", "summary": "`AWS::Lambda::Function.Role`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1205 }, "name": "role", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime", "stability": "external", "summary": "`AWS::Lambda::Function.Runtime`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1211 }, "name": "runtime", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig", "stability": "external", "summary": "`AWS::Lambda::Function.DeadLetterConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1217 }, "name": "deadLetterConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.DeadLetterConfigProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description", "stability": "external", "summary": "`AWS::Lambda::Function.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1223 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment", "stability": "external", "summary": "`AWS::Lambda::Function.Environment`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1229 }, "name": "environment", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.EnvironmentProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs", "stability": "external", "summary": "`AWS::Lambda::Function.FileSystemConfigs`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1235 }, "name": "fileSystemConfigs", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.FileSystemConfigProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname", "stability": "external", "summary": "`AWS::Lambda::Function.FunctionName`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1241 }, "name": "functionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn", "stability": "external", "summary": "`AWS::Lambda::Function.KmsKeyArn`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1247 }, "name": "kmsKeyArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers", "stability": "external", "summary": "`AWS::Lambda::Function.Layers`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1253 }, "name": "layers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize", "stability": "external", "summary": "`AWS::Lambda::Function.MemorySize`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1259 }, "name": "memorySize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions", "stability": "external", "summary": "`AWS::Lambda::Function.ReservedConcurrentExecutions`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1265 }, "name": "reservedConcurrentExecutions", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags", "stability": "external", "summary": "`AWS::Lambda::Function.Tags`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1271 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout", "stability": "external", "summary": "`AWS::Lambda::Function.Timeout`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1277 }, "name": "timeout", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig", "stability": "external", "summary": "`AWS::Lambda::Function.TracingConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1283 }, "name": "tracingConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.TracingConfigProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig", "stability": "external", "summary": "`AWS::Lambda::Function.VpcConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1289 }, "name": "vpcConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnFunction.VpcConfigProperty" } ] } } } ] }, "@aws-cdk/aws-lambda.CfnLayerVersion": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Lambda::LayerVersion" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html", "stability": "external", "summary": "A CloudFormation `AWS::Lambda::LayerVersion`." }, "fqn": "@aws-cdk/aws-lambda.CfnLayerVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Lambda::LayerVersion`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2120 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2061 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2138 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2152 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnLayerVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2065 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2143 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.Content`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2087 }, "name": "content", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnLayerVersion.ContentProperty" } ] } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.CompatibleRuntimes`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2093 }, "name": "compatibleRuntimes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.Description`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2099 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.LayerName`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2105 }, "name": "layerName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.LicenseInfo`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2111 }, "name": "licenseInfo", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnLayerVersion.ContentProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnLayerVersion.ContentProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2162 }, "name": "ContentProperty", "namespace": "CfnLayerVersion", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3bucket", "stability": "external", "summary": "`CfnLayerVersion.ContentProperty.S3Bucket`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2167 }, "name": "s3Bucket", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3key", "stability": "external", "summary": "`CfnLayerVersion.ContentProperty.S3Key`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2172 }, "name": "s3Key", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3objectversion", "stability": "external", "summary": "`CfnLayerVersion.ContentProperty.S3ObjectVersion`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2177 }, "name": "s3ObjectVersion", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnLayerVersionPermission": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Lambda::LayerVersionPermission" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html", "stability": "external", "summary": "A CloudFormation `AWS::Lambda::LayerVersionPermission`." }, "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionPermission", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Lambda::LayerVersionPermission`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2373 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionPermissionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2320 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2392 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2405 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnLayerVersionPermission", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2324 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2397 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-action", "stability": "external", "summary": "`AWS::Lambda::LayerVersionPermission.Action`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2346 }, "name": "action", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-layerversionarn", "stability": "external", "summary": "`AWS::Lambda::LayerVersionPermission.LayerVersionArn`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2352 }, "name": "layerVersionArn", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-principal", "stability": "external", "summary": "`AWS::Lambda::LayerVersionPermission.Principal`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2358 }, "name": "principal", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-organizationid", "stability": "external", "summary": "`AWS::Lambda::LayerVersionPermission.OrganizationId`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2364 }, "name": "organizationId", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnLayerVersionPermissionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html", "stability": "external", "summary": "Properties for defining a `AWS::Lambda::LayerVersionPermission`." }, "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionPermissionProps", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2236 }, "name": "CfnLayerVersionPermissionProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-action", "stability": "external", "summary": "`AWS::Lambda::LayerVersionPermission.Action`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2242 }, "name": "action", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-layerversionarn", "stability": "external", "summary": "`AWS::Lambda::LayerVersionPermission.LayerVersionArn`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2248 }, "name": "layerVersionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-principal", "stability": "external", "summary": "`AWS::Lambda::LayerVersionPermission.Principal`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2254 }, "name": "principal", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-organizationid", "stability": "external", "summary": "`AWS::Lambda::LayerVersionPermission.OrganizationId`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2260 }, "name": "organizationId", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnLayerVersionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html", "stability": "external", "summary": "Properties for defining a `AWS::Lambda::LayerVersion`." }, "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1970 }, "name": "CfnLayerVersionProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.Content`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1976 }, "name": "content", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnLayerVersion.ContentProperty" } ] } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.CompatibleRuntimes`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1982 }, "name": "compatibleRuntimes", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1988 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.LayerName`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 1994 }, "name": "layerName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo", "stability": "external", "summary": "`AWS::Lambda::LayerVersion.LicenseInfo`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2000 }, "name": "licenseInfo", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnParametersCode": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.Code", "docs": { "remarks": "Useful when you don't have access to the code of your Lambda from your CDK code, so you can't use Assets,\nand you want to deploy the Lambda in a CodePipeline, using CloudFormation Actions -\nyou can fill the parameters using the {@link #assign} method.", "stability": "stable", "summary": "Lambda code defined using 2 CloudFormation parameters." }, "fqn": "@aws-cdk/aws-lambda.CfnParametersCode", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/code.ts", "line": 253 }, "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.CfnParametersCodeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 248 }, "methods": [ { "docs": { "remarks": "It returns a map with 2 keys that correspond to the names of the parameters defined in this Lambda code,\nand as values it contains the appropriate expressions pointing at the provided S3 location\n(most likely, obtained from a CodePipeline Artifact by calling the `artifact.s3Location` method).\nThe result should be provided to the CloudFormation Action\nthat is deploying the Stack that the Lambda with this code is part of,\nin the `parameterOverrides` property.", "stability": "stable", "summary": "Create a parameters map from this instance's CloudFormation parameters." }, "locationInModule": { "filename": "lib/code.ts", "line": 293 }, "name": "assign", "parameters": [ { "docs": { "summary": "the location of the object in S3 that represents the Lambda code." }, "name": "location", "type": { "fqn": "@aws-cdk/aws-s3.Location" } } ], "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } }, { "docs": { "stability": "stable", "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 260 }, "name": "bind", "overrides": "@aws-cdk/aws-lambda.Code", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.CodeConfig" } } } ], "name": "CfnParametersCode", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 300 }, "name": "bucketNameParam", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Determines whether this Code is inline code or not." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 249 }, "name": "isInline", "overrides": "@aws-cdk/aws-lambda.Code", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 308 }, "name": "objectKeyParam", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnParametersCodeProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for {@link CfnParametersCode}." }, "fqn": "@aws-cdk/aws-lambda.CfnParametersCodeProps", "kind": "interface", "locationInModule": { "filename": "lib/code.ts", "line": 222 }, "name": "CfnParametersCodeProps", "properties": [ { "abstract": true, "docs": { "default": "a new parameter will be created", "remarks": "Must be of type 'String'.", "stability": "stable", "summary": "The CloudFormation parameter that represents the name of the S3 Bucket where the Lambda code will be located in." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 230 }, "name": "bucketNameParam", "optional": true, "type": { "fqn": "@aws-cdk/core.CfnParameter" } }, { "abstract": true, "docs": { "default": "a new parameter will be created", "remarks": "Must be of type 'String'.", "stability": "stable", "summary": "The CloudFormation parameter that represents the path inside the S3 Bucket where the Lambda code will be located at." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 239 }, "name": "objectKeyParam", "optional": true, "type": { "fqn": "@aws-cdk/core.CfnParameter" } } ] }, "@aws-cdk/aws-lambda.CfnPermission": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Lambda::Permission" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html", "stability": "external", "summary": "A CloudFormation `AWS::Lambda::Permission`." }, "fqn": "@aws-cdk/aws-lambda.CfnPermission", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Lambda::Permission`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2583 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.CfnPermissionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2518 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2604 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2619 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnPermission", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2522 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2609 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action", "stability": "external", "summary": "`AWS::Lambda::Permission.Action`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2544 }, "name": "action", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname", "stability": "external", "summary": "`AWS::Lambda::Permission.FunctionName`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2550 }, "name": "functionName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal", "stability": "external", "summary": "`AWS::Lambda::Permission.Principal`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2556 }, "name": "principal", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken", "stability": "external", "summary": "`AWS::Lambda::Permission.EventSourceToken`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2562 }, "name": "eventSourceToken", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount", "stability": "external", "summary": "`AWS::Lambda::Permission.SourceAccount`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2568 }, "name": "sourceAccount", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn", "stability": "external", "summary": "`AWS::Lambda::Permission.SourceArn`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2574 }, "name": "sourceArn", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnPermissionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html", "stability": "external", "summary": "Properties for defining a `AWS::Lambda::Permission`." }, "fqn": "@aws-cdk/aws-lambda.CfnPermissionProps", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2416 }, "name": "CfnPermissionProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action", "stability": "external", "summary": "`AWS::Lambda::Permission.Action`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2422 }, "name": "action", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname", "stability": "external", "summary": "`AWS::Lambda::Permission.FunctionName`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2428 }, "name": "functionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal", "stability": "external", "summary": "`AWS::Lambda::Permission.Principal`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2434 }, "name": "principal", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken", "stability": "external", "summary": "`AWS::Lambda::Permission.EventSourceToken`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2440 }, "name": "eventSourceToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount", "stability": "external", "summary": "`AWS::Lambda::Permission.SourceAccount`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2446 }, "name": "sourceAccount", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn", "stability": "external", "summary": "`AWS::Lambda::Permission.SourceArn`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2452 }, "name": "sourceArn", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.CfnVersion": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::Lambda::Version" }, "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html", "stability": "external", "summary": "A CloudFormation `AWS::Lambda::Version`." }, "fqn": "@aws-cdk/aws-lambda.CfnVersion", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::Lambda::Version`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2770 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.CfnVersionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2712 }, "methods": [ { "docs": { "stability": "experimental", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2788 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2801 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnVersion", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2716 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Version" }, "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2737 }, "name": "attrVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2793 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionname", "stability": "external", "summary": "`AWS::Lambda::Version.FunctionName`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2743 }, "name": "functionName", "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256", "stability": "external", "summary": "`AWS::Lambda::Version.CodeSha256`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2749 }, "name": "codeSha256", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description", "stability": "external", "summary": "`AWS::Lambda::Version.Description`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2755 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-provisionedconcurrencyconfig", "stability": "external", "summary": "`AWS::Lambda::Version.ProvisionedConcurrencyConfig`." }, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2761 }, "name": "provisionedConcurrencyConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty" } ] } } } ] }, "@aws-cdk/aws-lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-version-provisionedconcurrencyconfiguration.html", "stability": "external" }, "fqn": "@aws-cdk/aws-lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2811 }, "name": "ProvisionedConcurrencyConfigurationProperty", "namespace": "CfnVersion", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-version-provisionedconcurrencyconfiguration.html#cfn-lambda-version-provisionedconcurrencyconfiguration-provisionedconcurrentexecutions", "stability": "external", "summary": "`CfnVersion.ProvisionedConcurrencyConfigurationProperty.ProvisionedConcurrentExecutions`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2816 }, "name": "provisionedConcurrentExecutions", "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.CfnVersionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html", "stability": "external", "summary": "Properties for defining a `AWS::Lambda::Version`." }, "fqn": "@aws-cdk/aws-lambda.CfnVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2630 }, "name": "CfnVersionProps", "properties": [ { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionname", "stability": "external", "summary": "`AWS::Lambda::Version.FunctionName`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2636 }, "name": "functionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256", "stability": "external", "summary": "`AWS::Lambda::Version.CodeSha256`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2642 }, "name": "codeSha256", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description", "stability": "external", "summary": "`AWS::Lambda::Version.Description`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2648 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "see": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-provisionedconcurrencyconfig", "stability": "external", "summary": "`AWS::Lambda::Version.ProvisionedConcurrencyConfig`." }, "immutable": true, "locationInModule": { "filename": "lib/lambda.generated.ts", "line": 2654 }, "name": "provisionedConcurrencyConfig", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty" } ] } } } ] }, "@aws-cdk/aws-lambda.Code": { "abstract": true, "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.Code", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 5 }, "methods": [ { "docs": { "deprecated": "use `fromAsset`", "stability": "deprecated" }, "locationInModule": { "filename": "lib/code.ts", "line": 50 }, "name": "asset", "parameters": [ { "name": "path", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.AssetCode" } }, "static": true }, { "docs": { "deprecated": "use `fromBucket`", "stability": "deprecated" }, "locationInModule": { "filename": "lib/code.ts", "line": 19 }, "name": "bucket", "parameters": [ { "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "name": "key", "type": { "primitive": "string" } }, { "name": "objectVersion", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.S3Code" } }, "static": true }, { "docs": { "deprecated": "use `fromCfnParameters`", "stability": "deprecated" }, "locationInModule": { "filename": "lib/code.ts", "line": 67 }, "name": "cfnParameters", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.CfnParametersCodeProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.CfnParametersCode" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Loads the function code from a local disk path." }, "locationInModule": { "filename": "lib/code.ts", "line": 43 }, "name": "fromAsset", "parameters": [ { "docs": { "summary": "Either a directory with the Lambda code bundle or a .zip file." }, "name": "path", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3-assets.AssetOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.AssetCode" } }, "static": true }, { "docs": { "returns": "`LambdaS3Code` associated with the specified S3 object.", "stability": "stable" }, "locationInModule": { "filename": "lib/code.ts", "line": 12 }, "name": "fromBucket", "parameters": [ { "docs": { "summary": "The S3 bucket." }, "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "docs": { "summary": "The object key." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "Optional S3 object version." }, "name": "objectVersion", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.S3Code" } }, "static": true }, { "docs": { "returns": "a new instance of `CfnParametersCode`", "stability": "stable", "summary": "Creates a new Lambda source defined using CloudFormation parameters." }, "locationInModule": { "filename": "lib/code.ts", "line": 60 }, "name": "fromCfnParameters", "parameters": [ { "docs": { "summary": "optional construction properties of {@link CfnParametersCode}." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.CfnParametersCodeProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.CfnParametersCode" } }, "static": true }, { "docs": { "returns": "`LambdaInlineCode` with inline code.", "stability": "stable" }, "locationInModule": { "filename": "lib/code.ts", "line": 27 }, "name": "fromInline", "parameters": [ { "docs": { "summary": "The actual handler code (limited to 4KiB)." }, "name": "code", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.InlineCode" } }, "static": true }, { "docs": { "deprecated": "use `fromInline`", "stability": "deprecated" }, "locationInModule": { "filename": "lib/code.ts", "line": 34 }, "name": "inline", "parameters": [ { "name": "code", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.InlineCode" } }, "static": true }, { "abstract": true, "docs": { "stability": "stable", "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 86 }, "name": "bind", "parameters": [ { "docs": { "remarks": "Don't be smart about trying to down-cast or\nassume it's initialized. You may just use it as a construct scope.", "summary": "The binding scope." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.CodeConfig" } } }, { "docs": { "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.", "stability": "stable", "summary": "Called after the CFN function resource has been created to allow the code class to bind to it." }, "locationInModule": { "filename": "lib/code.ts", "line": 93 }, "name": "bindToResource", "parameters": [ { "name": "_resource", "type": { "fqn": "@aws-cdk/core.CfnResource" } }, { "name": "_options", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.ResourceBindOptions" } } ] } ], "name": "Code", "properties": [ { "abstract": true, "docs": { "deprecated": "this value is ignored since inline is now determined based on the\nthe `inlineCode` field of `CodeConfig` returned from `bind()`.", "stability": "deprecated", "summary": "Determines whether this Code is inline code or not." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 77 }, "name": "isInline", "type": { "primitive": "boolean" } } ] }, "@aws-cdk/aws-lambda.CodeConfig": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.CodeConfig", "kind": "interface", "locationInModule": { "filename": "lib/code.ts", "line": 98 }, "name": "CodeConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Inline code (mutually exclusive with `s3Location`)." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 107 }, "name": "inlineCode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The location of the code in S3 (mutually exclusive with `inlineCode`)." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 102 }, "name": "s3Location", "optional": true, "type": { "fqn": "@aws-cdk/aws-s3.Location" } } ] }, "@aws-cdk/aws-lambda.DestinationConfig": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "A destination configuration." }, "fqn": "@aws-cdk/aws-lambda.DestinationConfig", "kind": "interface", "locationInModule": { "filename": "lib/destination.ts", "line": 7 }, "name": "DestinationConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The Amazon Resource Name (ARN) of the destination resource." }, "immutable": true, "locationInModule": { "filename": "lib/destination.ts", "line": 11 }, "name": "destination", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.DestinationOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Options when binding a destination to a function." }, "fqn": "@aws-cdk/aws-lambda.DestinationOptions", "kind": "interface", "locationInModule": { "filename": "lib/destination.ts", "line": 32 }, "name": "DestinationOptions", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The destination type." }, "immutable": true, "locationInModule": { "filename": "lib/destination.ts", "line": 36 }, "name": "type", "type": { "fqn": "@aws-cdk/aws-lambda.DestinationType" } } ] }, "@aws-cdk/aws-lambda.DestinationType": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable", "summary": "The type of destination." }, "fqn": "@aws-cdk/aws-lambda.DestinationType", "kind": "enum", "locationInModule": { "filename": "lib/destination.ts", "line": 17 }, "members": [ { "docs": { "stability": "stable", "summary": "Failure." }, "name": "FAILURE" }, { "docs": { "stability": "stable", "summary": "Success." }, "name": "SUCCESS" } ], "name": "DestinationType" }, "@aws-cdk/aws-lambda.DlqDestinationConfig": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "A destination configuration." }, "fqn": "@aws-cdk/aws-lambda.DlqDestinationConfig", "kind": "interface", "locationInModule": { "filename": "lib/dlq.ts", "line": 7 }, "name": "DlqDestinationConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The Amazon Resource Name (ARN) of the destination resource." }, "immutable": true, "locationInModule": { "filename": "lib/dlq.ts", "line": 11 }, "name": "destination", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.EnvironmentOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Environment variables options." }, "fqn": "@aws-cdk/aws-lambda.EnvironmentOptions", "kind": "interface", "locationInModule": { "filename": "lib/function.ts", "line": 931 }, "name": "EnvironmentOptions", "properties": [ { "abstract": true, "docs": { "custom": { "Edge": "will throw" }, "default": "false - using the function in Lambda", "remarks": "If not set, an error will be thrown.", "see": "https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html#lambda-requirements-lambda-function-configuration", "stability": "stable", "summary": "When used in Lambda@Edge via edgeArn() API, these environment variables will be removed." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 939 }, "name": "removeInEdge", "optional": true, "type": { "primitive": "boolean" } } ] }, "@aws-cdk/aws-lambda.EventInvokeConfig": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.Resource", "docs": { "remarks": "By default, Lambda retries an asynchronous invocation twice if the function\nreturns an error. It retains events in a queue for up to six hours. When an\nevent fails all processing attempts or stays in the asynchronous invocation\nqueue for too long, Lambda discards it.", "stability": "stable", "summary": "Configure options for asynchronous invocation on a version or an alias." }, "fqn": "@aws-cdk/aws-lambda.EventInvokeConfig", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 72 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 71 }, "name": "EventInvokeConfig" }, "@aws-cdk/aws-lambda.EventInvokeConfigOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Options to add an EventInvokeConfig to a function." }, "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions", "kind": "interface", "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 9 }, "name": "EventInvokeConfigOptions", "properties": [ { "abstract": true, "docs": { "default": "Duration.hours(6)", "remarks": "Minimum: 60 seconds\nMaximum: 6 hours", "stability": "stable", "summary": "The maximum age of a request that Lambda sends to a function for processing." }, "immutable": true, "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 33 }, "name": "maxEventAge", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- no destination", "stability": "stable", "summary": "The destination for failed invocations." }, "immutable": true, "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 15 }, "name": "onFailure", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.IDestination" } }, { "abstract": true, "docs": { "default": "- no destination", "stability": "stable", "summary": "The destination for successful invocations." }, "immutable": true, "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 22 }, "name": "onSuccess", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.IDestination" } }, { "abstract": true, "docs": { "default": "2", "remarks": "Minimum: 0\nMaximum: 2", "stability": "stable", "summary": "The maximum number of times to retry when the function returns an error." }, "immutable": true, "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 43 }, "name": "retryAttempts", "optional": true, "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.EventInvokeConfigProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for an EventInvokeConfig." }, "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigProps", "interfaces": [ "@aws-cdk/aws-lambda.EventInvokeConfigOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 49 }, "name": "EventInvokeConfigProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 53 }, "name": "function", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "abstract": true, "docs": { "default": "- latest version", "stability": "stable", "summary": "The qualifier." }, "immutable": true, "locationInModule": { "filename": "lib/event-invoke-config.ts", "line": 60 }, "name": "qualifier", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.EventSourceMapping": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.Resource", "docs": { "remarks": "Usually, you won't need to define the mapping yourself. This will usually be done by\nevent sources. For example, to add an SQS event source to a function:\n\n import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';\n lambda.addEventSource(new SqsEventSource(sqs));\n\nThe `SqsEventSource` class will automatically create the mapping, and will also\nmodify the Lambda's execution role so it can consume messages from the queue.", "stability": "stable", "summary": "Defines a Lambda EventSourceMapping resource." }, "fqn": "@aws-cdk/aws-lambda.EventSourceMapping", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 144 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.EventSourceMappingProps" } } ] }, "interfaces": [ "@aws-cdk/aws-lambda.IEventSourceMapping" ], "kind": "class", "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 130 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an event source into this stack from its event source id." }, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 135 }, "name": "fromEventSourceMappingId", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "eventSourceMappingId", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.IEventSourceMapping" } }, "static": true } ], "name": "EventSourceMapping", "properties": [ { "docs": { "stability": "stable", "summary": "The identifier for this EventSourceMapping." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 142 }, "name": "eventSourceMappingId", "overrides": "@aws-cdk/aws-lambda.IEventSourceMapping", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.EventSourceMappingOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.EventSourceMappingOptions", "kind": "interface", "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 6 }, "name": "EventSourceMappingOptions", "properties": [ { "abstract": true, "docs": { "remarks": "Any record added to\nthis stream can invoke the Lambda function.", "stability": "stable", "summary": "The Amazon Resource Name (ARN) of the event source." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 11 }, "name": "eventSourceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Amazon Kinesis and Amazon DynamoDB is 100 records.\nBoth the default and maximum for Amazon SQS are 10 messages.", "remarks": "Your function receives an\nevent with all the retrieved records.\n\nValid Range: Minimum value of 1. Maximum value of 10000.", "stability": "stable", "summary": "The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 23 }, "name": "batchSize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "If the function returns an error, split the batch in two and retry." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 30 }, "name": "bisectBatchOnError", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Set to false to disable the event source upon creation." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 44 }, "name": "enabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "Duration.seconds(0)", "remarks": "Maximum of Duration.minutes(5)", "stability": "stable", "summary": "The maximum amount of time to gather records before invoking the function." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 62 }, "name": "maxBatchingWindow", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "Duration.days(7)", "remarks": "Valid Range:\n* Minimum value of 60 seconds\n* Maximum value of 7 days", "stability": "stable", "summary": "The maximum age of a record that Lambda sends to a function for processing." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 72 }, "name": "maxRecordAge", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "discarded records are ignored", "stability": "stable", "summary": "An Amazon SQS queue or Amazon SNS topic destination for discarded records." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 37 }, "name": "onFailure", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.IEventSourceDlq" } }, { "abstract": true, "docs": { "default": "1", "remarks": "Valid Range:\n* Minimum value of 1\n* Maximum value of 10", "stability": "stable", "summary": "The number of batches to process from each shard concurrently." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 93 }, "name": "parallelizationFactor", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "10000", "remarks": "Valid Range:\n* Minimum value of 0\n* Maximum value of 10000", "stability": "stable", "summary": "The maximum number of times to retry when the function returns an error." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 83 }, "name": "retryAttempts", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- Required for Amazon Kinesis and Amazon DynamoDB Streams sources.", "see": "https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType", "stability": "stable", "summary": "The position in the DynamoDB or Kinesis stream where AWS Lambda should start reading." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 54 }, "name": "startingPosition", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.StartingPosition" } } ] }, "@aws-cdk/aws-lambda.EventSourceMappingProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for declaring a new event source mapping." }, "fqn": "@aws-cdk/aws-lambda.EventSourceMappingProps", "interfaces": [ "@aws-cdk/aws-lambda.EventSourceMappingOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 99 }, "name": "EventSourceMappingProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The target AWS Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 103 }, "name": "target", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } } ] }, "@aws-cdk/aws-lambda.FileSystem": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "experimental", "summary": "Represents the filesystem for the Lambda function." }, "fqn": "@aws-cdk/aws-lambda.FileSystem", "initializer": { "docs": { "stability": "experimental" }, "locationInModule": { "filename": "lib/filesystem.ts", "line": 84 }, "parameters": [ { "docs": { "summary": "the FileSystem configurations for the Lambda function." }, "name": "config", "type": { "fqn": "@aws-cdk/aws-lambda.FileSystemConfig" } } ], "protected": true }, "kind": "class", "locationInModule": { "filename": "lib/filesystem.ts", "line": 47 }, "methods": [ { "docs": { "stability": "experimental", "summary": "mount the filesystem from Amazon EFS." }, "locationInModule": { "filename": "lib/filesystem.ts", "line": 53 }, "name": "fromEfsAccessPoint", "parameters": [ { "docs": { "summary": "the Amazon EFS access point." }, "name": "ap", "type": { "fqn": "@aws-cdk/aws-efs.AccessPoint" } }, { "docs": { "summary": "the target path in the lambda runtime environment." }, "name": "mountPath", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.FileSystem" } }, "static": true } ], "name": "FileSystem", "properties": [ { "docs": { "stability": "experimental", "summary": "the FileSystem configurations for the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/filesystem.ts", "line": 84 }, "name": "config", "type": { "fqn": "@aws-cdk/aws-lambda.FileSystemConfig" } } ] }, "@aws-cdk/aws-lambda.FileSystemConfig": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "experimental", "summary": "FileSystem configurations for the Lambda function." }, "fqn": "@aws-cdk/aws-lambda.FileSystemConfig", "kind": "interface", "locationInModule": { "filename": "lib/filesystem.ts", "line": 10 }, "name": "FileSystemConfig", "properties": [ { "abstract": true, "docs": { "stability": "experimental", "summary": "ARN of the access point." }, "immutable": true, "locationInModule": { "filename": "lib/filesystem.ts", "line": 19 }, "name": "arn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "experimental", "summary": "mount path in the lambda runtime environment." }, "immutable": true, "locationInModule": { "filename": "lib/filesystem.ts", "line": 14 }, "name": "localMountPath", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no connections required to add extra ingress rules for Lambda function", "stability": "experimental", "summary": "connections object used to allow ingress traffic from lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/filesystem.ts", "line": 33 }, "name": "connections", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "abstract": true, "docs": { "default": "- no dependency", "stability": "experimental", "summary": "array of IDependable that lambda function depends on." }, "immutable": true, "locationInModule": { "filename": "lib/filesystem.ts", "line": 26 }, "name": "dependency", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.IDependable" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no additional policies required", "stability": "experimental", "summary": "additional IAM policies required for the lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/filesystem.ts", "line": 40 }, "name": "policies", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-iam.PolicyStatement" }, "kind": "array" } } } ] }, "@aws-cdk/aws-lambda.Function": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.FunctionBase", "docs": { "remarks": "The supplied file is subject to the 4096 bytes limit of being embedded in a\nCloudFormation template.\n\nThe construct includes an associated role with the lambda.\n\nThis construct does not yet reproduce all features from the underlying resource\nlibrary.", "stability": "stable", "summary": "Deploys a file from from inside the construct library as a function." }, "fqn": "@aws-cdk/aws-lambda.Function", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/function.ts", "line": 523 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.FunctionProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/function.ts", "line": 324 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/function.ts", "line": 361 }, "name": "fromFunctionArn", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "functionArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a Lambda function object which represents a function not defined within this stack." }, "locationInModule": { "filename": "lib/function.ts", "line": 373 }, "name": "fromFunctionAttributes", "parameters": [ { "docs": { "summary": "The parent construct." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "The name of the lambda construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the attributes of the function to import." }, "name": "attrs", "type": { "fqn": "@aws-cdk/aws-lambda.FunctionAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Return the given named metric for this Lambda." }, "locationInModule": { "filename": "lib/function.ts", "line": 410 }, "name": "metricAll", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } }, "static": true }, { "docs": { "default": "max over 5 minutes", "stability": "stable", "summary": "Metric for the number of concurrent executions across all Lambdas." }, "locationInModule": { "filename": "lib/function.ts", "line": 458 }, "name": "metricAllConcurrentExecutions", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } }, "static": true }, { "docs": { "default": "average over 5 minutes", "stability": "stable", "summary": "Metric for the Duration executing all Lambdas." }, "locationInModule": { "filename": "lib/function.ts", "line": 431 }, "name": "metricAllDuration", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } }, "static": true }, { "docs": { "default": "sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of Errors executing all Lambdas." }, "locationInModule": { "filename": "lib/function.ts", "line": 422 }, "name": "metricAllErrors", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } }, "static": true }, { "docs": { "default": "sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of invocations of all Lambdas." }, "locationInModule": { "filename": "lib/function.ts", "line": 440 }, "name": "metricAllInvocations", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } }, "static": true }, { "docs": { "default": "sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of throttled invocations of all Lambdas." }, "locationInModule": { "filename": "lib/function.ts", "line": 449 }, "name": "metricAllThrottles", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } }, "static": true }, { "docs": { "default": "max over 5 minutes", "stability": "stable", "summary": "Metric for the number of unreserved concurrent executions across all Lambdas." }, "locationInModule": { "filename": "lib/function.ts", "line": 473 }, "name": "metricAllUnreservedConcurrentExecutions", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } }, "static": true }, { "docs": { "remarks": "If this is a ref to a Lambda function, this operation results in a no-op.", "stability": "stable", "summary": "Adds an environment variable to this Lambda function." }, "locationInModule": { "filename": "lib/function.ts", "line": 683 }, "name": "addEnvironment", "parameters": [ { "docs": { "summary": "The environment variable key." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "The environment variable's value." }, "name": "value", "type": { "primitive": "string" } }, { "docs": { "summary": "Environment variable options." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.EnvironmentOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.Function" } } }, { "docs": { "custom": { "throws": "if there are already 5 layers on this function, or the layer is incompatible with this function's runtime." }, "stability": "stable", "summary": "Adds one or more Lambda Layers to this Lambda function." }, "locationInModule": { "filename": "lib/function.ts", "line": 695 }, "name": "addLayers", "parameters": [ { "docs": { "summary": "the layers to be added." }, "name": "layers", "type": { "fqn": "@aws-cdk/aws-lambda.ILayerVersion" }, "variadic": true } ], "variadic": true }, { "docs": { "deprecated": "This method will create an AWS::Lambda::Version resource which\nsnapshots the AWS Lambda function *at the time of its creation* and it\nwon't get updated when the function changes. Instead, use\n`this.currentVersion` to obtain a reference to a version resource that gets\nautomatically recreated when the function configuration (or code) changes.", "remarks": "If you want to deploy through CloudFormation and use aliases, you need to\nadd a new version (with a new name) to your Lambda every time you want to\ndeploy an update. An alias can then refer to the newly created Version.\n\nAll versions should have distinct names, and you should not delete versions\nas long as your Alias needs to refer to them.", "returns": "A new Version object.", "stability": "deprecated", "summary": "Add a new version for this Lambda." }, "locationInModule": { "filename": "lib/function.ts", "line": 734 }, "name": "addVersion", "parameters": [ { "docs": { "summary": "A unique name for this version." }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "summary": "The SHA-256 hash of the most recently deployed Lambda source code, or omit to skip validation." }, "name": "codeSha256", "optional": true, "type": { "primitive": "string" } }, { "docs": { "summary": "A description for this version." }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "docs": { "summary": "A provisioned concurrency configuration for a function's version." }, "name": "provisionedExecutions", "optional": true, "type": { "primitive": "number" } }, { "docs": { "summary": "configuration for this version when it is invoked asynchronously." }, "name": "asyncInvokeConfig", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.Version" } } } ], "name": "Function", "properties": [ { "docs": { "remarks": "True for new Lambdas, false for imported Lambdas (they might live in different accounts).", "stability": "stable", "summary": "Whether the addPermission() call adds any permissions." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 509 }, "name": "canCreatePermissions", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "remarks": "You can specify options for this version using the `currentVersionOptions`\nprop when initializing the `lambda.Function`.", "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 334 }, "name": "currentVersion", "type": { "fqn": "@aws-cdk/aws-lambda.Version" } }, { "docs": { "stability": "stable", "summary": "ARN of this function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 485 }, "name": "functionArn", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Name of this function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 480 }, "name": "functionName", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The principal this Lambda Function is running as." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 500 }, "name": "grantPrincipal", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } }, { "docs": { "remarks": "If either `logRetention` is set or this property is called, a CloudFormation custom resource is added to the stack that\npre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention\nperiod (never expire, by default).\n\nFurther, if the log group already exists and the `logRetention` is not set, the custom resource will reset the log retention\nto never expire even if it was configured with a different value.", "stability": "stable", "summary": "The LogGroup where the Lambda function's logs are made available." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 760 }, "name": "logGroup", "type": { "fqn": "@aws-cdk/aws-logs.ILogGroup" } }, { "docs": { "stability": "stable", "summary": "The construct node where permissions are attached." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 507 }, "name": "permissionsNode", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "fqn": "@aws-cdk/core.ConstructNode" } }, { "docs": { "stability": "stable", "summary": "The runtime configured for this lambda." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 495 }, "name": "runtime", "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "docs": { "stability": "stable", "summary": "The DLQ associated with this Lambda Function (this is an optional attribute)." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 505 }, "name": "deadLetterQueue", "optional": true, "type": { "fqn": "@aws-cdk/aws-sqs.IQueue" } }, { "docs": { "stability": "stable", "summary": "Execution role associated with this function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 490 }, "name": "role", "optional": true, "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ] }, "@aws-cdk/aws-lambda.FunctionAttributes": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Represents a Lambda function defined outside of this stack." }, "fqn": "@aws-cdk/aws-lambda.FunctionAttributes", "kind": "interface", "locationInModule": { "filename": "lib/function-base.ts", "line": 120 }, "name": "FunctionAttributes", "properties": [ { "abstract": true, "docs": { "remarks": "Format: arn::lambda:::function:", "stability": "stable", "summary": "The ARN of the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 126 }, "name": "functionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If the role is not specified, any role-related operations will no-op.", "stability": "stable", "summary": "The IAM execution role associated with this function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 133 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "remarks": "This needs to be given in order to support allowing connections\nto this Lambda.", "stability": "stable", "summary": "The security group of this Lambda, if in a VPC." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 151 }, "name": "securityGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" } }, { "abstract": true, "docs": { "deprecated": "use `securityGroup` instead", "remarks": "This needs to be given in order to support allowing connections\nto this Lambda.", "stability": "deprecated", "summary": "Id of the security group of this Lambda, if in a VPC." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 143 }, "name": "securityGroupId", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.FunctionBase": { "abstract": true, "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.FunctionBase", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/resource.ts", "line": 110 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/core.ResourceProps" } } ] }, "interfaces": [ "@aws-cdk/aws-lambda.IFunction" ], "kind": "class", "locationInModule": { "filename": "lib/function-base.ts", "line": 154 }, "methods": [ { "docs": { "remarks": "Event sources are implemented in the @aws-cdk/aws-lambda-event-sources module.\n\nThe following example adds an SQS Queue as an event source:\n\n import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';\n myFunction.addEventSource(new SqsEventSource(myQueue));", "stability": "stable", "summary": "Adds an event source to this function." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 325 }, "name": "addEventSource", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "docs": { "summary": "The event source to bind to this function." }, "name": "source", "type": { "fqn": "@aws-cdk/aws-lambda.IEventSource" } } ] }, { "docs": { "stability": "stable", "summary": "Adds an event source that maps to this AWS Lambda function." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 270 }, "name": "addEventSourceMapping", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-lambda.EventSourceMappingOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.EventSourceMapping" } } }, { "docs": { "see": "Permission for details.", "stability": "stable", "summary": "Adds a permission to the Lambda resource policy." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 210 }, "name": "addPermission", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "docs": { "summary": "The id ƒor the permission construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "The permission to grant to this Lambda function." }, "name": "permission", "type": { "fqn": "@aws-cdk/aws-lambda.Permission" } } ] }, { "docs": { "stability": "stable", "summary": "Adds a statement to the IAM role assumed by the instance." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 233 }, "name": "addToRolePolicy", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "statement", "type": { "fqn": "@aws-cdk/aws-iam.PolicyStatement" } } ] }, { "docs": { "stability": "stable", "summary": "Configures options for asynchronous invocation." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 329 }, "name": "configureAsyncInvoke", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions" } } ] }, { "docs": { "stability": "stable", "summary": "Grant the given identity permissions to invoke this Lambda." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 280 }, "name": "grantInvoke", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Return the given named metric for this Function." }, "locationInModule": { "filename": "lib/lambda-augmentations.generated.ts", "line": 41 }, "name": "metric", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "How long execution of this Lambda takes." }, "locationInModule": { "filename": "lib/lambda-augmentations.generated.ts", "line": 65 }, "name": "metricDuration", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Sum over 5 minutes", "stability": "stable", "summary": "How many invocations of this Lambda fail." }, "locationInModule": { "filename": "lib/lambda-augmentations.generated.ts", "line": 59 }, "name": "metricErrors", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Sum over 5 minutes", "stability": "stable", "summary": "How often this Lambda is invoked." }, "locationInModule": { "filename": "lib/lambda-augmentations.generated.ts", "line": 53 }, "name": "metricInvocations", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Sum over 5 minutes", "stability": "stable", "summary": "How often this Lambda is throttled." }, "locationInModule": { "filename": "lib/lambda-augmentations.generated.ts", "line": 47 }, "name": "metricThrottles", "overrides": "@aws-cdk/aws-lambda.IFunction", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "FunctionBase", "properties": [ { "abstract": true, "docs": { "remarks": "True for new Lambdas, false for imported Lambdas (they might live in different accounts).", "stability": "stable", "summary": "Whether the addPermission() call adds any permissions." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 187 }, "name": "canCreatePermissions", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "remarks": "Will fail if not a VPC-enabled Lambda Function", "stability": "stable", "summary": "Access the Connections object." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 246 }, "name": "connections", "overrides": "@aws-cdk/aws-ec2.IConnectable", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN fo the function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 168 }, "name": "functionArn", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 163 }, "name": "functionName", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The principal this Lambda Function is running as." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 158 }, "name": "grantPrincipal", "overrides": "@aws-cdk/aws-iam.IGrantable", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } }, { "docs": { "remarks": "If this is is `false`, trying to access the `connections` object will fail.", "stability": "stable", "summary": "Whether or not this Lambda function was bound to a VPC." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 266 }, "name": "isBoundToVpc", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "primitive": "boolean" } }, { "docs": { "remarks": "Note that this is reference to a non-specific AWS Lambda version, which\nmeans the function this version refers to can return different results in\ndifferent invocations.\n\nTo obtain a reference to an explicit version which references the current\nfunction configuration, use `lambdaFunction.currentVersion` instead.", "stability": "stable", "summary": "The `$LATEST` version of this function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 254 }, "name": "latestVersion", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The construct node where permissions are attached." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 180 }, "name": "permissionsNode", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "fqn": "@aws-cdk/core.ConstructNode" } }, { "abstract": true, "docs": { "remarks": "Undefined if the function was imported without a role.", "stability": "stable", "summary": "The IAM role associated with this function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 175 }, "name": "role", "optional": true, "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ] }, "@aws-cdk/aws-lambda.FunctionOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Non runtime options." }, "fqn": "@aws-cdk/aws-lambda.FunctionOptions", "interfaces": [ "@aws-cdk/aws-lambda.EventInvokeConfigOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/function.ts", "line": 43 }, "name": "FunctionOptions", "properties": [ { "abstract": true, "docs": { "default": "true", "remarks": "If set to false, you must individually add traffic rules to allow the\nLambda to connect to network targets.", "stability": "stable", "summary": "Whether to allow the Lambda to send all network traffic." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 170 }, "name": "allowAllOutbound", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options as described in `VersionOptions`", "stability": "stable", "summary": "Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 266 }, "name": "currentVersionOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.VersionOptions" } }, { "abstract": true, "docs": { "default": "- SQS queue with 14 day retention period if `deadLetterQueueEnabled` is `true`", "stability": "stable", "summary": "The SQS queue to use if DLQ is enabled." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 185 }, "name": "deadLetterQueue", "optional": true, "type": { "fqn": "@aws-cdk/aws-sqs.IQueue" } }, { "abstract": true, "docs": { "default": "- false unless `deadLetterQueue` is set, which implies DLQ is enabled.", "remarks": "If `deadLetterQueue` is undefined,\nan SQS queue with default options will be defined for your Function.", "stability": "stable", "summary": "Enabled DLQ." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 178 }, "name": "deadLetterQueueEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- No description.", "stability": "stable", "summary": "A description of the function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 49 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No environment variables.", "remarks": "Use environment variables to apply configuration changes, such\nas test and production environment configurations, without changing your\nLambda function source code.", "stability": "stable", "summary": "Key-value pairs that Lambda caches and makes available for your Lambda functions." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 68 }, "name": "environment", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- No event sources.", "remarks": "You can also add event sources using `addEventSource`.", "stability": "stable", "summary": "Event sources for this function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 234 }, "name": "events", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-lambda.IEventSource" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- AWS CloudFormation generates a unique physical ID and uses that\nID for the function's name. For more information, see Name Type.", "stability": "stable", "summary": "A name for the function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 76 }, "name": "functionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No policy statements are added to the created Lambda role.", "remarks": "You can call `addToRolePolicy` to the created lambda to add statements post creation.", "stability": "stable", "summary": "Initial policy statements to add to the created Lambda Role." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 95 }, "name": "initialPolicy", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-iam.PolicyStatement" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No layers.", "remarks": "You can configure your Lambda function to pull in\nadditional code during initialization in the form of layers. Layers are packages of libraries or other dependencies\nthat can be used by mulitple functions.", "stability": "stable", "summary": "A list of layers to add to the function's execution environment." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 217 }, "name": "layers", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-lambda.ILayerVersion" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "logs.RetentionDays.INFINITE", "remarks": "When updating\nthis property, unsetting it doesn't remove the log retention policy. To\nremove the retention policy, set the value to `INFINITE`.", "stability": "stable", "summary": "The number of days log events are kept in CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 243 }, "name": "logRetention", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.RetentionDays" } }, { "abstract": true, "docs": { "default": "- Default AWS SDK retry options.", "remarks": "These options control the retry policy when interacting with CloudWatch APIs.", "stability": "stable", "summary": "When log retention is specified, a custom resource attempts to create the CloudWatch log group." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 259 }, "name": "logRetentionRetryOptions", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.LogRetentionRetryOptions" } }, { "abstract": true, "docs": { "default": "- A new role is created.", "stability": "stable", "summary": "The IAM role for the Lambda function associated with the custom resource that sets the retention policy." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 251 }, "name": "logRetentionRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "128", "remarks": "Lambda uses this value to proportionally allocate the amount of CPU\npower. For more information, see Resource Model in the AWS Lambda\nDeveloper Guide.", "stability": "stable", "summary": "The amount of memory, in MB, that is allocated to your Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 86 }, "name": "memorySize", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- No profiling.", "see": "https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html", "stability": "stable", "summary": "Enable profiling." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 200 }, "name": "profiling", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- A new profiling group will be created if `profiling` is set.", "see": "https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html", "stability": "stable", "summary": "Profiling Group." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 208 }, "name": "profilingGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-codeguruprofiler.IProfilingGroup" } }, { "abstract": true, "docs": { "default": "- No specific limit - account limit.", "see": "https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html", "stability": "stable", "summary": "The maximum of concurrent executions you want to reserve for the function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 225 }, "name": "reservedConcurrentExecutions", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- A unique role will be generated for this lambda function.\nBoth supplied and generated roles can always be changed by calling `addToRolePolicy`.", "remarks": "This is the role that will be assumed by the function upon execution.\nIt controls the permissions that the function will have. The Role must\nbe assumable by the 'lambda.amazonaws.com' service principal.\n\nThe default Role automatically has permissions granted for Lambda execution. If you\nprovide a Role, you must add the relevant AWS managed policies yourself.\n\nThe relevant managed policies are \"service-role/AWSLambdaBasicExecutionRole\" and\n\"service-role/AWSLambdaVPCAccessExecutionRole\".", "stability": "stable", "summary": "Lambda execution role." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 113 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- If the function is placed within a VPC and a security group is\nnot specified, either by this or securityGroups prop, a dedicated security\ngroup will be created for this function.", "deprecated": "- This property is deprecated, use securityGroups instead", "remarks": "Only used if 'vpc' is supplied.\n\nUse securityGroups property instead.\nFunction constructor will throw an error if both are specified.", "stability": "deprecated", "summary": "What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 149 }, "name": "securityGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" } }, { "abstract": true, "docs": { "default": "- If the function is placed within a VPC and a security group is\nnot specified, either by this or securityGroup prop, a dedicated security\ngroup will be created for this function.", "remarks": "Only used if 'vpc' is supplied.", "stability": "stable", "summary": "The list of security groups to associate with the Lambda's network interfaces." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 160 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "Duration.seconds(3)", "remarks": "Because the execution time affects cost, set this value\nbased on the function's expected execution time.", "stability": "stable", "summary": "The function execution time (in seconds) after which Lambda terminates the function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 58 }, "name": "timeout", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "Tracing.Disabled", "stability": "stable", "summary": "Enable AWS X-Ray Tracing for Lambda Function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 192 }, "name": "tracing", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.Tracing" } }, { "abstract": true, "docs": { "default": "- Function is not placed within a VPC.", "remarks": "Specify this if the Lambda function needs to access resources in a VPC.", "stability": "stable", "summary": "VPC network to place Lambda network interfaces." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 122 }, "name": "vpc", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "- the Vpc default strategy if not specified", "remarks": "Only used if 'vpc' is supplied. Note: internet access for Lambdas\nrequires a NAT gateway, so picking Public subnets is not allowed.", "stability": "stable", "summary": "Where to place the network interfaces within the VPC." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 132 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ] }, "@aws-cdk/aws-lambda.FunctionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.FunctionProps", "interfaces": [ "@aws-cdk/aws-lambda.FunctionOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/function.ts", "line": 269 }, "name": "FunctionProps", "properties": [ { "abstract": true, "docs": { "remarks": "You can point to a file in an\nAmazon Simple Storage Service (Amazon S3) bucket or specify your source\ncode as inline text.", "stability": "stable", "summary": "The source code of your Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 282 }, "name": "code", "type": { "fqn": "@aws-cdk/aws-lambda.Code" } }, { "abstract": true, "docs": { "remarks": "The format includes the file name. It can also include\nnamespaces and other qualifiers, depending on the runtime.\nFor more information, see https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-features.html#gettingstarted-features-programmingmodel.\n\nNOTE: If you specify your source code as inline text by specifying the\nZipFile property within the Code property, specify index.function_name as\nthe handler.", "stability": "stable", "summary": "The name of the method within your code that Lambda calls to execute your function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 294 }, "name": "handler", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "For valid values, see the Runtime property in the AWS Lambda Developer\nGuide.", "stability": "stable", "summary": "The runtime environment for the Lambda function that you are uploading." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 275 }, "name": "runtime", "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Use this property to acknowledge this limitation and still place the function in a public subnet.", "see": "https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841", "stability": "stable", "summary": "Lambda Functions in a public subnet can NOT access the internet." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 310 }, "name": "allowPublicSubnet", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- will not mount any filesystem", "stability": "stable", "summary": "The filesystem configuration for the lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/function.ts", "line": 301 }, "name": "filesystem", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.FileSystem" } } ] }, "@aws-cdk/aws-lambda.IAlias": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.IAlias", "interfaces": [ "@aws-cdk/aws-lambda.IFunction" ], "kind": "interface", "locationInModule": { "filename": "lib/alias.ts", "line": 12 }, "name": "IAlias", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Name of this alias." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 18 }, "name": "aliasName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The underlying Lambda function version." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 23 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } } ] }, "@aws-cdk/aws-lambda.IDestination": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable", "summary": "A Lambda destination." }, "fqn": "@aws-cdk/aws-lambda.IDestination", "kind": "interface", "locationInModule": { "filename": "lib/destination.ts", "line": 42 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Binds this destination to the Lambda function." }, "locationInModule": { "filename": "lib/destination.ts", "line": 46 }, "name": "bind", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "fn", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.DestinationOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.DestinationConfig" } } } ], "name": "IDestination" }, "@aws-cdk/aws-lambda.IEventSource": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable", "summary": "An abstract class which represents an AWS Lambda event source." }, "fqn": "@aws-cdk/aws-lambda.IEventSource", "kind": "interface", "locationInModule": { "filename": "lib/event-source.ts", "line": 6 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Called by `lambda.addEventSource` to allow the event source to bind to this function." }, "locationInModule": { "filename": "lib/event-source.ts", "line": 13 }, "name": "bind", "parameters": [ { "docs": { "summary": "That lambda function to bind to." }, "name": "target", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } } ] } ], "name": "IEventSource" }, "@aws-cdk/aws-lambda.IEventSourceDlq": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable", "summary": "A DLQ for an event source." }, "fqn": "@aws-cdk/aws-lambda.IEventSourceDlq", "kind": "interface", "locationInModule": { "filename": "lib/dlq.ts", "line": 17 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Returns the DLQ destination config of the DLQ." }, "locationInModule": { "filename": "lib/dlq.ts", "line": 21 }, "name": "bind", "parameters": [ { "name": "target", "type": { "fqn": "@aws-cdk/aws-lambda.IEventSourceMapping" } }, { "name": "targetHandler", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.DlqDestinationConfig" } } } ], "name": "IEventSourceDlq" }, "@aws-cdk/aws-lambda.IEventSourceMapping": { "assembly": "@aws-cdk/aws-lambda", "docs": { "see": "https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html", "stability": "stable", "summary": "Represents an event source mapping for a lambda function." }, "fqn": "@aws-cdk/aws-lambda.IEventSourceMapping", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 110 }, "name": "IEventSourceMapping", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The identifier for this EventSourceMapping." }, "immutable": true, "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 115 }, "name": "eventSourceMappingId", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.IFunction": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.IFunction", "interfaces": [ "@aws-cdk/core.IResource", "@aws-cdk/aws-ec2.IConnectable", "@aws-cdk/aws-iam.IGrantable" ], "kind": "interface", "locationInModule": { "filename": "lib/function-base.ts", "line": 14 }, "methods": [ { "abstract": true, "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/function-base.ts", "line": 109 }, "name": "addEventSource", "parameters": [ { "name": "source", "type": { "fqn": "@aws-cdk/aws-lambda.IEventSource" } } ] }, { "abstract": true, "docs": { "stability": "stable", "summary": "Adds an event source that maps to this AWS Lambda function." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 64 }, "name": "addEventSourceMapping", "parameters": [ { "docs": { "summary": "construct ID." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "mapping options." }, "name": "options", "type": { "fqn": "@aws-cdk/aws-lambda.EventSourceMappingOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.EventSourceMapping" } } }, { "abstract": true, "docs": { "see": "Permission for details.", "stability": "stable", "summary": "Adds a permission to the Lambda resource policy." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 71 }, "name": "addPermission", "parameters": [ { "docs": { "summary": "The id ƒor the permission construct." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "The permission to grant to this Lambda function." }, "name": "permission", "type": { "fqn": "@aws-cdk/aws-lambda.Permission" } } ] }, { "abstract": true, "docs": { "stability": "stable", "summary": "Adds a statement to the IAM role assumed by the instance." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 76 }, "name": "addToRolePolicy", "parameters": [ { "name": "statement", "type": { "fqn": "@aws-cdk/aws-iam.PolicyStatement" } } ] }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configures options for asynchronous invocation." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 114 }, "name": "configureAsyncInvoke", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions" } } ] }, { "abstract": true, "docs": { "stability": "stable", "summary": "Grant the given identity permissions to invoke this Lambda." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 81 }, "name": "grantInvoke", "parameters": [ { "name": "identity", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Return the given named metric for this Lambda Return the given named metric for this Function." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 86 }, "name": "metric", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "average over 5 minutes", "remarks": "Average over 5 minutes", "stability": "stable", "summary": "Metric for the Duration of this Lambda How long execution of this Lambda takes." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 93 }, "name": "metricDuration", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Sum over 5 minutes", "stability": "stable", "summary": "How many invocations of this Lambda fail." }, "locationInModule": { "filename": "lib/lambda-augmentations.generated.ts", "line": 29 }, "name": "metricErrors", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "sum over 5 minutes", "remarks": "Sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of invocations of this Lambda How often this Lambda is invoked." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 100 }, "name": "metricInvocations", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "default": "sum over 5 minutes", "remarks": "Sum over 5 minutes", "stability": "stable", "summary": "Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 107 }, "name": "metricThrottles", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "IFunction", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN fo the function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 28 }, "name": "functionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of the function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 21 }, "name": "functionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "If this is is `false`, trying to access the `connections` object will fail.", "stability": "stable", "summary": "Whether or not this Lambda function was bound to a VPC." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 40 }, "name": "isBoundToVpc", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Note that this is reference to a non-specific AWS Lambda version, which\nmeans the function this version refers to can return different results in\ndifferent invocations.\n\nTo obtain a reference to an explicit version which references the current\nfunction configuration, use `lambdaFunction.currentVersion` instead.", "stability": "stable", "summary": "The `$LATEST` version of this function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 52 }, "name": "latestVersion", "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The construct node where permissions are attached." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 57 }, "name": "permissionsNode", "type": { "fqn": "@aws-cdk/core.ConstructNode" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The IAM role associated with this function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 33 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ] }, "@aws-cdk/aws-lambda.ILayerVersion": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.ILayerVersion", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/layers.ts", "line": 43 }, "methods": [ { "abstract": true, "docs": { "remarks": "Usage within\nthe same account where the layer is defined is always allowed and does not\nrequire calling this method. Note that the principal that creates the\nLambda function using the layer (for example, a CloudFormation changeset\nexecution role) also needs to have the ``lambda:GetLayerVersion``\npermission on the layer version.", "stability": "stable", "summary": "Add permission for this layer version to specific entities." }, "locationInModule": { "filename": "lib/layers.ts", "line": 68 }, "name": "addPermission", "parameters": [ { "docs": { "summary": "the ID of the grant in the construct tree." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the identification of the grantee." }, "name": "permission", "type": { "fqn": "@aws-cdk/aws-lambda.LayerVersionPermission" } } ] } ], "name": "ILayerVersion", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The ARN of the Lambda Layer version that this Layer defines." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 48 }, "name": "layerVersionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "Runtime.All", "stability": "stable", "summary": "The runtimes compatible with this Layer." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 55 }, "name": "compatibleRuntimes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-lambda.Runtime" }, "kind": "array" } } } ] }, "@aws-cdk/aws-lambda.IScalableFunctionAttribute": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable", "summary": "Interface for scalable attributes." }, "fqn": "@aws-cdk/aws-lambda.IScalableFunctionAttribute", "interfaces": [ "@aws-cdk/core.IConstruct" ], "kind": "interface", "locationInModule": { "filename": "lib/scalable-attribute-api.ts", "line": 8 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Scale out or in based on schedule." }, "locationInModule": { "filename": "lib/scalable-attribute-api.ts", "line": 18 }, "name": "scaleOnSchedule", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "actions", "type": { "fqn": "@aws-cdk/aws-applicationautoscaling.ScalingSchedule" } } ] }, { "abstract": true, "docs": { "remarks": "The utilization is tracked by the\nLambdaProvisionedConcurrencyUtilization metric, emitted by lambda. See:\nhttps://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics.html#monitoring-metrics-concurrency", "stability": "stable", "summary": "Scale out or in to keep utilization at a given level." }, "locationInModule": { "filename": "lib/scalable-attribute-api.ts", "line": 14 }, "name": "scaleOnUtilization", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-lambda.UtilizationScalingOptions" } } ] } ], "name": "IScalableFunctionAttribute" }, "@aws-cdk/aws-lambda.IVersion": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.IVersion", "interfaces": [ "@aws-cdk/aws-lambda.IFunction" ], "kind": "interface", "locationInModule": { "filename": "lib/lambda-version.ts", "line": 10 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Defines an alias for this version." }, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 32 }, "name": "addAlias", "parameters": [ { "docs": { "summary": "The name of the alias." }, "name": "aliasName", "type": { "primitive": "string" } }, { "docs": { "summary": "Alias options." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.AliasOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.Alias" } } } ], "name": "IVersion", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN of the version for Lambda@Edge." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 25 }, "name": "edgeArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The underlying AWS Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 20 }, "name": "lambda", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The most recently deployed version of this function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 15 }, "name": "version", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.InlineCode": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.Code", "docs": { "stability": "stable", "summary": "Lambda code from an inline string (limited to 4KiB)." }, "fqn": "@aws-cdk/aws-lambda.InlineCode", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/code.ts", "line": 144 }, "parameters": [ { "name": "code", "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 141 }, "methods": [ { "docs": { "stability": "stable", "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 156 }, "name": "bind", "overrides": "@aws-cdk/aws-lambda.Code", "parameters": [ { "name": "_scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.CodeConfig" } } } ], "name": "InlineCode", "properties": [ { "docs": { "stability": "stable", "summary": "Determines whether this Code is inline code or not." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 142 }, "name": "isInline", "overrides": "@aws-cdk/aws-lambda.Code", "type": { "primitive": "boolean" } } ] }, "@aws-cdk/aws-lambda.LambdaRuntimeProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.LambdaRuntimeProps", "kind": "interface", "locationInModule": { "filename": "lib/runtime.ts", "line": 3 }, "name": "LambdaRuntimeProps", "properties": [ { "abstract": true, "docs": { "default": "- the latest docker image \"amazon/aws-sam-cli-build-image-\" from https://hub.docker.com/u/amazon", "stability": "stable", "summary": "The Docker image name to be used for bundling in this runtime." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 14 }, "name": "bundlingDockerImage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether the ``ZipFile`` (aka inline code) property can be used with this runtime." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 8 }, "name": "supportsInlineCode", "optional": true, "type": { "primitive": "boolean" } } ] }, "@aws-cdk/aws-lambda.LayerVersion": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "Defines a new Lambda Layer version." }, "fqn": "@aws-cdk/aws-lambda.LayerVersion", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/layers.ts", "line": 163 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.LayerVersionProps" } } ] }, "interfaces": [ "@aws-cdk/aws-lambda.ILayerVersion" ], "kind": "class", "locationInModule": { "filename": "lib/layers.ts", "line": 128 }, "methods": [ { "docs": { "remarks": "Assumes it is compatible with all Lambda runtimes.", "stability": "stable", "summary": "Imports a layer version by ARN." }, "locationInModule": { "filename": "lib/layers.ts", "line": 133 }, "name": "fromLayerVersionArn", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "layerVersionArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.ILayerVersion" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Imports a Layer that has been defined externally." }, "locationInModule": { "filename": "lib/layers.ts", "line": 147 }, "name": "fromLayerVersionAttributes", "parameters": [ { "docs": { "summary": "the parent Construct that will use the imported layer." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "the id of the imported layer in the construct tree." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "the properties of the imported layer." }, "name": "attrs", "type": { "fqn": "@aws-cdk/aws-lambda.LayerVersionAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.ILayerVersion" } }, "static": true }, { "docs": { "remarks": "Usage within\nthe same account where the layer is defined is always allowed and does not\nrequire calling this method. Note that the principal that creates the\nLambda function using the layer (for example, a CloudFormation changeset\nexecution role) also needs to have the ``lambda:GetLayerVersion``\npermission on the layer version.", "stability": "stable", "summary": "Add permission for this layer version to specific entities." }, "locationInModule": { "filename": "lib/layers.ts", "line": 78 }, "name": "addPermission", "overrides": "@aws-cdk/aws-lambda.ILayerVersion", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "permission", "type": { "fqn": "@aws-cdk/aws-lambda.LayerVersionPermission" } } ] } ], "name": "LayerVersion", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the Lambda Layer version that this Layer defines." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 160 }, "name": "layerVersionArn", "overrides": "@aws-cdk/aws-lambda.ILayerVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The runtimes compatible with this Layer." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 161 }, "name": "compatibleRuntimes", "optional": true, "overrides": "@aws-cdk/aws-lambda.ILayerVersion", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-lambda.Runtime" }, "kind": "array" } } } ] }, "@aws-cdk/aws-lambda.LayerVersionAttributes": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Properties necessary to import a LayerVersion." }, "fqn": "@aws-cdk/aws-lambda.LayerVersionAttributes", "kind": "interface", "locationInModule": { "filename": "lib/layers.ts", "line": 113 }, "name": "LayerVersionAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN of the LayerVersion." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 117 }, "name": "layerVersionArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The list of compatible runtimes with this Layer." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 122 }, "name": "compatibleRuntimes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-lambda.Runtime" }, "kind": "array" } } } ] }, "@aws-cdk/aws-lambda.LayerVersionPermission": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Identification of an account (or organization) that is allowed to access a Lambda Layer Version." }, "fqn": "@aws-cdk/aws-lambda.LayerVersionPermission", "kind": "interface", "locationInModule": { "filename": "lib/layers.ts", "line": 95 }, "name": "LayerVersionPermission", "properties": [ { "abstract": true, "docs": { "remarks": "The wild-card ``'*'`` can be\nused to grant access to \"any\" account (or any account in an organization when ``organizationId`` is specified).", "stability": "stable", "summary": "The AWS Account id of the account that is authorized to use a Lambda Layer Version." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 100 }, "name": "accountId", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Can only be specified if ``accountId`` is ``'*'``", "stability": "stable", "summary": "The ID of the AWS Organization to hwich the grant is restricted." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 107 }, "name": "organizationId", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.LayerVersionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.LayerVersionProps", "kind": "interface", "locationInModule": { "filename": "lib/layers.ts", "line": 6 }, "name": "LayerVersionProps", "properties": [ { "abstract": true, "docs": { "remarks": "Using `Code.fromInline` is not supported.", "stability": "stable", "summary": "The content of this Layer." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 19 }, "name": "code", "type": { "fqn": "@aws-cdk/aws-lambda.Code" } }, { "abstract": true, "docs": { "default": "- All runtimes are supported.", "stability": "stable", "summary": "The runtimes compatible with this Layer." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 12 }, "name": "compatibleRuntimes", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-lambda.Runtime" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- No description.", "stability": "stable", "summary": "The description the this Lambda Layer." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 26 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- A name will be generated.", "stability": "stable", "summary": "The name of the layer." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 40 }, "name": "layerVersionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- No license information will be recorded.", "stability": "stable", "summary": "The SPDX licence identifier or URL to the license file for this layer." }, "immutable": true, "locationInModule": { "filename": "lib/layers.ts", "line": 33 }, "name": "license", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.LogRetention": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-logs.LogRetention", "docs": { "custom": { "aws-cdk": "/aws-logs' instead" }, "deprecated": "use `LogRetention` from '", "remarks": "The log group is created if it doesn't already exist. The policy\nis removed when `retentionDays` is `undefined` or equal to `Infinity`.", "stability": "deprecated", "summary": "Creates a custom resource to control the retention policy of a CloudWatch Logs log group." }, "fqn": "@aws-cdk/aws-lambda.LogRetention", "initializer": { "docs": { "stability": "deprecated" }, "locationInModule": { "filename": "lib/log-retention.ts", "line": 28 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.LogRetentionProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/log-retention.ts", "line": 27 }, "name": "LogRetention" }, "@aws-cdk/aws-lambda.LogRetentionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "custom": { "aws-cdk": "/aws-logs' instead" }, "deprecated": "use `LogRetentionProps` from '", "stability": "deprecated", "summary": "Construction properties for a LogRetention." }, "fqn": "@aws-cdk/aws-lambda.LogRetentionProps", "interfaces": [ "@aws-cdk/aws-logs.LogRetentionProps" ], "kind": "interface", "locationInModule": { "filename": "lib/log-retention.ts", "line": 17 }, "name": "LogRetentionProps" }, "@aws-cdk/aws-lambda.LogRetentionRetryOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "custom": { "aws-cdk": "/aws-logs' instead" }, "deprecated": "use `LogRetentionRetryOptions` from '", "stability": "deprecated", "summary": "Retry options for all AWS API calls." }, "fqn": "@aws-cdk/aws-lambda.LogRetentionRetryOptions", "interfaces": [ "@aws-cdk/aws-logs.LogRetentionRetryOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/log-retention.ts", "line": 9 }, "name": "LogRetentionRetryOptions" }, "@aws-cdk/aws-lambda.Permission": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Represents a permission statement that can be added to a Lambda's resource policy via the `addToResourcePolicy` method." }, "fqn": "@aws-cdk/aws-lambda.Permission", "kind": "interface", "locationInModule": { "filename": "lib/permission.ts", "line": 8 }, "name": "Permission", "properties": [ { "abstract": true, "docs": { "remarks": "This entity can be any valid AWS service principal, such as\ns3.amazonaws.com or sns.amazonaws.com, or, if you are granting\ncross-account permission, an AWS account ID. For example, you might want\nto allow a custom application in another AWS account to push events to\nLambda by invoking your function.\n\nThe principal can be either an AccountPrincipal or a ServicePrincipal.", "stability": "stable", "summary": "The entity for which you are granting permission to invoke the Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/permission.ts", "line": 38 }, "name": "principal", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } }, { "abstract": true, "docs": { "default": "'lambda:InvokeFunction'", "remarks": "For example,\nyou can specify lambda:CreateFunction to specify a certain action, or use\na wildcard (``lambda:*``) to grant permission to all Lambda actions. For a\nlist of actions, see Actions and Condition Context Keys for AWS Lambda in\nthe IAM User Guide.", "stability": "stable", "summary": "The Lambda actions that you want to allow in this statement." }, "immutable": true, "locationInModule": { "filename": "lib/permission.ts", "line": 18 }, "name": "action", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "The caller would not need to present a token.", "stability": "stable", "summary": "A unique token that must be supplied by the principal invoking the function." }, "immutable": true, "locationInModule": { "filename": "lib/permission.ts", "line": 26 }, "name": "eventSourceToken", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- The instance of lambda.IFunction", "remarks": "The default is\nthe Lambda function construct itself, but this would need to be different\nin cases such as cross-stack references where the Permissions would need\nto sit closer to the consumer of this permission (i.e., the caller).", "stability": "stable", "summary": "The scope to which the permission constructs be attached." }, "immutable": true, "locationInModule": { "filename": "lib/permission.ts", "line": 48 }, "name": "scope", "optional": true, "type": { "fqn": "@aws-cdk/core.Construct" } }, { "abstract": true, "docs": { "remarks": "For example, if\nyou specify an S3 bucket in the SourceArn property, this value is the\nbucket owner's account ID. You can use this property to ensure that all\nsource principals are owned by a specific account.", "stability": "stable", "summary": "The AWS account ID (without hyphens) of the source owner." }, "immutable": true, "locationInModule": { "filename": "lib/permission.ts", "line": 56 }, "name": "sourceAccount", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "When granting\nAmazon Simple Storage Service (Amazon S3) permission to invoke your\nfunction, specify this property with the bucket ARN as its value. This\nensures that events generated only from the specified bucket, not just\nany bucket from any AWS account that creates a mapping to your function,\ncan invoke the function.", "stability": "stable", "summary": "The ARN of a resource that is invoking your function." }, "immutable": true, "locationInModule": { "filename": "lib/permission.ts", "line": 66 }, "name": "sourceArn", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.QualifiedFunctionBase": { "abstract": true, "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.FunctionBase", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.QualifiedFunctionBase", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/resource.ts", "line": 110 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/core.ResourceProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/function-base.ts", "line": 372 }, "methods": [ { "docs": { "stability": "stable", "summary": "Configures options for asynchronous invocation." }, "locationInModule": { "filename": "lib/function-base.ts", "line": 388 }, "name": "configureAsyncInvoke", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions" } } ] } ], "name": "QualifiedFunctionBase", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 373 }, "name": "lambda", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "docs": { "remarks": "Note that this is reference to a non-specific AWS Lambda version, which\nmeans the function this version refers to can return different results in\ndifferent invocations.\n\nTo obtain a reference to an explicit version which references the current\nfunction configuration, use `lambdaFunction.currentVersion` instead.", "stability": "stable", "summary": "The `$LATEST` version of this function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 384 }, "name": "latestVersion", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } }, { "docs": { "stability": "stable", "summary": "The construct node where permissions are attached." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 375 }, "name": "permissionsNode", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "fqn": "@aws-cdk/core.ConstructNode" } }, { "abstract": true, "docs": { "remarks": "A qualifier is the identifier that's appended to a version or alias ARN.", "see": "https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#API_GetFunctionConfiguration_RequestParameters", "stability": "stable", "summary": "The qualifier of the version or alias of this function." }, "immutable": true, "locationInModule": { "filename": "lib/function-base.ts", "line": 382 }, "name": "qualifier", "protected": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.ResourceBindOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.ResourceBindOptions", "kind": "interface", "locationInModule": { "filename": "lib/code.ts", "line": 210 }, "name": "ResourceBindOptions", "properties": [ { "abstract": true, "docs": { "default": "Code", "see": "https://github.com/aws/aws-cdk/issues/1432", "stability": "stable", "summary": "The name of the CloudFormation property to annotate with asset metadata." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 216 }, "name": "resourceProperty", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.Runtime": { "assembly": "@aws-cdk/aws-lambda", "docs": { "remarks": "If you need to use a runtime name that doesn't exist as a static member, you\ncan instantiate a `Runtime` object, e.g: `new Runtime('nodejs99.99')`.", "stability": "stable", "summary": "Lambda function runtime environment." }, "fqn": "@aws-cdk/aws-lambda.Runtime", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/runtime.ts", "line": 176 }, "parameters": [ { "name": "name", "type": { "primitive": "string" } }, { "name": "family", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.RuntimeFamily" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.LambdaRuntimeProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/runtime.ts", "line": 33 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/runtime.ts", "line": 190 }, "name": "runtimeEquals", "parameters": [ { "name": "other", "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } } ], "returns": { "type": { "primitive": "boolean" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/runtime.ts", "line": 186 }, "name": "toString", "returns": { "type": { "primitive": "string" } } } ], "name": "Runtime", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "A list of all known `Runtime`'s." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 35 }, "name": "ALL", "static": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-lambda.Runtime" }, "kind": "array" } } }, { "const": true, "docs": { "deprecated": "Use {@link DOTNET_CORE_2_1}", "stability": "deprecated", "summary": "The .NET Core 1.0 runtime (dotnetcore1.0)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 110 }, "name": "DOTNET_CORE_1", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "deprecated": "Use {@link DOTNET_CORE_2_1}", "stability": "deprecated", "summary": "The .NET Core 2.0 runtime (dotnetcore2.0)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 117 }, "name": "DOTNET_CORE_2", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The .NET Core 2.1 runtime (dotnetcore2.1)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 122 }, "name": "DOTNET_CORE_2_1", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The .NET Core 3.1 runtime (dotnetcore3.1)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 129 }, "name": "DOTNET_CORE_3_1", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Go 1.x runtime (go1.x)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 136 }, "name": "GO_1_X", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Java 11 runtime (java11)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 103 }, "name": "JAVA_11", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Java 8 runtime (java8)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 98 }, "name": "JAVA_8", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "deprecated": "Use {@link NODEJS_10_X}", "stability": "deprecated", "summary": "The NodeJS runtime (nodejs)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 42 }, "name": "NODEJS", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The NodeJS 10.x runtime (nodejs10.x)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 68 }, "name": "NODEJS_10_X", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The NodeJS 12.x runtime (nodejs12.x)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 73 }, "name": "NODEJS_12_X", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "deprecated": "Use {@link NODEJS_10_X}", "stability": "deprecated", "summary": "The NodeJS 4.3 runtime (nodejs4.3)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 49 }, "name": "NODEJS_4_3", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "deprecated": "Use {@link NODEJS_10_X}", "stability": "deprecated", "summary": "The NodeJS 6.10 runtime (nodejs6.10)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 56 }, "name": "NODEJS_6_10", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "deprecated": "Use {@link NODEJS_10_X}", "stability": "deprecated", "summary": "The NodeJS 8.10 runtime (nodejs8.10)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 63 }, "name": "NODEJS_8_10", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The custom provided runtime (provided)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 153 }, "name": "PROVIDED", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Python 2.7 runtime (python2.7)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 78 }, "name": "PYTHON_2_7", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Python 3.6 runtime (python3.6)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 83 }, "name": "PYTHON_3_6", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Python 3.7 runtime (python3.7)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 88 }, "name": "PYTHON_3_7", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Python 3.8 runtime (python3.8)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 93 }, "name": "PYTHON_3_8", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Ruby 2.5 runtime (ruby2.5)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 143 }, "name": "RUBY_2_5", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "const": true, "docs": { "stability": "stable", "summary": "The Ruby 2.7 runtime (ruby2.7)." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 148 }, "name": "RUBY_2_7", "static": true, "type": { "fqn": "@aws-cdk/aws-lambda.Runtime" } }, { "docs": { "stability": "stable", "summary": "The bundling Docker image for this runtime." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 174 }, "name": "bundlingDockerImage", "type": { "fqn": "@aws-cdk/core.BundlingDockerImage" } }, { "docs": { "stability": "stable", "summary": "The name of this runtime, as expected by the Lambda resource." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 158 }, "name": "name", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Whether the ``ZipFile`` (aka inline code) property can be used with this runtime." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 164 }, "name": "supportsInlineCode", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "The runtime family." }, "immutable": true, "locationInModule": { "filename": "lib/runtime.ts", "line": 169 }, "name": "family", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.RuntimeFamily" } } ] }, "@aws-cdk/aws-lambda.RuntimeFamily": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.RuntimeFamily", "kind": "enum", "locationInModule": { "filename": "lib/runtime.ts", "line": 17 }, "members": [ { "docs": { "stability": "stable" }, "name": "NODEJS" }, { "docs": { "stability": "stable" }, "name": "JAVA" }, { "docs": { "stability": "stable" }, "name": "PYTHON" }, { "docs": { "stability": "stable" }, "name": "DOTNET_CORE" }, { "docs": { "stability": "stable" }, "name": "GO" }, { "docs": { "stability": "stable" }, "name": "RUBY" }, { "docs": { "stability": "stable" }, "name": "OTHER" } ], "name": "RuntimeFamily" }, "@aws-cdk/aws-lambda.S3Code": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.Code", "docs": { "stability": "stable", "summary": "Lambda code from an S3 archive." }, "fqn": "@aws-cdk/aws-lambda.S3Code", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/code.ts", "line": 117 }, "parameters": [ { "name": "bucket", "type": { "fqn": "@aws-cdk/aws-s3.IBucket" } }, { "name": "key", "type": { "primitive": "string" } }, { "name": "objectVersion", "optional": true, "type": { "primitive": "string" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/code.ts", "line": 113 }, "methods": [ { "docs": { "stability": "stable", "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun." }, "locationInModule": { "filename": "lib/code.ts", "line": 127 }, "name": "bind", "overrides": "@aws-cdk/aws-lambda.Code", "parameters": [ { "name": "_scope", "type": { "fqn": "@aws-cdk/core.Construct" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.CodeConfig" } } } ], "name": "S3Code", "properties": [ { "docs": { "stability": "stable", "summary": "Determines whether this Code is inline code or not." }, "immutable": true, "locationInModule": { "filename": "lib/code.ts", "line": 114 }, "name": "isInline", "overrides": "@aws-cdk/aws-lambda.Code", "type": { "primitive": "boolean" } } ] }, "@aws-cdk/aws-lambda.SingletonFunction": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.FunctionBase", "docs": { "custom": { "resource": "AWS::Lambda::Function" }, "remarks": "This construct is a way to guarantee that the lambda function will be guaranteed to be part of the stack,\nonce and only once, irrespective of how many times the construct is declared to be part of the stack.\nThis is guaranteed as long as the `uuid` property and the optional `lambdaPurpose` property stay the same\nwhenever they're declared into the stack.", "stability": "stable", "summary": "A Lambda that will only ever be added to a stack once." }, "fqn": "@aws-cdk/aws-lambda.SingletonFunction", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 51 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.SingletonFunctionProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 42 }, "methods": [ { "docs": { "stability": "stable", "summary": "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." }, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 85 }, "name": "addDependency", "parameters": [ { "name": "up", "type": { "fqn": "@aws-cdk/core.IDependable" }, "variadic": true } ], "variadic": true }, { "docs": { "stability": "stable", "summary": "Adds a permission to the Lambda resource policy." }, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 77 }, "name": "addPermission", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "parameters": [ { "name": "name", "type": { "primitive": "string" } }, { "name": "permission", "type": { "fqn": "@aws-cdk/aws-lambda.Permission" } } ] }, { "docs": { "stability": "stable", "summary": "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." }, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 93 }, "name": "dependOn", "parameters": [ { "name": "down", "type": { "fqn": "@aws-cdk/core.IConstruct" } } ] } ], "name": "SingletonFunction", "properties": [ { "docs": { "remarks": "True for new Lambdas, false for imported Lambdas (they might live in different accounts).", "stability": "stable", "summary": "Whether the addPermission() call adds any permissions." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 48 }, "name": "canCreatePermissions", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "remarks": "You can specify options for this version using the `currentVersionOptions`\nprop when initializing the `lambda.SingletonFunction`.", "stability": "stable", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 73 }, "name": "currentVersion", "type": { "fqn": "@aws-cdk/aws-lambda.Version" } }, { "docs": { "stability": "stable", "summary": "The ARN fo the function." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 45 }, "name": "functionArn", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of the function." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 44 }, "name": "functionName", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The principal this Lambda Function is running as." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 43 }, "name": "grantPrincipal", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } }, { "docs": { "stability": "stable", "summary": "The construct node where permissions are attached." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 47 }, "name": "permissionsNode", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "fqn": "@aws-cdk/core.ConstructNode" } }, { "docs": { "remarks": "Undefined if the function was imported without a role.", "stability": "stable", "summary": "The IAM role associated with this function." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 46 }, "name": "role", "optional": true, "overrides": "@aws-cdk/aws-lambda.FunctionBase", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ] }, "@aws-cdk/aws-lambda.SingletonFunctionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a newly created singleton Lambda." }, "fqn": "@aws-cdk/aws-lambda.SingletonFunctionProps", "interfaces": [ "@aws-cdk/aws-lambda.FunctionProps" ], "kind": "interface", "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 11 }, "name": "SingletonFunctionProps", "properties": [ { "abstract": true, "docs": { "remarks": "The identifier should be unique across all custom resource providers.\nWe recommend generating a UUID per provider.", "stability": "stable", "summary": "A unique identifier to identify this lambda." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 18 }, "name": "uuid", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "SingletonLambda", "remarks": "If the Lambda does not have a physical name, this string will be\nreflected its generated name. The combination of lambdaPurpose\nand uuid must be unique.", "stability": "stable", "summary": "A descriptive name for the purpose of this Lambda." }, "immutable": true, "locationInModule": { "filename": "lib/singleton-lambda.ts", "line": 29 }, "name": "lambdaPurpose", "optional": true, "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.StartingPosition": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable", "summary": "The position in the DynamoDB or Kinesis stream where AWS Lambda should start reading." }, "fqn": "@aws-cdk/aws-lambda.StartingPosition", "kind": "enum", "locationInModule": { "filename": "lib/event-source-mapping.ts", "line": 197 }, "members": [ { "docs": { "stability": "stable", "summary": "Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard." }, "name": "TRIM_HORIZON" }, { "docs": { "stability": "stable", "summary": "Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard." }, "name": "LATEST" } ], "name": "StartingPosition" }, "@aws-cdk/aws-lambda.Tracing": { "assembly": "@aws-cdk/aws-lambda", "docs": { "stability": "stable", "summary": "X-Ray Tracing Modes (https://docs.aws.amazon.com/lambda/latest/dg/API_TracingConfig.html)." }, "fqn": "@aws-cdk/aws-lambda.Tracing", "kind": "enum", "locationInModule": { "filename": "lib/function.ts", "line": 23 }, "members": [ { "docs": { "remarks": "If no tracing header is received, Lambda will call X-Ray for a tracing decision.", "stability": "stable", "summary": "Lambda will respect any tracing header it receives from an upstream service." }, "name": "ACTIVE" }, { "docs": { "stability": "stable", "summary": "Lambda will only trace the request from an upstream service if it contains a tracing header with \"sampled=1\"." }, "name": "PASS_THROUGH" }, { "docs": { "stability": "stable", "summary": "Lambda will not trace any request." }, "name": "DISABLED" } ], "name": "Tracing" }, "@aws-cdk/aws-lambda.UtilizationScalingOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Options for enabling Lambda utilization tracking." }, "fqn": "@aws-cdk/aws-lambda.UtilizationScalingOptions", "interfaces": [ "@aws-cdk/aws-applicationautoscaling.BaseTargetTrackingProps" ], "kind": "interface", "locationInModule": { "filename": "lib/scalable-attribute-api.ts", "line": 24 }, "name": "UtilizationScalingOptions", "properties": [ { "abstract": true, "docs": { "remarks": "For example, .5 indicates that 50 percent of allocated provisioned concurrency is in use.", "stability": "stable", "summary": "Utilization target for the attribute." }, "immutable": true, "locationInModule": { "filename": "lib/scalable-attribute-api.ts", "line": 28 }, "name": "utilizationTarget", "type": { "primitive": "number" } } ] }, "@aws-cdk/aws-lambda.Version": { "assembly": "@aws-cdk/aws-lambda", "base": "@aws-cdk/aws-lambda.QualifiedFunctionBase", "docs": { "remarks": "This object exists to--at deploy time--query the \"then-current\" version of\nthe Lambda function that it refers to. This Version object can then be\nused in `Alias` to refer to a particular deployment of a Lambda.\n\nThis means that for every new update you deploy to your Lambda (using the\nCDK and Aliases), you must always create a new Version object. In\nparticular, it must have a different name, so that a new resource is\ncreated.\n\nIf you want to ensure that you're associating the right version with\nthe right deployment, specify the `codeSha256` property while\ncreating the `Version.", "stability": "stable", "summary": "A single newly-deployed version of a Lambda function." }, "fqn": "@aws-cdk/aws-lambda.Version", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 181 }, "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-lambda.VersionProps" } } ] }, "interfaces": [ "@aws-cdk/aws-lambda.IVersion" ], "kind": "class", "locationInModule": { "filename": "lib/lambda-version.ts", "line": 109 }, "methods": [ { "docs": { "stability": "stable", "summary": "Construct a Version object from a Version ARN." }, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 118 }, "name": "fromVersionArn", "parameters": [ { "docs": { "summary": "The cdk scope creating this resource." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "The cdk id of this resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "The version ARN to create this version from." }, "name": "versionArn", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 147 }, "name": "fromVersionAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-lambda.VersionAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Defines an alias for this version." }, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 241 }, "name": "addAlias", "overrides": "@aws-cdk/aws-lambda.IVersion", "parameters": [ { "docs": { "summary": "The name of the alias (e.g. \"live\")." }, "name": "aliasName", "type": { "primitive": "string" } }, { "docs": { "summary": "Alias options." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-lambda.AliasOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-lambda.Alias" } } }, { "docs": { "stability": "stable", "summary": "Return the given named metric for this Function." }, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 222 }, "name": "metric", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "Version", "properties": [ { "docs": { "remarks": "True for new Lambdas, false for imported Lambdas (they might live in different accounts).", "stability": "stable", "summary": "Whether the addPermission() call adds any permissions." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 179 }, "name": "canCreatePermissions", "overrides": "@aws-cdk/aws-lambda.FunctionBase", "protected": true, "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "The ARN of the version for Lambda@Edge." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 245 }, "name": "edgeArn", "overrides": "@aws-cdk/aws-lambda.IVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The ARN fo the function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 175 }, "name": "functionArn", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The name of the function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 176 }, "name": "functionName", "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The principal this Lambda Function is running as." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 214 }, "name": "grantPrincipal", "overrides": "@aws-cdk/aws-iam.IGrantable", "type": { "fqn": "@aws-cdk/aws-iam.IPrincipal" } }, { "docs": { "stability": "stable", "summary": "The underlying AWS Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 174 }, "name": "lambda", "overrides": "@aws-cdk/aws-lambda.IVersion", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "docs": { "remarks": "A qualifier is the identifier that's appended to a version or alias ARN.", "stability": "stable", "summary": "The qualifier of the version or alias of this function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 178 }, "name": "qualifier", "overrides": "@aws-cdk/aws-lambda.QualifiedFunctionBase", "protected": true, "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The most recently deployed version of this function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 173 }, "name": "version", "overrides": "@aws-cdk/aws-lambda.IVersion", "type": { "primitive": "string" } }, { "docs": { "remarks": "Undefined if the function was imported without a role.", "stability": "stable", "summary": "The IAM role associated with this function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 218 }, "name": "role", "optional": true, "overrides": "@aws-cdk/aws-lambda.IFunction", "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ] }, "@aws-cdk/aws-lambda.VersionAttributes": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable" }, "fqn": "@aws-cdk/aws-lambda.VersionAttributes", "kind": "interface", "locationInModule": { "filename": "lib/lambda-version.ts", "line": 81 }, "name": "VersionAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 90 }, "name": "lambda", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The version." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 85 }, "name": "version", "type": { "primitive": "string" } } ] }, "@aws-cdk/aws-lambda.VersionOptions": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Options for `lambda.Version`." }, "fqn": "@aws-cdk/aws-lambda.VersionOptions", "interfaces": [ "@aws-cdk/aws-lambda.EventInvokeConfigOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/lambda-version.ts", "line": 38 }, "name": "VersionOptions", "properties": [ { "abstract": true, "docs": { "default": "No validation is performed", "remarks": "Specify to validate that you're deploying the right version.", "stability": "stable", "summary": "SHA256 of the version of the Lambda source code." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 46 }, "name": "codeSha256", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "Description of the Lambda", "stability": "stable", "summary": "Description of the version." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 53 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "No provisioned concurrency", "stability": "stable", "summary": "Specifies a provisioned concurrency configuration for a function's version." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 60 }, "name": "provisionedConcurrentExecutions", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "RemovalPolicy.DESTROY", "stability": "stable", "summary": "Whether to retain old versions of this function when a new version is created." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 68 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } } ] }, "@aws-cdk/aws-lambda.VersionProps": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a new Lambda version." }, "fqn": "@aws-cdk/aws-lambda.VersionProps", "interfaces": [ "@aws-cdk/aws-lambda.VersionOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/lambda-version.ts", "line": 74 }, "name": "VersionProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Function to get the value of." }, "immutable": true, "locationInModule": { "filename": "lib/lambda-version.ts", "line": 78 }, "name": "lambda", "type": { "fqn": "@aws-cdk/aws-lambda.IFunction" } } ] }, "@aws-cdk/aws-lambda.VersionWeight": { "assembly": "@aws-cdk/aws-lambda", "datatype": true, "docs": { "stability": "stable", "summary": "A version/weight pair for routing traffic to Lambda functions." }, "fqn": "@aws-cdk/aws-lambda.VersionWeight", "kind": "interface", "locationInModule": { "filename": "lib/alias.ts", "line": 289 }, "name": "VersionWeight", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The version to route traffic to." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 293 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-lambda.IVersion" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "How much weight to assign to this version (0..1)." }, "immutable": true, "locationInModule": { "filename": "lib/alias.ts", "line": 298 }, "name": "weight", "type": { "primitive": "number" } } ] } }, "version": "1.61.0", "fingerprint": "i+6m4YtX4uaOSZupx/OD1rxY3x5DzbeQOtSqLYin6a0=" }