| 1 | {
|
| 2 | "author": {
|
| 3 | "name": "Amazon Web Services",
|
| 4 | "organization": true,
|
| 5 | "roles": [
|
| 6 | "author"
|
| 7 | ],
|
| 8 | "url": "https://aws.amazon.com"
|
| 9 | },
|
| 10 | "dependencies": {
|
| 11 | "@aws-cdk/aws-applicationautoscaling": "1.190.0",
|
| 12 | "@aws-cdk/aws-cloudwatch": "1.190.0",
|
| 13 | "@aws-cdk/aws-codeguruprofiler": "1.190.0",
|
| 14 | "@aws-cdk/aws-ec2": "1.190.0",
|
| 15 | "@aws-cdk/aws-ecr": "1.190.0",
|
| 16 | "@aws-cdk/aws-ecr-assets": "1.190.0",
|
| 17 | "@aws-cdk/aws-efs": "1.190.0",
|
| 18 | "@aws-cdk/aws-events": "1.190.0",
|
| 19 | "@aws-cdk/aws-iam": "1.190.0",
|
| 20 | "@aws-cdk/aws-kms": "1.190.0",
|
| 21 | "@aws-cdk/aws-logs": "1.190.0",
|
| 22 | "@aws-cdk/aws-s3": "1.190.0",
|
| 23 | "@aws-cdk/aws-s3-assets": "1.190.0",
|
| 24 | "@aws-cdk/aws-signer": "1.190.0",
|
| 25 | "@aws-cdk/aws-sns": "1.190.0",
|
| 26 | "@aws-cdk/aws-sqs": "1.190.0",
|
| 27 | "@aws-cdk/core": "1.190.0",
|
| 28 | "@aws-cdk/cx-api": "1.190.0",
|
| 29 | "@aws-cdk/region-info": "1.190.0",
|
| 30 | "constructs": "^3.3.69"
|
| 31 | },
|
| 32 | "dependencyClosure": {
|
| 33 | "@aws-cdk/assets": {
|
| 34 | "targets": {
|
| 35 | "dotnet": {
|
| 36 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 37 | "namespace": "Amazon.CDK.Assets",
|
| 38 | "packageId": "Amazon.CDK.Assets"
|
| 39 | },
|
| 40 | "java": {
|
| 41 | "maven": {
|
| 42 | "artifactId": "cdk-assets",
|
| 43 | "groupId": "software.amazon.awscdk"
|
| 44 | },
|
| 45 | "package": "software.amazon.awscdk.assets"
|
| 46 | },
|
| 47 | "js": {
|
| 48 | "npm": "@aws-cdk/assets"
|
| 49 | },
|
| 50 | "python": {
|
| 51 | "classifiers": [
|
| 52 | "Framework :: AWS CDK",
|
| 53 | "Framework :: AWS CDK :: 1"
|
| 54 | ],
|
| 55 | "distName": "aws-cdk.assets",
|
| 56 | "module": "aws_cdk.assets"
|
| 57 | }
|
| 58 | }
|
| 59 | },
|
| 60 | "@aws-cdk/aws-applicationautoscaling": {
|
| 61 | "targets": {
|
| 62 | "dotnet": {
|
| 63 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 64 | "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling",
|
| 65 | "packageId": "Amazon.CDK.AWS.ApplicationAutoScaling"
|
| 66 | },
|
| 67 | "java": {
|
| 68 | "maven": {
|
| 69 | "artifactId": "applicationautoscaling",
|
| 70 | "groupId": "software.amazon.awscdk"
|
| 71 | },
|
| 72 | "package": "software.amazon.awscdk.services.applicationautoscaling"
|
| 73 | },
|
| 74 | "js": {
|
| 75 | "npm": "@aws-cdk/aws-applicationautoscaling"
|
| 76 | },
|
| 77 | "python": {
|
| 78 | "classifiers": [
|
| 79 | "Framework :: AWS CDK",
|
| 80 | "Framework :: AWS CDK :: 1"
|
| 81 | ],
|
| 82 | "distName": "aws-cdk.aws-applicationautoscaling",
|
| 83 | "module": "aws_cdk.aws_applicationautoscaling"
|
| 84 | }
|
| 85 | }
|
| 86 | },
|
| 87 | "@aws-cdk/aws-autoscaling-common": {
|
| 88 | "targets": {
|
| 89 | "dotnet": {
|
| 90 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 91 | "namespace": "Amazon.CDK.AWS.AutoScaling.Common",
|
| 92 | "packageId": "Amazon.CDK.AWS.AutoScaling.Common"
|
| 93 | },
|
| 94 | "java": {
|
| 95 | "maven": {
|
| 96 | "artifactId": "autoscaling-common",
|
| 97 | "groupId": "software.amazon.awscdk"
|
| 98 | },
|
| 99 | "package": "software.amazon.awscdk.services.autoscaling.common"
|
| 100 | },
|
| 101 | "js": {
|
| 102 | "npm": "@aws-cdk/aws-autoscaling-common"
|
| 103 | },
|
| 104 | "python": {
|
| 105 | "classifiers": [
|
| 106 | "Framework :: AWS CDK",
|
| 107 | "Framework :: AWS CDK :: 1"
|
| 108 | ],
|
| 109 | "distName": "aws-cdk.aws-autoscaling-common",
|
| 110 | "module": "aws_cdk.aws_autoscaling_common"
|
| 111 | }
|
| 112 | }
|
| 113 | },
|
| 114 | "@aws-cdk/aws-cloudwatch": {
|
| 115 | "targets": {
|
| 116 | "dotnet": {
|
| 117 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 118 | "namespace": "Amazon.CDK.AWS.CloudWatch",
|
| 119 | "packageId": "Amazon.CDK.AWS.CloudWatch"
|
| 120 | },
|
| 121 | "java": {
|
| 122 | "maven": {
|
| 123 | "artifactId": "cloudwatch",
|
| 124 | "groupId": "software.amazon.awscdk"
|
| 125 | },
|
| 126 | "package": "software.amazon.awscdk.services.cloudwatch"
|
| 127 | },
|
| 128 | "js": {
|
| 129 | "npm": "@aws-cdk/aws-cloudwatch"
|
| 130 | },
|
| 131 | "python": {
|
| 132 | "classifiers": [
|
| 133 | "Framework :: AWS CDK",
|
| 134 | "Framework :: AWS CDK :: 1"
|
| 135 | ],
|
| 136 | "distName": "aws-cdk.aws-cloudwatch",
|
| 137 | "module": "aws_cdk.aws_cloudwatch"
|
| 138 | }
|
| 139 | }
|
| 140 | },
|
| 141 | "@aws-cdk/aws-codeguruprofiler": {
|
| 142 | "targets": {
|
| 143 | "dotnet": {
|
| 144 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 145 | "namespace": "Amazon.CDK.AWS.CodeGuruProfiler",
|
| 146 | "packageId": "Amazon.CDK.AWS.CodeGuruProfiler"
|
| 147 | },
|
| 148 | "java": {
|
| 149 | "maven": {
|
| 150 | "artifactId": "codeguruprofiler",
|
| 151 | "groupId": "software.amazon.awscdk"
|
| 152 | },
|
| 153 | "package": "software.amazon.awscdk.services.codeguruprofiler"
|
| 154 | },
|
| 155 | "js": {
|
| 156 | "npm": "@aws-cdk/aws-codeguruprofiler"
|
| 157 | },
|
| 158 | "python": {
|
| 159 | "classifiers": [
|
| 160 | "Framework :: AWS CDK",
|
| 161 | "Framework :: AWS CDK :: 1"
|
| 162 | ],
|
| 163 | "distName": "aws-cdk.aws-codeguruprofiler",
|
| 164 | "module": "aws_cdk.aws_codeguruprofiler"
|
| 165 | }
|
| 166 | }
|
| 167 | },
|
| 168 | "@aws-cdk/aws-codestarnotifications": {
|
| 169 | "targets": {
|
| 170 | "dotnet": {
|
| 171 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 172 | "namespace": "Amazon.CDK.AWS.CodeStarNotifications",
|
| 173 | "packageId": "Amazon.CDK.AWS.CodeStarNotifications"
|
| 174 | },
|
| 175 | "java": {
|
| 176 | "maven": {
|
| 177 | "artifactId": "codestarnotifications",
|
| 178 | "groupId": "software.amazon.awscdk"
|
| 179 | },
|
| 180 | "package": "software.amazon.awscdk.services.codestarnotifications"
|
| 181 | },
|
| 182 | "js": {
|
| 183 | "npm": "@aws-cdk/aws-codestarnotifications"
|
| 184 | },
|
| 185 | "python": {
|
| 186 | "classifiers": [
|
| 187 | "Framework :: AWS CDK",
|
| 188 | "Framework :: AWS CDK :: 1"
|
| 189 | ],
|
| 190 | "distName": "aws-cdk.aws-codestarnotifications",
|
| 191 | "module": "aws_cdk.aws_codestarnotifications"
|
| 192 | }
|
| 193 | }
|
| 194 | },
|
| 195 | "@aws-cdk/aws-ec2": {
|
| 196 | "targets": {
|
| 197 | "dotnet": {
|
| 198 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 199 | "namespace": "Amazon.CDK.AWS.EC2",
|
| 200 | "packageId": "Amazon.CDK.AWS.EC2"
|
| 201 | },
|
| 202 | "java": {
|
| 203 | "maven": {
|
| 204 | "artifactId": "ec2",
|
| 205 | "groupId": "software.amazon.awscdk"
|
| 206 | },
|
| 207 | "package": "software.amazon.awscdk.services.ec2"
|
| 208 | },
|
| 209 | "js": {
|
| 210 | "npm": "@aws-cdk/aws-ec2"
|
| 211 | },
|
| 212 | "python": {
|
| 213 | "classifiers": [
|
| 214 | "Framework :: AWS CDK",
|
| 215 | "Framework :: AWS CDK :: 1"
|
| 216 | ],
|
| 217 | "distName": "aws-cdk.aws-ec2",
|
| 218 | "module": "aws_cdk.aws_ec2"
|
| 219 | }
|
| 220 | }
|
| 221 | },
|
| 222 | "@aws-cdk/aws-ecr": {
|
| 223 | "targets": {
|
| 224 | "dotnet": {
|
| 225 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 226 | "namespace": "Amazon.CDK.AWS.ECR",
|
| 227 | "packageId": "Amazon.CDK.AWS.ECR"
|
| 228 | },
|
| 229 | "java": {
|
| 230 | "maven": {
|
| 231 | "artifactId": "ecr",
|
| 232 | "groupId": "software.amazon.awscdk"
|
| 233 | },
|
| 234 | "package": "software.amazon.awscdk.services.ecr"
|
| 235 | },
|
| 236 | "js": {
|
| 237 | "npm": "@aws-cdk/aws-ecr"
|
| 238 | },
|
| 239 | "python": {
|
| 240 | "classifiers": [
|
| 241 | "Framework :: AWS CDK",
|
| 242 | "Framework :: AWS CDK :: 1"
|
| 243 | ],
|
| 244 | "distName": "aws-cdk.aws-ecr",
|
| 245 | "module": "aws_cdk.aws_ecr"
|
| 246 | }
|
| 247 | }
|
| 248 | },
|
| 249 | "@aws-cdk/aws-ecr-assets": {
|
| 250 | "targets": {
|
| 251 | "dotnet": {
|
| 252 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 253 | "namespace": "Amazon.CDK.AWS.Ecr.Assets",
|
| 254 | "packageId": "Amazon.CDK.ECR.Assets"
|
| 255 | },
|
| 256 | "java": {
|
| 257 | "maven": {
|
| 258 | "artifactId": "ecr-assets",
|
| 259 | "groupId": "software.amazon.awscdk"
|
| 260 | },
|
| 261 | "package": "software.amazon.awscdk.services.ecr.assets"
|
| 262 | },
|
| 263 | "js": {
|
| 264 | "npm": "@aws-cdk/aws-ecr-assets"
|
| 265 | },
|
| 266 | "python": {
|
| 267 | "classifiers": [
|
| 268 | "Framework :: AWS CDK",
|
| 269 | "Framework :: AWS CDK :: 1"
|
| 270 | ],
|
| 271 | "distName": "aws-cdk.aws-ecr-assets",
|
| 272 | "module": "aws_cdk.aws_ecr_assets"
|
| 273 | }
|
| 274 | }
|
| 275 | },
|
| 276 | "@aws-cdk/aws-efs": {
|
| 277 | "targets": {
|
| 278 | "dotnet": {
|
| 279 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 280 | "namespace": "Amazon.CDK.AWS.EFS",
|
| 281 | "packageId": "Amazon.CDK.AWS.EFS"
|
| 282 | },
|
| 283 | "java": {
|
| 284 | "maven": {
|
| 285 | "artifactId": "efs",
|
| 286 | "groupId": "software.amazon.awscdk"
|
| 287 | },
|
| 288 | "package": "software.amazon.awscdk.services.efs"
|
| 289 | },
|
| 290 | "js": {
|
| 291 | "npm": "@aws-cdk/aws-efs"
|
| 292 | },
|
| 293 | "python": {
|
| 294 | "classifiers": [
|
| 295 | "Framework :: AWS CDK",
|
| 296 | "Framework :: AWS CDK :: 1"
|
| 297 | ],
|
| 298 | "distName": "aws-cdk.aws-efs",
|
| 299 | "module": "aws_cdk.aws_efs"
|
| 300 | }
|
| 301 | }
|
| 302 | },
|
| 303 | "@aws-cdk/aws-events": {
|
| 304 | "targets": {
|
| 305 | "dotnet": {
|
| 306 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 307 | "namespace": "Amazon.CDK.AWS.Events",
|
| 308 | "packageId": "Amazon.CDK.AWS.Events"
|
| 309 | },
|
| 310 | "java": {
|
| 311 | "maven": {
|
| 312 | "artifactId": "events",
|
| 313 | "groupId": "software.amazon.awscdk"
|
| 314 | },
|
| 315 | "package": "software.amazon.awscdk.services.events"
|
| 316 | },
|
| 317 | "js": {
|
| 318 | "npm": "@aws-cdk/aws-events"
|
| 319 | },
|
| 320 | "python": {
|
| 321 | "classifiers": [
|
| 322 | "Framework :: AWS CDK",
|
| 323 | "Framework :: AWS CDK :: 1"
|
| 324 | ],
|
| 325 | "distName": "aws-cdk.aws-events",
|
| 326 | "module": "aws_cdk.aws_events"
|
| 327 | }
|
| 328 | }
|
| 329 | },
|
| 330 | "@aws-cdk/aws-iam": {
|
| 331 | "targets": {
|
| 332 | "dotnet": {
|
| 333 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 334 | "namespace": "Amazon.CDK.AWS.IAM",
|
| 335 | "packageId": "Amazon.CDK.AWS.IAM"
|
| 336 | },
|
| 337 | "java": {
|
| 338 | "maven": {
|
| 339 | "artifactId": "iam",
|
| 340 | "groupId": "software.amazon.awscdk"
|
| 341 | },
|
| 342 | "package": "software.amazon.awscdk.services.iam"
|
| 343 | },
|
| 344 | "js": {
|
| 345 | "npm": "@aws-cdk/aws-iam"
|
| 346 | },
|
| 347 | "python": {
|
| 348 | "classifiers": [
|
| 349 | "Framework :: AWS CDK",
|
| 350 | "Framework :: AWS CDK :: 1"
|
| 351 | ],
|
| 352 | "distName": "aws-cdk.aws-iam",
|
| 353 | "module": "aws_cdk.aws_iam"
|
| 354 | }
|
| 355 | }
|
| 356 | },
|
| 357 | "@aws-cdk/aws-kms": {
|
| 358 | "targets": {
|
| 359 | "dotnet": {
|
| 360 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 361 | "namespace": "Amazon.CDK.AWS.KMS",
|
| 362 | "packageId": "Amazon.CDK.AWS.KMS"
|
| 363 | },
|
| 364 | "java": {
|
| 365 | "maven": {
|
| 366 | "artifactId": "kms",
|
| 367 | "groupId": "software.amazon.awscdk"
|
| 368 | },
|
| 369 | "package": "software.amazon.awscdk.services.kms"
|
| 370 | },
|
| 371 | "js": {
|
| 372 | "npm": "@aws-cdk/aws-kms"
|
| 373 | },
|
| 374 | "python": {
|
| 375 | "classifiers": [
|
| 376 | "Framework :: AWS CDK",
|
| 377 | "Framework :: AWS CDK :: 1"
|
| 378 | ],
|
| 379 | "distName": "aws-cdk.aws-kms",
|
| 380 | "module": "aws_cdk.aws_kms"
|
| 381 | }
|
| 382 | }
|
| 383 | },
|
| 384 | "@aws-cdk/aws-logs": {
|
| 385 | "targets": {
|
| 386 | "dotnet": {
|
| 387 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 388 | "namespace": "Amazon.CDK.AWS.Logs",
|
| 389 | "packageId": "Amazon.CDK.AWS.Logs"
|
| 390 | },
|
| 391 | "java": {
|
| 392 | "maven": {
|
| 393 | "artifactId": "logs",
|
| 394 | "groupId": "software.amazon.awscdk"
|
| 395 | },
|
| 396 | "package": "software.amazon.awscdk.services.logs"
|
| 397 | },
|
| 398 | "js": {
|
| 399 | "npm": "@aws-cdk/aws-logs"
|
| 400 | },
|
| 401 | "python": {
|
| 402 | "classifiers": [
|
| 403 | "Framework :: AWS CDK",
|
| 404 | "Framework :: AWS CDK :: 1"
|
| 405 | ],
|
| 406 | "distName": "aws-cdk.aws-logs",
|
| 407 | "module": "aws_cdk.aws_logs"
|
| 408 | }
|
| 409 | }
|
| 410 | },
|
| 411 | "@aws-cdk/aws-s3": {
|
| 412 | "targets": {
|
| 413 | "dotnet": {
|
| 414 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 415 | "namespace": "Amazon.CDK.AWS.S3",
|
| 416 | "packageId": "Amazon.CDK.AWS.S3"
|
| 417 | },
|
| 418 | "java": {
|
| 419 | "maven": {
|
| 420 | "artifactId": "s3",
|
| 421 | "groupId": "software.amazon.awscdk"
|
| 422 | },
|
| 423 | "package": "software.amazon.awscdk.services.s3"
|
| 424 | },
|
| 425 | "js": {
|
| 426 | "npm": "@aws-cdk/aws-s3"
|
| 427 | },
|
| 428 | "python": {
|
| 429 | "classifiers": [
|
| 430 | "Framework :: AWS CDK",
|
| 431 | "Framework :: AWS CDK :: 1"
|
| 432 | ],
|
| 433 | "distName": "aws-cdk.aws-s3",
|
| 434 | "module": "aws_cdk.aws_s3"
|
| 435 | }
|
| 436 | }
|
| 437 | },
|
| 438 | "@aws-cdk/aws-s3-assets": {
|
| 439 | "targets": {
|
| 440 | "dotnet": {
|
| 441 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 442 | "namespace": "Amazon.CDK.AWS.S3.Assets",
|
| 443 | "packageId": "Amazon.CDK.AWS.S3.Assets"
|
| 444 | },
|
| 445 | "java": {
|
| 446 | "maven": {
|
| 447 | "artifactId": "s3-assets",
|
| 448 | "groupId": "software.amazon.awscdk"
|
| 449 | },
|
| 450 | "package": "software.amazon.awscdk.services.s3.assets"
|
| 451 | },
|
| 452 | "js": {
|
| 453 | "npm": "@aws-cdk/aws-s3-assets"
|
| 454 | },
|
| 455 | "python": {
|
| 456 | "classifiers": [
|
| 457 | "Framework :: AWS CDK",
|
| 458 | "Framework :: AWS CDK :: 1"
|
| 459 | ],
|
| 460 | "distName": "aws-cdk.aws-s3-assets",
|
| 461 | "module": "aws_cdk.aws_s3_assets"
|
| 462 | }
|
| 463 | }
|
| 464 | },
|
| 465 | "@aws-cdk/aws-signer": {
|
| 466 | "targets": {
|
| 467 | "dotnet": {
|
| 468 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 469 | "namespace": "Amazon.CDK.AWS.Signer",
|
| 470 | "packageId": "Amazon.CDK.AWS.Signer"
|
| 471 | },
|
| 472 | "java": {
|
| 473 | "maven": {
|
| 474 | "artifactId": "signer",
|
| 475 | "groupId": "software.amazon.awscdk"
|
| 476 | },
|
| 477 | "package": "software.amazon.awscdk.services.signer"
|
| 478 | },
|
| 479 | "js": {
|
| 480 | "npm": "@aws-cdk/aws-signer"
|
| 481 | },
|
| 482 | "python": {
|
| 483 | "classifiers": [
|
| 484 | "Framework :: AWS CDK",
|
| 485 | "Framework :: AWS CDK :: 1"
|
| 486 | ],
|
| 487 | "distName": "aws-cdk.aws-signer",
|
| 488 | "module": "aws_cdk.aws_signer"
|
| 489 | }
|
| 490 | }
|
| 491 | },
|
| 492 | "@aws-cdk/aws-sns": {
|
| 493 | "targets": {
|
| 494 | "dotnet": {
|
| 495 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 496 | "namespace": "Amazon.CDK.AWS.SNS",
|
| 497 | "packageId": "Amazon.CDK.AWS.SNS"
|
| 498 | },
|
| 499 | "java": {
|
| 500 | "maven": {
|
| 501 | "artifactId": "sns",
|
| 502 | "groupId": "software.amazon.awscdk"
|
| 503 | },
|
| 504 | "package": "software.amazon.awscdk.services.sns"
|
| 505 | },
|
| 506 | "js": {
|
| 507 | "npm": "@aws-cdk/aws-sns"
|
| 508 | },
|
| 509 | "python": {
|
| 510 | "classifiers": [
|
| 511 | "Framework :: AWS CDK",
|
| 512 | "Framework :: AWS CDK :: 1"
|
| 513 | ],
|
| 514 | "distName": "aws-cdk.aws-sns",
|
| 515 | "module": "aws_cdk.aws_sns"
|
| 516 | }
|
| 517 | }
|
| 518 | },
|
| 519 | "@aws-cdk/aws-sqs": {
|
| 520 | "targets": {
|
| 521 | "dotnet": {
|
| 522 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 523 | "namespace": "Amazon.CDK.AWS.SQS",
|
| 524 | "packageId": "Amazon.CDK.AWS.SQS"
|
| 525 | },
|
| 526 | "java": {
|
| 527 | "maven": {
|
| 528 | "artifactId": "sqs",
|
| 529 | "groupId": "software.amazon.awscdk"
|
| 530 | },
|
| 531 | "package": "software.amazon.awscdk.services.sqs"
|
| 532 | },
|
| 533 | "js": {
|
| 534 | "npm": "@aws-cdk/aws-sqs"
|
| 535 | },
|
| 536 | "python": {
|
| 537 | "classifiers": [
|
| 538 | "Framework :: AWS CDK",
|
| 539 | "Framework :: AWS CDK :: 1"
|
| 540 | ],
|
| 541 | "distName": "aws-cdk.aws-sqs",
|
| 542 | "module": "aws_cdk.aws_sqs"
|
| 543 | }
|
| 544 | }
|
| 545 | },
|
| 546 | "@aws-cdk/aws-ssm": {
|
| 547 | "targets": {
|
| 548 | "dotnet": {
|
| 549 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 550 | "namespace": "Amazon.CDK.AWS.SSM",
|
| 551 | "packageId": "Amazon.CDK.AWS.SSM"
|
| 552 | },
|
| 553 | "java": {
|
| 554 | "maven": {
|
| 555 | "artifactId": "ssm",
|
| 556 | "groupId": "software.amazon.awscdk"
|
| 557 | },
|
| 558 | "package": "software.amazon.awscdk.services.ssm"
|
| 559 | },
|
| 560 | "js": {
|
| 561 | "npm": "@aws-cdk/aws-ssm"
|
| 562 | },
|
| 563 | "python": {
|
| 564 | "classifiers": [
|
| 565 | "Framework :: AWS CDK",
|
| 566 | "Framework :: AWS CDK :: 1"
|
| 567 | ],
|
| 568 | "distName": "aws-cdk.aws-ssm",
|
| 569 | "module": "aws_cdk.aws_ssm"
|
| 570 | }
|
| 571 | }
|
| 572 | },
|
| 573 | "@aws-cdk/cloud-assembly-schema": {
|
| 574 | "targets": {
|
| 575 | "dotnet": {
|
| 576 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 577 | "namespace": "Amazon.CDK.CloudAssembly.Schema",
|
| 578 | "packageId": "Amazon.CDK.CloudAssembly.Schema"
|
| 579 | },
|
| 580 | "java": {
|
| 581 | "maven": {
|
| 582 | "artifactId": "cdk-cloud-assembly-schema",
|
| 583 | "groupId": "software.amazon.awscdk"
|
| 584 | },
|
| 585 | "package": "software.amazon.awscdk.cloudassembly.schema"
|
| 586 | },
|
| 587 | "js": {
|
| 588 | "npm": "@aws-cdk/cloud-assembly-schema"
|
| 589 | },
|
| 590 | "python": {
|
| 591 | "classifiers": [
|
| 592 | "Framework :: AWS CDK",
|
| 593 | "Framework :: AWS CDK :: 1"
|
| 594 | ],
|
| 595 | "distName": "aws-cdk.cloud-assembly-schema",
|
| 596 | "module": "aws_cdk.cloud_assembly_schema"
|
| 597 | }
|
| 598 | }
|
| 599 | },
|
| 600 | "@aws-cdk/core": {
|
| 601 | "targets": {
|
| 602 | "dotnet": {
|
| 603 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 604 | "namespace": "Amazon.CDK",
|
| 605 | "packageId": "Amazon.CDK"
|
| 606 | },
|
| 607 | "java": {
|
| 608 | "maven": {
|
| 609 | "artifactId": "core",
|
| 610 | "groupId": "software.amazon.awscdk"
|
| 611 | },
|
| 612 | "package": "software.amazon.awscdk.core"
|
| 613 | },
|
| 614 | "js": {
|
| 615 | "npm": "@aws-cdk/core"
|
| 616 | },
|
| 617 | "python": {
|
| 618 | "classifiers": [
|
| 619 | "Framework :: AWS CDK",
|
| 620 | "Framework :: AWS CDK :: 1"
|
| 621 | ],
|
| 622 | "distName": "aws-cdk.core",
|
| 623 | "module": "aws_cdk.core"
|
| 624 | }
|
| 625 | }
|
| 626 | },
|
| 627 | "@aws-cdk/cx-api": {
|
| 628 | "targets": {
|
| 629 | "dotnet": {
|
| 630 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 631 | "namespace": "Amazon.CDK.CXAPI",
|
| 632 | "packageId": "Amazon.CDK.CXAPI"
|
| 633 | },
|
| 634 | "java": {
|
| 635 | "maven": {
|
| 636 | "artifactId": "cdk-cx-api",
|
| 637 | "groupId": "software.amazon.awscdk"
|
| 638 | },
|
| 639 | "package": "software.amazon.awscdk.cxapi"
|
| 640 | },
|
| 641 | "js": {
|
| 642 | "npm": "@aws-cdk/cx-api"
|
| 643 | },
|
| 644 | "python": {
|
| 645 | "classifiers": [
|
| 646 | "Framework :: AWS CDK",
|
| 647 | "Framework :: AWS CDK :: 1"
|
| 648 | ],
|
| 649 | "distName": "aws-cdk.cx-api",
|
| 650 | "module": "aws_cdk.cx_api"
|
| 651 | }
|
| 652 | }
|
| 653 | },
|
| 654 | "@aws-cdk/region-info": {
|
| 655 | "targets": {
|
| 656 | "dotnet": {
|
| 657 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 658 | "namespace": "Amazon.CDK.RegionInfo",
|
| 659 | "packageId": "Amazon.CDK.RegionInfo"
|
| 660 | },
|
| 661 | "java": {
|
| 662 | "maven": {
|
| 663 | "artifactId": "cdk-region-info",
|
| 664 | "groupId": "software.amazon.awscdk"
|
| 665 | },
|
| 666 | "package": "software.amazon.awscdk.regioninfo"
|
| 667 | },
|
| 668 | "js": {
|
| 669 | "npm": "@aws-cdk/region-info"
|
| 670 | },
|
| 671 | "python": {
|
| 672 | "classifiers": [
|
| 673 | "Framework :: AWS CDK",
|
| 674 | "Framework :: AWS CDK :: 1"
|
| 675 | ],
|
| 676 | "distName": "aws-cdk.region-info",
|
| 677 | "module": "aws_cdk.region_info"
|
| 678 | }
|
| 679 | }
|
| 680 | },
|
| 681 | "constructs": {
|
| 682 | "targets": {
|
| 683 | "dotnet": {
|
| 684 | "namespace": "Constructs",
|
| 685 | "packageId": "Constructs"
|
| 686 | },
|
| 687 | "go": {
|
| 688 | "moduleName": "github.com/aws/constructs-go"
|
| 689 | },
|
| 690 | "java": {
|
| 691 | "maven": {
|
| 692 | "artifactId": "constructs",
|
| 693 | "groupId": "software.constructs"
|
| 694 | },
|
| 695 | "package": "software.constructs"
|
| 696 | },
|
| 697 | "js": {
|
| 698 | "npm": "constructs"
|
| 699 | },
|
| 700 | "python": {
|
| 701 | "distName": "constructs",
|
| 702 | "module": "constructs"
|
| 703 | }
|
| 704 | }
|
| 705 | }
|
| 706 | },
|
| 707 | "description": "The CDK Construct Library for AWS::Lambda",
|
| 708 | "docs": {
|
| 709 | "stability": "stable"
|
| 710 | },
|
| 711 | "homepage": "https://github.com/aws/aws-cdk",
|
| 712 | "jsiiVersion": "1.73.0 (build 6faeda3)",
|
| 713 | "keywords": [
|
| 714 | "aws",
|
| 715 | "cdk",
|
| 716 | "constructs",
|
| 717 | "lambda"
|
| 718 | ],
|
| 719 | "license": "Apache-2.0",
|
| 720 | "metadata": {
|
| 721 | "jsii": {
|
| 722 | "compiledWithDeprecationWarnings": true,
|
| 723 | "pacmak": {
|
| 724 | "hasDefaultInterfaces": true
|
| 725 | },
|
| 726 | "rosetta": {
|
| 727 | "strict": true
|
| 728 | }
|
| 729 | }
|
| 730 | },
|
| 731 | "name": "@aws-cdk/aws-lambda",
|
| 732 | "readme": {
|
| 733 | "markdown": "# AWS Lambda Construct Library\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n\n\n\n\n---\n\n<!--END STABILITY BANNER-->\n\nThis construct library allows you to define AWS Lambda Functions.\n\n```ts\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_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 * `lambda.Code.fromDockerBuild(path, options)` - use the result of a Docker\n build as code. The runtime code is expected to be located at `/asset` in the\n image and will be zipped and uploaded to S3 as an asset.\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_9,\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## Docker Images\n\nLambda functions allow specifying their handlers within docker images. The docker\nimage can be an image from ECR or a local asset that the CDK will package and load\ninto ECR.\n\nThe following `DockerImageFunction` construct uses a local folder with a\nDockerfile as the asset that will be used as the function handler.\n\n```ts\nnew lambda.DockerImageFunction(this, 'AssetFunction', {\n code: lambda.DockerImageCode.fromImageAsset(path.join(__dirname, 'docker-handler')),\n});\n```\n\nYou can also specify an image that already exists in ECR as the function handler.\n\n```ts\nimport * as ecr from '@aws-cdk/aws-ecr';\nconst repo = new ecr.Repository(this, 'Repository');\n\nnew lambda.DockerImageFunction(this, 'ECRFunction', {\n code: lambda.DockerImageCode.fromEcr(repo),\n});\n```\n\nThe props for these docker image resources allow overriding the image's `CMD`, `ENTRYPOINT`, and `WORKDIR`\nconfigurations as well as choosing a specific tag or digest. See their docs for more information.\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_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});\n\nconst role = fn.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 myRole = new iam.Role(this, 'My Role', {\n assumedBy: new iam.ServicePrincipal('sns.amazonaws.com'),\n});\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_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(iam.ManagedPolicy.fromAwsManagedPolicyName(\"service-role/AWSLambdaBasicExecutionRole\"));\nmyRole.addManagedPolicy(iam.ManagedPolicy.fromAwsManagedPolicyName(\"service-role/AWSLambdaVPCAccessExecutionRole\")); // only required if your function lives in a VPC\n```\n\n## Function Timeout\n\nAWS Lambda functions have a default timeout of 3 seconds, but this can be increased\nup to 15 minutes. The timeout is available as a property of `Function` so that\nyou can reference it elsewhere in your stack. For instance, you could use it to create\na CloudWatch alarm to report when your function timed out:\n\n```ts\nimport * as cdk from '@aws-cdk/core';\nimport * as cloudwatch from '@aws-cdk/aws-cloudwatch';\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n timeout: cdk.Duration.minutes(5),\n});\n\nif (fn.timeout) {\n new cloudwatch.Alarm(this, `MyAlarm`, {\n metric: fn.metricDuration().with({\n statistic: 'Maximum',\n }),\n evaluationPeriods: 1,\n datapointsToAlarm: 1,\n threshold: fn.timeout.toMilliseconds(),\n treatMissingData: cloudwatch.TreatMissingData.IGNORE,\n alarmName: 'My Lambda Timeout',\n });\n}\n```\n\n## Resource-based Policies\n\nAWS Lambda supports resource-based policies for controlling access to Lambda\nfunctions and layers on a per-resource basis. In particular, this allows you to\ngive permission to AWS services and other AWS accounts to modify and invoke your\nfunctions. You can also restrict permissions given to AWS services by providing\na source account or ARN (representing the account and identifier of the resource\nthat accesses the function or layer).\n\n```ts\ndeclare const fn: lambda.Function;\nconst principal = new iam.ServicePrincipal('my-service');\n\nfn.grantInvoke(principal);\n\n// Equivalent to:\nfn.addPermission('my-service Invocation', {\n principal: principal,\n});\n```\n\nFor more information, see [Resource-based\npolicies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html)\nin the AWS Lambda Developer Guide.\n\nProviding an unowned principal (such as account principals, generic ARN\nprincipals, service principals, and principals in other accounts) to a call to\n`fn.grantInvoke` will result in a resource-based policy being created. If the\nprincipal in question has conditions limiting the source account or ARN of the\noperation (see above), these conditions will be automatically added to the\nresource policy.\n\n```ts\ndeclare const fn: lambda.Function;\nconst servicePrincipal = new iam.ServicePrincipal('my-service');\nconst sourceArn = 'arn:aws:s3:::my-bucket';\nconst sourceAccount = '111122223333';\nconst servicePrincipalWithConditions = servicePrincipal.withConditions({\n ArnLike: {\n 'aws:SourceArn': sourceArn,\n },\n StringEquals: {\n 'aws:SourceAccount': sourceAccount,\n },\n});\n\nfn.grantInvoke(servicePrincipalWithConditions);\n\n// Equivalent to:\nfn.addPermission('my-service Invocation', {\n principal: servicePrincipal,\n sourceArn: sourceArn,\n sourceAccount: sourceAccount,\n});\n```\n\n## Versions\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 could create a version to your lambda function using the `Version` construct.\n\n```ts\ndeclare const fn: lambda.Function;\nconst version = new lambda.Version(this, 'MyVersion', {\n lambda: fn,\n});\n```\n\nThe major caveat to know here is that a function version must always point to a\nspecific 'version' of the function. When the function is modified, the version\nwill continue to point to the 'then version' of the function.\n\nOne way to ensure that the `lambda.Version` always points to the latest version\nof your `lambda.Function` is to set an environment variable which changes at\nleast as often as your code does. This makes sure the function always has the\nlatest code. For instance -\n\n```ts\nconst codeVersion = \"stringOrMethodToGetCodeVersion\";\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n environment: {\n 'CodeVersionString': codeVersion,\n },\n});\n```\n\nThe `fn.latestVersion` property returns a `lambda.IVersion` which represents\nthe `$LATEST` pseudo-version.\n\nHowever, most AWS services require a specific AWS Lambda version,\nand won't allow you to use `$LATEST`. Therefore, you would normally want\nto use `lambda.currentVersion`.\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\nNOTE: The `currentVersion` property is only supported when your AWS Lambda function\nuses either `lambda.Code.fromAsset` or `lambda.Code.fromInline`. Other types\nof 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\ntheir contents had changed.\n\n### `currentVersion`: Updated hashing logic\n\nTo produce a new lambda version each time the lambda function is modified, the\n`currentVersion` property under the hood, computes a new logical id based on the\nproperties of the function. This informs CloudFormation that a new\n`AWS::Lambda::Version` resource should be created pointing to the updated Lambda\nfunction.\n\nHowever, a bug was introduced in this calculation that caused the logical id to\nchange when it was not required (ex: when the Function's `Tags` property, or\nwhen the `DependsOn` clause was modified). This caused the deployment to fail\nsince the Lambda service does not allow creating duplicate versions.\n\nThis has been fixed in the AWS CDK but *existing* users need to opt-in via a\n[feature flag]. Users who have run `cdk init` since this fix will be opted in,\nby default.\n\nOtherwise, you will need to enable the [feature flag]\n`@aws-cdk/aws-lambda:recognizeVersionProps`. Since CloudFormation does not\nallow duplicate versions, you will also need to make some modification to\nyour function so that a new version can be created. To efficiently and trivially\nmodify all your lambda functions at once, you can attach the\n`FunctionVersionUpgrade` aspect to the stack, which slightly alters the\nfunction description. This aspect is intended for one-time use to upgrade the\nversion of all your functions at the same time, and can safely be removed after\ndeploying once.\n\n```ts\nconst stack = new Stack();\nAspects.of(stack).add(new lambda.FunctionVersionUpgrade(LAMBDA_RECOGNIZE_VERSION_PROPS));\n```\n\nWhen the new logic is in effect, you may rarely come across the following error:\n`The following properties are not recognized as version properties`. This will\noccur, typically when [property overrides] are used, when a new property\nintroduced in `AWS::Lambda::Function` is used that CDK is still unaware of.\n\nTo overcome this error, use the API `Function.classifyVersionProperty()` to\nrecord whether a new version should be generated when this property is changed.\nThis can be typically determined by checking whether the property can be\nmodified using the *[UpdateFunctionConfiguration]* API or not.\n\n### `currentVersion`: Updated hashing logic for layer versions\n\nAn additional update to the hashing logic fixes two issues surrounding layers.\nPrior to this change, updating the lambda layer version would have no effect on\nthe function version. Also, the order of lambda layers provided to the function\nwas unnecessarily baked into the hash.\n\nThis has been fixed in the AWS CDK starting with version 2.27. If you ran\n`cdk init` with an earlier version, you will need to opt-in via a [feature flag].\nIf you run `cdk init` with v2.27 or later, this fix will be opted in, by default.\n\nExisting users will need to enable the [feature flag]\n`@aws-cdk/aws-lambda:recognizeLayerVersion`. Since CloudFormation does not\nallow duplicate versions, they will also need to make some modification to\ntheir function so that a new version can be created. To efficiently and trivially\nmodify all your lambda functions at once, users can attach the\n`FunctionVersionUpgrade` aspect to the stack, which slightly alters the\nfunction description. This aspect is intended for one-time use to upgrade the\nversion of all your functions at the same time, and can safely be removed after\ndeploying once.\n\n```ts\nconst stack = new Stack();\nAspects.of(stack).add(new lambda.FunctionVersionUpgrade(LAMBDA_RECOGNIZE_LAYER_VERSION));\n```\n\n[feature flag]: https://docs.aws.amazon.com/cdk/latest/guide/featureflags.html\n[property overrides]: https://docs.aws.amazon.com/cdk/latest/guide/cfn_layer.html#cfn_layer_raw\n[UpdateFunctionConfiguration]: https://docs.aws.amazon.com/lambda/latest/dg/API_UpdateFunctionConfiguration.html\n\n## Aliases\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 `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 runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});\n\nfn.addAlias('live');\n```\n\n## Function URL\n\nA function URL is a dedicated HTTP(S) endpoint for your Lambda function. When you create a function URL, Lambda automatically generates a unique URL endpoint for you. Function URLs can be created for the latest version Lambda Functions, or Function Aliases (but not for Versions).\n\nFunction URLs are dual stack-enabled, supporting IPv4 and IPv6, and cross-origin resource sharing (CORS) configuration. After you configure a function URL for your function, you can invoke your function through its HTTP(S) endpoint via a web browser, curl, Postman, or any HTTP client. To invoke a function using IAM authentication your HTTP client must support SigV4 signing.\n\nSee the [Invoking Function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-invocation.html) section of the AWS Lambda Developer Guide\nfor more information on the input and output payloads of Functions invoked in this way.\n\n### IAM-authenticated Function URLs\n\nTo create a Function URL which can be called by an IAM identity, call `addFunctionUrl()`, followed by `grantInvokeFunctionUrl()`:\n\n```ts\n// Can be a Function or an Alias\ndeclare const fn: lambda.Function;\ndeclare const myRole: iam.Role;\n\nconst fnUrl = fn.addFunctionUrl();\nfnUrl.grantInvokeUrl(myRole);\n\nnew CfnOutput(this, 'TheUrl', {\n // The .url attributes will return the unique Function URL\n value: fnUrl.url,\n});\n```\n\nCalls to this URL need to be signed with SigV4.\n\n### Anonymous Function URLs\n\nTo create a Function URL which can be called anonymously, pass `authType: FunctionUrlAuthType.NONE` to `addFunctionUrl()`:\n\n```ts\n// Can be a Function or an Alias\ndeclare const fn: lambda.Function;\n\nconst fnUrl = fn.addFunctionUrl({\n authType: lambda.FunctionUrlAuthType.NONE,\n});\n\nnew CfnOutput(this, 'TheUrl', {\n value: fnUrl.url,\n});\n```\n\n### CORS configuration for Function URLs\n\nIf you want your Function URLs to be invokable from a web page in browser, you\nwill need to configure cross-origin resource sharing to allow the call (if you do\nnot do this, your browser will refuse to make the call):\n\n```ts\ndeclare const fn: lambda.Function;\n\nfn.addFunctionUrl({\n authType: lambda.FunctionUrlAuthType.NONE,\n cors: {\n // Allow this to be called from websites on https://example.com.\n // Can also be ['*'] to allow all domain.\n allowedOrigins: ['https://example.com'],\n\n // More options are possible here, see the documentation for FunctionUrlCorsOptions\n },\n});\n```\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_14_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_14_X,\n layers: [layer],\n});\n```\n\nBy default, updating a layer creates a new layer version, and CloudFormation will delete the old version as part of the stack update.\n\nAlternatively, a removal policy can be used to retain the old version:\n\n```ts\nnew lambda.LayerVersion(this, 'MyLayer', {\n removalPolicy: RemovalPolicy.RETAIN,\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});\n```\n\n## Architecture\n\nLambda functions, by default, run on compute systems that have the 64 bit x86 architecture.\n\nThe AWS Lambda service also runs compute on the ARM architecture, which can reduce cost\nfor some workloads.\n\nA lambda function can be configured to be run on one of these platforms:\n\n```ts\nnew lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n architecture: lambda.Architecture.ARM_64,\n});\n```\n\nSimilarly, lambda layer versions can also be tagged with architectures it is compatible with.\n\n```ts\nnew lambda.LayerVersion(this, 'MyLayer', {\n removalPolicy: RemovalPolicy.RETAIN,\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n compatibleArchitectures: [lambda.Architecture.X86_64, lambda.Architecture.ARM_64],\n});\n```\n\n## Lambda Insights\n\nLambda functions can be configured to use CloudWatch [Lambda Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights.html)\nwhich provides low-level runtime metrics for a Lambda functions.\n\n```ts\nnew lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n insightsVersion: lambda.LambdaInsightsVersion.VERSION_1_0_98_0,\n});\n```\n\nIf the version of insights is not yet available in the CDK, you can also provide the ARN directly as so -\n\n```ts\nconst layerArn = 'arn:aws:lambda:us-east-1:580247275435:layer:LambdaInsightsExtension:14';\nnew lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n insightsVersion: lambda.LambdaInsightsVersion.fromInsightVersionArn(layerArn),\n});\n```\n\nIf you are deploying an ARM_64 Lambda Function, you must specify a\nLambda Insights Version >= `1_0_119_0`.\n\n```ts\nnew lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n architecture: lambda.Architecture.ARM_64,\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n insightsVersion: lambda.LambdaInsightsVersion.VERSION_1_0_119_0,\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 events from '@aws-cdk/aws-events';\nimport * as targets from '@aws-cdk/aws-events-targets';\n\ndeclare const fn: lambda.Function;\nconst rule = new events.Rule(this, 'Schedule Rule', {\n schedule: events.Schedule.cron({ minute: '0', hour: '4' }),\n});\nrule.addTarget(new targets.LambdaFunction(fn));\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 `add<Event>Notification` 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 * as eventsources from '@aws-cdk/aws-lambda-event-sources';\nimport * as sqs from '@aws-cdk/aws-sqs';\n\ndeclare const fn: lambda.Function;\nconst queue = new sqs.Queue(this, 'Queue');\nfn.addEventSource(new eventsources.SqsEventSource(queue));\n```\n\nThe following code adds an S3 bucket notification as an event source:\n\n```ts\nimport * as eventsources from '@aws-cdk/aws-lambda-event-sources';\nimport * as s3 from '@aws-cdk/aws-s3';\n\ndeclare const fn: lambda.Function;\nconst bucket = new s3.Bucket(this, 'Bucket');\nfn.addEventSource(new eventsources.S3EventSource(bucket, {\n events: [ s3.EventType.OBJECT_CREATED, s3.EventType.OBJECT_REMOVED ],\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## Imported Lambdas\n\nWhen referencing an imported lambda in the CDK, use `fromFunctionArn()` for most use cases:\n\n```ts\nconst fn = lambda.Function.fromFunctionArn(\n this,\n 'Function',\n 'arn:aws:lambda:us-east-1:123456789012:function:MyFn',\n);\n```\n\nThe `fromFunctionAttributes()` API is available for more specific use cases:\n\n```ts\nconst fn = lambda.Function.fromFunctionAttributes(this, 'Function', {\n functionArn: 'arn:aws:lambda:us-east-1:123456789012:function:MyFn',\n // The following are optional properties for specific use cases and should be used with caution:\n\n // Use Case: imported function is in the same account as the stack. This tells the CDK that it\n // can modify the function's permissions.\n sameEnvironment: true,\n\n // Use Case: imported function is in a different account and user commits to ensuring that the\n // imported function has the correct permissions outside the CDK.\n skipPermissions: true,\n});\n```\n\nIf `fromFunctionArn()` causes an error related to having to provide an account and/or region in a different construct,\nand the lambda is in the same account and region as the stack you're importing it into,\nyou can use `Function.fromFunctionName()` instead:\n\n```ts\nconst fn = lambda.Function.fromFunctionName(this, 'Function', 'MyFn');\n```\n\n## Lambda with DLQ\n\nA dead-letter queue can be automatically created for a Lambda function by\nsetting the `deadLetterQueueEnabled: true` configuration. In such case CDK creates\na `sqs.Queue` as `deadLetterQueue`.\n\n```ts\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_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 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_16_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\nYou can also use a `sns.Topic` instead of an `sqs.Queue` as dead-letter queue:\n\n```ts\nimport * as sns from '@aws-cdk/aws-sns';\n\nconst dlt = new sns.Topic(this, 'DLQ');\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline('// your code here'),\n deadLetterTopic: dlt,\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\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_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\nThe following code configures the lambda function with CodeGuru profiling. By default, this creates a new CodeGuru\nprofiling group -\n\n```ts\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.PYTHON_3_9,\n handler: 'index.handler',\n code: lambda.Code.fromAsset('lambda-handler'),\n profiling: true,\n});\n```\n\nThe `profilingGroup` property can be used to configure an existing CodeGuru profiler group.\n\nCodeGuru profiling is supported for all Java runtimes and Python3.6+ runtimes.\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\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_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\nimport * as autoscaling from '@aws-cdk/aws-autoscaling';\n\ndeclare const fn: lambda.Function;\nconst alias = fn.addAlias('prod');\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: autoscaling.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 { LAMBDA_RECOGNIZE_LAYER_VERSION } from '@aws-cdk/cx-api';\nimport * as lambda from '../lib';\n\n/**\n* Stack verification steps:\n* aws application-autoscaling describe-scalable-targets --service-namespace lambda --resource-ids function:<function name>: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 () => { console.log(\\'hello world\\'); };'),\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_14_X,\n });\n\n const version = fn.currentVersion;\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\nconst stack = new TestStack(app, 'aws-lambda-autoscaling');\n\n// Changes the function description when the feature flag is present\n// to validate the changed function hash.\ncdk.Aspects.of(stack).add(new lambda.FunctionVersionUpgrade(LAMBDA_RECOGNIZE_LAYER_VERSION));\n\napp.synth();\n\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/<function-name>` 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\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as efs from '@aws-cdk/aws-efs';\n\n// create a new VPC\nconst vpc = new ec2.Vpc(this, 'VPC');\n\n// create a new Amazon EFS filesystem\nconst fileSystem = new efs.FileSystem(this, '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(this, 'MyLambda', {\n // mount the access point to /mnt/msg in the lambda runtime environment\n filesystem: lambda.FileSystem.fromEfsAccessPoint(accessPoint, '/mnt/msg'),\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n vpc,\n});\n```\n\n## Ephemeral Storage\n\nYou can configure ephemeral storage on a function to control the amount of storage it gets for reading\nor writing data, allowing you to use AWS Lambda for ETL jobs, ML inference, or other data-intensive workloads.\nThe ephemeral storage will be accessible in the functions' `/tmp` directory.\n\n```ts\nimport { Size } from '@aws-cdk/core';\n\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n ephemeralStorageSize: Size.mebibytes(1024),\n});\n```\n\nRead more about using this feature in [this AWS blog post](https://aws.amazon.com/blogs/aws/aws-lambda-now-supports-up-to-10-gb-ephemeral-storage/).\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\n\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\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_9.bundlingImage,\n command: [\n 'bash', '-c',\n 'pip install -r requirements.txt -t /asset-output && cp -au . /asset-output'\n ],\n },\n }),\n runtime: lambda.Runtime.PYTHON_3_9,\n handler: 'index.handler',\n});\n```\n\nRuntimes expose a `bundlingImage` property that points to the [AWS SAM](https://github.com/awslabs/aws-sam-cli) build image.\n\nUse `cdk.DockerImage.fromRegistry(image)` to use an existing image or\n`cdk.DockerImage.fromBuild(path)` to build a specific image:\n\n```ts\nnew lambda.Function(this, 'Function', {\n code: lambda.Code.fromAsset('/path/to/handler', {\n bundling: {\n image: DockerImage.fromBuild('/path/to/dir/with/DockerFile', {\n buildArgs: {\n ARG1: 'value1',\n },\n }),\n command: ['my', 'cool', 'command'],\n },\n }),\n runtime: lambda.Runtime.PYTHON_3_9,\n handler: 'index.handler',\n});\n```\n\n## Language-specific APIs\n\nLanguage-specific higher level constructs are provided in separate modules:\n\n* `@aws-cdk/aws-lambda-nodejs`: [Github](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-lambda-nodejs) & [CDK Docs](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-nodejs-readme.html)\n* `@aws-cdk/aws-lambda-python`: [Github](https://github.com/aws/aws-cdk/tree/master/packages/%40aws-cdk/aws-lambda-python) & [CDK Docs](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-python-readme.html)\n\n## Code Signing\n\nCode signing for AWS Lambda helps to ensure that only trusted code runs in your Lambda functions.\nWhen enabled, AWS Lambda checks every code deployment and verifies that the code package is signed by a trusted source.\nFor more information, see [Configuring code signing for AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html).\nThe following code configures a function with code signing.\n\n```ts\nimport * as signer from '@aws-cdk/aws-signer';\n\nconst signingProfile = new signer.SigningProfile(this, 'SigningProfile', {\n platform: signer.Platform.AWS_LAMBDA_SHA384_ECDSA,\n});\n\nconst codeSigningConfig = new lambda.CodeSigningConfig(this, 'CodeSigningConfig', {\n signingProfiles: [signingProfile],\n});\n\nnew lambda.Function(this, 'Function', {\n codeSigningConfig,\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});\n```\n"
|
| 734 | },
|
| 735 | "repository": {
|
| 736 | "directory": "packages/@aws-cdk/aws-lambda",
|
| 737 | "type": "git",
|
| 738 | "url": "https://github.com/aws/aws-cdk.git"
|
| 739 | },
|
| 740 | "schema": "jsii/0.10.0",
|
| 741 | "targets": {
|
| 742 | "dotnet": {
|
| 743 | "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png",
|
| 744 | "namespace": "Amazon.CDK.AWS.Lambda",
|
| 745 | "packageId": "Amazon.CDK.AWS.Lambda"
|
| 746 | },
|
| 747 | "java": {
|
| 748 | "maven": {
|
| 749 | "artifactId": "lambda",
|
| 750 | "groupId": "software.amazon.awscdk"
|
| 751 | },
|
| 752 | "package": "software.amazon.awscdk.services.lambda"
|
| 753 | },
|
| 754 | "js": {
|
| 755 | "npm": "@aws-cdk/aws-lambda"
|
| 756 | },
|
| 757 | "python": {
|
| 758 | "classifiers": [
|
| 759 | "Framework :: AWS CDK",
|
| 760 | "Framework :: AWS CDK :: 1"
|
| 761 | ],
|
| 762 | "distName": "aws-cdk.aws-lambda",
|
| 763 | "module": "aws_cdk.aws_lambda"
|
| 764 | }
|
| 765 | },
|
| 766 | "types": {
|
| 767 | "@aws-cdk/aws-lambda.Alias": {
|
| 768 | "assembly": "@aws-cdk/aws-lambda",
|
| 769 | "base": "@aws-cdk/aws-lambda.QualifiedFunctionBase",
|
| 770 | "docs": {
|
| 771 | "stability": "stable",
|
| 772 | "summary": "A new alias to a particular version of a Lambda function.",
|
| 773 | "example": "const lambdaCode = lambda.Code.fromCfnParameters();\nconst func = new lambda.Function(this, 'Lambda', {\n code: lambdaCode,\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_14_X,\n});\n// used to make sure each CDK synthesis produces a different Version\nconst version = func.currentVersion;\nconst alias = new lambda.Alias(this, 'LambdaAlias', {\n aliasName: 'Prod',\n version,\n});\n\nnew codedeploy.LambdaDeploymentGroup(this, 'DeploymentGroup', {\n alias,\n deploymentConfig: codedeploy.LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,\n});",
|
| 774 | "custom": {
|
| 775 | "exampleMetadata": "infused"
|
| 776 | }
|
| 777 | },
|
| 778 | "fqn": "@aws-cdk/aws-lambda.Alias",
|
| 779 | "initializer": {
|
| 780 | "docs": {
|
| 781 | "stability": "stable"
|
| 782 | },
|
| 783 | "locationInModule": {
|
| 784 | "filename": "lib/alias.ts",
|
| 785 | "line": 144
|
| 786 | },
|
| 787 | "parameters": [
|
| 788 | {
|
| 789 | "name": "scope",
|
| 790 | "type": {
|
| 791 | "fqn": "constructs.Construct"
|
| 792 | }
|
| 793 | },
|
| 794 | {
|
| 795 | "name": "id",
|
| 796 | "type": {
|
| 797 | "primitive": "string"
|
| 798 | }
|
| 799 | },
|
| 800 | {
|
| 801 | "name": "props",
|
| 802 | "type": {
|
| 803 | "fqn": "@aws-cdk/aws-lambda.AliasProps"
|
| 804 | }
|
| 805 | }
|
| 806 | ]
|
| 807 | },
|
| 808 | "interfaces": [
|
| 809 | "@aws-cdk/aws-lambda.IAlias"
|
| 810 | ],
|
| 811 | "kind": "class",
|
| 812 | "locationInModule": {
|
| 813 | "filename": "lib/alias.ts",
|
| 814 | "line": 91
|
| 815 | },
|
| 816 | "methods": [
|
| 817 | {
|
| 818 | "docs": {
|
| 819 | "stability": "stable"
|
| 820 | },
|
| 821 | "locationInModule": {
|
| 822 | "filename": "lib/alias.ts",
|
| 823 | "line": 92
|
| 824 | },
|
| 825 | "name": "fromAliasAttributes",
|
| 826 | "parameters": [
|
| 827 | {
|
| 828 | "name": "scope",
|
| 829 | "type": {
|
| 830 | "fqn": "constructs.Construct"
|
| 831 | }
|
| 832 | },
|
| 833 | {
|
| 834 | "name": "id",
|
| 835 | "type": {
|
| 836 | "primitive": "string"
|
| 837 | }
|
| 838 | },
|
| 839 | {
|
| 840 | "name": "attrs",
|
| 841 | "type": {
|
| 842 | "fqn": "@aws-cdk/aws-lambda.AliasAttributes"
|
| 843 | }
|
| 844 | }
|
| 845 | ],
|
| 846 | "returns": {
|
| 847 | "type": {
|
| 848 | "fqn": "@aws-cdk/aws-lambda.IAlias"
|
| 849 | }
|
| 850 | },
|
| 851 | "static": true
|
| 852 | },
|
| 853 | {
|
| 854 | "docs": {
|
| 855 | "remarks": "Returns a scalable attribute that can call\n`scaleOnUtilization()` and `scaleOnSchedule()`.",
|
| 856 | "stability": "stable",
|
| 857 | "summary": "Configure provisioned concurrency autoscaling on a function alias."
|
| 858 | },
|
| 859 | "locationInModule": {
|
| 860 | "filename": "lib/alias.ts",
|
| 861 | "line": 224
|
| 862 | },
|
| 863 | "name": "addAutoScaling",
|
| 864 | "parameters": [
|
| 865 | {
|
| 866 | "docs": {
|
| 867 | "summary": "Autoscaling options."
|
| 868 | },
|
| 869 | "name": "options",
|
| 870 | "type": {
|
| 871 | "fqn": "@aws-cdk/aws-lambda.AutoScalingOptions"
|
| 872 | }
|
| 873 | }
|
| 874 | ],
|
| 875 | "returns": {
|
| 876 | "type": {
|
| 877 | "fqn": "@aws-cdk/aws-lambda.IScalableFunctionAttribute"
|
| 878 | }
|
| 879 | }
|
| 880 | },
|
| 881 | {
|
| 882 | "docs": {
|
| 883 | "stability": "stable",
|
| 884 | "summary": "Return the given named metric for this Function."
|
| 885 | },
|
| 886 | "locationInModule": {
|
| 887 | "filename": "lib/alias.ts",
|
| 888 | "line": 204
|
| 889 | },
|
| 890 | "name": "metric",
|
| 891 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 892 | "parameters": [
|
| 893 | {
|
| 894 | "name": "metricName",
|
| 895 | "type": {
|
| 896 | "primitive": "string"
|
| 897 | }
|
| 898 | },
|
| 899 | {
|
| 900 | "name": "props",
|
| 901 | "optional": true,
|
| 902 | "type": {
|
| 903 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 904 | }
|
| 905 | }
|
| 906 | ],
|
| 907 | "returns": {
|
| 908 | "type": {
|
| 909 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 910 | }
|
| 911 | }
|
| 912 | }
|
| 913 | ],
|
| 914 | "name": "Alias",
|
| 915 | "properties": [
|
| 916 | {
|
| 917 | "docs": {
|
| 918 | "custom": {
|
| 919 | "attribute": "true"
|
| 920 | },
|
| 921 | "stability": "stable",
|
| 922 | "summary": "Name of this alias."
|
| 923 | },
|
| 924 | "immutable": true,
|
| 925 | "locationInModule": {
|
| 926 | "filename": "lib/alias.ts",
|
| 927 | "line": 114
|
| 928 | },
|
| 929 | "name": "aliasName",
|
| 930 | "overrides": "@aws-cdk/aws-lambda.IAlias",
|
| 931 | "type": {
|
| 932 | "primitive": "string"
|
| 933 | }
|
| 934 | },
|
| 935 | {
|
| 936 | "docs": {
|
| 937 | "stability": "stable",
|
| 938 | "summary": "The architecture of this Lambda Function."
|
| 939 | },
|
| 940 | "immutable": true,
|
| 941 | "locationInModule": {
|
| 942 | "filename": "lib/alias.ts",
|
| 943 | "line": 125
|
| 944 | },
|
| 945 | "name": "architecture",
|
| 946 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 947 | "type": {
|
| 948 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 949 | }
|
| 950 | },
|
| 951 | {
|
| 952 | "docs": {
|
| 953 | "remarks": "True for new Lambdas, false for version $LATEST and imported Lambdas\nfrom different accounts.",
|
| 954 | "stability": "stable",
|
| 955 | "summary": "Whether the addPermission() call adds any permissions."
|
| 956 | },
|
| 957 | "immutable": true,
|
| 958 | "locationInModule": {
|
| 959 | "filename": "lib/alias.ts",
|
| 960 | "line": 139
|
| 961 | },
|
| 962 | "name": "canCreatePermissions",
|
| 963 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 964 | "protected": true,
|
| 965 | "type": {
|
| 966 | "primitive": "boolean"
|
| 967 | }
|
| 968 | },
|
| 969 | {
|
| 970 | "docs": {
|
| 971 | "remarks": "Used to be able to use Alias in place of a regular Lambda. Lambda accepts\nARNs everywhere it accepts function names.",
|
| 972 | "stability": "stable",
|
| 973 | "summary": "ARN of this alias."
|
| 974 | },
|
| 975 | "immutable": true,
|
| 976 | "locationInModule": {
|
| 977 | "filename": "lib/alias.ts",
|
| 978 | "line": 135
|
| 979 | },
|
| 980 | "name": "functionArn",
|
| 981 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 982 | "type": {
|
| 983 | "primitive": "string"
|
| 984 | }
|
| 985 | },
|
| 986 | {
|
| 987 | "docs": {
|
| 988 | "remarks": "Used to be able to use Alias in place of a regular Lambda. Lambda accepts\nARNs everywhere it accepts function names.",
|
| 989 | "stability": "stable",
|
| 990 | "summary": "ARN of this alias."
|
| 991 | },
|
| 992 | "immutable": true,
|
| 993 | "locationInModule": {
|
| 994 | "filename": "lib/alias.ts",
|
| 995 | "line": 121
|
| 996 | },
|
| 997 | "name": "functionName",
|
| 998 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 999 | "type": {
|
| 1000 | "primitive": "string"
|
| 1001 | }
|
| 1002 | },
|
| 1003 | {
|
| 1004 | "docs": {
|
| 1005 | "stability": "stable",
|
| 1006 | "summary": "The principal this Lambda Function is running as."
|
| 1007 | },
|
| 1008 | "immutable": true,
|
| 1009 | "locationInModule": {
|
| 1010 | "filename": "lib/alias.ts",
|
| 1011 | "line": 196
|
| 1012 | },
|
| 1013 | "name": "grantPrincipal",
|
| 1014 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 1015 | "type": {
|
| 1016 | "fqn": "@aws-cdk/aws-iam.IPrincipal"
|
| 1017 | }
|
| 1018 | },
|
| 1019 | {
|
| 1020 | "docs": {
|
| 1021 | "stability": "stable"
|
| 1022 | },
|
| 1023 | "immutable": true,
|
| 1024 | "locationInModule": {
|
| 1025 | "filename": "lib/alias.ts",
|
| 1026 | "line": 123
|
| 1027 | },
|
| 1028 | "name": "lambda",
|
| 1029 | "overrides": "@aws-cdk/aws-lambda.QualifiedFunctionBase",
|
| 1030 | "type": {
|
| 1031 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 1032 | }
|
| 1033 | },
|
| 1034 | {
|
| 1035 | "docs": {
|
| 1036 | "remarks": "A qualifier is the identifier that's appended to a version or alias ARN.",
|
| 1037 | "stability": "stable",
|
| 1038 | "summary": "The qualifier of the version or alias of this function."
|
| 1039 | },
|
| 1040 | "immutable": true,
|
| 1041 | "locationInModule": {
|
| 1042 | "filename": "lib/alias.ts",
|
| 1043 | "line": 137
|
| 1044 | },
|
| 1045 | "name": "qualifier",
|
| 1046 | "overrides": "@aws-cdk/aws-lambda.QualifiedFunctionBase",
|
| 1047 | "protected": true,
|
| 1048 | "type": {
|
| 1049 | "primitive": "string"
|
| 1050 | }
|
| 1051 | },
|
| 1052 | {
|
| 1053 | "docs": {
|
| 1054 | "stability": "stable",
|
| 1055 | "summary": "The underlying Lambda function version."
|
| 1056 | },
|
| 1057 | "immutable": true,
|
| 1058 | "locationInModule": {
|
| 1059 | "filename": "lib/alias.ts",
|
| 1060 | "line": 127
|
| 1061 | },
|
| 1062 | "name": "version",
|
| 1063 | "overrides": "@aws-cdk/aws-lambda.IAlias",
|
| 1064 | "type": {
|
| 1065 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 1066 | }
|
| 1067 | },
|
| 1068 | {
|
| 1069 | "docs": {
|
| 1070 | "remarks": "Undefined if the function was imported without a role.",
|
| 1071 | "stability": "stable",
|
| 1072 | "summary": "The IAM role associated with this function."
|
| 1073 | },
|
| 1074 | "immutable": true,
|
| 1075 | "locationInModule": {
|
| 1076 | "filename": "lib/alias.ts",
|
| 1077 | "line": 200
|
| 1078 | },
|
| 1079 | "name": "role",
|
| 1080 | "optional": true,
|
| 1081 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 1082 | "type": {
|
| 1083 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 1084 | }
|
| 1085 | }
|
| 1086 | ],
|
| 1087 | "symbolId": "lib/alias:Alias"
|
| 1088 | },
|
| 1089 | "@aws-cdk/aws-lambda.AliasAttributes": {
|
| 1090 | "assembly": "@aws-cdk/aws-lambda",
|
| 1091 | "datatype": true,
|
| 1092 | "docs": {
|
| 1093 | "stability": "stable",
|
| 1094 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\n\ndeclare const version: lambda.Version;\nconst aliasAttributes: lambda.AliasAttributes = {\n aliasName: 'aliasName',\n aliasVersion: version,\n};",
|
| 1095 | "custom": {
|
| 1096 | "exampleMetadata": "fixture=_generated"
|
| 1097 | }
|
| 1098 | },
|
| 1099 | "fqn": "@aws-cdk/aws-lambda.AliasAttributes",
|
| 1100 | "kind": "interface",
|
| 1101 | "locationInModule": {
|
| 1102 | "filename": "lib/alias.ts",
|
| 1103 | "line": 83
|
| 1104 | },
|
| 1105 | "name": "AliasAttributes",
|
| 1106 | "properties": [
|
| 1107 | {
|
| 1108 | "abstract": true,
|
| 1109 | "docs": {
|
| 1110 | "stability": "stable"
|
| 1111 | },
|
| 1112 | "immutable": true,
|
| 1113 | "locationInModule": {
|
| 1114 | "filename": "lib/alias.ts",
|
| 1115 | "line": 84
|
| 1116 | },
|
| 1117 | "name": "aliasName",
|
| 1118 | "type": {
|
| 1119 | "primitive": "string"
|
| 1120 | }
|
| 1121 | },
|
| 1122 | {
|
| 1123 | "abstract": true,
|
| 1124 | "docs": {
|
| 1125 | "stability": "stable"
|
| 1126 | },
|
| 1127 | "immutable": true,
|
| 1128 | "locationInModule": {
|
| 1129 | "filename": "lib/alias.ts",
|
| 1130 | "line": 85
|
| 1131 | },
|
| 1132 | "name": "aliasVersion",
|
| 1133 | "type": {
|
| 1134 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 1135 | }
|
| 1136 | }
|
| 1137 | ],
|
| 1138 | "symbolId": "lib/alias:AliasAttributes"
|
| 1139 | },
|
| 1140 | "@aws-cdk/aws-lambda.AliasOptions": {
|
| 1141 | "assembly": "@aws-cdk/aws-lambda",
|
| 1142 | "datatype": true,
|
| 1143 | "docs": {
|
| 1144 | "stability": "stable",
|
| 1145 | "summary": "Options for `lambda.Alias`.",
|
| 1146 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const destination: lambda.IDestination;\ndeclare const version: lambda.Version;\nconst aliasOptions: lambda.AliasOptions = {\n additionalVersions: [{\n version: version,\n weight: 123,\n }],\n description: 'description',\n maxEventAge: cdk.Duration.minutes(30),\n onFailure: destination,\n onSuccess: destination,\n provisionedConcurrentExecutions: 123,\n retryAttempts: 123,\n};",
|
| 1147 | "custom": {
|
| 1148 | "exampleMetadata": "fixture=_generated"
|
| 1149 | }
|
| 1150 | },
|
| 1151 | "fqn": "@aws-cdk/aws-lambda.AliasOptions",
|
| 1152 | "interfaces": [
|
| 1153 | "@aws-cdk/aws-lambda.EventInvokeConfigOptions"
|
| 1154 | ],
|
| 1155 | "kind": "interface",
|
| 1156 | "locationInModule": {
|
| 1157 | "filename": "lib/alias.ts",
|
| 1158 | "line": 31
|
| 1159 | },
|
| 1160 | "name": "AliasOptions",
|
| 1161 | "properties": [
|
| 1162 | {
|
| 1163 | "abstract": true,
|
| 1164 | "docs": {
|
| 1165 | "default": "No additional versions",
|
| 1166 | "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.",
|
| 1167 | "stability": "stable",
|
| 1168 | "summary": "Additional versions with individual weights this alias points to."
|
| 1169 | },
|
| 1170 | "immutable": true,
|
| 1171 | "locationInModule": {
|
| 1172 | "filename": "lib/alias.ts",
|
| 1173 | "line": 56
|
| 1174 | },
|
| 1175 | "name": "additionalVersions",
|
| 1176 | "optional": true,
|
| 1177 | "type": {
|
| 1178 | "collection": {
|
| 1179 | "elementtype": {
|
| 1180 | "fqn": "@aws-cdk/aws-lambda.VersionWeight"
|
| 1181 | },
|
| 1182 | "kind": "array"
|
| 1183 | }
|
| 1184 | }
|
| 1185 | },
|
| 1186 | {
|
| 1187 | "abstract": true,
|
| 1188 | "docs": {
|
| 1189 | "default": "No description",
|
| 1190 | "stability": "stable",
|
| 1191 | "summary": "Description for the alias."
|
| 1192 | },
|
| 1193 | "immutable": true,
|
| 1194 | "locationInModule": {
|
| 1195 | "filename": "lib/alias.ts",
|
| 1196 | "line": 37
|
| 1197 | },
|
| 1198 | "name": "description",
|
| 1199 | "optional": true,
|
| 1200 | "type": {
|
| 1201 | "primitive": "string"
|
| 1202 | }
|
| 1203 | },
|
| 1204 | {
|
| 1205 | "abstract": true,
|
| 1206 | "docs": {
|
| 1207 | "default": "No provisioned concurrency",
|
| 1208 | "stability": "stable",
|
| 1209 | "summary": "Specifies a provisioned concurrency configuration for a function's alias."
|
| 1210 | },
|
| 1211 | "immutable": true,
|
| 1212 | "locationInModule": {
|
| 1213 | "filename": "lib/alias.ts",
|
| 1214 | "line": 63
|
| 1215 | },
|
| 1216 | "name": "provisionedConcurrentExecutions",
|
| 1217 | "optional": true,
|
| 1218 | "type": {
|
| 1219 | "primitive": "number"
|
| 1220 | }
|
| 1221 | }
|
| 1222 | ],
|
| 1223 | "symbolId": "lib/alias:AliasOptions"
|
| 1224 | },
|
| 1225 | "@aws-cdk/aws-lambda.AliasProps": {
|
| 1226 | "assembly": "@aws-cdk/aws-lambda",
|
| 1227 | "datatype": true,
|
| 1228 | "docs": {
|
| 1229 | "stability": "stable",
|
| 1230 | "summary": "Properties for a new Lambda alias.",
|
| 1231 | "example": "const lambdaCode = lambda.Code.fromCfnParameters();\nconst func = new lambda.Function(this, 'Lambda', {\n code: lambdaCode,\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_14_X,\n});\n// used to make sure each CDK synthesis produces a different Version\nconst version = func.currentVersion;\nconst alias = new lambda.Alias(this, 'LambdaAlias', {\n aliasName: 'Prod',\n version,\n});\n\nnew codedeploy.LambdaDeploymentGroup(this, 'DeploymentGroup', {\n alias,\n deploymentConfig: codedeploy.LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,\n});",
|
| 1232 | "custom": {
|
| 1233 | "exampleMetadata": "infused"
|
| 1234 | }
|
| 1235 | },
|
| 1236 | "fqn": "@aws-cdk/aws-lambda.AliasProps",
|
| 1237 | "interfaces": [
|
| 1238 | "@aws-cdk/aws-lambda.AliasOptions"
|
| 1239 | ],
|
| 1240 | "kind": "interface",
|
| 1241 | "locationInModule": {
|
| 1242 | "filename": "lib/alias.ts",
|
| 1243 | "line": 69
|
| 1244 | },
|
| 1245 | "name": "AliasProps",
|
| 1246 | "properties": [
|
| 1247 | {
|
| 1248 | "abstract": true,
|
| 1249 | "docs": {
|
| 1250 | "stability": "stable",
|
| 1251 | "summary": "Name of this alias."
|
| 1252 | },
|
| 1253 | "immutable": true,
|
| 1254 | "locationInModule": {
|
| 1255 | "filename": "lib/alias.ts",
|
| 1256 | "line": 73
|
| 1257 | },
|
| 1258 | "name": "aliasName",
|
| 1259 | "type": {
|
| 1260 | "primitive": "string"
|
| 1261 | }
|
| 1262 | },
|
| 1263 | {
|
| 1264 | "abstract": true,
|
| 1265 | "docs": {
|
| 1266 | "remarks": "Use lambda.currentVersion to reference a version with your latest changes.",
|
| 1267 | "stability": "stable",
|
| 1268 | "summary": "Function version this alias refers to."
|
| 1269 | },
|
| 1270 | "immutable": true,
|
| 1271 | "locationInModule": {
|
| 1272 | "filename": "lib/alias.ts",
|
| 1273 | "line": 80
|
| 1274 | },
|
| 1275 | "name": "version",
|
| 1276 | "type": {
|
| 1277 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 1278 | }
|
| 1279 | }
|
| 1280 | ],
|
| 1281 | "symbolId": "lib/alias:AliasProps"
|
| 1282 | },
|
| 1283 | "@aws-cdk/aws-lambda.Architecture": {
|
| 1284 | "assembly": "@aws-cdk/aws-lambda",
|
| 1285 | "docs": {
|
| 1286 | "stability": "stable",
|
| 1287 | "summary": "Architectures supported by AWS Lambda.",
|
| 1288 | "example": "new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n architecture: lambda.Architecture.ARM_64,\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n insightsVersion: lambda.LambdaInsightsVersion.VERSION_1_0_119_0,\n});",
|
| 1289 | "custom": {
|
| 1290 | "exampleMetadata": "infused"
|
| 1291 | }
|
| 1292 | },
|
| 1293 | "fqn": "@aws-cdk/aws-lambda.Architecture",
|
| 1294 | "kind": "class",
|
| 1295 | "locationInModule": {
|
| 1296 | "filename": "lib/architecture.ts",
|
| 1297 | "line": 4
|
| 1298 | },
|
| 1299 | "methods": [
|
| 1300 | {
|
| 1301 | "docs": {
|
| 1302 | "remarks": "Use this if the architecture name is not yet supported by the CDK.",
|
| 1303 | "stability": "stable",
|
| 1304 | "summary": "Used to specify a custom architecture name."
|
| 1305 | },
|
| 1306 | "locationInModule": {
|
| 1307 | "filename": "lib/architecture.ts",
|
| 1308 | "line": 21
|
| 1309 | },
|
| 1310 | "name": "custom",
|
| 1311 | "parameters": [
|
| 1312 | {
|
| 1313 | "docs": {
|
| 1314 | "summary": "the architecture name as recognized by AWS Lambda."
|
| 1315 | },
|
| 1316 | "name": "name",
|
| 1317 | "type": {
|
| 1318 | "primitive": "string"
|
| 1319 | }
|
| 1320 | },
|
| 1321 | {
|
| 1322 | "docs": {
|
| 1323 | "summary": "the platform to use for this architecture when building with Docker."
|
| 1324 | },
|
| 1325 | "name": "dockerPlatform",
|
| 1326 | "optional": true,
|
| 1327 | "type": {
|
| 1328 | "primitive": "string"
|
| 1329 | }
|
| 1330 | }
|
| 1331 | ],
|
| 1332 | "returns": {
|
| 1333 | "type": {
|
| 1334 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 1335 | }
|
| 1336 | },
|
| 1337 | "static": true
|
| 1338 | }
|
| 1339 | ],
|
| 1340 | "name": "Architecture",
|
| 1341 | "properties": [
|
| 1342 | {
|
| 1343 | "const": true,
|
| 1344 | "docs": {
|
| 1345 | "stability": "stable",
|
| 1346 | "summary": "64 bit architecture with the ARM instruction set."
|
| 1347 | },
|
| 1348 | "immutable": true,
|
| 1349 | "locationInModule": {
|
| 1350 | "filename": "lib/architecture.ts",
|
| 1351 | "line": 13
|
| 1352 | },
|
| 1353 | "name": "ARM_64",
|
| 1354 | "static": true,
|
| 1355 | "type": {
|
| 1356 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 1357 | }
|
| 1358 | },
|
| 1359 | {
|
| 1360 | "const": true,
|
| 1361 | "docs": {
|
| 1362 | "stability": "stable",
|
| 1363 | "summary": "64 bit architecture with x86 instruction set."
|
| 1364 | },
|
| 1365 | "immutable": true,
|
| 1366 | "locationInModule": {
|
| 1367 | "filename": "lib/architecture.ts",
|
| 1368 | "line": 8
|
| 1369 | },
|
| 1370 | "name": "X86_64",
|
| 1371 | "static": true,
|
| 1372 | "type": {
|
| 1373 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 1374 | }
|
| 1375 | },
|
| 1376 | {
|
| 1377 | "docs": {
|
| 1378 | "stability": "stable",
|
| 1379 | "summary": "The platform to use for this architecture when building with Docker."
|
| 1380 | },
|
| 1381 | "immutable": true,
|
| 1382 | "locationInModule": {
|
| 1383 | "filename": "lib/architecture.ts",
|
| 1384 | "line": 33
|
| 1385 | },
|
| 1386 | "name": "dockerPlatform",
|
| 1387 | "type": {
|
| 1388 | "primitive": "string"
|
| 1389 | }
|
| 1390 | },
|
| 1391 | {
|
| 1392 | "docs": {
|
| 1393 | "stability": "stable",
|
| 1394 | "summary": "The name of the architecture as recognized by the AWS Lambda service APIs."
|
| 1395 | },
|
| 1396 | "immutable": true,
|
| 1397 | "locationInModule": {
|
| 1398 | "filename": "lib/architecture.ts",
|
| 1399 | "line": 28
|
| 1400 | },
|
| 1401 | "name": "name",
|
| 1402 | "type": {
|
| 1403 | "primitive": "string"
|
| 1404 | }
|
| 1405 | }
|
| 1406 | ],
|
| 1407 | "symbolId": "lib/architecture:Architecture"
|
| 1408 | },
|
| 1409 | "@aws-cdk/aws-lambda.AssetCode": {
|
| 1410 | "assembly": "@aws-cdk/aws-lambda",
|
| 1411 | "base": "@aws-cdk/aws-lambda.Code",
|
| 1412 | "docs": {
|
| 1413 | "stability": "stable",
|
| 1414 | "summary": "Lambda code from a local directory.",
|
| 1415 | "example": "import * as path from 'path';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport { App, Stack } from '@aws-cdk/core';\nimport { MockIntegration, PassthroughBehavior, RestApi, TokenAuthorizer } from '../../lib';\n\n/*\n * Stack verification steps:\n * * `curl -s -o /dev/null -w \"%{http_code}\" <url>` should return 401\n * * `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: deny' <url>` should return 403\n * * `curl -s -o /dev/null -w \"%{http_code}\" -H 'Authorization: allow' <url>` should return 200\n */\n\nconst app = new App();\nconst stack = new Stack(app, 'TokenAuthorizerInteg');\n\nconst authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.token-authorizer.handler')),\n});\n\nconst restapi = new RestApi(stack, 'MyRestApi');\n\nconst authorizer = new TokenAuthorizer(stack, 'MyAuthorizer', {\n handler: authorizerFn,\n});\n\nrestapi.root.addMethod('ANY', new MockIntegration({\n integrationResponses: [\n { statusCode: '200' },\n ],\n passthroughBehavior: PassthroughBehavior.NEVER,\n requestTemplates: {\n 'application/json': '{ \"statusCode\": 200 }',\n },\n}), {\n methodResponses: [\n { statusCode: '200' },\n ],\n authorizer,\n});",
|
| 1416 | "custom": {
|
| 1417 | "exampleMetadata": "lit=test/authorizers/integ.token-authorizer.lit.ts infused"
|
| 1418 | }
|
| 1419 | },
|
| 1420 | "fqn": "@aws-cdk/aws-lambda.AssetCode",
|
| 1421 | "initializer": {
|
| 1422 | "docs": {
|
| 1423 | "stability": "stable"
|
| 1424 | },
|
| 1425 | "locationInModule": {
|
| 1426 | "filename": "lib/code.ts",
|
| 1427 | "line": 278
|
| 1428 | },
|
| 1429 | "parameters": [
|
| 1430 | {
|
| 1431 | "docs": {
|
| 1432 | "summary": "The path to the asset file or directory."
|
| 1433 | },
|
| 1434 | "name": "path",
|
| 1435 | "type": {
|
| 1436 | "primitive": "string"
|
| 1437 | }
|
| 1438 | },
|
| 1439 | {
|
| 1440 | "name": "options",
|
| 1441 | "optional": true,
|
| 1442 | "type": {
|
| 1443 | "fqn": "@aws-cdk/aws-s3-assets.AssetOptions"
|
| 1444 | }
|
| 1445 | }
|
| 1446 | ]
|
| 1447 | },
|
| 1448 | "kind": "class",
|
| 1449 | "locationInModule": {
|
| 1450 | "filename": "lib/code.ts",
|
| 1451 | "line": 271
|
| 1452 | },
|
| 1453 | "methods": [
|
| 1454 | {
|
| 1455 | "docs": {
|
| 1456 | "stability": "stable",
|
| 1457 | "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun."
|
| 1458 | },
|
| 1459 | "locationInModule": {
|
| 1460 | "filename": "lib/code.ts",
|
| 1461 | "line": 282
|
| 1462 | },
|
| 1463 | "name": "bind",
|
| 1464 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 1465 | "parameters": [
|
| 1466 | {
|
| 1467 | "name": "scope",
|
| 1468 | "type": {
|
| 1469 | "fqn": "@aws-cdk/core.Construct"
|
| 1470 | }
|
| 1471 | }
|
| 1472 | ],
|
| 1473 | "returns": {
|
| 1474 | "type": {
|
| 1475 | "fqn": "@aws-cdk/aws-lambda.CodeConfig"
|
| 1476 | }
|
| 1477 | }
|
| 1478 | },
|
| 1479 | {
|
| 1480 | "docs": {
|
| 1481 | "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.",
|
| 1482 | "stability": "stable",
|
| 1483 | "summary": "Called after the CFN function resource has been created to allow the code class to bind to it."
|
| 1484 | },
|
| 1485 | "locationInModule": {
|
| 1486 | "filename": "lib/code.ts",
|
| 1487 | "line": 306
|
| 1488 | },
|
| 1489 | "name": "bindToResource",
|
| 1490 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 1491 | "parameters": [
|
| 1492 | {
|
| 1493 | "name": "resource",
|
| 1494 | "type": {
|
| 1495 | "fqn": "@aws-cdk/core.CfnResource"
|
| 1496 | }
|
| 1497 | },
|
| 1498 | {
|
| 1499 | "name": "options",
|
| 1500 | "optional": true,
|
| 1501 | "type": {
|
| 1502 | "fqn": "@aws-cdk/aws-lambda.ResourceBindOptions"
|
| 1503 | }
|
| 1504 | }
|
| 1505 | ]
|
| 1506 | }
|
| 1507 | ],
|
| 1508 | "name": "AssetCode",
|
| 1509 | "properties": [
|
| 1510 | {
|
| 1511 | "docs": {
|
| 1512 | "stability": "stable",
|
| 1513 | "summary": "Determines whether this Code is inline code or not."
|
| 1514 | },
|
| 1515 | "immutable": true,
|
| 1516 | "locationInModule": {
|
| 1517 | "filename": "lib/code.ts",
|
| 1518 | "line": 272
|
| 1519 | },
|
| 1520 | "name": "isInline",
|
| 1521 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 1522 | "type": {
|
| 1523 | "primitive": "boolean"
|
| 1524 | }
|
| 1525 | },
|
| 1526 | {
|
| 1527 | "docs": {
|
| 1528 | "stability": "stable",
|
| 1529 | "summary": "The path to the asset file or directory."
|
| 1530 | },
|
| 1531 | "immutable": true,
|
| 1532 | "locationInModule": {
|
| 1533 | "filename": "lib/code.ts",
|
| 1534 | "line": 278
|
| 1535 | },
|
| 1536 | "name": "path",
|
| 1537 | "type": {
|
| 1538 | "primitive": "string"
|
| 1539 | }
|
| 1540 | }
|
| 1541 | ],
|
| 1542 | "symbolId": "lib/code:AssetCode"
|
| 1543 | },
|
| 1544 | "@aws-cdk/aws-lambda.AssetImageCode": {
|
| 1545 | "assembly": "@aws-cdk/aws-lambda",
|
| 1546 | "base": "@aws-cdk/aws-lambda.Code",
|
| 1547 | "docs": {
|
| 1548 | "stability": "stable",
|
| 1549 | "summary": "Represents an ECR image that will be constructed from the specified asset and can be bound as Lambda code.",
|
| 1550 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as assets from '@aws-cdk/assets';\nimport * as ecr_assets from '@aws-cdk/aws-ecr-assets';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const networkMode: ecr_assets.NetworkMode;\ndeclare const platform: ecr_assets.Platform;\nconst assetImageCode = new lambda.AssetImageCode('directory', {\n buildArgs: {\n buildArgsKey: 'buildArgs',\n },\n cmd: ['cmd'],\n entrypoint: ['entrypoint'],\n exclude: ['exclude'],\n extraHash: 'extraHash',\n file: 'file',\n follow: assets.FollowMode.NEVER,\n followSymlinks: cdk.SymlinkFollowMode.NEVER,\n ignoreMode: cdk.IgnoreMode.GLOB,\n invalidation: {\n buildArgs: false,\n extraHash: false,\n file: false,\n networkMode: false,\n platform: false,\n repositoryName: false,\n target: false,\n },\n networkMode: networkMode,\n platform: platform,\n repositoryName: 'repositoryName',\n target: 'target',\n workingDirectory: 'workingDirectory',\n});",
|
| 1551 | "custom": {
|
| 1552 | "exampleMetadata": "fixture=_generated"
|
| 1553 | }
|
| 1554 | },
|
| 1555 | "fqn": "@aws-cdk/aws-lambda.AssetImageCode",
|
| 1556 | "initializer": {
|
| 1557 | "docs": {
|
| 1558 | "stability": "stable"
|
| 1559 | },
|
| 1560 | "locationInModule": {
|
| 1561 | "filename": "lib/code.ts",
|
| 1562 | "line": 529
|
| 1563 | },
|
| 1564 | "parameters": [
|
| 1565 | {
|
| 1566 | "name": "directory",
|
| 1567 | "type": {
|
| 1568 | "primitive": "string"
|
| 1569 | }
|
| 1570 | },
|
| 1571 | {
|
| 1572 | "name": "props",
|
| 1573 | "type": {
|
| 1574 | "fqn": "@aws-cdk/aws-lambda.AssetImageCodeProps"
|
| 1575 | }
|
| 1576 | }
|
| 1577 | ]
|
| 1578 | },
|
| 1579 | "kind": "class",
|
| 1580 | "locationInModule": {
|
| 1581 | "filename": "lib/code.ts",
|
| 1582 | "line": 525
|
| 1583 | },
|
| 1584 | "methods": [
|
| 1585 | {
|
| 1586 | "docs": {
|
| 1587 | "stability": "stable",
|
| 1588 | "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun."
|
| 1589 | },
|
| 1590 | "locationInModule": {
|
| 1591 | "filename": "lib/code.ts",
|
| 1592 | "line": 533
|
| 1593 | },
|
| 1594 | "name": "bind",
|
| 1595 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 1596 | "parameters": [
|
| 1597 | {
|
| 1598 | "name": "scope",
|
| 1599 | "type": {
|
| 1600 | "fqn": "@aws-cdk/core.Construct"
|
| 1601 | }
|
| 1602 | }
|
| 1603 | ],
|
| 1604 | "returns": {
|
| 1605 | "type": {
|
| 1606 | "fqn": "@aws-cdk/aws-lambda.CodeConfig"
|
| 1607 | }
|
| 1608 | }
|
| 1609 | },
|
| 1610 | {
|
| 1611 | "docs": {
|
| 1612 | "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.",
|
| 1613 | "stability": "stable",
|
| 1614 | "summary": "Called after the CFN function resource has been created to allow the code class to bind to it."
|
| 1615 | },
|
| 1616 | "locationInModule": {
|
| 1617 | "filename": "lib/code.ts",
|
| 1618 | "line": 556
|
| 1619 | },
|
| 1620 | "name": "bindToResource",
|
| 1621 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 1622 | "parameters": [
|
| 1623 | {
|
| 1624 | "name": "resource",
|
| 1625 | "type": {
|
| 1626 | "fqn": "@aws-cdk/core.CfnResource"
|
| 1627 | }
|
| 1628 | },
|
| 1629 | {
|
| 1630 | "name": "options",
|
| 1631 | "optional": true,
|
| 1632 | "type": {
|
| 1633 | "fqn": "@aws-cdk/aws-lambda.ResourceBindOptions"
|
| 1634 | }
|
| 1635 | }
|
| 1636 | ]
|
| 1637 | }
|
| 1638 | ],
|
| 1639 | "name": "AssetImageCode",
|
| 1640 | "properties": [
|
| 1641 | {
|
| 1642 | "docs": {
|
| 1643 | "stability": "stable",
|
| 1644 | "summary": "Determines whether this Code is inline code or not."
|
| 1645 | },
|
| 1646 | "immutable": true,
|
| 1647 | "locationInModule": {
|
| 1648 | "filename": "lib/code.ts",
|
| 1649 | "line": 526
|
| 1650 | },
|
| 1651 | "name": "isInline",
|
| 1652 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 1653 | "type": {
|
| 1654 | "primitive": "boolean"
|
| 1655 | }
|
| 1656 | }
|
| 1657 | ],
|
| 1658 | "symbolId": "lib/code:AssetImageCode"
|
| 1659 | },
|
| 1660 | "@aws-cdk/aws-lambda.AssetImageCodeProps": {
|
| 1661 | "assembly": "@aws-cdk/aws-lambda",
|
| 1662 | "datatype": true,
|
| 1663 | "docs": {
|
| 1664 | "stability": "stable",
|
| 1665 | "summary": "Properties to initialize a new AssetImage.",
|
| 1666 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as assets from '@aws-cdk/assets';\nimport * as ecr_assets from '@aws-cdk/aws-ecr-assets';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const networkMode: ecr_assets.NetworkMode;\ndeclare const platform: ecr_assets.Platform;\nconst assetImageCodeProps: lambda.AssetImageCodeProps = {\n buildArgs: {\n buildArgsKey: 'buildArgs',\n },\n cmd: ['cmd'],\n entrypoint: ['entrypoint'],\n exclude: ['exclude'],\n extraHash: 'extraHash',\n file: 'file',\n follow: assets.FollowMode.NEVER,\n followSymlinks: cdk.SymlinkFollowMode.NEVER,\n ignoreMode: cdk.IgnoreMode.GLOB,\n invalidation: {\n buildArgs: false,\n extraHash: false,\n file: false,\n networkMode: false,\n platform: false,\n repositoryName: false,\n target: false,\n },\n networkMode: networkMode,\n platform: platform,\n repositoryName: 'repositoryName',\n target: 'target',\n workingDirectory: 'workingDirectory',\n};",
|
| 1667 | "custom": {
|
| 1668 | "exampleMetadata": "fixture=_generated"
|
| 1669 | }
|
| 1670 | },
|
| 1671 | "fqn": "@aws-cdk/aws-lambda.AssetImageCodeProps",
|
| 1672 | "interfaces": [
|
| 1673 | "@aws-cdk/aws-ecr-assets.DockerImageAssetOptions"
|
| 1674 | ],
|
| 1675 | "kind": "interface",
|
| 1676 | "locationInModule": {
|
| 1677 | "filename": "lib/code.ts",
|
| 1678 | "line": 495
|
| 1679 | },
|
| 1680 | "name": "AssetImageCodeProps",
|
| 1681 | "properties": [
|
| 1682 | {
|
| 1683 | "abstract": true,
|
| 1684 | "docs": {
|
| 1685 | "default": "- use the CMD specified in the docker image or Dockerfile.",
|
| 1686 | "remarks": "This needs to be in the 'exec form', viz., `[ 'executable', 'param1', 'param2' ]`.",
|
| 1687 | "see": "https://docs.docker.com/engine/reference/builder/#cmd",
|
| 1688 | "stability": "stable",
|
| 1689 | "summary": "Specify or override the CMD on the specified Docker image or Dockerfile."
|
| 1690 | },
|
| 1691 | "immutable": true,
|
| 1692 | "locationInModule": {
|
| 1693 | "filename": "lib/code.ts",
|
| 1694 | "line": 502
|
| 1695 | },
|
| 1696 | "name": "cmd",
|
| 1697 | "optional": true,
|
| 1698 | "type": {
|
| 1699 | "collection": {
|
| 1700 | "elementtype": {
|
| 1701 | "primitive": "string"
|
| 1702 | },
|
| 1703 | "kind": "array"
|
| 1704 | }
|
| 1705 | }
|
| 1706 | },
|
| 1707 | {
|
| 1708 | "abstract": true,
|
| 1709 | "docs": {
|
| 1710 | "default": "- use the ENTRYPOINT in the docker image or Dockerfile.",
|
| 1711 | "remarks": "An ENTRYPOINT allows you to configure a container that will run as an executable.\nThis needs to be in the 'exec form', viz., `[ 'executable', 'param1', 'param2' ]`.",
|
| 1712 | "see": "https://docs.docker.com/engine/reference/builder/#entrypoint",
|
| 1713 | "stability": "stable",
|
| 1714 | "summary": "Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile."
|
| 1715 | },
|
| 1716 | "immutable": true,
|
| 1717 | "locationInModule": {
|
| 1718 | "filename": "lib/code.ts",
|
| 1719 | "line": 511
|
| 1720 | },
|
| 1721 | "name": "entrypoint",
|
| 1722 | "optional": true,
|
| 1723 | "type": {
|
| 1724 | "collection": {
|
| 1725 | "elementtype": {
|
| 1726 | "primitive": "string"
|
| 1727 | },
|
| 1728 | "kind": "array"
|
| 1729 | }
|
| 1730 | }
|
| 1731 | },
|
| 1732 | {
|
| 1733 | "abstract": true,
|
| 1734 | "docs": {
|
| 1735 | "default": "- use the WORKDIR in the docker image or Dockerfile.",
|
| 1736 | "remarks": "A WORKDIR allows you to configure the working directory the container will use.",
|
| 1737 | "see": "https://docs.docker.com/engine/reference/builder/#workdir",
|
| 1738 | "stability": "stable",
|
| 1739 | "summary": "Specify or override the WORKDIR on the specified Docker image or Dockerfile."
|
| 1740 | },
|
| 1741 | "immutable": true,
|
| 1742 | "locationInModule": {
|
| 1743 | "filename": "lib/code.ts",
|
| 1744 | "line": 519
|
| 1745 | },
|
| 1746 | "name": "workingDirectory",
|
| 1747 | "optional": true,
|
| 1748 | "type": {
|
| 1749 | "primitive": "string"
|
| 1750 | }
|
| 1751 | }
|
| 1752 | ],
|
| 1753 | "symbolId": "lib/code:AssetImageCodeProps"
|
| 1754 | },
|
| 1755 | "@aws-cdk/aws-lambda.AutoScalingOptions": {
|
| 1756 | "assembly": "@aws-cdk/aws-lambda",
|
| 1757 | "datatype": true,
|
| 1758 | "docs": {
|
| 1759 | "stability": "stable",
|
| 1760 | "summary": "Properties for enabling Lambda autoscaling.",
|
| 1761 | "example": "import * as autoscaling from '@aws-cdk/aws-autoscaling';\n\ndeclare const fn: lambda.Function;\nconst alias = fn.addAlias('prod');\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: autoscaling.Schedule.cron({ hour: '8', minute: '0'}),\n minCapacity: 20,\n});",
|
| 1762 | "custom": {
|
| 1763 | "exampleMetadata": "infused"
|
| 1764 | }
|
| 1765 | },
|
| 1766 | "fqn": "@aws-cdk/aws-lambda.AutoScalingOptions",
|
| 1767 | "kind": "interface",
|
| 1768 | "locationInModule": {
|
| 1769 | "filename": "lib/scalable-attribute-api.ts",
|
| 1770 | "line": 34
|
| 1771 | },
|
| 1772 | "name": "AutoScalingOptions",
|
| 1773 | "properties": [
|
| 1774 | {
|
| 1775 | "abstract": true,
|
| 1776 | "docs": {
|
| 1777 | "stability": "stable",
|
| 1778 | "summary": "Maximum capacity to scale to."
|
| 1779 | },
|
| 1780 | "immutable": true,
|
| 1781 | "locationInModule": {
|
| 1782 | "filename": "lib/scalable-attribute-api.ts",
|
| 1783 | "line": 45
|
| 1784 | },
|
| 1785 | "name": "maxCapacity",
|
| 1786 | "type": {
|
| 1787 | "primitive": "number"
|
| 1788 | }
|
| 1789 | },
|
| 1790 | {
|
| 1791 | "abstract": true,
|
| 1792 | "docs": {
|
| 1793 | "default": "1",
|
| 1794 | "stability": "stable",
|
| 1795 | "summary": "Minimum capacity to scale to."
|
| 1796 | },
|
| 1797 | "immutable": true,
|
| 1798 | "locationInModule": {
|
| 1799 | "filename": "lib/scalable-attribute-api.ts",
|
| 1800 | "line": 40
|
| 1801 | },
|
| 1802 | "name": "minCapacity",
|
| 1803 | "optional": true,
|
| 1804 | "type": {
|
| 1805 | "primitive": "number"
|
| 1806 | }
|
| 1807 | }
|
| 1808 | ],
|
| 1809 | "symbolId": "lib/scalable-attribute-api:AutoScalingOptions"
|
| 1810 | },
|
| 1811 | "@aws-cdk/aws-lambda.CfnAlias": {
|
| 1812 | "assembly": "@aws-cdk/aws-lambda",
|
| 1813 | "base": "@aws-cdk/core.CfnResource",
|
| 1814 | "docs": {
|
| 1815 | "custom": {
|
| 1816 | "cloudformationResource": "AWS::Lambda::Alias",
|
| 1817 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html",
|
| 1818 | "exampleMetadata": "fixture=_generated"
|
| 1819 | },
|
| 1820 | "remarks": "The `AWS::Lambda::Alias` resource creates an [alias](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.\n\nYou can also map an alias to split invocation requests between two versions. Use the `RoutingConfig` parameter to specify a second version and the percentage of invocation requests that it receives.",
|
| 1821 | "stability": "external",
|
| 1822 | "summary": "A CloudFormation `AWS::Lambda::Alias`.",
|
| 1823 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnAlias = new lambda.CfnAlias(this, 'MyCfnAlias', {\n functionName: 'functionName',\n functionVersion: 'functionVersion',\n name: 'name',\n\n // the properties below are optional\n description: 'description',\n provisionedConcurrencyConfig: {\n provisionedConcurrentExecutions: 123,\n },\n routingConfig: {\n additionalVersionWeights: [{\n functionVersion: 'functionVersion',\n functionWeight: 123,\n }],\n },\n});"
|
| 1824 | },
|
| 1825 | "fqn": "@aws-cdk/aws-lambda.CfnAlias",
|
| 1826 | "initializer": {
|
| 1827 | "docs": {
|
| 1828 | "stability": "external",
|
| 1829 | "summary": "Create a new `AWS::Lambda::Alias`."
|
| 1830 | },
|
| 1831 | "locationInModule": {
|
| 1832 | "filename": "lib/lambda.generated.ts",
|
| 1833 | "line": 225
|
| 1834 | },
|
| 1835 | "parameters": [
|
| 1836 | {
|
| 1837 | "docs": {
|
| 1838 | "summary": "- scope in which this resource is defined."
|
| 1839 | },
|
| 1840 | "name": "scope",
|
| 1841 | "type": {
|
| 1842 | "fqn": "@aws-cdk/core.Construct"
|
| 1843 | }
|
| 1844 | },
|
| 1845 | {
|
| 1846 | "docs": {
|
| 1847 | "summary": "- scoped id of the resource."
|
| 1848 | },
|
| 1849 | "name": "id",
|
| 1850 | "type": {
|
| 1851 | "primitive": "string"
|
| 1852 | }
|
| 1853 | },
|
| 1854 | {
|
| 1855 | "docs": {
|
| 1856 | "summary": "- resource properties."
|
| 1857 | },
|
| 1858 | "name": "props",
|
| 1859 | "type": {
|
| 1860 | "fqn": "@aws-cdk/aws-lambda.CfnAliasProps"
|
| 1861 | }
|
| 1862 | }
|
| 1863 | ]
|
| 1864 | },
|
| 1865 | "interfaces": [
|
| 1866 | "@aws-cdk/core.IInspectable"
|
| 1867 | ],
|
| 1868 | "kind": "class",
|
| 1869 | "locationInModule": {
|
| 1870 | "filename": "lib/lambda.generated.ts",
|
| 1871 | "line": 145
|
| 1872 | },
|
| 1873 | "methods": [
|
| 1874 | {
|
| 1875 | "docs": {
|
| 1876 | "stability": "external",
|
| 1877 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 1878 | },
|
| 1879 | "locationInModule": {
|
| 1880 | "filename": "lib/lambda.generated.ts",
|
| 1881 | "line": 245
|
| 1882 | },
|
| 1883 | "name": "inspect",
|
| 1884 | "overrides": "@aws-cdk/core.IInspectable",
|
| 1885 | "parameters": [
|
| 1886 | {
|
| 1887 | "docs": {
|
| 1888 | "summary": "- tree inspector to collect and process attributes."
|
| 1889 | },
|
| 1890 | "name": "inspector",
|
| 1891 | "type": {
|
| 1892 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 1893 | }
|
| 1894 | }
|
| 1895 | ]
|
| 1896 | },
|
| 1897 | {
|
| 1898 | "docs": {
|
| 1899 | "stability": "external"
|
| 1900 | },
|
| 1901 | "locationInModule": {
|
| 1902 | "filename": "lib/lambda.generated.ts",
|
| 1903 | "line": 261
|
| 1904 | },
|
| 1905 | "name": "renderProperties",
|
| 1906 | "overrides": "@aws-cdk/core.CfnResource",
|
| 1907 | "parameters": [
|
| 1908 | {
|
| 1909 | "name": "props",
|
| 1910 | "type": {
|
| 1911 | "collection": {
|
| 1912 | "elementtype": {
|
| 1913 | "primitive": "any"
|
| 1914 | },
|
| 1915 | "kind": "map"
|
| 1916 | }
|
| 1917 | }
|
| 1918 | }
|
| 1919 | ],
|
| 1920 | "protected": true,
|
| 1921 | "returns": {
|
| 1922 | "type": {
|
| 1923 | "collection": {
|
| 1924 | "elementtype": {
|
| 1925 | "primitive": "any"
|
| 1926 | },
|
| 1927 | "kind": "map"
|
| 1928 | }
|
| 1929 | }
|
| 1930 | }
|
| 1931 | }
|
| 1932 | ],
|
| 1933 | "name": "CfnAlias",
|
| 1934 | "properties": [
|
| 1935 | {
|
| 1936 | "const": true,
|
| 1937 | "docs": {
|
| 1938 | "stability": "external",
|
| 1939 | "summary": "The CloudFormation resource type name for this resource class."
|
| 1940 | },
|
| 1941 | "immutable": true,
|
| 1942 | "locationInModule": {
|
| 1943 | "filename": "lib/lambda.generated.ts",
|
| 1944 | "line": 149
|
| 1945 | },
|
| 1946 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 1947 | "static": true,
|
| 1948 | "type": {
|
| 1949 | "primitive": "string"
|
| 1950 | }
|
| 1951 | },
|
| 1952 | {
|
| 1953 | "docs": {
|
| 1954 | "stability": "external"
|
| 1955 | },
|
| 1956 | "immutable": true,
|
| 1957 | "locationInModule": {
|
| 1958 | "filename": "lib/lambda.generated.ts",
|
| 1959 | "line": 250
|
| 1960 | },
|
| 1961 | "name": "cfnProperties",
|
| 1962 | "overrides": "@aws-cdk/core.CfnResource",
|
| 1963 | "protected": true,
|
| 1964 | "type": {
|
| 1965 | "collection": {
|
| 1966 | "elementtype": {
|
| 1967 | "primitive": "any"
|
| 1968 | },
|
| 1969 | "kind": "map"
|
| 1970 | }
|
| 1971 | }
|
| 1972 | },
|
| 1973 | {
|
| 1974 | "docs": {
|
| 1975 | "custom": {
|
| 1976 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname"
|
| 1977 | },
|
| 1978 | "remarks": "**Name formats** - *Function name* - `MyFunction` .\n- *Function ARN* - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction` .\n- *Partial ARN* - `123456789012:function:MyFunction` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
| 1979 | "stability": "external",
|
| 1980 | "summary": "The name of the Lambda function."
|
| 1981 | },
|
| 1982 | "locationInModule": {
|
| 1983 | "filename": "lib/lambda.generated.ts",
|
| 1984 | "line": 181
|
| 1985 | },
|
| 1986 | "name": "functionName",
|
| 1987 | "type": {
|
| 1988 | "primitive": "string"
|
| 1989 | }
|
| 1990 | },
|
| 1991 | {
|
| 1992 | "docs": {
|
| 1993 | "custom": {
|
| 1994 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion"
|
| 1995 | },
|
| 1996 | "stability": "external",
|
| 1997 | "summary": "The function version that the alias invokes."
|
| 1998 | },
|
| 1999 | "locationInModule": {
|
| 2000 | "filename": "lib/lambda.generated.ts",
|
| 2001 | "line": 188
|
| 2002 | },
|
| 2003 | "name": "functionVersion",
|
| 2004 | "type": {
|
| 2005 | "primitive": "string"
|
| 2006 | }
|
| 2007 | },
|
| 2008 | {
|
| 2009 | "docs": {
|
| 2010 | "custom": {
|
| 2011 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name"
|
| 2012 | },
|
| 2013 | "stability": "external",
|
| 2014 | "summary": "The name of the alias."
|
| 2015 | },
|
| 2016 | "locationInModule": {
|
| 2017 | "filename": "lib/lambda.generated.ts",
|
| 2018 | "line": 195
|
| 2019 | },
|
| 2020 | "name": "name",
|
| 2021 | "type": {
|
| 2022 | "primitive": "string"
|
| 2023 | }
|
| 2024 | },
|
| 2025 | {
|
| 2026 | "docs": {
|
| 2027 | "custom": {
|
| 2028 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description"
|
| 2029 | },
|
| 2030 | "stability": "external",
|
| 2031 | "summary": "A description of the alias."
|
| 2032 | },
|
| 2033 | "locationInModule": {
|
| 2034 | "filename": "lib/lambda.generated.ts",
|
| 2035 | "line": 202
|
| 2036 | },
|
| 2037 | "name": "description",
|
| 2038 | "optional": true,
|
| 2039 | "type": {
|
| 2040 | "primitive": "string"
|
| 2041 | }
|
| 2042 | },
|
| 2043 | {
|
| 2044 | "docs": {
|
| 2045 | "custom": {
|
| 2046 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig"
|
| 2047 | },
|
| 2048 | "stability": "external",
|
| 2049 | "summary": "Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias."
|
| 2050 | },
|
| 2051 | "locationInModule": {
|
| 2052 | "filename": "lib/lambda.generated.ts",
|
| 2053 | "line": 209
|
| 2054 | },
|
| 2055 | "name": "provisionedConcurrencyConfig",
|
| 2056 | "optional": true,
|
| 2057 | "type": {
|
| 2058 | "union": {
|
| 2059 | "types": [
|
| 2060 | {
|
| 2061 | "fqn": "@aws-cdk/aws-lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty"
|
| 2062 | },
|
| 2063 | {
|
| 2064 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2065 | }
|
| 2066 | ]
|
| 2067 | }
|
| 2068 | }
|
| 2069 | },
|
| 2070 | {
|
| 2071 | "docs": {
|
| 2072 | "custom": {
|
| 2073 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig"
|
| 2074 | },
|
| 2075 | "stability": "external",
|
| 2076 | "summary": "The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias."
|
| 2077 | },
|
| 2078 | "locationInModule": {
|
| 2079 | "filename": "lib/lambda.generated.ts",
|
| 2080 | "line": 216
|
| 2081 | },
|
| 2082 | "name": "routingConfig",
|
| 2083 | "optional": true,
|
| 2084 | "type": {
|
| 2085 | "union": {
|
| 2086 | "types": [
|
| 2087 | {
|
| 2088 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2089 | },
|
| 2090 | {
|
| 2091 | "fqn": "@aws-cdk/aws-lambda.CfnAlias.AliasRoutingConfigurationProperty"
|
| 2092 | }
|
| 2093 | ]
|
| 2094 | }
|
| 2095 | }
|
| 2096 | }
|
| 2097 | ],
|
| 2098 | "symbolId": "lib/lambda.generated:CfnAlias"
|
| 2099 | },
|
| 2100 | "@aws-cdk/aws-lambda.CfnAlias.AliasRoutingConfigurationProperty": {
|
| 2101 | "assembly": "@aws-cdk/aws-lambda",
|
| 2102 | "datatype": true,
|
| 2103 | "docs": {
|
| 2104 | "custom": {
|
| 2105 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html",
|
| 2106 | "exampleMetadata": "fixture=_generated"
|
| 2107 | },
|
| 2108 | "stability": "external",
|
| 2109 | "summary": "The [traffic-shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) configuration of a Lambda function alias.",
|
| 2110 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst aliasRoutingConfigurationProperty: lambda.CfnAlias.AliasRoutingConfigurationProperty = {\n additionalVersionWeights: [{\n functionVersion: 'functionVersion',\n functionWeight: 123,\n }],\n};"
|
| 2111 | },
|
| 2112 | "fqn": "@aws-cdk/aws-lambda.CfnAlias.AliasRoutingConfigurationProperty",
|
| 2113 | "kind": "interface",
|
| 2114 | "locationInModule": {
|
| 2115 | "filename": "lib/lambda.generated.ts",
|
| 2116 | "line": 275
|
| 2117 | },
|
| 2118 | "name": "AliasRoutingConfigurationProperty",
|
| 2119 | "namespace": "CfnAlias",
|
| 2120 | "properties": [
|
| 2121 | {
|
| 2122 | "abstract": true,
|
| 2123 | "docs": {
|
| 2124 | "custom": {
|
| 2125 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-aliasroutingconfiguration.html#cfn-lambda-alias-aliasroutingconfiguration-additionalversionweights"
|
| 2126 | },
|
| 2127 | "stability": "external",
|
| 2128 | "summary": "The second version, and the percentage of traffic that's routed to it."
|
| 2129 | },
|
| 2130 | "immutable": true,
|
| 2131 | "locationInModule": {
|
| 2132 | "filename": "lib/lambda.generated.ts",
|
| 2133 | "line": 281
|
| 2134 | },
|
| 2135 | "name": "additionalVersionWeights",
|
| 2136 | "type": {
|
| 2137 | "union": {
|
| 2138 | "types": [
|
| 2139 | {
|
| 2140 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2141 | },
|
| 2142 | {
|
| 2143 | "collection": {
|
| 2144 | "elementtype": {
|
| 2145 | "union": {
|
| 2146 | "types": [
|
| 2147 | {
|
| 2148 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2149 | },
|
| 2150 | {
|
| 2151 | "fqn": "@aws-cdk/aws-lambda.CfnAlias.VersionWeightProperty"
|
| 2152 | }
|
| 2153 | ]
|
| 2154 | }
|
| 2155 | },
|
| 2156 | "kind": "array"
|
| 2157 | }
|
| 2158 | }
|
| 2159 | ]
|
| 2160 | }
|
| 2161 | }
|
| 2162 | }
|
| 2163 | ],
|
| 2164 | "symbolId": "lib/lambda.generated:CfnAlias.AliasRoutingConfigurationProperty"
|
| 2165 | },
|
| 2166 | "@aws-cdk/aws-lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty": {
|
| 2167 | "assembly": "@aws-cdk/aws-lambda",
|
| 2168 | "datatype": true,
|
| 2169 | "docs": {
|
| 2170 | "custom": {
|
| 2171 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html",
|
| 2172 | "exampleMetadata": "fixture=_generated"
|
| 2173 | },
|
| 2174 | "stability": "external",
|
| 2175 | "summary": "A provisioned concurrency configuration for a function's alias.",
|
| 2176 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst provisionedConcurrencyConfigurationProperty: lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty = {\n provisionedConcurrentExecutions: 123,\n};"
|
| 2177 | },
|
| 2178 | "fqn": "@aws-cdk/aws-lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty",
|
| 2179 | "kind": "interface",
|
| 2180 | "locationInModule": {
|
| 2181 | "filename": "lib/lambda.generated.ts",
|
| 2182 | "line": 343
|
| 2183 | },
|
| 2184 | "name": "ProvisionedConcurrencyConfigurationProperty",
|
| 2185 | "namespace": "CfnAlias",
|
| 2186 | "properties": [
|
| 2187 | {
|
| 2188 | "abstract": true,
|
| 2189 | "docs": {
|
| 2190 | "custom": {
|
| 2191 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-provisionedconcurrencyconfiguration.html#cfn-lambda-alias-provisionedconcurrencyconfiguration-provisionedconcurrentexecutions"
|
| 2192 | },
|
| 2193 | "stability": "external",
|
| 2194 | "summary": "The amount of provisioned concurrency to allocate for the alias."
|
| 2195 | },
|
| 2196 | "immutable": true,
|
| 2197 | "locationInModule": {
|
| 2198 | "filename": "lib/lambda.generated.ts",
|
| 2199 | "line": 349
|
| 2200 | },
|
| 2201 | "name": "provisionedConcurrentExecutions",
|
| 2202 | "type": {
|
| 2203 | "primitive": "number"
|
| 2204 | }
|
| 2205 | }
|
| 2206 | ],
|
| 2207 | "symbolId": "lib/lambda.generated:CfnAlias.ProvisionedConcurrencyConfigurationProperty"
|
| 2208 | },
|
| 2209 | "@aws-cdk/aws-lambda.CfnAlias.VersionWeightProperty": {
|
| 2210 | "assembly": "@aws-cdk/aws-lambda",
|
| 2211 | "datatype": true,
|
| 2212 | "docs": {
|
| 2213 | "custom": {
|
| 2214 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html",
|
| 2215 | "exampleMetadata": "fixture=_generated"
|
| 2216 | },
|
| 2217 | "stability": "external",
|
| 2218 | "summary": "The [traffic-shifting](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) configuration of a Lambda function alias.",
|
| 2219 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst versionWeightProperty: lambda.CfnAlias.VersionWeightProperty = {\n functionVersion: 'functionVersion',\n functionWeight: 123,\n};"
|
| 2220 | },
|
| 2221 | "fqn": "@aws-cdk/aws-lambda.CfnAlias.VersionWeightProperty",
|
| 2222 | "kind": "interface",
|
| 2223 | "locationInModule": {
|
| 2224 | "filename": "lib/lambda.generated.ts",
|
| 2225 | "line": 411
|
| 2226 | },
|
| 2227 | "name": "VersionWeightProperty",
|
| 2228 | "namespace": "CfnAlias",
|
| 2229 | "properties": [
|
| 2230 | {
|
| 2231 | "abstract": true,
|
| 2232 | "docs": {
|
| 2233 | "custom": {
|
| 2234 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionversion"
|
| 2235 | },
|
| 2236 | "stability": "external",
|
| 2237 | "summary": "The qualifier of the second version."
|
| 2238 | },
|
| 2239 | "immutable": true,
|
| 2240 | "locationInModule": {
|
| 2241 | "filename": "lib/lambda.generated.ts",
|
| 2242 | "line": 417
|
| 2243 | },
|
| 2244 | "name": "functionVersion",
|
| 2245 | "type": {
|
| 2246 | "primitive": "string"
|
| 2247 | }
|
| 2248 | },
|
| 2249 | {
|
| 2250 | "abstract": true,
|
| 2251 | "docs": {
|
| 2252 | "custom": {
|
| 2253 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-alias-versionweight.html#cfn-lambda-alias-versionweight-functionweight"
|
| 2254 | },
|
| 2255 | "stability": "external",
|
| 2256 | "summary": "The percentage of traffic that the alias routes to the second version."
|
| 2257 | },
|
| 2258 | "immutable": true,
|
| 2259 | "locationInModule": {
|
| 2260 | "filename": "lib/lambda.generated.ts",
|
| 2261 | "line": 423
|
| 2262 | },
|
| 2263 | "name": "functionWeight",
|
| 2264 | "type": {
|
| 2265 | "primitive": "number"
|
| 2266 | }
|
| 2267 | }
|
| 2268 | ],
|
| 2269 | "symbolId": "lib/lambda.generated:CfnAlias.VersionWeightProperty"
|
| 2270 | },
|
| 2271 | "@aws-cdk/aws-lambda.CfnAliasProps": {
|
| 2272 | "assembly": "@aws-cdk/aws-lambda",
|
| 2273 | "datatype": true,
|
| 2274 | "docs": {
|
| 2275 | "custom": {
|
| 2276 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html",
|
| 2277 | "exampleMetadata": "fixture=_generated"
|
| 2278 | },
|
| 2279 | "stability": "external",
|
| 2280 | "summary": "Properties for defining a `CfnAlias`.",
|
| 2281 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnAliasProps: lambda.CfnAliasProps = {\n functionName: 'functionName',\n functionVersion: 'functionVersion',\n name: 'name',\n\n // the properties below are optional\n description: 'description',\n provisionedConcurrencyConfig: {\n provisionedConcurrentExecutions: 123,\n },\n routingConfig: {\n additionalVersionWeights: [{\n functionVersion: 'functionVersion',\n functionWeight: 123,\n }],\n },\n};"
|
| 2282 | },
|
| 2283 | "fqn": "@aws-cdk/aws-lambda.CfnAliasProps",
|
| 2284 | "kind": "interface",
|
| 2285 | "locationInModule": {
|
| 2286 | "filename": "lib/lambda.generated.ts",
|
| 2287 | "line": 19
|
| 2288 | },
|
| 2289 | "name": "CfnAliasProps",
|
| 2290 | "properties": [
|
| 2291 | {
|
| 2292 | "abstract": true,
|
| 2293 | "docs": {
|
| 2294 | "custom": {
|
| 2295 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionname"
|
| 2296 | },
|
| 2297 | "remarks": "**Name formats** - *Function name* - `MyFunction` .\n- *Function ARN* - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction` .\n- *Partial ARN* - `123456789012:function:MyFunction` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
| 2298 | "stability": "external",
|
| 2299 | "summary": "The name of the Lambda function."
|
| 2300 | },
|
| 2301 | "immutable": true,
|
| 2302 | "locationInModule": {
|
| 2303 | "filename": "lib/lambda.generated.ts",
|
| 2304 | "line": 32
|
| 2305 | },
|
| 2306 | "name": "functionName",
|
| 2307 | "type": {
|
| 2308 | "primitive": "string"
|
| 2309 | }
|
| 2310 | },
|
| 2311 | {
|
| 2312 | "abstract": true,
|
| 2313 | "docs": {
|
| 2314 | "custom": {
|
| 2315 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-functionversion"
|
| 2316 | },
|
| 2317 | "stability": "external",
|
| 2318 | "summary": "The function version that the alias invokes."
|
| 2319 | },
|
| 2320 | "immutable": true,
|
| 2321 | "locationInModule": {
|
| 2322 | "filename": "lib/lambda.generated.ts",
|
| 2323 | "line": 39
|
| 2324 | },
|
| 2325 | "name": "functionVersion",
|
| 2326 | "type": {
|
| 2327 | "primitive": "string"
|
| 2328 | }
|
| 2329 | },
|
| 2330 | {
|
| 2331 | "abstract": true,
|
| 2332 | "docs": {
|
| 2333 | "custom": {
|
| 2334 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-name"
|
| 2335 | },
|
| 2336 | "stability": "external",
|
| 2337 | "summary": "The name of the alias."
|
| 2338 | },
|
| 2339 | "immutable": true,
|
| 2340 | "locationInModule": {
|
| 2341 | "filename": "lib/lambda.generated.ts",
|
| 2342 | "line": 46
|
| 2343 | },
|
| 2344 | "name": "name",
|
| 2345 | "type": {
|
| 2346 | "primitive": "string"
|
| 2347 | }
|
| 2348 | },
|
| 2349 | {
|
| 2350 | "abstract": true,
|
| 2351 | "docs": {
|
| 2352 | "custom": {
|
| 2353 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-description"
|
| 2354 | },
|
| 2355 | "stability": "external",
|
| 2356 | "summary": "A description of the alias."
|
| 2357 | },
|
| 2358 | "immutable": true,
|
| 2359 | "locationInModule": {
|
| 2360 | "filename": "lib/lambda.generated.ts",
|
| 2361 | "line": 53
|
| 2362 | },
|
| 2363 | "name": "description",
|
| 2364 | "optional": true,
|
| 2365 | "type": {
|
| 2366 | "primitive": "string"
|
| 2367 | }
|
| 2368 | },
|
| 2369 | {
|
| 2370 | "abstract": true,
|
| 2371 | "docs": {
|
| 2372 | "custom": {
|
| 2373 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-provisionedconcurrencyconfig"
|
| 2374 | },
|
| 2375 | "stability": "external",
|
| 2376 | "summary": "Specifies a [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's alias."
|
| 2377 | },
|
| 2378 | "immutable": true,
|
| 2379 | "locationInModule": {
|
| 2380 | "filename": "lib/lambda.generated.ts",
|
| 2381 | "line": 60
|
| 2382 | },
|
| 2383 | "name": "provisionedConcurrencyConfig",
|
| 2384 | "optional": true,
|
| 2385 | "type": {
|
| 2386 | "union": {
|
| 2387 | "types": [
|
| 2388 | {
|
| 2389 | "fqn": "@aws-cdk/aws-lambda.CfnAlias.ProvisionedConcurrencyConfigurationProperty"
|
| 2390 | },
|
| 2391 | {
|
| 2392 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2393 | }
|
| 2394 | ]
|
| 2395 | }
|
| 2396 | }
|
| 2397 | },
|
| 2398 | {
|
| 2399 | "abstract": true,
|
| 2400 | "docs": {
|
| 2401 | "custom": {
|
| 2402 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-alias.html#cfn-lambda-alias-routingconfig"
|
| 2403 | },
|
| 2404 | "stability": "external",
|
| 2405 | "summary": "The [routing configuration](https://docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html) of the alias."
|
| 2406 | },
|
| 2407 | "immutable": true,
|
| 2408 | "locationInModule": {
|
| 2409 | "filename": "lib/lambda.generated.ts",
|
| 2410 | "line": 67
|
| 2411 | },
|
| 2412 | "name": "routingConfig",
|
| 2413 | "optional": true,
|
| 2414 | "type": {
|
| 2415 | "union": {
|
| 2416 | "types": [
|
| 2417 | {
|
| 2418 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2419 | },
|
| 2420 | {
|
| 2421 | "fqn": "@aws-cdk/aws-lambda.CfnAlias.AliasRoutingConfigurationProperty"
|
| 2422 | }
|
| 2423 | ]
|
| 2424 | }
|
| 2425 | }
|
| 2426 | }
|
| 2427 | ],
|
| 2428 | "symbolId": "lib/lambda.generated:CfnAliasProps"
|
| 2429 | },
|
| 2430 | "@aws-cdk/aws-lambda.CfnCodeSigningConfig": {
|
| 2431 | "assembly": "@aws-cdk/aws-lambda",
|
| 2432 | "base": "@aws-cdk/core.CfnResource",
|
| 2433 | "docs": {
|
| 2434 | "custom": {
|
| 2435 | "cloudformationResource": "AWS::Lambda::CodeSigningConfig",
|
| 2436 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html",
|
| 2437 | "exampleMetadata": "fixture=_generated"
|
| 2438 | },
|
| 2439 | "remarks": "Details about a [Code signing configuration](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) .",
|
| 2440 | "stability": "external",
|
| 2441 | "summary": "A CloudFormation `AWS::Lambda::CodeSigningConfig`.",
|
| 2442 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnCodeSigningConfig = new lambda.CfnCodeSigningConfig(this, 'MyCfnCodeSigningConfig', {\n allowedPublishers: {\n signingProfileVersionArns: ['signingProfileVersionArns'],\n },\n\n // the properties below are optional\n codeSigningPolicies: {\n untrustedArtifactOnDeployment: 'untrustedArtifactOnDeployment',\n },\n description: 'description',\n});"
|
| 2443 | },
|
| 2444 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfig",
|
| 2445 | "initializer": {
|
| 2446 | "docs": {
|
| 2447 | "stability": "external",
|
| 2448 | "summary": "Create a new `AWS::Lambda::CodeSigningConfig`."
|
| 2449 | },
|
| 2450 | "locationInModule": {
|
| 2451 | "filename": "lib/lambda.generated.ts",
|
| 2452 | "line": 639
|
| 2453 | },
|
| 2454 | "parameters": [
|
| 2455 | {
|
| 2456 | "docs": {
|
| 2457 | "summary": "- scope in which this resource is defined."
|
| 2458 | },
|
| 2459 | "name": "scope",
|
| 2460 | "type": {
|
| 2461 | "fqn": "@aws-cdk/core.Construct"
|
| 2462 | }
|
| 2463 | },
|
| 2464 | {
|
| 2465 | "docs": {
|
| 2466 | "summary": "- scoped id of the resource."
|
| 2467 | },
|
| 2468 | "name": "id",
|
| 2469 | "type": {
|
| 2470 | "primitive": "string"
|
| 2471 | }
|
| 2472 | },
|
| 2473 | {
|
| 2474 | "docs": {
|
| 2475 | "summary": "- resource properties."
|
| 2476 | },
|
| 2477 | "name": "props",
|
| 2478 | "type": {
|
| 2479 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfigProps"
|
| 2480 | }
|
| 2481 | }
|
| 2482 | ]
|
| 2483 | },
|
| 2484 | "interfaces": [
|
| 2485 | "@aws-cdk/core.IInspectable"
|
| 2486 | ],
|
| 2487 | "kind": "class",
|
| 2488 | "locationInModule": {
|
| 2489 | "filename": "lib/lambda.generated.ts",
|
| 2490 | "line": 574
|
| 2491 | },
|
| 2492 | "methods": [
|
| 2493 | {
|
| 2494 | "docs": {
|
| 2495 | "stability": "external",
|
| 2496 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 2497 | },
|
| 2498 | "locationInModule": {
|
| 2499 | "filename": "lib/lambda.generated.ts",
|
| 2500 | "line": 656
|
| 2501 | },
|
| 2502 | "name": "inspect",
|
| 2503 | "overrides": "@aws-cdk/core.IInspectable",
|
| 2504 | "parameters": [
|
| 2505 | {
|
| 2506 | "docs": {
|
| 2507 | "summary": "- tree inspector to collect and process attributes."
|
| 2508 | },
|
| 2509 | "name": "inspector",
|
| 2510 | "type": {
|
| 2511 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 2512 | }
|
| 2513 | }
|
| 2514 | ]
|
| 2515 | },
|
| 2516 | {
|
| 2517 | "docs": {
|
| 2518 | "stability": "external"
|
| 2519 | },
|
| 2520 | "locationInModule": {
|
| 2521 | "filename": "lib/lambda.generated.ts",
|
| 2522 | "line": 669
|
| 2523 | },
|
| 2524 | "name": "renderProperties",
|
| 2525 | "overrides": "@aws-cdk/core.CfnResource",
|
| 2526 | "parameters": [
|
| 2527 | {
|
| 2528 | "name": "props",
|
| 2529 | "type": {
|
| 2530 | "collection": {
|
| 2531 | "elementtype": {
|
| 2532 | "primitive": "any"
|
| 2533 | },
|
| 2534 | "kind": "map"
|
| 2535 | }
|
| 2536 | }
|
| 2537 | }
|
| 2538 | ],
|
| 2539 | "protected": true,
|
| 2540 | "returns": {
|
| 2541 | "type": {
|
| 2542 | "collection": {
|
| 2543 | "elementtype": {
|
| 2544 | "primitive": "any"
|
| 2545 | },
|
| 2546 | "kind": "map"
|
| 2547 | }
|
| 2548 | }
|
| 2549 | }
|
| 2550 | }
|
| 2551 | ],
|
| 2552 | "name": "CfnCodeSigningConfig",
|
| 2553 | "properties": [
|
| 2554 | {
|
| 2555 | "const": true,
|
| 2556 | "docs": {
|
| 2557 | "stability": "external",
|
| 2558 | "summary": "The CloudFormation resource type name for this resource class."
|
| 2559 | },
|
| 2560 | "immutable": true,
|
| 2561 | "locationInModule": {
|
| 2562 | "filename": "lib/lambda.generated.ts",
|
| 2563 | "line": 578
|
| 2564 | },
|
| 2565 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 2566 | "static": true,
|
| 2567 | "type": {
|
| 2568 | "primitive": "string"
|
| 2569 | }
|
| 2570 | },
|
| 2571 | {
|
| 2572 | "docs": {
|
| 2573 | "custom": {
|
| 2574 | "cloudformationAttribute": "CodeSigningConfigArn"
|
| 2575 | },
|
| 2576 | "stability": "external",
|
| 2577 | "summary": "The Amazon Resource Name (ARN) of the code signing configuration."
|
| 2578 | },
|
| 2579 | "immutable": true,
|
| 2580 | "locationInModule": {
|
| 2581 | "filename": "lib/lambda.generated.ts",
|
| 2582 | "line": 603
|
| 2583 | },
|
| 2584 | "name": "attrCodeSigningConfigArn",
|
| 2585 | "type": {
|
| 2586 | "primitive": "string"
|
| 2587 | }
|
| 2588 | },
|
| 2589 | {
|
| 2590 | "docs": {
|
| 2591 | "custom": {
|
| 2592 | "cloudformationAttribute": "CodeSigningConfigId"
|
| 2593 | },
|
| 2594 | "stability": "external",
|
| 2595 | "summary": "The code signing configuration ID."
|
| 2596 | },
|
| 2597 | "immutable": true,
|
| 2598 | "locationInModule": {
|
| 2599 | "filename": "lib/lambda.generated.ts",
|
| 2600 | "line": 609
|
| 2601 | },
|
| 2602 | "name": "attrCodeSigningConfigId",
|
| 2603 | "type": {
|
| 2604 | "primitive": "string"
|
| 2605 | }
|
| 2606 | },
|
| 2607 | {
|
| 2608 | "docs": {
|
| 2609 | "stability": "external"
|
| 2610 | },
|
| 2611 | "immutable": true,
|
| 2612 | "locationInModule": {
|
| 2613 | "filename": "lib/lambda.generated.ts",
|
| 2614 | "line": 661
|
| 2615 | },
|
| 2616 | "name": "cfnProperties",
|
| 2617 | "overrides": "@aws-cdk/core.CfnResource",
|
| 2618 | "protected": true,
|
| 2619 | "type": {
|
| 2620 | "collection": {
|
| 2621 | "elementtype": {
|
| 2622 | "primitive": "any"
|
| 2623 | },
|
| 2624 | "kind": "map"
|
| 2625 | }
|
| 2626 | }
|
| 2627 | },
|
| 2628 | {
|
| 2629 | "docs": {
|
| 2630 | "custom": {
|
| 2631 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-allowedpublishers"
|
| 2632 | },
|
| 2633 | "stability": "external",
|
| 2634 | "summary": "List of allowed publishers."
|
| 2635 | },
|
| 2636 | "locationInModule": {
|
| 2637 | "filename": "lib/lambda.generated.ts",
|
| 2638 | "line": 616
|
| 2639 | },
|
| 2640 | "name": "allowedPublishers",
|
| 2641 | "type": {
|
| 2642 | "union": {
|
| 2643 | "types": [
|
| 2644 | {
|
| 2645 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2646 | },
|
| 2647 | {
|
| 2648 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfig.AllowedPublishersProperty"
|
| 2649 | }
|
| 2650 | ]
|
| 2651 | }
|
| 2652 | }
|
| 2653 | },
|
| 2654 | {
|
| 2655 | "docs": {
|
| 2656 | "custom": {
|
| 2657 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-codesigningpolicies"
|
| 2658 | },
|
| 2659 | "stability": "external",
|
| 2660 | "summary": "The code signing policy controls the validation failure action for signature mismatch or expiry."
|
| 2661 | },
|
| 2662 | "locationInModule": {
|
| 2663 | "filename": "lib/lambda.generated.ts",
|
| 2664 | "line": 623
|
| 2665 | },
|
| 2666 | "name": "codeSigningPolicies",
|
| 2667 | "optional": true,
|
| 2668 | "type": {
|
| 2669 | "union": {
|
| 2670 | "types": [
|
| 2671 | {
|
| 2672 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2673 | },
|
| 2674 | {
|
| 2675 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfig.CodeSigningPoliciesProperty"
|
| 2676 | }
|
| 2677 | ]
|
| 2678 | }
|
| 2679 | }
|
| 2680 | },
|
| 2681 | {
|
| 2682 | "docs": {
|
| 2683 | "custom": {
|
| 2684 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-description"
|
| 2685 | },
|
| 2686 | "stability": "external",
|
| 2687 | "summary": "Code signing configuration description."
|
| 2688 | },
|
| 2689 | "locationInModule": {
|
| 2690 | "filename": "lib/lambda.generated.ts",
|
| 2691 | "line": 630
|
| 2692 | },
|
| 2693 | "name": "description",
|
| 2694 | "optional": true,
|
| 2695 | "type": {
|
| 2696 | "primitive": "string"
|
| 2697 | }
|
| 2698 | }
|
| 2699 | ],
|
| 2700 | "symbolId": "lib/lambda.generated:CfnCodeSigningConfig"
|
| 2701 | },
|
| 2702 | "@aws-cdk/aws-lambda.CfnCodeSigningConfig.AllowedPublishersProperty": {
|
| 2703 | "assembly": "@aws-cdk/aws-lambda",
|
| 2704 | "datatype": true,
|
| 2705 | "docs": {
|
| 2706 | "custom": {
|
| 2707 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-codesigningconfig-allowedpublishers.html",
|
| 2708 | "exampleMetadata": "fixture=_generated"
|
| 2709 | },
|
| 2710 | "stability": "external",
|
| 2711 | "summary": "List of signing profiles that can sign a code package.",
|
| 2712 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst allowedPublishersProperty: lambda.CfnCodeSigningConfig.AllowedPublishersProperty = {\n signingProfileVersionArns: ['signingProfileVersionArns'],\n};"
|
| 2713 | },
|
| 2714 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfig.AllowedPublishersProperty",
|
| 2715 | "kind": "interface",
|
| 2716 | "locationInModule": {
|
| 2717 | "filename": "lib/lambda.generated.ts",
|
| 2718 | "line": 683
|
| 2719 | },
|
| 2720 | "name": "AllowedPublishersProperty",
|
| 2721 | "namespace": "CfnCodeSigningConfig",
|
| 2722 | "properties": [
|
| 2723 | {
|
| 2724 | "abstract": true,
|
| 2725 | "docs": {
|
| 2726 | "custom": {
|
| 2727 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-codesigningconfig-allowedpublishers.html#cfn-lambda-codesigningconfig-allowedpublishers-signingprofileversionarns"
|
| 2728 | },
|
| 2729 | "remarks": "A signing profile defines a trusted user who can sign a code package.",
|
| 2730 | "stability": "external",
|
| 2731 | "summary": "The Amazon Resource Name (ARN) for each of the signing profiles."
|
| 2732 | },
|
| 2733 | "immutable": true,
|
| 2734 | "locationInModule": {
|
| 2735 | "filename": "lib/lambda.generated.ts",
|
| 2736 | "line": 689
|
| 2737 | },
|
| 2738 | "name": "signingProfileVersionArns",
|
| 2739 | "type": {
|
| 2740 | "collection": {
|
| 2741 | "elementtype": {
|
| 2742 | "primitive": "string"
|
| 2743 | },
|
| 2744 | "kind": "array"
|
| 2745 | }
|
| 2746 | }
|
| 2747 | }
|
| 2748 | ],
|
| 2749 | "symbolId": "lib/lambda.generated:CfnCodeSigningConfig.AllowedPublishersProperty"
|
| 2750 | },
|
| 2751 | "@aws-cdk/aws-lambda.CfnCodeSigningConfig.CodeSigningPoliciesProperty": {
|
| 2752 | "assembly": "@aws-cdk/aws-lambda",
|
| 2753 | "datatype": true,
|
| 2754 | "docs": {
|
| 2755 | "custom": {
|
| 2756 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-codesigningconfig-codesigningpolicies.html",
|
| 2757 | "exampleMetadata": "fixture=_generated"
|
| 2758 | },
|
| 2759 | "stability": "external",
|
| 2760 | "summary": "Code signing configuration [policies](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html#config-codesigning-policies) specify the validation failure action for signature mismatch or expiry.",
|
| 2761 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst codeSigningPoliciesProperty: lambda.CfnCodeSigningConfig.CodeSigningPoliciesProperty = {\n untrustedArtifactOnDeployment: 'untrustedArtifactOnDeployment',\n};"
|
| 2762 | },
|
| 2763 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfig.CodeSigningPoliciesProperty",
|
| 2764 | "kind": "interface",
|
| 2765 | "locationInModule": {
|
| 2766 | "filename": "lib/lambda.generated.ts",
|
| 2767 | "line": 751
|
| 2768 | },
|
| 2769 | "name": "CodeSigningPoliciesProperty",
|
| 2770 | "namespace": "CfnCodeSigningConfig",
|
| 2771 | "properties": [
|
| 2772 | {
|
| 2773 | "abstract": true,
|
| 2774 | "docs": {
|
| 2775 | "custom": {
|
| 2776 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-codesigningconfig-codesigningpolicies.html#cfn-lambda-codesigningconfig-codesigningpolicies-untrustedartifactondeployment"
|
| 2777 | },
|
| 2778 | "remarks": "If you set the policy to `Enforce` , Lambda blocks the deployment request if signature validation checks fail. If you set the policy to `Warn` , Lambda allows the deployment and creates a CloudWatch log.\n\nDefault value: `Warn`",
|
| 2779 | "stability": "external",
|
| 2780 | "summary": "Code signing configuration policy for deployment validation failure."
|
| 2781 | },
|
| 2782 | "immutable": true,
|
| 2783 | "locationInModule": {
|
| 2784 | "filename": "lib/lambda.generated.ts",
|
| 2785 | "line": 759
|
| 2786 | },
|
| 2787 | "name": "untrustedArtifactOnDeployment",
|
| 2788 | "type": {
|
| 2789 | "primitive": "string"
|
| 2790 | }
|
| 2791 | }
|
| 2792 | ],
|
| 2793 | "symbolId": "lib/lambda.generated:CfnCodeSigningConfig.CodeSigningPoliciesProperty"
|
| 2794 | },
|
| 2795 | "@aws-cdk/aws-lambda.CfnCodeSigningConfigProps": {
|
| 2796 | "assembly": "@aws-cdk/aws-lambda",
|
| 2797 | "datatype": true,
|
| 2798 | "docs": {
|
| 2799 | "custom": {
|
| 2800 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html",
|
| 2801 | "exampleMetadata": "fixture=_generated"
|
| 2802 | },
|
| 2803 | "stability": "external",
|
| 2804 | "summary": "Properties for defining a `CfnCodeSigningConfig`.",
|
| 2805 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnCodeSigningConfigProps: lambda.CfnCodeSigningConfigProps = {\n allowedPublishers: {\n signingProfileVersionArns: ['signingProfileVersionArns'],\n },\n\n // the properties below are optional\n codeSigningPolicies: {\n untrustedArtifactOnDeployment: 'untrustedArtifactOnDeployment',\n },\n description: 'description',\n};"
|
| 2806 | },
|
| 2807 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfigProps",
|
| 2808 | "kind": "interface",
|
| 2809 | "locationInModule": {
|
| 2810 | "filename": "lib/lambda.generated.ts",
|
| 2811 | "line": 488
|
| 2812 | },
|
| 2813 | "name": "CfnCodeSigningConfigProps",
|
| 2814 | "properties": [
|
| 2815 | {
|
| 2816 | "abstract": true,
|
| 2817 | "docs": {
|
| 2818 | "custom": {
|
| 2819 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-allowedpublishers"
|
| 2820 | },
|
| 2821 | "stability": "external",
|
| 2822 | "summary": "List of allowed publishers."
|
| 2823 | },
|
| 2824 | "immutable": true,
|
| 2825 | "locationInModule": {
|
| 2826 | "filename": "lib/lambda.generated.ts",
|
| 2827 | "line": 495
|
| 2828 | },
|
| 2829 | "name": "allowedPublishers",
|
| 2830 | "type": {
|
| 2831 | "union": {
|
| 2832 | "types": [
|
| 2833 | {
|
| 2834 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2835 | },
|
| 2836 | {
|
| 2837 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfig.AllowedPublishersProperty"
|
| 2838 | }
|
| 2839 | ]
|
| 2840 | }
|
| 2841 | }
|
| 2842 | },
|
| 2843 | {
|
| 2844 | "abstract": true,
|
| 2845 | "docs": {
|
| 2846 | "custom": {
|
| 2847 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-codesigningpolicies"
|
| 2848 | },
|
| 2849 | "stability": "external",
|
| 2850 | "summary": "The code signing policy controls the validation failure action for signature mismatch or expiry."
|
| 2851 | },
|
| 2852 | "immutable": true,
|
| 2853 | "locationInModule": {
|
| 2854 | "filename": "lib/lambda.generated.ts",
|
| 2855 | "line": 502
|
| 2856 | },
|
| 2857 | "name": "codeSigningPolicies",
|
| 2858 | "optional": true,
|
| 2859 | "type": {
|
| 2860 | "union": {
|
| 2861 | "types": [
|
| 2862 | {
|
| 2863 | "fqn": "@aws-cdk/core.IResolvable"
|
| 2864 | },
|
| 2865 | {
|
| 2866 | "fqn": "@aws-cdk/aws-lambda.CfnCodeSigningConfig.CodeSigningPoliciesProperty"
|
| 2867 | }
|
| 2868 | ]
|
| 2869 | }
|
| 2870 | }
|
| 2871 | },
|
| 2872 | {
|
| 2873 | "abstract": true,
|
| 2874 | "docs": {
|
| 2875 | "custom": {
|
| 2876 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-codesigningconfig.html#cfn-lambda-codesigningconfig-description"
|
| 2877 | },
|
| 2878 | "stability": "external",
|
| 2879 | "summary": "Code signing configuration description."
|
| 2880 | },
|
| 2881 | "immutable": true,
|
| 2882 | "locationInModule": {
|
| 2883 | "filename": "lib/lambda.generated.ts",
|
| 2884 | "line": 509
|
| 2885 | },
|
| 2886 | "name": "description",
|
| 2887 | "optional": true,
|
| 2888 | "type": {
|
| 2889 | "primitive": "string"
|
| 2890 | }
|
| 2891 | }
|
| 2892 | ],
|
| 2893 | "symbolId": "lib/lambda.generated:CfnCodeSigningConfigProps"
|
| 2894 | },
|
| 2895 | "@aws-cdk/aws-lambda.CfnEventInvokeConfig": {
|
| 2896 | "assembly": "@aws-cdk/aws-lambda",
|
| 2897 | "base": "@aws-cdk/core.CfnResource",
|
| 2898 | "docs": {
|
| 2899 | "custom": {
|
| 2900 | "cloudformationResource": "AWS::Lambda::EventInvokeConfig",
|
| 2901 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html",
|
| 2902 | "exampleMetadata": "fixture=_generated"
|
| 2903 | },
|
| 2904 | "remarks": "The `AWS::Lambda::EventInvokeConfig` resource configures options for [asynchronous invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html) on a version or an alias.\n\nBy default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it.",
|
| 2905 | "stability": "external",
|
| 2906 | "summary": "A CloudFormation `AWS::Lambda::EventInvokeConfig`.",
|
| 2907 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnEventInvokeConfig = new lambda.CfnEventInvokeConfig(this, 'MyCfnEventInvokeConfig', {\n functionName: 'functionName',\n qualifier: 'qualifier',\n\n // the properties below are optional\n destinationConfig: {\n onFailure: {\n destination: 'destination',\n },\n onSuccess: {\n destination: 'destination',\n },\n },\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n});"
|
| 2908 | },
|
| 2909 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig",
|
| 2910 | "initializer": {
|
| 2911 | "docs": {
|
| 2912 | "stability": "external",
|
| 2913 | "summary": "Create a new `AWS::Lambda::EventInvokeConfig`."
|
| 2914 | },
|
| 2915 | "locationInModule": {
|
| 2916 | "filename": "lib/lambda.generated.ts",
|
| 2917 | "line": 1026
|
| 2918 | },
|
| 2919 | "parameters": [
|
| 2920 | {
|
| 2921 | "docs": {
|
| 2922 | "summary": "- scope in which this resource is defined."
|
| 2923 | },
|
| 2924 | "name": "scope",
|
| 2925 | "type": {
|
| 2926 | "fqn": "@aws-cdk/core.Construct"
|
| 2927 | }
|
| 2928 | },
|
| 2929 | {
|
| 2930 | "docs": {
|
| 2931 | "summary": "- scoped id of the resource."
|
| 2932 | },
|
| 2933 | "name": "id",
|
| 2934 | "type": {
|
| 2935 | "primitive": "string"
|
| 2936 | }
|
| 2937 | },
|
| 2938 | {
|
| 2939 | "docs": {
|
| 2940 | "summary": "- resource properties."
|
| 2941 | },
|
| 2942 | "name": "props",
|
| 2943 | "type": {
|
| 2944 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfigProps"
|
| 2945 | }
|
| 2946 | }
|
| 2947 | ]
|
| 2948 | },
|
| 2949 | "interfaces": [
|
| 2950 | "@aws-cdk/core.IInspectable"
|
| 2951 | ],
|
| 2952 | "kind": "class",
|
| 2953 | "locationInModule": {
|
| 2954 | "filename": "lib/lambda.generated.ts",
|
| 2955 | "line": 944
|
| 2956 | },
|
| 2957 | "methods": [
|
| 2958 | {
|
| 2959 | "docs": {
|
| 2960 | "stability": "external",
|
| 2961 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 2962 | },
|
| 2963 | "locationInModule": {
|
| 2964 | "filename": "lib/lambda.generated.ts",
|
| 2965 | "line": 1044
|
| 2966 | },
|
| 2967 | "name": "inspect",
|
| 2968 | "overrides": "@aws-cdk/core.IInspectable",
|
| 2969 | "parameters": [
|
| 2970 | {
|
| 2971 | "docs": {
|
| 2972 | "summary": "- tree inspector to collect and process attributes."
|
| 2973 | },
|
| 2974 | "name": "inspector",
|
| 2975 | "type": {
|
| 2976 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 2977 | }
|
| 2978 | }
|
| 2979 | ]
|
| 2980 | },
|
| 2981 | {
|
| 2982 | "docs": {
|
| 2983 | "stability": "external"
|
| 2984 | },
|
| 2985 | "locationInModule": {
|
| 2986 | "filename": "lib/lambda.generated.ts",
|
| 2987 | "line": 1059
|
| 2988 | },
|
| 2989 | "name": "renderProperties",
|
| 2990 | "overrides": "@aws-cdk/core.CfnResource",
|
| 2991 | "parameters": [
|
| 2992 | {
|
| 2993 | "name": "props",
|
| 2994 | "type": {
|
| 2995 | "collection": {
|
| 2996 | "elementtype": {
|
| 2997 | "primitive": "any"
|
| 2998 | },
|
| 2999 | "kind": "map"
|
| 3000 | }
|
| 3001 | }
|
| 3002 | }
|
| 3003 | ],
|
| 3004 | "protected": true,
|
| 3005 | "returns": {
|
| 3006 | "type": {
|
| 3007 | "collection": {
|
| 3008 | "elementtype": {
|
| 3009 | "primitive": "any"
|
| 3010 | },
|
| 3011 | "kind": "map"
|
| 3012 | }
|
| 3013 | }
|
| 3014 | }
|
| 3015 | }
|
| 3016 | ],
|
| 3017 | "name": "CfnEventInvokeConfig",
|
| 3018 | "properties": [
|
| 3019 | {
|
| 3020 | "const": true,
|
| 3021 | "docs": {
|
| 3022 | "stability": "external",
|
| 3023 | "summary": "The CloudFormation resource type name for this resource class."
|
| 3024 | },
|
| 3025 | "immutable": true,
|
| 3026 | "locationInModule": {
|
| 3027 | "filename": "lib/lambda.generated.ts",
|
| 3028 | "line": 948
|
| 3029 | },
|
| 3030 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 3031 | "static": true,
|
| 3032 | "type": {
|
| 3033 | "primitive": "string"
|
| 3034 | }
|
| 3035 | },
|
| 3036 | {
|
| 3037 | "docs": {
|
| 3038 | "stability": "external"
|
| 3039 | },
|
| 3040 | "immutable": true,
|
| 3041 | "locationInModule": {
|
| 3042 | "filename": "lib/lambda.generated.ts",
|
| 3043 | "line": 1049
|
| 3044 | },
|
| 3045 | "name": "cfnProperties",
|
| 3046 | "overrides": "@aws-cdk/core.CfnResource",
|
| 3047 | "protected": true,
|
| 3048 | "type": {
|
| 3049 | "collection": {
|
| 3050 | "elementtype": {
|
| 3051 | "primitive": "any"
|
| 3052 | },
|
| 3053 | "kind": "map"
|
| 3054 | }
|
| 3055 | }
|
| 3056 | },
|
| 3057 | {
|
| 3058 | "docs": {
|
| 3059 | "custom": {
|
| 3060 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname"
|
| 3061 | },
|
| 3062 | "remarks": "*Minimum* : `1`\n\n*Maximum* : `64`\n\n*Pattern* : `([a-zA-Z0-9-_]+)`",
|
| 3063 | "stability": "external",
|
| 3064 | "summary": "The name of the Lambda function."
|
| 3065 | },
|
| 3066 | "locationInModule": {
|
| 3067 | "filename": "lib/lambda.generated.ts",
|
| 3068 | "line": 980
|
| 3069 | },
|
| 3070 | "name": "functionName",
|
| 3071 | "type": {
|
| 3072 | "primitive": "string"
|
| 3073 | }
|
| 3074 | },
|
| 3075 | {
|
| 3076 | "docs": {
|
| 3077 | "custom": {
|
| 3078 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier"
|
| 3079 | },
|
| 3080 | "remarks": "- *Version* - A version number.\n- *Alias* - An alias name.\n- *Latest* - To specify the unpublished version, use `$LATEST` .",
|
| 3081 | "stability": "external",
|
| 3082 | "summary": "The identifier of a version or alias."
|
| 3083 | },
|
| 3084 | "locationInModule": {
|
| 3085 | "filename": "lib/lambda.generated.ts",
|
| 3086 | "line": 991
|
| 3087 | },
|
| 3088 | "name": "qualifier",
|
| 3089 | "type": {
|
| 3090 | "primitive": "string"
|
| 3091 | }
|
| 3092 | },
|
| 3093 | {
|
| 3094 | "docs": {
|
| 3095 | "custom": {
|
| 3096 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig"
|
| 3097 | },
|
| 3098 | "remarks": "**Destinations** - *Function* - The Amazon Resource Name (ARN) of a Lambda function.\n- *Queue* - The ARN of an SQS queue.\n- *Topic* - The ARN of an SNS topic.\n- *Event Bus* - The ARN of an Amazon EventBridge event bus.",
|
| 3099 | "stability": "external",
|
| 3100 | "summary": "A destination for events after they have been sent to a function for processing."
|
| 3101 | },
|
| 3102 | "locationInModule": {
|
| 3103 | "filename": "lib/lambda.generated.ts",
|
| 3104 | "line": 1003
|
| 3105 | },
|
| 3106 | "name": "destinationConfig",
|
| 3107 | "optional": true,
|
| 3108 | "type": {
|
| 3109 | "union": {
|
| 3110 | "types": [
|
| 3111 | {
|
| 3112 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3113 | },
|
| 3114 | {
|
| 3115 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.DestinationConfigProperty"
|
| 3116 | }
|
| 3117 | ]
|
| 3118 | }
|
| 3119 | }
|
| 3120 | },
|
| 3121 | {
|
| 3122 | "docs": {
|
| 3123 | "custom": {
|
| 3124 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds"
|
| 3125 | },
|
| 3126 | "stability": "external",
|
| 3127 | "summary": "The maximum age of a request that Lambda sends to a function for processing."
|
| 3128 | },
|
| 3129 | "locationInModule": {
|
| 3130 | "filename": "lib/lambda.generated.ts",
|
| 3131 | "line": 1010
|
| 3132 | },
|
| 3133 | "name": "maximumEventAgeInSeconds",
|
| 3134 | "optional": true,
|
| 3135 | "type": {
|
| 3136 | "primitive": "number"
|
| 3137 | }
|
| 3138 | },
|
| 3139 | {
|
| 3140 | "docs": {
|
| 3141 | "custom": {
|
| 3142 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts"
|
| 3143 | },
|
| 3144 | "stability": "external",
|
| 3145 | "summary": "The maximum number of times to retry when the function returns an error."
|
| 3146 | },
|
| 3147 | "locationInModule": {
|
| 3148 | "filename": "lib/lambda.generated.ts",
|
| 3149 | "line": 1017
|
| 3150 | },
|
| 3151 | "name": "maximumRetryAttempts",
|
| 3152 | "optional": true,
|
| 3153 | "type": {
|
| 3154 | "primitive": "number"
|
| 3155 | }
|
| 3156 | }
|
| 3157 | ],
|
| 3158 | "symbolId": "lib/lambda.generated:CfnEventInvokeConfig"
|
| 3159 | },
|
| 3160 | "@aws-cdk/aws-lambda.CfnEventInvokeConfig.DestinationConfigProperty": {
|
| 3161 | "assembly": "@aws-cdk/aws-lambda",
|
| 3162 | "datatype": true,
|
| 3163 | "docs": {
|
| 3164 | "custom": {
|
| 3165 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html",
|
| 3166 | "exampleMetadata": "fixture=_generated"
|
| 3167 | },
|
| 3168 | "stability": "external",
|
| 3169 | "summary": "A configuration object that specifies the destination of an event after Lambda processes it.",
|
| 3170 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst destinationConfigProperty: lambda.CfnEventInvokeConfig.DestinationConfigProperty = {\n onFailure: {\n destination: 'destination',\n },\n onSuccess: {\n destination: 'destination',\n },\n};"
|
| 3171 | },
|
| 3172 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.DestinationConfigProperty",
|
| 3173 | "kind": "interface",
|
| 3174 | "locationInModule": {
|
| 3175 | "filename": "lib/lambda.generated.ts",
|
| 3176 | "line": 1073
|
| 3177 | },
|
| 3178 | "name": "DestinationConfigProperty",
|
| 3179 | "namespace": "CfnEventInvokeConfig",
|
| 3180 | "properties": [
|
| 3181 | {
|
| 3182 | "abstract": true,
|
| 3183 | "docs": {
|
| 3184 | "custom": {
|
| 3185 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onfailure"
|
| 3186 | },
|
| 3187 | "stability": "external",
|
| 3188 | "summary": "The destination configuration for failed invocations."
|
| 3189 | },
|
| 3190 | "immutable": true,
|
| 3191 | "locationInModule": {
|
| 3192 | "filename": "lib/lambda.generated.ts",
|
| 3193 | "line": 1079
|
| 3194 | },
|
| 3195 | "name": "onFailure",
|
| 3196 | "optional": true,
|
| 3197 | "type": {
|
| 3198 | "union": {
|
| 3199 | "types": [
|
| 3200 | {
|
| 3201 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3202 | },
|
| 3203 | {
|
| 3204 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnFailureProperty"
|
| 3205 | }
|
| 3206 | ]
|
| 3207 | }
|
| 3208 | }
|
| 3209 | },
|
| 3210 | {
|
| 3211 | "abstract": true,
|
| 3212 | "docs": {
|
| 3213 | "custom": {
|
| 3214 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig-onsuccess"
|
| 3215 | },
|
| 3216 | "stability": "external",
|
| 3217 | "summary": "The destination configuration for successful invocations."
|
| 3218 | },
|
| 3219 | "immutable": true,
|
| 3220 | "locationInModule": {
|
| 3221 | "filename": "lib/lambda.generated.ts",
|
| 3222 | "line": 1085
|
| 3223 | },
|
| 3224 | "name": "onSuccess",
|
| 3225 | "optional": true,
|
| 3226 | "type": {
|
| 3227 | "union": {
|
| 3228 | "types": [
|
| 3229 | {
|
| 3230 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3231 | },
|
| 3232 | {
|
| 3233 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnSuccessProperty"
|
| 3234 | }
|
| 3235 | ]
|
| 3236 | }
|
| 3237 | }
|
| 3238 | }
|
| 3239 | ],
|
| 3240 | "symbolId": "lib/lambda.generated:CfnEventInvokeConfig.DestinationConfigProperty"
|
| 3241 | },
|
| 3242 | "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnFailureProperty": {
|
| 3243 | "assembly": "@aws-cdk/aws-lambda",
|
| 3244 | "datatype": true,
|
| 3245 | "docs": {
|
| 3246 | "custom": {
|
| 3247 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onfailure.html",
|
| 3248 | "exampleMetadata": "fixture=_generated"
|
| 3249 | },
|
| 3250 | "stability": "external",
|
| 3251 | "summary": "A destination for events that failed processing.",
|
| 3252 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst onFailureProperty: lambda.CfnEventInvokeConfig.OnFailureProperty = {\n destination: 'destination',\n};"
|
| 3253 | },
|
| 3254 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnFailureProperty",
|
| 3255 | "kind": "interface",
|
| 3256 | "locationInModule": {
|
| 3257 | "filename": "lib/lambda.generated.ts",
|
| 3258 | "line": 1149
|
| 3259 | },
|
| 3260 | "name": "OnFailureProperty",
|
| 3261 | "namespace": "CfnEventInvokeConfig",
|
| 3262 | "properties": [
|
| 3263 | {
|
| 3264 | "abstract": true,
|
| 3265 | "docs": {
|
| 3266 | "custom": {
|
| 3267 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onfailure.html#cfn-lambda-eventinvokeconfig-destinationconfig-onfailure-destination"
|
| 3268 | },
|
| 3269 | "stability": "external",
|
| 3270 | "summary": "The Amazon Resource Name (ARN) of the destination resource."
|
| 3271 | },
|
| 3272 | "immutable": true,
|
| 3273 | "locationInModule": {
|
| 3274 | "filename": "lib/lambda.generated.ts",
|
| 3275 | "line": 1155
|
| 3276 | },
|
| 3277 | "name": "destination",
|
| 3278 | "type": {
|
| 3279 | "primitive": "string"
|
| 3280 | }
|
| 3281 | }
|
| 3282 | ],
|
| 3283 | "symbolId": "lib/lambda.generated:CfnEventInvokeConfig.OnFailureProperty"
|
| 3284 | },
|
| 3285 | "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnSuccessProperty": {
|
| 3286 | "assembly": "@aws-cdk/aws-lambda",
|
| 3287 | "datatype": true,
|
| 3288 | "docs": {
|
| 3289 | "custom": {
|
| 3290 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onsuccess.html",
|
| 3291 | "exampleMetadata": "fixture=_generated"
|
| 3292 | },
|
| 3293 | "stability": "external",
|
| 3294 | "summary": "A destination for events that were processed successfully.",
|
| 3295 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst onSuccessProperty: lambda.CfnEventInvokeConfig.OnSuccessProperty = {\n destination: 'destination',\n};"
|
| 3296 | },
|
| 3297 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.OnSuccessProperty",
|
| 3298 | "kind": "interface",
|
| 3299 | "locationInModule": {
|
| 3300 | "filename": "lib/lambda.generated.ts",
|
| 3301 | "line": 1217
|
| 3302 | },
|
| 3303 | "name": "OnSuccessProperty",
|
| 3304 | "namespace": "CfnEventInvokeConfig",
|
| 3305 | "properties": [
|
| 3306 | {
|
| 3307 | "abstract": true,
|
| 3308 | "docs": {
|
| 3309 | "custom": {
|
| 3310 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventinvokeconfig-destinationconfig-onsuccess.html#cfn-lambda-eventinvokeconfig-destinationconfig-onsuccess-destination"
|
| 3311 | },
|
| 3312 | "stability": "external",
|
| 3313 | "summary": "The Amazon Resource Name (ARN) of the destination resource."
|
| 3314 | },
|
| 3315 | "immutable": true,
|
| 3316 | "locationInModule": {
|
| 3317 | "filename": "lib/lambda.generated.ts",
|
| 3318 | "line": 1223
|
| 3319 | },
|
| 3320 | "name": "destination",
|
| 3321 | "type": {
|
| 3322 | "primitive": "string"
|
| 3323 | }
|
| 3324 | }
|
| 3325 | ],
|
| 3326 | "symbolId": "lib/lambda.generated:CfnEventInvokeConfig.OnSuccessProperty"
|
| 3327 | },
|
| 3328 | "@aws-cdk/aws-lambda.CfnEventInvokeConfigProps": {
|
| 3329 | "assembly": "@aws-cdk/aws-lambda",
|
| 3330 | "datatype": true,
|
| 3331 | "docs": {
|
| 3332 | "custom": {
|
| 3333 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html",
|
| 3334 | "exampleMetadata": "fixture=_generated"
|
| 3335 | },
|
| 3336 | "stability": "external",
|
| 3337 | "summary": "Properties for defining a `CfnEventInvokeConfig`.",
|
| 3338 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnEventInvokeConfigProps: lambda.CfnEventInvokeConfigProps = {\n functionName: 'functionName',\n qualifier: 'qualifier',\n\n // the properties below are optional\n destinationConfig: {\n onFailure: {\n destination: 'destination',\n },\n onSuccess: {\n destination: 'destination',\n },\n },\n maximumEventAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n};"
|
| 3339 | },
|
| 3340 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfigProps",
|
| 3341 | "kind": "interface",
|
| 3342 | "locationInModule": {
|
| 3343 | "filename": "lib/lambda.generated.ts",
|
| 3344 | "line": 820
|
| 3345 | },
|
| 3346 | "name": "CfnEventInvokeConfigProps",
|
| 3347 | "properties": [
|
| 3348 | {
|
| 3349 | "abstract": true,
|
| 3350 | "docs": {
|
| 3351 | "custom": {
|
| 3352 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-functionname"
|
| 3353 | },
|
| 3354 | "remarks": "*Minimum* : `1`\n\n*Maximum* : `64`\n\n*Pattern* : `([a-zA-Z0-9-_]+)`",
|
| 3355 | "stability": "external",
|
| 3356 | "summary": "The name of the Lambda function."
|
| 3357 | },
|
| 3358 | "immutable": true,
|
| 3359 | "locationInModule": {
|
| 3360 | "filename": "lib/lambda.generated.ts",
|
| 3361 | "line": 833
|
| 3362 | },
|
| 3363 | "name": "functionName",
|
| 3364 | "type": {
|
| 3365 | "primitive": "string"
|
| 3366 | }
|
| 3367 | },
|
| 3368 | {
|
| 3369 | "abstract": true,
|
| 3370 | "docs": {
|
| 3371 | "custom": {
|
| 3372 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-qualifier"
|
| 3373 | },
|
| 3374 | "remarks": "- *Version* - A version number.\n- *Alias* - An alias name.\n- *Latest* - To specify the unpublished version, use `$LATEST` .",
|
| 3375 | "stability": "external",
|
| 3376 | "summary": "The identifier of a version or alias."
|
| 3377 | },
|
| 3378 | "immutable": true,
|
| 3379 | "locationInModule": {
|
| 3380 | "filename": "lib/lambda.generated.ts",
|
| 3381 | "line": 844
|
| 3382 | },
|
| 3383 | "name": "qualifier",
|
| 3384 | "type": {
|
| 3385 | "primitive": "string"
|
| 3386 | }
|
| 3387 | },
|
| 3388 | {
|
| 3389 | "abstract": true,
|
| 3390 | "docs": {
|
| 3391 | "custom": {
|
| 3392 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-destinationconfig"
|
| 3393 | },
|
| 3394 | "remarks": "**Destinations** - *Function* - The Amazon Resource Name (ARN) of a Lambda function.\n- *Queue* - The ARN of an SQS queue.\n- *Topic* - The ARN of an SNS topic.\n- *Event Bus* - The ARN of an Amazon EventBridge event bus.",
|
| 3395 | "stability": "external",
|
| 3396 | "summary": "A destination for events after they have been sent to a function for processing."
|
| 3397 | },
|
| 3398 | "immutable": true,
|
| 3399 | "locationInModule": {
|
| 3400 | "filename": "lib/lambda.generated.ts",
|
| 3401 | "line": 856
|
| 3402 | },
|
| 3403 | "name": "destinationConfig",
|
| 3404 | "optional": true,
|
| 3405 | "type": {
|
| 3406 | "union": {
|
| 3407 | "types": [
|
| 3408 | {
|
| 3409 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3410 | },
|
| 3411 | {
|
| 3412 | "fqn": "@aws-cdk/aws-lambda.CfnEventInvokeConfig.DestinationConfigProperty"
|
| 3413 | }
|
| 3414 | ]
|
| 3415 | }
|
| 3416 | }
|
| 3417 | },
|
| 3418 | {
|
| 3419 | "abstract": true,
|
| 3420 | "docs": {
|
| 3421 | "custom": {
|
| 3422 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumeventageinseconds"
|
| 3423 | },
|
| 3424 | "stability": "external",
|
| 3425 | "summary": "The maximum age of a request that Lambda sends to a function for processing."
|
| 3426 | },
|
| 3427 | "immutable": true,
|
| 3428 | "locationInModule": {
|
| 3429 | "filename": "lib/lambda.generated.ts",
|
| 3430 | "line": 863
|
| 3431 | },
|
| 3432 | "name": "maximumEventAgeInSeconds",
|
| 3433 | "optional": true,
|
| 3434 | "type": {
|
| 3435 | "primitive": "number"
|
| 3436 | }
|
| 3437 | },
|
| 3438 | {
|
| 3439 | "abstract": true,
|
| 3440 | "docs": {
|
| 3441 | "custom": {
|
| 3442 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventinvokeconfig.html#cfn-lambda-eventinvokeconfig-maximumretryattempts"
|
| 3443 | },
|
| 3444 | "stability": "external",
|
| 3445 | "summary": "The maximum number of times to retry when the function returns an error."
|
| 3446 | },
|
| 3447 | "immutable": true,
|
| 3448 | "locationInModule": {
|
| 3449 | "filename": "lib/lambda.generated.ts",
|
| 3450 | "line": 870
|
| 3451 | },
|
| 3452 | "name": "maximumRetryAttempts",
|
| 3453 | "optional": true,
|
| 3454 | "type": {
|
| 3455 | "primitive": "number"
|
| 3456 | }
|
| 3457 | }
|
| 3458 | ],
|
| 3459 | "symbolId": "lib/lambda.generated:CfnEventInvokeConfigProps"
|
| 3460 | },
|
| 3461 | "@aws-cdk/aws-lambda.CfnEventSourceMapping": {
|
| 3462 | "assembly": "@aws-cdk/aws-lambda",
|
| 3463 | "base": "@aws-cdk/core.CfnResource",
|
| 3464 | "docs": {
|
| 3465 | "custom": {
|
| 3466 | "cloudformationResource": "AWS::Lambda::EventSourceMapping",
|
| 3467 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html",
|
| 3468 | "exampleMetadata": "fixture=_generated"
|
| 3469 | },
|
| 3470 | "remarks": "The `AWS::Lambda::EventSourceMapping` resource creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.\n\nFor details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.\n\n- [Configuring a Dynamo DB stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping)\n- [Configuring a Kinesis stream as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping)\n- [Configuring an SQS queue as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource)\n- [Configuring an MQ broker as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping)\n- [Configuring MSK as an event source](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html)\n- [Configuring Self-Managed Apache Kafka as an event source](https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html)",
|
| 3471 | "stability": "external",
|
| 3472 | "summary": "A CloudFormation `AWS::Lambda::EventSourceMapping`.",
|
| 3473 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnEventSourceMapping = new lambda.CfnEventSourceMapping(this, 'MyCfnEventSourceMapping', {\n functionName: 'functionName',\n\n // the properties below are optional\n amazonManagedKafkaEventSourceConfig: {\n consumerGroupId: 'consumerGroupId',\n },\n batchSize: 123,\n bisectBatchOnFunctionError: false,\n destinationConfig: {\n onFailure: {\n destination: 'destination',\n },\n },\n enabled: false,\n eventSourceArn: 'eventSourceArn',\n filterCriteria: {\n filters: [{\n pattern: 'pattern',\n }],\n },\n functionResponseTypes: ['functionResponseTypes'],\n maximumBatchingWindowInSeconds: 123,\n maximumRecordAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n parallelizationFactor: 123,\n queues: ['queues'],\n scalingConfig: {\n maximumConcurrency: 123,\n },\n selfManagedEventSource: {\n endpoints: {\n kafkaBootstrapServers: ['kafkaBootstrapServers'],\n },\n },\n selfManagedKafkaEventSourceConfig: {\n consumerGroupId: 'consumerGroupId',\n },\n sourceAccessConfigurations: [{\n type: 'type',\n uri: 'uri',\n }],\n startingPosition: 'startingPosition',\n startingPositionTimestamp: 123,\n topics: ['topics'],\n tumblingWindowInSeconds: 123,\n});"
|
| 3474 | },
|
| 3475 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping",
|
| 3476 | "initializer": {
|
| 3477 | "docs": {
|
| 3478 | "stability": "external",
|
| 3479 | "summary": "Create a new `AWS::Lambda::EventSourceMapping`."
|
| 3480 | },
|
| 3481 | "locationInModule": {
|
| 3482 | "filename": "lib/lambda.generated.ts",
|
| 3483 | "line": 1833
|
| 3484 | },
|
| 3485 | "parameters": [
|
| 3486 | {
|
| 3487 | "docs": {
|
| 3488 | "summary": "- scope in which this resource is defined."
|
| 3489 | },
|
| 3490 | "name": "scope",
|
| 3491 | "type": {
|
| 3492 | "fqn": "@aws-cdk/core.Construct"
|
| 3493 | }
|
| 3494 | },
|
| 3495 | {
|
| 3496 | "docs": {
|
| 3497 | "summary": "- scoped id of the resource."
|
| 3498 | },
|
| 3499 | "name": "id",
|
| 3500 | "type": {
|
| 3501 | "primitive": "string"
|
| 3502 | }
|
| 3503 | },
|
| 3504 | {
|
| 3505 | "docs": {
|
| 3506 | "summary": "- resource properties."
|
| 3507 | },
|
| 3508 | "name": "props",
|
| 3509 | "type": {
|
| 3510 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMappingProps"
|
| 3511 | }
|
| 3512 | }
|
| 3513 | ]
|
| 3514 | },
|
| 3515 | "interfaces": [
|
| 3516 | "@aws-cdk/core.IInspectable"
|
| 3517 | ],
|
| 3518 | "kind": "class",
|
| 3519 | "locationInModule": {
|
| 3520 | "filename": "lib/lambda.generated.ts",
|
| 3521 | "line": 1605
|
| 3522 | },
|
| 3523 | "methods": [
|
| 3524 | {
|
| 3525 | "docs": {
|
| 3526 | "stability": "external",
|
| 3527 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 3528 | },
|
| 3529 | "locationInModule": {
|
| 3530 | "filename": "lib/lambda.generated.ts",
|
| 3531 | "line": 1868
|
| 3532 | },
|
| 3533 | "name": "inspect",
|
| 3534 | "overrides": "@aws-cdk/core.IInspectable",
|
| 3535 | "parameters": [
|
| 3536 | {
|
| 3537 | "docs": {
|
| 3538 | "summary": "- tree inspector to collect and process attributes."
|
| 3539 | },
|
| 3540 | "name": "inspector",
|
| 3541 | "type": {
|
| 3542 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 3543 | }
|
| 3544 | }
|
| 3545 | ]
|
| 3546 | },
|
| 3547 | {
|
| 3548 | "docs": {
|
| 3549 | "stability": "external"
|
| 3550 | },
|
| 3551 | "locationInModule": {
|
| 3552 | "filename": "lib/lambda.generated.ts",
|
| 3553 | "line": 1900
|
| 3554 | },
|
| 3555 | "name": "renderProperties",
|
| 3556 | "overrides": "@aws-cdk/core.CfnResource",
|
| 3557 | "parameters": [
|
| 3558 | {
|
| 3559 | "name": "props",
|
| 3560 | "type": {
|
| 3561 | "collection": {
|
| 3562 | "elementtype": {
|
| 3563 | "primitive": "any"
|
| 3564 | },
|
| 3565 | "kind": "map"
|
| 3566 | }
|
| 3567 | }
|
| 3568 | }
|
| 3569 | ],
|
| 3570 | "protected": true,
|
| 3571 | "returns": {
|
| 3572 | "type": {
|
| 3573 | "collection": {
|
| 3574 | "elementtype": {
|
| 3575 | "primitive": "any"
|
| 3576 | },
|
| 3577 | "kind": "map"
|
| 3578 | }
|
| 3579 | }
|
| 3580 | }
|
| 3581 | }
|
| 3582 | ],
|
| 3583 | "name": "CfnEventSourceMapping",
|
| 3584 | "properties": [
|
| 3585 | {
|
| 3586 | "const": true,
|
| 3587 | "docs": {
|
| 3588 | "stability": "external",
|
| 3589 | "summary": "The CloudFormation resource type name for this resource class."
|
| 3590 | },
|
| 3591 | "immutable": true,
|
| 3592 | "locationInModule": {
|
| 3593 | "filename": "lib/lambda.generated.ts",
|
| 3594 | "line": 1609
|
| 3595 | },
|
| 3596 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 3597 | "static": true,
|
| 3598 | "type": {
|
| 3599 | "primitive": "string"
|
| 3600 | }
|
| 3601 | },
|
| 3602 | {
|
| 3603 | "docs": {
|
| 3604 | "custom": {
|
| 3605 | "cloudformationAttribute": "Id"
|
| 3606 | },
|
| 3607 | "stability": "external",
|
| 3608 | "summary": "The event source mapping's ID."
|
| 3609 | },
|
| 3610 | "immutable": true,
|
| 3611 | "locationInModule": {
|
| 3612 | "filename": "lib/lambda.generated.ts",
|
| 3613 | "line": 1634
|
| 3614 | },
|
| 3615 | "name": "attrId",
|
| 3616 | "type": {
|
| 3617 | "primitive": "string"
|
| 3618 | }
|
| 3619 | },
|
| 3620 | {
|
| 3621 | "docs": {
|
| 3622 | "stability": "external"
|
| 3623 | },
|
| 3624 | "immutable": true,
|
| 3625 | "locationInModule": {
|
| 3626 | "filename": "lib/lambda.generated.ts",
|
| 3627 | "line": 1873
|
| 3628 | },
|
| 3629 | "name": "cfnProperties",
|
| 3630 | "overrides": "@aws-cdk/core.CfnResource",
|
| 3631 | "protected": true,
|
| 3632 | "type": {
|
| 3633 | "collection": {
|
| 3634 | "elementtype": {
|
| 3635 | "primitive": "any"
|
| 3636 | },
|
| 3637 | "kind": "map"
|
| 3638 | }
|
| 3639 | }
|
| 3640 | },
|
| 3641 | {
|
| 3642 | "docs": {
|
| 3643 | "custom": {
|
| 3644 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname"
|
| 3645 | },
|
| 3646 | "remarks": "**Name formats** - *Function name* – `MyFunction` .\n- *Function ARN* – `arn:aws:lambda:us-west-2:123456789012:function:MyFunction` .\n- *Version or Alias ARN* – `arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD` .\n- *Partial ARN* – `123456789012:function:MyFunction` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.",
|
| 3647 | "stability": "external",
|
| 3648 | "summary": "The name of the Lambda function."
|
| 3649 | },
|
| 3650 | "locationInModule": {
|
| 3651 | "filename": "lib/lambda.generated.ts",
|
| 3652 | "line": 1648
|
| 3653 | },
|
| 3654 | "name": "functionName",
|
| 3655 | "type": {
|
| 3656 | "primitive": "string"
|
| 3657 | }
|
| 3658 | },
|
| 3659 | {
|
| 3660 | "docs": {
|
| 3661 | "custom": {
|
| 3662 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig"
|
| 3663 | },
|
| 3664 | "stability": "external",
|
| 3665 | "summary": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source."
|
| 3666 | },
|
| 3667 | "locationInModule": {
|
| 3668 | "filename": "lib/lambda.generated.ts",
|
| 3669 | "line": 1655
|
| 3670 | },
|
| 3671 | "name": "amazonManagedKafkaEventSourceConfig",
|
| 3672 | "optional": true,
|
| 3673 | "type": {
|
| 3674 | "union": {
|
| 3675 | "types": [
|
| 3676 | {
|
| 3677 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3678 | },
|
| 3679 | {
|
| 3680 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty"
|
| 3681 | }
|
| 3682 | ]
|
| 3683 | }
|
| 3684 | }
|
| 3685 | },
|
| 3686 | {
|
| 3687 | "docs": {
|
| 3688 | "custom": {
|
| 3689 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize"
|
| 3690 | },
|
| 3691 | "remarks": "Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).\n\n- *Amazon Kinesis* – Default 100. Max 10,000.\n- *Amazon DynamoDB Streams* – Default 100. Max 10,000.\n- *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.\n- *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.\n- *Self-managed Apache Kafka* – Default 100. Max 10,000.\n- *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.",
|
| 3692 | "stability": "external",
|
| 3693 | "summary": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function."
|
| 3694 | },
|
| 3695 | "locationInModule": {
|
| 3696 | "filename": "lib/lambda.generated.ts",
|
| 3697 | "line": 1669
|
| 3698 | },
|
| 3699 | "name": "batchSize",
|
| 3700 | "optional": true,
|
| 3701 | "type": {
|
| 3702 | "primitive": "number"
|
| 3703 | }
|
| 3704 | },
|
| 3705 | {
|
| 3706 | "docs": {
|
| 3707 | "custom": {
|
| 3708 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror"
|
| 3709 | },
|
| 3710 | "remarks": "The default value is false.",
|
| 3711 | "stability": "external",
|
| 3712 | "summary": "(Streams only) If the function returns an error, split the batch in two and retry."
|
| 3713 | },
|
| 3714 | "locationInModule": {
|
| 3715 | "filename": "lib/lambda.generated.ts",
|
| 3716 | "line": 1676
|
| 3717 | },
|
| 3718 | "name": "bisectBatchOnFunctionError",
|
| 3719 | "optional": true,
|
| 3720 | "type": {
|
| 3721 | "union": {
|
| 3722 | "types": [
|
| 3723 | {
|
| 3724 | "primitive": "boolean"
|
| 3725 | },
|
| 3726 | {
|
| 3727 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3728 | }
|
| 3729 | ]
|
| 3730 | }
|
| 3731 | }
|
| 3732 | },
|
| 3733 | {
|
| 3734 | "docs": {
|
| 3735 | "custom": {
|
| 3736 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig"
|
| 3737 | },
|
| 3738 | "stability": "external",
|
| 3739 | "summary": "(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records."
|
| 3740 | },
|
| 3741 | "locationInModule": {
|
| 3742 | "filename": "lib/lambda.generated.ts",
|
| 3743 | "line": 1683
|
| 3744 | },
|
| 3745 | "name": "destinationConfig",
|
| 3746 | "optional": true,
|
| 3747 | "type": {
|
| 3748 | "union": {
|
| 3749 | "types": [
|
| 3750 | {
|
| 3751 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3752 | },
|
| 3753 | {
|
| 3754 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.DestinationConfigProperty"
|
| 3755 | }
|
| 3756 | ]
|
| 3757 | }
|
| 3758 | }
|
| 3759 | },
|
| 3760 | {
|
| 3761 | "docs": {
|
| 3762 | "custom": {
|
| 3763 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled"
|
| 3764 | },
|
| 3765 | "remarks": "Default: True",
|
| 3766 | "stability": "external",
|
| 3767 | "summary": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation."
|
| 3768 | },
|
| 3769 | "locationInModule": {
|
| 3770 | "filename": "lib/lambda.generated.ts",
|
| 3771 | "line": 1692
|
| 3772 | },
|
| 3773 | "name": "enabled",
|
| 3774 | "optional": true,
|
| 3775 | "type": {
|
| 3776 | "union": {
|
| 3777 | "types": [
|
| 3778 | {
|
| 3779 | "primitive": "boolean"
|
| 3780 | },
|
| 3781 | {
|
| 3782 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3783 | }
|
| 3784 | ]
|
| 3785 | }
|
| 3786 | }
|
| 3787 | },
|
| 3788 | {
|
| 3789 | "docs": {
|
| 3790 | "custom": {
|
| 3791 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn"
|
| 3792 | },
|
| 3793 | "remarks": "- *Amazon Kinesis* – The ARN of the data stream or a stream consumer.\n- *Amazon DynamoDB Streams* – The ARN of the stream.\n- *Amazon Simple Queue Service* – The ARN of the queue.\n- *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster.\n- *Amazon MQ* – The ARN of the broker.",
|
| 3794 | "stability": "external",
|
| 3795 | "summary": "The Amazon Resource Name (ARN) of the event source."
|
| 3796 | },
|
| 3797 | "locationInModule": {
|
| 3798 | "filename": "lib/lambda.generated.ts",
|
| 3799 | "line": 1705
|
| 3800 | },
|
| 3801 | "name": "eventSourceArn",
|
| 3802 | "optional": true,
|
| 3803 | "type": {
|
| 3804 | "primitive": "string"
|
| 3805 | }
|
| 3806 | },
|
| 3807 | {
|
| 3808 | "docs": {
|
| 3809 | "custom": {
|
| 3810 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria"
|
| 3811 | },
|
| 3812 | "remarks": "For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) .",
|
| 3813 | "stability": "external",
|
| 3814 | "summary": "An object that defines the filter criteria that determine whether Lambda should process an event."
|
| 3815 | },
|
| 3816 | "locationInModule": {
|
| 3817 | "filename": "lib/lambda.generated.ts",
|
| 3818 | "line": 1712
|
| 3819 | },
|
| 3820 | "name": "filterCriteria",
|
| 3821 | "optional": true,
|
| 3822 | "type": {
|
| 3823 | "union": {
|
| 3824 | "types": [
|
| 3825 | {
|
| 3826 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3827 | },
|
| 3828 | {
|
| 3829 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.FilterCriteriaProperty"
|
| 3830 | }
|
| 3831 | ]
|
| 3832 | }
|
| 3833 | }
|
| 3834 | },
|
| 3835 | {
|
| 3836 | "docs": {
|
| 3837 | "custom": {
|
| 3838 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes"
|
| 3839 | },
|
| 3840 | "remarks": "Valid Values: `ReportBatchItemFailures`",
|
| 3841 | "stability": "external",
|
| 3842 | "summary": "(Streams and SQS) A list of current response type enums applied to the event source mapping."
|
| 3843 | },
|
| 3844 | "locationInModule": {
|
| 3845 | "filename": "lib/lambda.generated.ts",
|
| 3846 | "line": 1721
|
| 3847 | },
|
| 3848 | "name": "functionResponseTypes",
|
| 3849 | "optional": true,
|
| 3850 | "type": {
|
| 3851 | "collection": {
|
| 3852 | "elementtype": {
|
| 3853 | "primitive": "string"
|
| 3854 | },
|
| 3855 | "kind": "array"
|
| 3856 | }
|
| 3857 | }
|
| 3858 | },
|
| 3859 | {
|
| 3860 | "docs": {
|
| 3861 | "custom": {
|
| 3862 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds"
|
| 3863 | },
|
| 3864 | "remarks": "*Default ( Kinesis , DynamoDB , Amazon SQS event sources)* : 0\n\n*Default ( Amazon MSK , Kafka, Amazon MQ event sources)* : 500 ms\n\n*Related setting:* When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1.",
|
| 3865 | "stability": "external",
|
| 3866 | "summary": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function."
|
| 3867 | },
|
| 3868 | "locationInModule": {
|
| 3869 | "filename": "lib/lambda.generated.ts",
|
| 3870 | "line": 1734
|
| 3871 | },
|
| 3872 | "name": "maximumBatchingWindowInSeconds",
|
| 3873 | "optional": true,
|
| 3874 | "type": {
|
| 3875 | "primitive": "number"
|
| 3876 | }
|
| 3877 | },
|
| 3878 | {
|
| 3879 | "docs": {
|
| 3880 | "custom": {
|
| 3881 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds"
|
| 3882 | },
|
| 3883 | "remarks": "The default value is -1,\nwhich sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.",
|
| 3884 | "stability": "external",
|
| 3885 | "summary": "(Streams only) Discard records older than the specified age."
|
| 3886 | },
|
| 3887 | "locationInModule": {
|
| 3888 | "filename": "lib/lambda.generated.ts",
|
| 3889 | "line": 1742
|
| 3890 | },
|
| 3891 | "name": "maximumRecordAgeInSeconds",
|
| 3892 | "optional": true,
|
| 3893 | "type": {
|
| 3894 | "primitive": "number"
|
| 3895 | }
|
| 3896 | },
|
| 3897 | {
|
| 3898 | "docs": {
|
| 3899 | "custom": {
|
| 3900 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts"
|
| 3901 | },
|
| 3902 | "remarks": "The default value is -1,\nwhich sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.",
|
| 3903 | "stability": "external",
|
| 3904 | "summary": "(Streams only) Discard records after the specified number of retries."
|
| 3905 | },
|
| 3906 | "locationInModule": {
|
| 3907 | "filename": "lib/lambda.generated.ts",
|
| 3908 | "line": 1750
|
| 3909 | },
|
| 3910 | "name": "maximumRetryAttempts",
|
| 3911 | "optional": true,
|
| 3912 | "type": {
|
| 3913 | "primitive": "number"
|
| 3914 | }
|
| 3915 | },
|
| 3916 | {
|
| 3917 | "docs": {
|
| 3918 | "custom": {
|
| 3919 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor"
|
| 3920 | },
|
| 3921 | "remarks": "The default value is 1.",
|
| 3922 | "stability": "external",
|
| 3923 | "summary": "(Streams only) The number of batches to process concurrently from each shard."
|
| 3924 | },
|
| 3925 | "locationInModule": {
|
| 3926 | "filename": "lib/lambda.generated.ts",
|
| 3927 | "line": 1757
|
| 3928 | },
|
| 3929 | "name": "parallelizationFactor",
|
| 3930 | "optional": true,
|
| 3931 | "type": {
|
| 3932 | "primitive": "number"
|
| 3933 | }
|
| 3934 | },
|
| 3935 | {
|
| 3936 | "docs": {
|
| 3937 | "custom": {
|
| 3938 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues"
|
| 3939 | },
|
| 3940 | "stability": "external",
|
| 3941 | "summary": "(Amazon MQ) The name of the Amazon MQ broker destination queue to consume."
|
| 3942 | },
|
| 3943 | "locationInModule": {
|
| 3944 | "filename": "lib/lambda.generated.ts",
|
| 3945 | "line": 1764
|
| 3946 | },
|
| 3947 | "name": "queues",
|
| 3948 | "optional": true,
|
| 3949 | "type": {
|
| 3950 | "collection": {
|
| 3951 | "elementtype": {
|
| 3952 | "primitive": "string"
|
| 3953 | },
|
| 3954 | "kind": "array"
|
| 3955 | }
|
| 3956 | }
|
| 3957 | },
|
| 3958 | {
|
| 3959 | "docs": {
|
| 3960 | "custom": {
|
| 3961 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-scalingconfig"
|
| 3962 | },
|
| 3963 | "remarks": "For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) .",
|
| 3964 | "stability": "external",
|
| 3965 | "summary": "(Amazon SQS only) The scaling configuration for the event source."
|
| 3966 | },
|
| 3967 | "locationInModule": {
|
| 3968 | "filename": "lib/lambda.generated.ts",
|
| 3969 | "line": 1771
|
| 3970 | },
|
| 3971 | "name": "scalingConfig",
|
| 3972 | "optional": true,
|
| 3973 | "type": {
|
| 3974 | "union": {
|
| 3975 | "types": [
|
| 3976 | {
|
| 3977 | "fqn": "@aws-cdk/core.IResolvable"
|
| 3978 | },
|
| 3979 | {
|
| 3980 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.ScalingConfigProperty"
|
| 3981 | }
|
| 3982 | ]
|
| 3983 | }
|
| 3984 | }
|
| 3985 | },
|
| 3986 | {
|
| 3987 | "docs": {
|
| 3988 | "custom": {
|
| 3989 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource"
|
| 3990 | },
|
| 3991 | "stability": "external",
|
| 3992 | "summary": "The self-managed Apache Kafka cluster for your event source."
|
| 3993 | },
|
| 3994 | "locationInModule": {
|
| 3995 | "filename": "lib/lambda.generated.ts",
|
| 3996 | "line": 1778
|
| 3997 | },
|
| 3998 | "name": "selfManagedEventSource",
|
| 3999 | "optional": true,
|
| 4000 | "type": {
|
| 4001 | "union": {
|
| 4002 | "types": [
|
| 4003 | {
|
| 4004 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4005 | },
|
| 4006 | {
|
| 4007 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SelfManagedEventSourceProperty"
|
| 4008 | }
|
| 4009 | ]
|
| 4010 | }
|
| 4011 | }
|
| 4012 | },
|
| 4013 | {
|
| 4014 | "docs": {
|
| 4015 | "custom": {
|
| 4016 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig"
|
| 4017 | },
|
| 4018 | "stability": "external",
|
| 4019 | "summary": "Specific configuration settings for a self-managed Apache Kafka event source."
|
| 4020 | },
|
| 4021 | "locationInModule": {
|
| 4022 | "filename": "lib/lambda.generated.ts",
|
| 4023 | "line": 1785
|
| 4024 | },
|
| 4025 | "name": "selfManagedKafkaEventSourceConfig",
|
| 4026 | "optional": true,
|
| 4027 | "type": {
|
| 4028 | "union": {
|
| 4029 | "types": [
|
| 4030 | {
|
| 4031 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4032 | },
|
| 4033 | {
|
| 4034 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty"
|
| 4035 | }
|
| 4036 | ]
|
| 4037 | }
|
| 4038 | }
|
| 4039 | },
|
| 4040 | {
|
| 4041 | "docs": {
|
| 4042 | "custom": {
|
| 4043 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations"
|
| 4044 | },
|
| 4045 | "stability": "external",
|
| 4046 | "summary": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source."
|
| 4047 | },
|
| 4048 | "locationInModule": {
|
| 4049 | "filename": "lib/lambda.generated.ts",
|
| 4050 | "line": 1792
|
| 4051 | },
|
| 4052 | "name": "sourceAccessConfigurations",
|
| 4053 | "optional": true,
|
| 4054 | "type": {
|
| 4055 | "union": {
|
| 4056 | "types": [
|
| 4057 | {
|
| 4058 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4059 | },
|
| 4060 | {
|
| 4061 | "collection": {
|
| 4062 | "elementtype": {
|
| 4063 | "union": {
|
| 4064 | "types": [
|
| 4065 | {
|
| 4066 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4067 | },
|
| 4068 | {
|
| 4069 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SourceAccessConfigurationProperty"
|
| 4070 | }
|
| 4071 | ]
|
| 4072 | }
|
| 4073 | },
|
| 4074 | "kind": "array"
|
| 4075 | }
|
| 4076 | }
|
| 4077 | ]
|
| 4078 | }
|
| 4079 | }
|
| 4080 | },
|
| 4081 | {
|
| 4082 | "docs": {
|
| 4083 | "custom": {
|
| 4084 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition"
|
| 4085 | },
|
| 4086 | "remarks": "- *LATEST* - Read only new records.\n- *TRIM_HORIZON* - Process all available records.\n- *AT_TIMESTAMP* - Specify a time from which to start reading records.",
|
| 4087 | "stability": "external",
|
| 4088 | "summary": "The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB."
|
| 4089 | },
|
| 4090 | "locationInModule": {
|
| 4091 | "filename": "lib/lambda.generated.ts",
|
| 4092 | "line": 1803
|
| 4093 | },
|
| 4094 | "name": "startingPosition",
|
| 4095 | "optional": true,
|
| 4096 | "type": {
|
| 4097 | "primitive": "string"
|
| 4098 | }
|
| 4099 | },
|
| 4100 | {
|
| 4101 | "docs": {
|
| 4102 | "custom": {
|
| 4103 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp"
|
| 4104 | },
|
| 4105 | "stability": "external",
|
| 4106 | "summary": "With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds."
|
| 4107 | },
|
| 4108 | "locationInModule": {
|
| 4109 | "filename": "lib/lambda.generated.ts",
|
| 4110 | "line": 1810
|
| 4111 | },
|
| 4112 | "name": "startingPositionTimestamp",
|
| 4113 | "optional": true,
|
| 4114 | "type": {
|
| 4115 | "primitive": "number"
|
| 4116 | }
|
| 4117 | },
|
| 4118 | {
|
| 4119 | "docs": {
|
| 4120 | "custom": {
|
| 4121 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics"
|
| 4122 | },
|
| 4123 | "stability": "external",
|
| 4124 | "summary": "The name of the Kafka topic."
|
| 4125 | },
|
| 4126 | "locationInModule": {
|
| 4127 | "filename": "lib/lambda.generated.ts",
|
| 4128 | "line": 1817
|
| 4129 | },
|
| 4130 | "name": "topics",
|
| 4131 | "optional": true,
|
| 4132 | "type": {
|
| 4133 | "collection": {
|
| 4134 | "elementtype": {
|
| 4135 | "primitive": "string"
|
| 4136 | },
|
| 4137 | "kind": "array"
|
| 4138 | }
|
| 4139 | }
|
| 4140 | },
|
| 4141 | {
|
| 4142 | "docs": {
|
| 4143 | "custom": {
|
| 4144 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds"
|
| 4145 | },
|
| 4146 | "remarks": "The range is between 1 second and 900 seconds.",
|
| 4147 | "stability": "external",
|
| 4148 | "summary": "(Streams only) The duration in seconds of a processing window."
|
| 4149 | },
|
| 4150 | "locationInModule": {
|
| 4151 | "filename": "lib/lambda.generated.ts",
|
| 4152 | "line": 1824
|
| 4153 | },
|
| 4154 | "name": "tumblingWindowInSeconds",
|
| 4155 | "optional": true,
|
| 4156 | "type": {
|
| 4157 | "primitive": "number"
|
| 4158 | }
|
| 4159 | }
|
| 4160 | ],
|
| 4161 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping"
|
| 4162 | },
|
| 4163 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty": {
|
| 4164 | "assembly": "@aws-cdk/aws-lambda",
|
| 4165 | "datatype": true,
|
| 4166 | "docs": {
|
| 4167 | "custom": {
|
| 4168 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig.html",
|
| 4169 | "exampleMetadata": "fixture=_generated"
|
| 4170 | },
|
| 4171 | "stability": "external",
|
| 4172 | "summary": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source.",
|
| 4173 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst amazonManagedKafkaEventSourceConfigProperty: lambda.CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty = {\n consumerGroupId: 'consumerGroupId',\n};"
|
| 4174 | },
|
| 4175 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty",
|
| 4176 | "kind": "interface",
|
| 4177 | "locationInModule": {
|
| 4178 | "filename": "lib/lambda.generated.ts",
|
| 4179 | "line": 1914
|
| 4180 | },
|
| 4181 | "name": "AmazonManagedKafkaEventSourceConfigProperty",
|
| 4182 | "namespace": "CfnEventSourceMapping",
|
| 4183 | "properties": [
|
| 4184 | {
|
| 4185 | "abstract": true,
|
| 4186 | "docs": {
|
| 4187 | "custom": {
|
| 4188 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig-consumergroupid"
|
| 4189 | },
|
| 4190 | "remarks": "The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id) .",
|
| 4191 | "stability": "external",
|
| 4192 | "summary": "The identifier for the Kafka consumer group to join."
|
| 4193 | },
|
| 4194 | "immutable": true,
|
| 4195 | "locationInModule": {
|
| 4196 | "filename": "lib/lambda.generated.ts",
|
| 4197 | "line": 1920
|
| 4198 | },
|
| 4199 | "name": "consumerGroupId",
|
| 4200 | "optional": true,
|
| 4201 | "type": {
|
| 4202 | "primitive": "string"
|
| 4203 | }
|
| 4204 | }
|
| 4205 | ],
|
| 4206 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty"
|
| 4207 | },
|
| 4208 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.DestinationConfigProperty": {
|
| 4209 | "assembly": "@aws-cdk/aws-lambda",
|
| 4210 | "datatype": true,
|
| 4211 | "docs": {
|
| 4212 | "custom": {
|
| 4213 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html",
|
| 4214 | "exampleMetadata": "fixture=_generated"
|
| 4215 | },
|
| 4216 | "stability": "external",
|
| 4217 | "summary": "A configuration object that specifies the destination of an event after Lambda processes it.",
|
| 4218 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst destinationConfigProperty: lambda.CfnEventSourceMapping.DestinationConfigProperty = {\n onFailure: {\n destination: 'destination',\n },\n};"
|
| 4219 | },
|
| 4220 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.DestinationConfigProperty",
|
| 4221 | "kind": "interface",
|
| 4222 | "locationInModule": {
|
| 4223 | "filename": "lib/lambda.generated.ts",
|
| 4224 | "line": 1981
|
| 4225 | },
|
| 4226 | "name": "DestinationConfigProperty",
|
| 4227 | "namespace": "CfnEventSourceMapping",
|
| 4228 | "properties": [
|
| 4229 | {
|
| 4230 | "abstract": true,
|
| 4231 | "docs": {
|
| 4232 | "custom": {
|
| 4233 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-destinationconfig.html#cfn-lambda-eventsourcemapping-destinationconfig-onfailure"
|
| 4234 | },
|
| 4235 | "stability": "external",
|
| 4236 | "summary": "The destination configuration for failed invocations."
|
| 4237 | },
|
| 4238 | "immutable": true,
|
| 4239 | "locationInModule": {
|
| 4240 | "filename": "lib/lambda.generated.ts",
|
| 4241 | "line": 1987
|
| 4242 | },
|
| 4243 | "name": "onFailure",
|
| 4244 | "optional": true,
|
| 4245 | "type": {
|
| 4246 | "union": {
|
| 4247 | "types": [
|
| 4248 | {
|
| 4249 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4250 | },
|
| 4251 | {
|
| 4252 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.OnFailureProperty"
|
| 4253 | }
|
| 4254 | ]
|
| 4255 | }
|
| 4256 | }
|
| 4257 | }
|
| 4258 | ],
|
| 4259 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.DestinationConfigProperty"
|
| 4260 | },
|
| 4261 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.EndpointsProperty": {
|
| 4262 | "assembly": "@aws-cdk/aws-lambda",
|
| 4263 | "datatype": true,
|
| 4264 | "docs": {
|
| 4265 | "custom": {
|
| 4266 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-endpoints.html",
|
| 4267 | "exampleMetadata": "fixture=_generated"
|
| 4268 | },
|
| 4269 | "stability": "external",
|
| 4270 | "summary": "The list of bootstrap servers for your Kafka brokers in the following format: `\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]` .",
|
| 4271 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst endpointsProperty: lambda.CfnEventSourceMapping.EndpointsProperty = {\n kafkaBootstrapServers: ['kafkaBootstrapServers'],\n};"
|
| 4272 | },
|
| 4273 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.EndpointsProperty",
|
| 4274 | "kind": "interface",
|
| 4275 | "locationInModule": {
|
| 4276 | "filename": "lib/lambda.generated.ts",
|
| 4277 | "line": 2048
|
| 4278 | },
|
| 4279 | "name": "EndpointsProperty",
|
| 4280 | "namespace": "CfnEventSourceMapping",
|
| 4281 | "properties": [
|
| 4282 | {
|
| 4283 | "abstract": true,
|
| 4284 | "docs": {
|
| 4285 | "custom": {
|
| 4286 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-endpoints.html#cfn-lambda-eventsourcemapping-endpoints-kafkabootstrapservers"
|
| 4287 | },
|
| 4288 | "stability": "external",
|
| 4289 | "summary": "The list of bootstrap servers for your Kafka brokers in the following format: `\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]` ."
|
| 4290 | },
|
| 4291 | "immutable": true,
|
| 4292 | "locationInModule": {
|
| 4293 | "filename": "lib/lambda.generated.ts",
|
| 4294 | "line": 2054
|
| 4295 | },
|
| 4296 | "name": "kafkaBootstrapServers",
|
| 4297 | "optional": true,
|
| 4298 | "type": {
|
| 4299 | "collection": {
|
| 4300 | "elementtype": {
|
| 4301 | "primitive": "string"
|
| 4302 | },
|
| 4303 | "kind": "array"
|
| 4304 | }
|
| 4305 | }
|
| 4306 | }
|
| 4307 | ],
|
| 4308 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.EndpointsProperty"
|
| 4309 | },
|
| 4310 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.FilterCriteriaProperty": {
|
| 4311 | "assembly": "@aws-cdk/aws-lambda",
|
| 4312 | "datatype": true,
|
| 4313 | "docs": {
|
| 4314 | "custom": {
|
| 4315 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html",
|
| 4316 | "exampleMetadata": "fixture=_generated"
|
| 4317 | },
|
| 4318 | "stability": "external",
|
| 4319 | "summary": "An object that contains the filters for an event source.",
|
| 4320 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst filterCriteriaProperty: lambda.CfnEventSourceMapping.FilterCriteriaProperty = {\n filters: [{\n pattern: 'pattern',\n }],\n};"
|
| 4321 | },
|
| 4322 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.FilterCriteriaProperty",
|
| 4323 | "kind": "interface",
|
| 4324 | "locationInModule": {
|
| 4325 | "filename": "lib/lambda.generated.ts",
|
| 4326 | "line": 2182
|
| 4327 | },
|
| 4328 | "name": "FilterCriteriaProperty",
|
| 4329 | "namespace": "CfnEventSourceMapping",
|
| 4330 | "properties": [
|
| 4331 | {
|
| 4332 | "abstract": true,
|
| 4333 | "docs": {
|
| 4334 | "custom": {
|
| 4335 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html#cfn-lambda-eventsourcemapping-filtercriteria-filters"
|
| 4336 | },
|
| 4337 | "stability": "external",
|
| 4338 | "summary": "A list of filters."
|
| 4339 | },
|
| 4340 | "immutable": true,
|
| 4341 | "locationInModule": {
|
| 4342 | "filename": "lib/lambda.generated.ts",
|
| 4343 | "line": 2188
|
| 4344 | },
|
| 4345 | "name": "filters",
|
| 4346 | "optional": true,
|
| 4347 | "type": {
|
| 4348 | "union": {
|
| 4349 | "types": [
|
| 4350 | {
|
| 4351 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4352 | },
|
| 4353 | {
|
| 4354 | "collection": {
|
| 4355 | "elementtype": {
|
| 4356 | "union": {
|
| 4357 | "types": [
|
| 4358 | {
|
| 4359 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4360 | },
|
| 4361 | {
|
| 4362 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.FilterProperty"
|
| 4363 | }
|
| 4364 | ]
|
| 4365 | }
|
| 4366 | },
|
| 4367 | "kind": "array"
|
| 4368 | }
|
| 4369 | }
|
| 4370 | ]
|
| 4371 | }
|
| 4372 | }
|
| 4373 | }
|
| 4374 | ],
|
| 4375 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.FilterCriteriaProperty"
|
| 4376 | },
|
| 4377 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.FilterProperty": {
|
| 4378 | "assembly": "@aws-cdk/aws-lambda",
|
| 4379 | "datatype": true,
|
| 4380 | "docs": {
|
| 4381 | "custom": {
|
| 4382 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filter.html",
|
| 4383 | "exampleMetadata": "fixture=_generated"
|
| 4384 | },
|
| 4385 | "stability": "external",
|
| 4386 | "summary": "A structure within a `FilterCriteria` object that defines an event filtering pattern.",
|
| 4387 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst filterProperty: lambda.CfnEventSourceMapping.FilterProperty = {\n pattern: 'pattern',\n};"
|
| 4388 | },
|
| 4389 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.FilterProperty",
|
| 4390 | "kind": "interface",
|
| 4391 | "locationInModule": {
|
| 4392 | "filename": "lib/lambda.generated.ts",
|
| 4393 | "line": 2115
|
| 4394 | },
|
| 4395 | "name": "FilterProperty",
|
| 4396 | "namespace": "CfnEventSourceMapping",
|
| 4397 | "properties": [
|
| 4398 | {
|
| 4399 | "abstract": true,
|
| 4400 | "docs": {
|
| 4401 | "custom": {
|
| 4402 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filter.html#cfn-lambda-eventsourcemapping-filter-pattern"
|
| 4403 | },
|
| 4404 | "remarks": "For more information on the syntax of a filter pattern, see [Filter rule syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax) .",
|
| 4405 | "stability": "external",
|
| 4406 | "summary": "A filter pattern."
|
| 4407 | },
|
| 4408 | "immutable": true,
|
| 4409 | "locationInModule": {
|
| 4410 | "filename": "lib/lambda.generated.ts",
|
| 4411 | "line": 2121
|
| 4412 | },
|
| 4413 | "name": "pattern",
|
| 4414 | "optional": true,
|
| 4415 | "type": {
|
| 4416 | "primitive": "string"
|
| 4417 | }
|
| 4418 | }
|
| 4419 | ],
|
| 4420 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.FilterProperty"
|
| 4421 | },
|
| 4422 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.OnFailureProperty": {
|
| 4423 | "assembly": "@aws-cdk/aws-lambda",
|
| 4424 | "datatype": true,
|
| 4425 | "docs": {
|
| 4426 | "custom": {
|
| 4427 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html",
|
| 4428 | "exampleMetadata": "fixture=_generated"
|
| 4429 | },
|
| 4430 | "stability": "external",
|
| 4431 | "summary": "A destination for events that failed processing.",
|
| 4432 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst onFailureProperty: lambda.CfnEventSourceMapping.OnFailureProperty = {\n destination: 'destination',\n};"
|
| 4433 | },
|
| 4434 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.OnFailureProperty",
|
| 4435 | "kind": "interface",
|
| 4436 | "locationInModule": {
|
| 4437 | "filename": "lib/lambda.generated.ts",
|
| 4438 | "line": 2249
|
| 4439 | },
|
| 4440 | "name": "OnFailureProperty",
|
| 4441 | "namespace": "CfnEventSourceMapping",
|
| 4442 | "properties": [
|
| 4443 | {
|
| 4444 | "abstract": true,
|
| 4445 | "docs": {
|
| 4446 | "custom": {
|
| 4447 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-onfailure.html#cfn-lambda-eventsourcemapping-onfailure-destination"
|
| 4448 | },
|
| 4449 | "stability": "external",
|
| 4450 | "summary": "The Amazon Resource Name (ARN) of the destination resource."
|
| 4451 | },
|
| 4452 | "immutable": true,
|
| 4453 | "locationInModule": {
|
| 4454 | "filename": "lib/lambda.generated.ts",
|
| 4455 | "line": 2255
|
| 4456 | },
|
| 4457 | "name": "destination",
|
| 4458 | "optional": true,
|
| 4459 | "type": {
|
| 4460 | "primitive": "string"
|
| 4461 | }
|
| 4462 | }
|
| 4463 | ],
|
| 4464 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.OnFailureProperty"
|
| 4465 | },
|
| 4466 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.ScalingConfigProperty": {
|
| 4467 | "assembly": "@aws-cdk/aws-lambda",
|
| 4468 | "datatype": true,
|
| 4469 | "docs": {
|
| 4470 | "custom": {
|
| 4471 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html",
|
| 4472 | "exampleMetadata": "fixture=_generated"
|
| 4473 | },
|
| 4474 | "remarks": "To remove the configuration, pass an empty value.",
|
| 4475 | "stability": "external",
|
| 4476 | "summary": "(Amazon SQS only) The scaling configuration for the event source.",
|
| 4477 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst scalingConfigProperty: lambda.CfnEventSourceMapping.ScalingConfigProperty = {\n maximumConcurrency: 123,\n};"
|
| 4478 | },
|
| 4479 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.ScalingConfigProperty",
|
| 4480 | "kind": "interface",
|
| 4481 | "locationInModule": {
|
| 4482 | "filename": "lib/lambda.generated.ts",
|
| 4483 | "line": 2316
|
| 4484 | },
|
| 4485 | "name": "ScalingConfigProperty",
|
| 4486 | "namespace": "CfnEventSourceMapping",
|
| 4487 | "properties": [
|
| 4488 | {
|
| 4489 | "abstract": true,
|
| 4490 | "docs": {
|
| 4491 | "custom": {
|
| 4492 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html#cfn-lambda-eventsourcemapping-scalingconfig-maximumconcurrency"
|
| 4493 | },
|
| 4494 | "stability": "external",
|
| 4495 | "summary": "Limits the number of concurrent instances that the Amazon SQS event source can invoke."
|
| 4496 | },
|
| 4497 | "immutable": true,
|
| 4498 | "locationInModule": {
|
| 4499 | "filename": "lib/lambda.generated.ts",
|
| 4500 | "line": 2322
|
| 4501 | },
|
| 4502 | "name": "maximumConcurrency",
|
| 4503 | "optional": true,
|
| 4504 | "type": {
|
| 4505 | "primitive": "number"
|
| 4506 | }
|
| 4507 | }
|
| 4508 | ],
|
| 4509 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.ScalingConfigProperty"
|
| 4510 | },
|
| 4511 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.SelfManagedEventSourceProperty": {
|
| 4512 | "assembly": "@aws-cdk/aws-lambda",
|
| 4513 | "datatype": true,
|
| 4514 | "docs": {
|
| 4515 | "custom": {
|
| 4516 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedeventsource.html",
|
| 4517 | "exampleMetadata": "fixture=_generated"
|
| 4518 | },
|
| 4519 | "stability": "external",
|
| 4520 | "summary": "The self-managed Apache Kafka cluster for your event source.",
|
| 4521 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst selfManagedEventSourceProperty: lambda.CfnEventSourceMapping.SelfManagedEventSourceProperty = {\n endpoints: {\n kafkaBootstrapServers: ['kafkaBootstrapServers'],\n },\n};"
|
| 4522 | },
|
| 4523 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SelfManagedEventSourceProperty",
|
| 4524 | "kind": "interface",
|
| 4525 | "locationInModule": {
|
| 4526 | "filename": "lib/lambda.generated.ts",
|
| 4527 | "line": 2383
|
| 4528 | },
|
| 4529 | "name": "SelfManagedEventSourceProperty",
|
| 4530 | "namespace": "CfnEventSourceMapping",
|
| 4531 | "properties": [
|
| 4532 | {
|
| 4533 | "abstract": true,
|
| 4534 | "docs": {
|
| 4535 | "custom": {
|
| 4536 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedeventsource.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource-endpoints"
|
| 4537 | },
|
| 4538 | "stability": "external",
|
| 4539 | "summary": "The list of bootstrap servers for your Kafka brokers in the following format: `\"KafkaBootstrapServers\": [\"abc.xyz.com:xxxx\",\"abc2.xyz.com:xxxx\"]` ."
|
| 4540 | },
|
| 4541 | "immutable": true,
|
| 4542 | "locationInModule": {
|
| 4543 | "filename": "lib/lambda.generated.ts",
|
| 4544 | "line": 2389
|
| 4545 | },
|
| 4546 | "name": "endpoints",
|
| 4547 | "optional": true,
|
| 4548 | "type": {
|
| 4549 | "union": {
|
| 4550 | "types": [
|
| 4551 | {
|
| 4552 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4553 | },
|
| 4554 | {
|
| 4555 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.EndpointsProperty"
|
| 4556 | }
|
| 4557 | ]
|
| 4558 | }
|
| 4559 | }
|
| 4560 | }
|
| 4561 | ],
|
| 4562 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.SelfManagedEventSourceProperty"
|
| 4563 | },
|
| 4564 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty": {
|
| 4565 | "assembly": "@aws-cdk/aws-lambda",
|
| 4566 | "datatype": true,
|
| 4567 | "docs": {
|
| 4568 | "custom": {
|
| 4569 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html",
|
| 4570 | "exampleMetadata": "fixture=_generated"
|
| 4571 | },
|
| 4572 | "stability": "external",
|
| 4573 | "summary": "Specific configuration settings for a self-managed Apache Kafka event source.",
|
| 4574 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst selfManagedKafkaEventSourceConfigProperty: lambda.CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty = {\n consumerGroupId: 'consumerGroupId',\n};"
|
| 4575 | },
|
| 4576 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty",
|
| 4577 | "kind": "interface",
|
| 4578 | "locationInModule": {
|
| 4579 | "filename": "lib/lambda.generated.ts",
|
| 4580 | "line": 2450
|
| 4581 | },
|
| 4582 | "name": "SelfManagedKafkaEventSourceConfigProperty",
|
| 4583 | "namespace": "CfnEventSourceMapping",
|
| 4584 | "properties": [
|
| 4585 | {
|
| 4586 | "abstract": true,
|
| 4587 | "docs": {
|
| 4588 | "custom": {
|
| 4589 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig-consumergroupid"
|
| 4590 | },
|
| 4591 | "remarks": "The consumer group ID must be unique among all your Kafka event sources. After creating a Kafka event source mapping with the consumer group ID specified, you cannot update this value. For more information, see [Customizable consumer group ID](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-consumer-group-id) .",
|
| 4592 | "stability": "external",
|
| 4593 | "summary": "The identifier for the Kafka consumer group to join."
|
| 4594 | },
|
| 4595 | "immutable": true,
|
| 4596 | "locationInModule": {
|
| 4597 | "filename": "lib/lambda.generated.ts",
|
| 4598 | "line": 2456
|
| 4599 | },
|
| 4600 | "name": "consumerGroupId",
|
| 4601 | "optional": true,
|
| 4602 | "type": {
|
| 4603 | "primitive": "string"
|
| 4604 | }
|
| 4605 | }
|
| 4606 | ],
|
| 4607 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty"
|
| 4608 | },
|
| 4609 | "@aws-cdk/aws-lambda.CfnEventSourceMapping.SourceAccessConfigurationProperty": {
|
| 4610 | "assembly": "@aws-cdk/aws-lambda",
|
| 4611 | "datatype": true,
|
| 4612 | "docs": {
|
| 4613 | "custom": {
|
| 4614 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html",
|
| 4615 | "exampleMetadata": "fixture=_generated"
|
| 4616 | },
|
| 4617 | "stability": "external",
|
| 4618 | "summary": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.",
|
| 4619 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst sourceAccessConfigurationProperty: lambda.CfnEventSourceMapping.SourceAccessConfigurationProperty = {\n type: 'type',\n uri: 'uri',\n};"
|
| 4620 | },
|
| 4621 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SourceAccessConfigurationProperty",
|
| 4622 | "kind": "interface",
|
| 4623 | "locationInModule": {
|
| 4624 | "filename": "lib/lambda.generated.ts",
|
| 4625 | "line": 2517
|
| 4626 | },
|
| 4627 | "name": "SourceAccessConfigurationProperty",
|
| 4628 | "namespace": "CfnEventSourceMapping",
|
| 4629 | "properties": [
|
| 4630 | {
|
| 4631 | "abstract": true,
|
| 4632 | "docs": {
|
| 4633 | "custom": {
|
| 4634 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html#cfn-lambda-eventsourcemapping-sourceaccessconfiguration-type"
|
| 4635 | },
|
| 4636 | "remarks": "- `BASIC_AUTH` – (Amazon MQ) The AWS Secrets Manager secret that stores your broker credentials.\n- `BASIC_AUTH` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers.\n- `VPC_SUBNET` – (Self-managed Apache Kafka) The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster.\n- `VPC_SECURITY_GROUP` – (Self-managed Apache Kafka) The VPC security group used to manage access to your self-managed Apache Kafka brokers.\n- `SASL_SCRAM_256_AUTH` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers.\n- `SASL_SCRAM_512_AUTH` – (Amazon MSK, Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers.\n- `VIRTUAL_HOST` –- (RabbitMQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source. This property cannot be specified in an UpdateEventSourceMapping API call.\n- `CLIENT_CERTIFICATE_TLS_AUTH` – (Amazon MSK, self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers.\n- `SERVER_ROOT_CA_CERTIFICATE` – (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key containing the root CA certificate (X.509 PEM) used for TLS encryption of your Apache Kafka brokers.",
|
| 4637 | "stability": "external",
|
| 4638 | "summary": "The type of authentication protocol, VPC components, or virtual host for your event source. For example: `\"Type\":\"SASL_SCRAM_512_AUTH\"` ."
|
| 4639 | },
|
| 4640 | "immutable": true,
|
| 4641 | "locationInModule": {
|
| 4642 | "filename": "lib/lambda.generated.ts",
|
| 4643 | "line": 2533
|
| 4644 | },
|
| 4645 | "name": "type",
|
| 4646 | "optional": true,
|
| 4647 | "type": {
|
| 4648 | "primitive": "string"
|
| 4649 | }
|
| 4650 | },
|
| 4651 | {
|
| 4652 | "abstract": true,
|
| 4653 | "docs": {
|
| 4654 | "custom": {
|
| 4655 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html#cfn-lambda-eventsourcemapping-sourceaccessconfiguration-uri"
|
| 4656 | },
|
| 4657 | "remarks": "For example: `\"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\"` .",
|
| 4658 | "stability": "external",
|
| 4659 | "summary": "The value for your chosen configuration in `Type` ."
|
| 4660 | },
|
| 4661 | "immutable": true,
|
| 4662 | "locationInModule": {
|
| 4663 | "filename": "lib/lambda.generated.ts",
|
| 4664 | "line": 2539
|
| 4665 | },
|
| 4666 | "name": "uri",
|
| 4667 | "optional": true,
|
| 4668 | "type": {
|
| 4669 | "primitive": "string"
|
| 4670 | }
|
| 4671 | }
|
| 4672 | ],
|
| 4673 | "symbolId": "lib/lambda.generated:CfnEventSourceMapping.SourceAccessConfigurationProperty"
|
| 4674 | },
|
| 4675 | "@aws-cdk/aws-lambda.CfnEventSourceMappingProps": {
|
| 4676 | "assembly": "@aws-cdk/aws-lambda",
|
| 4677 | "datatype": true,
|
| 4678 | "docs": {
|
| 4679 | "custom": {
|
| 4680 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html",
|
| 4681 | "exampleMetadata": "fixture=_generated"
|
| 4682 | },
|
| 4683 | "stability": "external",
|
| 4684 | "summary": "Properties for defining a `CfnEventSourceMapping`.",
|
| 4685 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnEventSourceMappingProps: lambda.CfnEventSourceMappingProps = {\n functionName: 'functionName',\n\n // the properties below are optional\n amazonManagedKafkaEventSourceConfig: {\n consumerGroupId: 'consumerGroupId',\n },\n batchSize: 123,\n bisectBatchOnFunctionError: false,\n destinationConfig: {\n onFailure: {\n destination: 'destination',\n },\n },\n enabled: false,\n eventSourceArn: 'eventSourceArn',\n filterCriteria: {\n filters: [{\n pattern: 'pattern',\n }],\n },\n functionResponseTypes: ['functionResponseTypes'],\n maximumBatchingWindowInSeconds: 123,\n maximumRecordAgeInSeconds: 123,\n maximumRetryAttempts: 123,\n parallelizationFactor: 123,\n queues: ['queues'],\n scalingConfig: {\n maximumConcurrency: 123,\n },\n selfManagedEventSource: {\n endpoints: {\n kafkaBootstrapServers: ['kafkaBootstrapServers'],\n },\n },\n selfManagedKafkaEventSourceConfig: {\n consumerGroupId: 'consumerGroupId',\n },\n sourceAccessConfigurations: [{\n type: 'type',\n uri: 'uri',\n }],\n startingPosition: 'startingPosition',\n startingPositionTimestamp: 123,\n topics: ['topics'],\n tumblingWindowInSeconds: 123,\n};"
|
| 4686 | },
|
| 4687 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMappingProps",
|
| 4688 | "kind": "interface",
|
| 4689 | "locationInModule": {
|
| 4690 | "filename": "lib/lambda.generated.ts",
|
| 4691 | "line": 1284
|
| 4692 | },
|
| 4693 | "name": "CfnEventSourceMappingProps",
|
| 4694 | "properties": [
|
| 4695 | {
|
| 4696 | "abstract": true,
|
| 4697 | "docs": {
|
| 4698 | "custom": {
|
| 4699 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionname"
|
| 4700 | },
|
| 4701 | "remarks": "**Name formats** - *Function name* – `MyFunction` .\n- *Function ARN* – `arn:aws:lambda:us-west-2:123456789012:function:MyFunction` .\n- *Version or Alias ARN* – `arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD` .\n- *Partial ARN* – `123456789012:function:MyFunction` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.",
|
| 4702 | "stability": "external",
|
| 4703 | "summary": "The name of the Lambda function."
|
| 4704 | },
|
| 4705 | "immutable": true,
|
| 4706 | "locationInModule": {
|
| 4707 | "filename": "lib/lambda.generated.ts",
|
| 4708 | "line": 1298
|
| 4709 | },
|
| 4710 | "name": "functionName",
|
| 4711 | "type": {
|
| 4712 | "primitive": "string"
|
| 4713 | }
|
| 4714 | },
|
| 4715 | {
|
| 4716 | "abstract": true,
|
| 4717 | "docs": {
|
| 4718 | "custom": {
|
| 4719 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-amazonmanagedkafkaeventsourceconfig"
|
| 4720 | },
|
| 4721 | "stability": "external",
|
| 4722 | "summary": "Specific configuration settings for an Amazon Managed Streaming for Apache Kafka (Amazon MSK) event source."
|
| 4723 | },
|
| 4724 | "immutable": true,
|
| 4725 | "locationInModule": {
|
| 4726 | "filename": "lib/lambda.generated.ts",
|
| 4727 | "line": 1305
|
| 4728 | },
|
| 4729 | "name": "amazonManagedKafkaEventSourceConfig",
|
| 4730 | "optional": true,
|
| 4731 | "type": {
|
| 4732 | "union": {
|
| 4733 | "types": [
|
| 4734 | {
|
| 4735 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4736 | },
|
| 4737 | {
|
| 4738 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.AmazonManagedKafkaEventSourceConfigProperty"
|
| 4739 | }
|
| 4740 | ]
|
| 4741 | }
|
| 4742 | }
|
| 4743 | },
|
| 4744 | {
|
| 4745 | "abstract": true,
|
| 4746 | "docs": {
|
| 4747 | "custom": {
|
| 4748 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize"
|
| 4749 | },
|
| 4750 | "remarks": "Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).\n\n- *Amazon Kinesis* – Default 100. Max 10,000.\n- *Amazon DynamoDB Streams* – Default 100. Max 10,000.\n- *Amazon Simple Queue Service* – Default 10. For standard queues the max is 10,000. For FIFO queues the max is 10.\n- *Amazon Managed Streaming for Apache Kafka* – Default 100. Max 10,000.\n- *Self-managed Apache Kafka* – Default 100. Max 10,000.\n- *Amazon MQ (ActiveMQ and RabbitMQ)* – Default 100. Max 10,000.",
|
| 4751 | "stability": "external",
|
| 4752 | "summary": "The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function."
|
| 4753 | },
|
| 4754 | "immutable": true,
|
| 4755 | "locationInModule": {
|
| 4756 | "filename": "lib/lambda.generated.ts",
|
| 4757 | "line": 1319
|
| 4758 | },
|
| 4759 | "name": "batchSize",
|
| 4760 | "optional": true,
|
| 4761 | "type": {
|
| 4762 | "primitive": "number"
|
| 4763 | }
|
| 4764 | },
|
| 4765 | {
|
| 4766 | "abstract": true,
|
| 4767 | "docs": {
|
| 4768 | "custom": {
|
| 4769 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-bisectbatchonfunctionerror"
|
| 4770 | },
|
| 4771 | "remarks": "The default value is false.",
|
| 4772 | "stability": "external",
|
| 4773 | "summary": "(Streams only) If the function returns an error, split the batch in two and retry."
|
| 4774 | },
|
| 4775 | "immutable": true,
|
| 4776 | "locationInModule": {
|
| 4777 | "filename": "lib/lambda.generated.ts",
|
| 4778 | "line": 1326
|
| 4779 | },
|
| 4780 | "name": "bisectBatchOnFunctionError",
|
| 4781 | "optional": true,
|
| 4782 | "type": {
|
| 4783 | "union": {
|
| 4784 | "types": [
|
| 4785 | {
|
| 4786 | "primitive": "boolean"
|
| 4787 | },
|
| 4788 | {
|
| 4789 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4790 | }
|
| 4791 | ]
|
| 4792 | }
|
| 4793 | }
|
| 4794 | },
|
| 4795 | {
|
| 4796 | "abstract": true,
|
| 4797 | "docs": {
|
| 4798 | "custom": {
|
| 4799 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-destinationconfig"
|
| 4800 | },
|
| 4801 | "stability": "external",
|
| 4802 | "summary": "(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded records."
|
| 4803 | },
|
| 4804 | "immutable": true,
|
| 4805 | "locationInModule": {
|
| 4806 | "filename": "lib/lambda.generated.ts",
|
| 4807 | "line": 1333
|
| 4808 | },
|
| 4809 | "name": "destinationConfig",
|
| 4810 | "optional": true,
|
| 4811 | "type": {
|
| 4812 | "union": {
|
| 4813 | "types": [
|
| 4814 | {
|
| 4815 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4816 | },
|
| 4817 | {
|
| 4818 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.DestinationConfigProperty"
|
| 4819 | }
|
| 4820 | ]
|
| 4821 | }
|
| 4822 | }
|
| 4823 | },
|
| 4824 | {
|
| 4825 | "abstract": true,
|
| 4826 | "docs": {
|
| 4827 | "custom": {
|
| 4828 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled"
|
| 4829 | },
|
| 4830 | "remarks": "Default: True",
|
| 4831 | "stability": "external",
|
| 4832 | "summary": "When true, the event source mapping is active. When false, Lambda pauses polling and invocation."
|
| 4833 | },
|
| 4834 | "immutable": true,
|
| 4835 | "locationInModule": {
|
| 4836 | "filename": "lib/lambda.generated.ts",
|
| 4837 | "line": 1342
|
| 4838 | },
|
| 4839 | "name": "enabled",
|
| 4840 | "optional": true,
|
| 4841 | "type": {
|
| 4842 | "union": {
|
| 4843 | "types": [
|
| 4844 | {
|
| 4845 | "primitive": "boolean"
|
| 4846 | },
|
| 4847 | {
|
| 4848 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4849 | }
|
| 4850 | ]
|
| 4851 | }
|
| 4852 | }
|
| 4853 | },
|
| 4854 | {
|
| 4855 | "abstract": true,
|
| 4856 | "docs": {
|
| 4857 | "custom": {
|
| 4858 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn"
|
| 4859 | },
|
| 4860 | "remarks": "- *Amazon Kinesis* – The ARN of the data stream or a stream consumer.\n- *Amazon DynamoDB Streams* – The ARN of the stream.\n- *Amazon Simple Queue Service* – The ARN of the queue.\n- *Amazon Managed Streaming for Apache Kafka* – The ARN of the cluster.\n- *Amazon MQ* – The ARN of the broker.",
|
| 4861 | "stability": "external",
|
| 4862 | "summary": "The Amazon Resource Name (ARN) of the event source."
|
| 4863 | },
|
| 4864 | "immutable": true,
|
| 4865 | "locationInModule": {
|
| 4866 | "filename": "lib/lambda.generated.ts",
|
| 4867 | "line": 1355
|
| 4868 | },
|
| 4869 | "name": "eventSourceArn",
|
| 4870 | "optional": true,
|
| 4871 | "type": {
|
| 4872 | "primitive": "string"
|
| 4873 | }
|
| 4874 | },
|
| 4875 | {
|
| 4876 | "abstract": true,
|
| 4877 | "docs": {
|
| 4878 | "custom": {
|
| 4879 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-filtercriteria"
|
| 4880 | },
|
| 4881 | "remarks": "For more information, see [Lambda event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) .",
|
| 4882 | "stability": "external",
|
| 4883 | "summary": "An object that defines the filter criteria that determine whether Lambda should process an event."
|
| 4884 | },
|
| 4885 | "immutable": true,
|
| 4886 | "locationInModule": {
|
| 4887 | "filename": "lib/lambda.generated.ts",
|
| 4888 | "line": 1362
|
| 4889 | },
|
| 4890 | "name": "filterCriteria",
|
| 4891 | "optional": true,
|
| 4892 | "type": {
|
| 4893 | "union": {
|
| 4894 | "types": [
|
| 4895 | {
|
| 4896 | "fqn": "@aws-cdk/core.IResolvable"
|
| 4897 | },
|
| 4898 | {
|
| 4899 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.FilterCriteriaProperty"
|
| 4900 | }
|
| 4901 | ]
|
| 4902 | }
|
| 4903 | }
|
| 4904 | },
|
| 4905 | {
|
| 4906 | "abstract": true,
|
| 4907 | "docs": {
|
| 4908 | "custom": {
|
| 4909 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes"
|
| 4910 | },
|
| 4911 | "remarks": "Valid Values: `ReportBatchItemFailures`",
|
| 4912 | "stability": "external",
|
| 4913 | "summary": "(Streams and SQS) A list of current response type enums applied to the event source mapping."
|
| 4914 | },
|
| 4915 | "immutable": true,
|
| 4916 | "locationInModule": {
|
| 4917 | "filename": "lib/lambda.generated.ts",
|
| 4918 | "line": 1371
|
| 4919 | },
|
| 4920 | "name": "functionResponseTypes",
|
| 4921 | "optional": true,
|
| 4922 | "type": {
|
| 4923 | "collection": {
|
| 4924 | "elementtype": {
|
| 4925 | "primitive": "string"
|
| 4926 | },
|
| 4927 | "kind": "array"
|
| 4928 | }
|
| 4929 | }
|
| 4930 | },
|
| 4931 | {
|
| 4932 | "abstract": true,
|
| 4933 | "docs": {
|
| 4934 | "custom": {
|
| 4935 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds"
|
| 4936 | },
|
| 4937 | "remarks": "*Default ( Kinesis , DynamoDB , Amazon SQS event sources)* : 0\n\n*Default ( Amazon MSK , Kafka, Amazon MQ event sources)* : 500 ms\n\n*Related setting:* When you set `BatchSize` to a value greater than 10, you must set `MaximumBatchingWindowInSeconds` to at least 1.",
|
| 4938 | "stability": "external",
|
| 4939 | "summary": "The maximum amount of time, in seconds, that Lambda spends gathering records before invoking the function."
|
| 4940 | },
|
| 4941 | "immutable": true,
|
| 4942 | "locationInModule": {
|
| 4943 | "filename": "lib/lambda.generated.ts",
|
| 4944 | "line": 1384
|
| 4945 | },
|
| 4946 | "name": "maximumBatchingWindowInSeconds",
|
| 4947 | "optional": true,
|
| 4948 | "type": {
|
| 4949 | "primitive": "number"
|
| 4950 | }
|
| 4951 | },
|
| 4952 | {
|
| 4953 | "abstract": true,
|
| 4954 | "docs": {
|
| 4955 | "custom": {
|
| 4956 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumrecordageinseconds"
|
| 4957 | },
|
| 4958 | "remarks": "The default value is -1,\nwhich sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records.",
|
| 4959 | "stability": "external",
|
| 4960 | "summary": "(Streams only) Discard records older than the specified age."
|
| 4961 | },
|
| 4962 | "immutable": true,
|
| 4963 | "locationInModule": {
|
| 4964 | "filename": "lib/lambda.generated.ts",
|
| 4965 | "line": 1392
|
| 4966 | },
|
| 4967 | "name": "maximumRecordAgeInSeconds",
|
| 4968 | "optional": true,
|
| 4969 | "type": {
|
| 4970 | "primitive": "number"
|
| 4971 | }
|
| 4972 | },
|
| 4973 | {
|
| 4974 | "abstract": true,
|
| 4975 | "docs": {
|
| 4976 | "custom": {
|
| 4977 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumretryattempts"
|
| 4978 | },
|
| 4979 | "remarks": "The default value is -1,\nwhich sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, Lambda retries failed records until the record expires in the event source.",
|
| 4980 | "stability": "external",
|
| 4981 | "summary": "(Streams only) Discard records after the specified number of retries."
|
| 4982 | },
|
| 4983 | "immutable": true,
|
| 4984 | "locationInModule": {
|
| 4985 | "filename": "lib/lambda.generated.ts",
|
| 4986 | "line": 1400
|
| 4987 | },
|
| 4988 | "name": "maximumRetryAttempts",
|
| 4989 | "optional": true,
|
| 4990 | "type": {
|
| 4991 | "primitive": "number"
|
| 4992 | }
|
| 4993 | },
|
| 4994 | {
|
| 4995 | "abstract": true,
|
| 4996 | "docs": {
|
| 4997 | "custom": {
|
| 4998 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-parallelizationfactor"
|
| 4999 | },
|
| 5000 | "remarks": "The default value is 1.",
|
| 5001 | "stability": "external",
|
| 5002 | "summary": "(Streams only) The number of batches to process concurrently from each shard."
|
| 5003 | },
|
| 5004 | "immutable": true,
|
| 5005 | "locationInModule": {
|
| 5006 | "filename": "lib/lambda.generated.ts",
|
| 5007 | "line": 1407
|
| 5008 | },
|
| 5009 | "name": "parallelizationFactor",
|
| 5010 | "optional": true,
|
| 5011 | "type": {
|
| 5012 | "primitive": "number"
|
| 5013 | }
|
| 5014 | },
|
| 5015 | {
|
| 5016 | "abstract": true,
|
| 5017 | "docs": {
|
| 5018 | "custom": {
|
| 5019 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-queues"
|
| 5020 | },
|
| 5021 | "stability": "external",
|
| 5022 | "summary": "(Amazon MQ) The name of the Amazon MQ broker destination queue to consume."
|
| 5023 | },
|
| 5024 | "immutable": true,
|
| 5025 | "locationInModule": {
|
| 5026 | "filename": "lib/lambda.generated.ts",
|
| 5027 | "line": 1414
|
| 5028 | },
|
| 5029 | "name": "queues",
|
| 5030 | "optional": true,
|
| 5031 | "type": {
|
| 5032 | "collection": {
|
| 5033 | "elementtype": {
|
| 5034 | "primitive": "string"
|
| 5035 | },
|
| 5036 | "kind": "array"
|
| 5037 | }
|
| 5038 | }
|
| 5039 | },
|
| 5040 | {
|
| 5041 | "abstract": true,
|
| 5042 | "docs": {
|
| 5043 | "custom": {
|
| 5044 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-scalingconfig"
|
| 5045 | },
|
| 5046 | "remarks": "For more information, see [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency) .",
|
| 5047 | "stability": "external",
|
| 5048 | "summary": "(Amazon SQS only) The scaling configuration for the event source."
|
| 5049 | },
|
| 5050 | "immutable": true,
|
| 5051 | "locationInModule": {
|
| 5052 | "filename": "lib/lambda.generated.ts",
|
| 5053 | "line": 1421
|
| 5054 | },
|
| 5055 | "name": "scalingConfig",
|
| 5056 | "optional": true,
|
| 5057 | "type": {
|
| 5058 | "union": {
|
| 5059 | "types": [
|
| 5060 | {
|
| 5061 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5062 | },
|
| 5063 | {
|
| 5064 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.ScalingConfigProperty"
|
| 5065 | }
|
| 5066 | ]
|
| 5067 | }
|
| 5068 | }
|
| 5069 | },
|
| 5070 | {
|
| 5071 | "abstract": true,
|
| 5072 | "docs": {
|
| 5073 | "custom": {
|
| 5074 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedeventsource"
|
| 5075 | },
|
| 5076 | "stability": "external",
|
| 5077 | "summary": "The self-managed Apache Kafka cluster for your event source."
|
| 5078 | },
|
| 5079 | "immutable": true,
|
| 5080 | "locationInModule": {
|
| 5081 | "filename": "lib/lambda.generated.ts",
|
| 5082 | "line": 1428
|
| 5083 | },
|
| 5084 | "name": "selfManagedEventSource",
|
| 5085 | "optional": true,
|
| 5086 | "type": {
|
| 5087 | "union": {
|
| 5088 | "types": [
|
| 5089 | {
|
| 5090 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5091 | },
|
| 5092 | {
|
| 5093 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SelfManagedEventSourceProperty"
|
| 5094 | }
|
| 5095 | ]
|
| 5096 | }
|
| 5097 | }
|
| 5098 | },
|
| 5099 | {
|
| 5100 | "abstract": true,
|
| 5101 | "docs": {
|
| 5102 | "custom": {
|
| 5103 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-selfmanagedkafkaeventsourceconfig"
|
| 5104 | },
|
| 5105 | "stability": "external",
|
| 5106 | "summary": "Specific configuration settings for a self-managed Apache Kafka event source."
|
| 5107 | },
|
| 5108 | "immutable": true,
|
| 5109 | "locationInModule": {
|
| 5110 | "filename": "lib/lambda.generated.ts",
|
| 5111 | "line": 1435
|
| 5112 | },
|
| 5113 | "name": "selfManagedKafkaEventSourceConfig",
|
| 5114 | "optional": true,
|
| 5115 | "type": {
|
| 5116 | "union": {
|
| 5117 | "types": [
|
| 5118 | {
|
| 5119 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5120 | },
|
| 5121 | {
|
| 5122 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SelfManagedKafkaEventSourceConfigProperty"
|
| 5123 | }
|
| 5124 | ]
|
| 5125 | }
|
| 5126 | }
|
| 5127 | },
|
| 5128 | {
|
| 5129 | "abstract": true,
|
| 5130 | "docs": {
|
| 5131 | "custom": {
|
| 5132 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-sourceaccessconfigurations"
|
| 5133 | },
|
| 5134 | "stability": "external",
|
| 5135 | "summary": "An array of the authentication protocol, VPC components, or virtual host to secure and define your event source."
|
| 5136 | },
|
| 5137 | "immutable": true,
|
| 5138 | "locationInModule": {
|
| 5139 | "filename": "lib/lambda.generated.ts",
|
| 5140 | "line": 1442
|
| 5141 | },
|
| 5142 | "name": "sourceAccessConfigurations",
|
| 5143 | "optional": true,
|
| 5144 | "type": {
|
| 5145 | "union": {
|
| 5146 | "types": [
|
| 5147 | {
|
| 5148 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5149 | },
|
| 5150 | {
|
| 5151 | "collection": {
|
| 5152 | "elementtype": {
|
| 5153 | "union": {
|
| 5154 | "types": [
|
| 5155 | {
|
| 5156 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5157 | },
|
| 5158 | {
|
| 5159 | "fqn": "@aws-cdk/aws-lambda.CfnEventSourceMapping.SourceAccessConfigurationProperty"
|
| 5160 | }
|
| 5161 | ]
|
| 5162 | }
|
| 5163 | },
|
| 5164 | "kind": "array"
|
| 5165 | }
|
| 5166 | }
|
| 5167 | ]
|
| 5168 | }
|
| 5169 | }
|
| 5170 | },
|
| 5171 | {
|
| 5172 | "abstract": true,
|
| 5173 | "docs": {
|
| 5174 | "custom": {
|
| 5175 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingposition"
|
| 5176 | },
|
| 5177 | "remarks": "- *LATEST* - Read only new records.\n- *TRIM_HORIZON* - Process all available records.\n- *AT_TIMESTAMP* - Specify a time from which to start reading records.",
|
| 5178 | "stability": "external",
|
| 5179 | "summary": "The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB."
|
| 5180 | },
|
| 5181 | "immutable": true,
|
| 5182 | "locationInModule": {
|
| 5183 | "filename": "lib/lambda.generated.ts",
|
| 5184 | "line": 1453
|
| 5185 | },
|
| 5186 | "name": "startingPosition",
|
| 5187 | "optional": true,
|
| 5188 | "type": {
|
| 5189 | "primitive": "string"
|
| 5190 | }
|
| 5191 | },
|
| 5192 | {
|
| 5193 | "abstract": true,
|
| 5194 | "docs": {
|
| 5195 | "custom": {
|
| 5196 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-startingpositiontimestamp"
|
| 5197 | },
|
| 5198 | "stability": "external",
|
| 5199 | "summary": "With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds."
|
| 5200 | },
|
| 5201 | "immutable": true,
|
| 5202 | "locationInModule": {
|
| 5203 | "filename": "lib/lambda.generated.ts",
|
| 5204 | "line": 1460
|
| 5205 | },
|
| 5206 | "name": "startingPositionTimestamp",
|
| 5207 | "optional": true,
|
| 5208 | "type": {
|
| 5209 | "primitive": "number"
|
| 5210 | }
|
| 5211 | },
|
| 5212 | {
|
| 5213 | "abstract": true,
|
| 5214 | "docs": {
|
| 5215 | "custom": {
|
| 5216 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-topics"
|
| 5217 | },
|
| 5218 | "stability": "external",
|
| 5219 | "summary": "The name of the Kafka topic."
|
| 5220 | },
|
| 5221 | "immutable": true,
|
| 5222 | "locationInModule": {
|
| 5223 | "filename": "lib/lambda.generated.ts",
|
| 5224 | "line": 1467
|
| 5225 | },
|
| 5226 | "name": "topics",
|
| 5227 | "optional": true,
|
| 5228 | "type": {
|
| 5229 | "collection": {
|
| 5230 | "elementtype": {
|
| 5231 | "primitive": "string"
|
| 5232 | },
|
| 5233 | "kind": "array"
|
| 5234 | }
|
| 5235 | }
|
| 5236 | },
|
| 5237 | {
|
| 5238 | "abstract": true,
|
| 5239 | "docs": {
|
| 5240 | "custom": {
|
| 5241 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-tumblingwindowinseconds"
|
| 5242 | },
|
| 5243 | "remarks": "The range is between 1 second and 900 seconds.",
|
| 5244 | "stability": "external",
|
| 5245 | "summary": "(Streams only) The duration in seconds of a processing window."
|
| 5246 | },
|
| 5247 | "immutable": true,
|
| 5248 | "locationInModule": {
|
| 5249 | "filename": "lib/lambda.generated.ts",
|
| 5250 | "line": 1474
|
| 5251 | },
|
| 5252 | "name": "tumblingWindowInSeconds",
|
| 5253 | "optional": true,
|
| 5254 | "type": {
|
| 5255 | "primitive": "number"
|
| 5256 | }
|
| 5257 | }
|
| 5258 | ],
|
| 5259 | "symbolId": "lib/lambda.generated:CfnEventSourceMappingProps"
|
| 5260 | },
|
| 5261 | "@aws-cdk/aws-lambda.CfnFunction": {
|
| 5262 | "assembly": "@aws-cdk/aws-lambda",
|
| 5263 | "base": "@aws-cdk/core.CfnResource",
|
| 5264 | "docs": {
|
| 5265 | "custom": {
|
| 5266 | "cloudformationResource": "AWS::Lambda::Function",
|
| 5267 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html",
|
| 5268 | "exampleMetadata": "fixture=_generated"
|
| 5269 | },
|
| 5270 | "remarks": "The `AWS::Lambda::Function` resource creates a Lambda function. To create a function, you need a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) and an [execution role](https://docs.aws.amazon.com/lambda/latest/dg/lambda-intro-execution-role.html) . The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.\n\nYou set the package type to `Image` if the deployment package is a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) . For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.\n\nYou set the package type to `Zip` if the deployment package is a [.zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html#gettingstarted-package-zip) . For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. For a Python example, see [Deploy Python Lambda functions with .zip file archives](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html) .\n\nYou can use [code signing](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html) if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with `UpdateFunctionCode` , Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.\n\nNote that you configure [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) on a `AWS::Lambda::Version` or a `AWS::Lambda::Alias` .\n\nFor a complete introduction to Lambda functions, see [What is Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/lambda-welcome.html) in the *Lambda developer guide.*",
|
| 5271 | "stability": "external",
|
| 5272 | "summary": "A CloudFormation `AWS::Lambda::Function`.",
|
| 5273 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnFunction = new lambda.CfnFunction(this, 'MyCfnFunction', {\n code: {\n imageUri: 'imageUri',\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n s3ObjectVersion: 's3ObjectVersion',\n zipFile: 'zipFile',\n },\n role: 'role',\n\n // the properties below are optional\n architectures: ['architectures'],\n codeSigningConfigArn: 'codeSigningConfigArn',\n deadLetterConfig: {\n targetArn: 'targetArn',\n },\n description: 'description',\n environment: {\n variables: {\n variablesKey: 'variables',\n },\n },\n ephemeralStorage: {\n size: 123,\n },\n fileSystemConfigs: [{\n arn: 'arn',\n localMountPath: 'localMountPath',\n }],\n functionName: 'functionName',\n handler: 'handler',\n imageConfig: {\n command: ['command'],\n entryPoint: ['entryPoint'],\n workingDirectory: 'workingDirectory',\n },\n kmsKeyArn: 'kmsKeyArn',\n layers: ['layers'],\n memorySize: 123,\n packageType: 'packageType',\n reservedConcurrentExecutions: 123,\n runtime: 'runtime',\n snapStart: {\n applyOn: 'applyOn',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n timeout: 123,\n tracingConfig: {\n mode: 'mode',\n },\n vpcConfig: {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n },\n});"
|
| 5274 | },
|
| 5275 | "fqn": "@aws-cdk/aws-lambda.CfnFunction",
|
| 5276 | "initializer": {
|
| 5277 | "docs": {
|
| 5278 | "stability": "external",
|
| 5279 | "summary": "Create a new `AWS::Lambda::Function`."
|
| 5280 | },
|
| 5281 | "locationInModule": {
|
| 5282 | "filename": "lib/lambda.generated.ts",
|
| 5283 | "line": 3120
|
| 5284 | },
|
| 5285 | "parameters": [
|
| 5286 | {
|
| 5287 | "docs": {
|
| 5288 | "summary": "- scope in which this resource is defined."
|
| 5289 | },
|
| 5290 | "name": "scope",
|
| 5291 | "type": {
|
| 5292 | "fqn": "@aws-cdk/core.Construct"
|
| 5293 | }
|
| 5294 | },
|
| 5295 | {
|
| 5296 | "docs": {
|
| 5297 | "summary": "- scoped id of the resource."
|
| 5298 | },
|
| 5299 | "name": "id",
|
| 5300 | "type": {
|
| 5301 | "primitive": "string"
|
| 5302 | }
|
| 5303 | },
|
| 5304 | {
|
| 5305 | "docs": {
|
| 5306 | "summary": "- resource properties."
|
| 5307 | },
|
| 5308 | "name": "props",
|
| 5309 | "type": {
|
| 5310 | "fqn": "@aws-cdk/aws-lambda.CfnFunctionProps"
|
| 5311 | }
|
| 5312 | }
|
| 5313 | ]
|
| 5314 | },
|
| 5315 | "interfaces": [
|
| 5316 | "@aws-cdk/core.IInspectable"
|
| 5317 | ],
|
| 5318 | "kind": "class",
|
| 5319 | "locationInModule": {
|
| 5320 | "filename": "lib/lambda.generated.ts",
|
| 5321 | "line": 2904
|
| 5322 | },
|
| 5323 | "methods": [
|
| 5324 | {
|
| 5325 | "docs": {
|
| 5326 | "stability": "external",
|
| 5327 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 5328 | },
|
| 5329 | "locationInModule": {
|
| 5330 | "filename": "lib/lambda.generated.ts",
|
| 5331 | "line": 3159
|
| 5332 | },
|
| 5333 | "name": "inspect",
|
| 5334 | "overrides": "@aws-cdk/core.IInspectable",
|
| 5335 | "parameters": [
|
| 5336 | {
|
| 5337 | "docs": {
|
| 5338 | "summary": "- tree inspector to collect and process attributes."
|
| 5339 | },
|
| 5340 | "name": "inspector",
|
| 5341 | "type": {
|
| 5342 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 5343 | }
|
| 5344 | }
|
| 5345 | ]
|
| 5346 | },
|
| 5347 | {
|
| 5348 | "docs": {
|
| 5349 | "stability": "external"
|
| 5350 | },
|
| 5351 | "locationInModule": {
|
| 5352 | "filename": "lib/lambda.generated.ts",
|
| 5353 | "line": 3192
|
| 5354 | },
|
| 5355 | "name": "renderProperties",
|
| 5356 | "overrides": "@aws-cdk/core.CfnResource",
|
| 5357 | "parameters": [
|
| 5358 | {
|
| 5359 | "name": "props",
|
| 5360 | "type": {
|
| 5361 | "collection": {
|
| 5362 | "elementtype": {
|
| 5363 | "primitive": "any"
|
| 5364 | },
|
| 5365 | "kind": "map"
|
| 5366 | }
|
| 5367 | }
|
| 5368 | }
|
| 5369 | ],
|
| 5370 | "protected": true,
|
| 5371 | "returns": {
|
| 5372 | "type": {
|
| 5373 | "collection": {
|
| 5374 | "elementtype": {
|
| 5375 | "primitive": "any"
|
| 5376 | },
|
| 5377 | "kind": "map"
|
| 5378 | }
|
| 5379 | }
|
| 5380 | }
|
| 5381 | }
|
| 5382 | ],
|
| 5383 | "name": "CfnFunction",
|
| 5384 | "properties": [
|
| 5385 | {
|
| 5386 | "const": true,
|
| 5387 | "docs": {
|
| 5388 | "stability": "external",
|
| 5389 | "summary": "The CloudFormation resource type name for this resource class."
|
| 5390 | },
|
| 5391 | "immutable": true,
|
| 5392 | "locationInModule": {
|
| 5393 | "filename": "lib/lambda.generated.ts",
|
| 5394 | "line": 2908
|
| 5395 | },
|
| 5396 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 5397 | "static": true,
|
| 5398 | "type": {
|
| 5399 | "primitive": "string"
|
| 5400 | }
|
| 5401 | },
|
| 5402 | {
|
| 5403 | "docs": {
|
| 5404 | "custom": {
|
| 5405 | "cloudformationAttribute": "Arn"
|
| 5406 | },
|
| 5407 | "stability": "external",
|
| 5408 | "summary": "The Amazon Resource Name (ARN) of the function."
|
| 5409 | },
|
| 5410 | "immutable": true,
|
| 5411 | "locationInModule": {
|
| 5412 | "filename": "lib/lambda.generated.ts",
|
| 5413 | "line": 2933
|
| 5414 | },
|
| 5415 | "name": "attrArn",
|
| 5416 | "type": {
|
| 5417 | "primitive": "string"
|
| 5418 | }
|
| 5419 | },
|
| 5420 | {
|
| 5421 | "docs": {
|
| 5422 | "custom": {
|
| 5423 | "cloudformationAttribute": "SnapStartResponse.ApplyOn"
|
| 5424 | },
|
| 5425 | "stability": "external"
|
| 5426 | },
|
| 5427 | "immutable": true,
|
| 5428 | "locationInModule": {
|
| 5429 | "filename": "lib/lambda.generated.ts",
|
| 5430 | "line": 2939
|
| 5431 | },
|
| 5432 | "name": "attrSnapStartResponseApplyOn",
|
| 5433 | "type": {
|
| 5434 | "primitive": "string"
|
| 5435 | }
|
| 5436 | },
|
| 5437 | {
|
| 5438 | "docs": {
|
| 5439 | "custom": {
|
| 5440 | "cloudformationAttribute": "SnapStartResponse.OptimizationStatus"
|
| 5441 | },
|
| 5442 | "stability": "external"
|
| 5443 | },
|
| 5444 | "immutable": true,
|
| 5445 | "locationInModule": {
|
| 5446 | "filename": "lib/lambda.generated.ts",
|
| 5447 | "line": 2945
|
| 5448 | },
|
| 5449 | "name": "attrSnapStartResponseOptimizationStatus",
|
| 5450 | "type": {
|
| 5451 | "primitive": "string"
|
| 5452 | }
|
| 5453 | },
|
| 5454 | {
|
| 5455 | "docs": {
|
| 5456 | "stability": "external"
|
| 5457 | },
|
| 5458 | "immutable": true,
|
| 5459 | "locationInModule": {
|
| 5460 | "filename": "lib/lambda.generated.ts",
|
| 5461 | "line": 3164
|
| 5462 | },
|
| 5463 | "name": "cfnProperties",
|
| 5464 | "overrides": "@aws-cdk/core.CfnResource",
|
| 5465 | "protected": true,
|
| 5466 | "type": {
|
| 5467 | "collection": {
|
| 5468 | "elementtype": {
|
| 5469 | "primitive": "any"
|
| 5470 | },
|
| 5471 | "kind": "map"
|
| 5472 | }
|
| 5473 | }
|
| 5474 | },
|
| 5475 | {
|
| 5476 | "docs": {
|
| 5477 | "custom": {
|
| 5478 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags"
|
| 5479 | },
|
| 5480 | "stability": "external",
|
| 5481 | "summary": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function."
|
| 5482 | },
|
| 5483 | "immutable": true,
|
| 5484 | "locationInModule": {
|
| 5485 | "filename": "lib/lambda.generated.ts",
|
| 5486 | "line": 3090
|
| 5487 | },
|
| 5488 | "name": "tags",
|
| 5489 | "type": {
|
| 5490 | "fqn": "@aws-cdk/core.TagManager"
|
| 5491 | }
|
| 5492 | },
|
| 5493 | {
|
| 5494 | "docs": {
|
| 5495 | "custom": {
|
| 5496 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code"
|
| 5497 | },
|
| 5498 | "stability": "external",
|
| 5499 | "summary": "The code for the function."
|
| 5500 | },
|
| 5501 | "locationInModule": {
|
| 5502 | "filename": "lib/lambda.generated.ts",
|
| 5503 | "line": 2952
|
| 5504 | },
|
| 5505 | "name": "code",
|
| 5506 | "type": {
|
| 5507 | "union": {
|
| 5508 | "types": [
|
| 5509 | {
|
| 5510 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5511 | },
|
| 5512 | {
|
| 5513 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.CodeProperty"
|
| 5514 | }
|
| 5515 | ]
|
| 5516 | }
|
| 5517 | }
|
| 5518 | },
|
| 5519 | {
|
| 5520 | "docs": {
|
| 5521 | "custom": {
|
| 5522 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role"
|
| 5523 | },
|
| 5524 | "stability": "external",
|
| 5525 | "summary": "The Amazon Resource Name (ARN) of the function's execution role."
|
| 5526 | },
|
| 5527 | "locationInModule": {
|
| 5528 | "filename": "lib/lambda.generated.ts",
|
| 5529 | "line": 2959
|
| 5530 | },
|
| 5531 | "name": "role",
|
| 5532 | "type": {
|
| 5533 | "primitive": "string"
|
| 5534 | }
|
| 5535 | },
|
| 5536 | {
|
| 5537 | "docs": {
|
| 5538 | "custom": {
|
| 5539 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures"
|
| 5540 | },
|
| 5541 | "remarks": "Enter a string array with one of the valid values (arm64 or x86_64). The default value is `x86_64` .",
|
| 5542 | "stability": "external",
|
| 5543 | "summary": "The instruction set architecture that the function supports."
|
| 5544 | },
|
| 5545 | "locationInModule": {
|
| 5546 | "filename": "lib/lambda.generated.ts",
|
| 5547 | "line": 2966
|
| 5548 | },
|
| 5549 | "name": "architectures",
|
| 5550 | "optional": true,
|
| 5551 | "type": {
|
| 5552 | "collection": {
|
| 5553 | "elementtype": {
|
| 5554 | "primitive": "string"
|
| 5555 | },
|
| 5556 | "kind": "array"
|
| 5557 | }
|
| 5558 | }
|
| 5559 | },
|
| 5560 | {
|
| 5561 | "docs": {
|
| 5562 | "custom": {
|
| 5563 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn"
|
| 5564 | },
|
| 5565 | "remarks": "A code-signing configuration\nincludes a set of signing profiles, which define the trusted publishers for this function.",
|
| 5566 | "stability": "external",
|
| 5567 | "summary": "To enable code signing for this function, specify the ARN of a code-signing configuration."
|
| 5568 | },
|
| 5569 | "locationInModule": {
|
| 5570 | "filename": "lib/lambda.generated.ts",
|
| 5571 | "line": 2974
|
| 5572 | },
|
| 5573 | "name": "codeSigningConfigArn",
|
| 5574 | "optional": true,
|
| 5575 | "type": {
|
| 5576 | "primitive": "string"
|
| 5577 | }
|
| 5578 | },
|
| 5579 | {
|
| 5580 | "docs": {
|
| 5581 | "custom": {
|
| 5582 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig"
|
| 5583 | },
|
| 5584 | "remarks": "For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) .",
|
| 5585 | "stability": "external",
|
| 5586 | "summary": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing."
|
| 5587 | },
|
| 5588 | "locationInModule": {
|
| 5589 | "filename": "lib/lambda.generated.ts",
|
| 5590 | "line": 2981
|
| 5591 | },
|
| 5592 | "name": "deadLetterConfig",
|
| 5593 | "optional": true,
|
| 5594 | "type": {
|
| 5595 | "union": {
|
| 5596 | "types": [
|
| 5597 | {
|
| 5598 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5599 | },
|
| 5600 | {
|
| 5601 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.DeadLetterConfigProperty"
|
| 5602 | }
|
| 5603 | ]
|
| 5604 | }
|
| 5605 | }
|
| 5606 | },
|
| 5607 | {
|
| 5608 | "docs": {
|
| 5609 | "custom": {
|
| 5610 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description"
|
| 5611 | },
|
| 5612 | "stability": "external",
|
| 5613 | "summary": "A description of the function."
|
| 5614 | },
|
| 5615 | "locationInModule": {
|
| 5616 | "filename": "lib/lambda.generated.ts",
|
| 5617 | "line": 2988
|
| 5618 | },
|
| 5619 | "name": "description",
|
| 5620 | "optional": true,
|
| 5621 | "type": {
|
| 5622 | "primitive": "string"
|
| 5623 | }
|
| 5624 | },
|
| 5625 | {
|
| 5626 | "docs": {
|
| 5627 | "custom": {
|
| 5628 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment"
|
| 5629 | },
|
| 5630 | "stability": "external",
|
| 5631 | "summary": "Environment variables that are accessible from function code during execution."
|
| 5632 | },
|
| 5633 | "locationInModule": {
|
| 5634 | "filename": "lib/lambda.generated.ts",
|
| 5635 | "line": 2995
|
| 5636 | },
|
| 5637 | "name": "environment",
|
| 5638 | "optional": true,
|
| 5639 | "type": {
|
| 5640 | "union": {
|
| 5641 | "types": [
|
| 5642 | {
|
| 5643 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5644 | },
|
| 5645 | {
|
| 5646 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.EnvironmentProperty"
|
| 5647 | }
|
| 5648 | ]
|
| 5649 | }
|
| 5650 | }
|
| 5651 | },
|
| 5652 | {
|
| 5653 | "docs": {
|
| 5654 | "custom": {
|
| 5655 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage"
|
| 5656 | },
|
| 5657 | "remarks": "The default value is 512, but it can be any whole number between 512 and 10,240 MB.",
|
| 5658 | "stability": "external",
|
| 5659 | "summary": "The size of the function's `/tmp` directory in MB."
|
| 5660 | },
|
| 5661 | "locationInModule": {
|
| 5662 | "filename": "lib/lambda.generated.ts",
|
| 5663 | "line": 3002
|
| 5664 | },
|
| 5665 | "name": "ephemeralStorage",
|
| 5666 | "optional": true,
|
| 5667 | "type": {
|
| 5668 | "union": {
|
| 5669 | "types": [
|
| 5670 | {
|
| 5671 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5672 | },
|
| 5673 | {
|
| 5674 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.EphemeralStorageProperty"
|
| 5675 | }
|
| 5676 | ]
|
| 5677 | }
|
| 5678 | }
|
| 5679 | },
|
| 5680 | {
|
| 5681 | "docs": {
|
| 5682 | "custom": {
|
| 5683 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs"
|
| 5684 | },
|
| 5685 | "remarks": "To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a `DependsOn` attribute to ensure that the mount target is created or updated before the function.\n\nFor more information about using the `DependsOn` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) .",
|
| 5686 | "stability": "external",
|
| 5687 | "summary": "Connection settings for an Amazon EFS file system."
|
| 5688 | },
|
| 5689 | "locationInModule": {
|
| 5690 | "filename": "lib/lambda.generated.ts",
|
| 5691 | "line": 3011
|
| 5692 | },
|
| 5693 | "name": "fileSystemConfigs",
|
| 5694 | "optional": true,
|
| 5695 | "type": {
|
| 5696 | "union": {
|
| 5697 | "types": [
|
| 5698 | {
|
| 5699 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5700 | },
|
| 5701 | {
|
| 5702 | "collection": {
|
| 5703 | "elementtype": {
|
| 5704 | "union": {
|
| 5705 | "types": [
|
| 5706 | {
|
| 5707 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5708 | },
|
| 5709 | {
|
| 5710 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.FileSystemConfigProperty"
|
| 5711 | }
|
| 5712 | ]
|
| 5713 | }
|
| 5714 | },
|
| 5715 | "kind": "array"
|
| 5716 | }
|
| 5717 | }
|
| 5718 | ]
|
| 5719 | }
|
| 5720 | }
|
| 5721 | },
|
| 5722 | {
|
| 5723 | "docs": {
|
| 5724 | "custom": {
|
| 5725 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname"
|
| 5726 | },
|
| 5727 | "remarks": "If you don't specify a name, AWS CloudFormation generates one.\n\nIf you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
|
| 5728 | "stability": "external",
|
| 5729 | "summary": "The name of the Lambda function, up to 64 characters in length."
|
| 5730 | },
|
| 5731 | "locationInModule": {
|
| 5732 | "filename": "lib/lambda.generated.ts",
|
| 5733 | "line": 3020
|
| 5734 | },
|
| 5735 | "name": "functionName",
|
| 5736 | "optional": true,
|
| 5737 | "type": {
|
| 5738 | "primitive": "string"
|
| 5739 | }
|
| 5740 | },
|
| 5741 | {
|
| 5742 | "docs": {
|
| 5743 | "custom": {
|
| 5744 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler"
|
| 5745 | },
|
| 5746 | "remarks": "Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html) .",
|
| 5747 | "stability": "external",
|
| 5748 | "summary": "The name of the method within your code that Lambda calls to run your function."
|
| 5749 | },
|
| 5750 | "locationInModule": {
|
| 5751 | "filename": "lib/lambda.generated.ts",
|
| 5752 | "line": 3027
|
| 5753 | },
|
| 5754 | "name": "handler",
|
| 5755 | "optional": true,
|
| 5756 | "type": {
|
| 5757 | "primitive": "string"
|
| 5758 | }
|
| 5759 | },
|
| 5760 | {
|
| 5761 | "docs": {
|
| 5762 | "custom": {
|
| 5763 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig"
|
| 5764 | },
|
| 5765 | "remarks": "For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms) .",
|
| 5766 | "stability": "external",
|
| 5767 | "summary": "Configuration values that override the container image Dockerfile settings."
|
| 5768 | },
|
| 5769 | "locationInModule": {
|
| 5770 | "filename": "lib/lambda.generated.ts",
|
| 5771 | "line": 3034
|
| 5772 | },
|
| 5773 | "name": "imageConfig",
|
| 5774 | "optional": true,
|
| 5775 | "type": {
|
| 5776 | "union": {
|
| 5777 | "types": [
|
| 5778 | {
|
| 5779 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5780 | },
|
| 5781 | {
|
| 5782 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.ImageConfigProperty"
|
| 5783 | }
|
| 5784 | ]
|
| 5785 | }
|
| 5786 | }
|
| 5787 | },
|
| 5788 | {
|
| 5789 | "docs": {
|
| 5790 | "custom": {
|
| 5791 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn"
|
| 5792 | },
|
| 5793 | "remarks": "If it's not provided, Lambda uses a default service key.",
|
| 5794 | "stability": "external",
|
| 5795 | "summary": "The ARN of the AWS Key Management Service ( AWS KMS ) key that's used to encrypt your function's environment variables."
|
| 5796 | },
|
| 5797 | "locationInModule": {
|
| 5798 | "filename": "lib/lambda.generated.ts",
|
| 5799 | "line": 3041
|
| 5800 | },
|
| 5801 | "name": "kmsKeyArn",
|
| 5802 | "optional": true,
|
| 5803 | "type": {
|
| 5804 | "primitive": "string"
|
| 5805 | }
|
| 5806 | },
|
| 5807 | {
|
| 5808 | "docs": {
|
| 5809 | "custom": {
|
| 5810 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers"
|
| 5811 | },
|
| 5812 | "stability": "external",
|
| 5813 | "summary": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version."
|
| 5814 | },
|
| 5815 | "locationInModule": {
|
| 5816 | "filename": "lib/lambda.generated.ts",
|
| 5817 | "line": 3048
|
| 5818 | },
|
| 5819 | "name": "layers",
|
| 5820 | "optional": true,
|
| 5821 | "type": {
|
| 5822 | "collection": {
|
| 5823 | "elementtype": {
|
| 5824 | "primitive": "string"
|
| 5825 | },
|
| 5826 | "kind": "array"
|
| 5827 | }
|
| 5828 | }
|
| 5829 | },
|
| 5830 | {
|
| 5831 | "docs": {
|
| 5832 | "custom": {
|
| 5833 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize"
|
| 5834 | },
|
| 5835 | "stability": "external",
|
| 5836 | "summary": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB."
|
| 5837 | },
|
| 5838 | "locationInModule": {
|
| 5839 | "filename": "lib/lambda.generated.ts",
|
| 5840 | "line": 3055
|
| 5841 | },
|
| 5842 | "name": "memorySize",
|
| 5843 | "optional": true,
|
| 5844 | "type": {
|
| 5845 | "primitive": "number"
|
| 5846 | }
|
| 5847 | },
|
| 5848 | {
|
| 5849 | "docs": {
|
| 5850 | "custom": {
|
| 5851 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype"
|
| 5852 | },
|
| 5853 | "remarks": "Set to `Image` for container image and set `Zip` for .zip file archive.",
|
| 5854 | "stability": "external",
|
| 5855 | "summary": "The type of deployment package."
|
| 5856 | },
|
| 5857 | "locationInModule": {
|
| 5858 | "filename": "lib/lambda.generated.ts",
|
| 5859 | "line": 3062
|
| 5860 | },
|
| 5861 | "name": "packageType",
|
| 5862 | "optional": true,
|
| 5863 | "type": {
|
| 5864 | "primitive": "string"
|
| 5865 | }
|
| 5866 | },
|
| 5867 | {
|
| 5868 | "docs": {
|
| 5869 | "custom": {
|
| 5870 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions"
|
| 5871 | },
|
| 5872 | "stability": "external",
|
| 5873 | "summary": "The number of simultaneous executions to reserve for the function."
|
| 5874 | },
|
| 5875 | "locationInModule": {
|
| 5876 | "filename": "lib/lambda.generated.ts",
|
| 5877 | "line": 3069
|
| 5878 | },
|
| 5879 | "name": "reservedConcurrentExecutions",
|
| 5880 | "optional": true,
|
| 5881 | "type": {
|
| 5882 | "primitive": "number"
|
| 5883 | }
|
| 5884 | },
|
| 5885 | {
|
| 5886 | "docs": {
|
| 5887 | "custom": {
|
| 5888 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime"
|
| 5889 | },
|
| 5890 | "stability": "external",
|
| 5891 | "summary": "The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Runtime is required if the deployment package is a .zip file archive."
|
| 5892 | },
|
| 5893 | "locationInModule": {
|
| 5894 | "filename": "lib/lambda.generated.ts",
|
| 5895 | "line": 3076
|
| 5896 | },
|
| 5897 | "name": "runtime",
|
| 5898 | "optional": true,
|
| 5899 | "type": {
|
| 5900 | "primitive": "string"
|
| 5901 | }
|
| 5902 | },
|
| 5903 | {
|
| 5904 | "docs": {
|
| 5905 | "custom": {
|
| 5906 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-snapstart"
|
| 5907 | },
|
| 5908 | "stability": "external",
|
| 5909 | "summary": "The function's [AWS Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting."
|
| 5910 | },
|
| 5911 | "locationInModule": {
|
| 5912 | "filename": "lib/lambda.generated.ts",
|
| 5913 | "line": 3083
|
| 5914 | },
|
| 5915 | "name": "snapStart",
|
| 5916 | "optional": true,
|
| 5917 | "type": {
|
| 5918 | "union": {
|
| 5919 | "types": [
|
| 5920 | {
|
| 5921 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5922 | },
|
| 5923 | {
|
| 5924 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.SnapStartProperty"
|
| 5925 | }
|
| 5926 | ]
|
| 5927 | }
|
| 5928 | }
|
| 5929 | },
|
| 5930 | {
|
| 5931 | "docs": {
|
| 5932 | "custom": {
|
| 5933 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout"
|
| 5934 | },
|
| 5935 | "remarks": "The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) .",
|
| 5936 | "stability": "external",
|
| 5937 | "summary": "The amount of time (in seconds) that Lambda allows a function to run before stopping it."
|
| 5938 | },
|
| 5939 | "locationInModule": {
|
| 5940 | "filename": "lib/lambda.generated.ts",
|
| 5941 | "line": 3097
|
| 5942 | },
|
| 5943 | "name": "timeout",
|
| 5944 | "optional": true,
|
| 5945 | "type": {
|
| 5946 | "primitive": "number"
|
| 5947 | }
|
| 5948 | },
|
| 5949 | {
|
| 5950 | "docs": {
|
| 5951 | "custom": {
|
| 5952 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig"
|
| 5953 | },
|
| 5954 | "stability": "external",
|
| 5955 | "summary": "Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) ."
|
| 5956 | },
|
| 5957 | "locationInModule": {
|
| 5958 | "filename": "lib/lambda.generated.ts",
|
| 5959 | "line": 3104
|
| 5960 | },
|
| 5961 | "name": "tracingConfig",
|
| 5962 | "optional": true,
|
| 5963 | "type": {
|
| 5964 | "union": {
|
| 5965 | "types": [
|
| 5966 | {
|
| 5967 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5968 | },
|
| 5969 | {
|
| 5970 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.TracingConfigProperty"
|
| 5971 | }
|
| 5972 | ]
|
| 5973 | }
|
| 5974 | }
|
| 5975 | },
|
| 5976 | {
|
| 5977 | "docs": {
|
| 5978 | "custom": {
|
| 5979 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig"
|
| 5980 | },
|
| 5981 | "stability": "external",
|
| 5982 | "summary": "For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC."
|
| 5983 | },
|
| 5984 | "locationInModule": {
|
| 5985 | "filename": "lib/lambda.generated.ts",
|
| 5986 | "line": 3111
|
| 5987 | },
|
| 5988 | "name": "vpcConfig",
|
| 5989 | "optional": true,
|
| 5990 | "type": {
|
| 5991 | "union": {
|
| 5992 | "types": [
|
| 5993 | {
|
| 5994 | "fqn": "@aws-cdk/core.IResolvable"
|
| 5995 | },
|
| 5996 | {
|
| 5997 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.VpcConfigProperty"
|
| 5998 | }
|
| 5999 | ]
|
| 6000 | }
|
| 6001 | }
|
| 6002 | }
|
| 6003 | ],
|
| 6004 | "symbolId": "lib/lambda.generated:CfnFunction"
|
| 6005 | },
|
| 6006 | "@aws-cdk/aws-lambda.CfnFunction.CodeProperty": {
|
| 6007 | "assembly": "@aws-cdk/aws-lambda",
|
| 6008 | "datatype": true,
|
| 6009 | "docs": {
|
| 6010 | "custom": {
|
| 6011 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html",
|
| 6012 | "exampleMetadata": "fixture=_generated"
|
| 6013 | },
|
| 6014 | "remarks": "Changes to a deployment package in Amazon S3 are not detected automatically during stack updates. To update the function code, change the object key or version in the template.",
|
| 6015 | "stability": "external",
|
| 6016 | "summary": "The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template.",
|
| 6017 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst codeProperty: lambda.CfnFunction.CodeProperty = {\n imageUri: 'imageUri',\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n s3ObjectVersion: 's3ObjectVersion',\n zipFile: 'zipFile',\n};"
|
| 6018 | },
|
| 6019 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.CodeProperty",
|
| 6020 | "kind": "interface",
|
| 6021 | "locationInModule": {
|
| 6022 | "filename": "lib/lambda.generated.ts",
|
| 6023 | "line": 3208
|
| 6024 | },
|
| 6025 | "name": "CodeProperty",
|
| 6026 | "namespace": "CfnFunction",
|
| 6027 | "properties": [
|
| 6028 | {
|
| 6029 | "abstract": true,
|
| 6030 | "docs": {
|
| 6031 | "custom": {
|
| 6032 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-imageuri"
|
| 6033 | },
|
| 6034 | "stability": "external",
|
| 6035 | "summary": "URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry."
|
| 6036 | },
|
| 6037 | "immutable": true,
|
| 6038 | "locationInModule": {
|
| 6039 | "filename": "lib/lambda.generated.ts",
|
| 6040 | "line": 3214
|
| 6041 | },
|
| 6042 | "name": "imageUri",
|
| 6043 | "optional": true,
|
| 6044 | "type": {
|
| 6045 | "primitive": "string"
|
| 6046 | }
|
| 6047 | },
|
| 6048 | {
|
| 6049 | "abstract": true,
|
| 6050 | "docs": {
|
| 6051 | "custom": {
|
| 6052 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3bucket"
|
| 6053 | },
|
| 6054 | "remarks": "The bucket can be in a different AWS account .",
|
| 6055 | "stability": "external",
|
| 6056 | "summary": "An Amazon S3 bucket in the same AWS Region as your function."
|
| 6057 | },
|
| 6058 | "immutable": true,
|
| 6059 | "locationInModule": {
|
| 6060 | "filename": "lib/lambda.generated.ts",
|
| 6061 | "line": 3220
|
| 6062 | },
|
| 6063 | "name": "s3Bucket",
|
| 6064 | "optional": true,
|
| 6065 | "type": {
|
| 6066 | "primitive": "string"
|
| 6067 | }
|
| 6068 | },
|
| 6069 | {
|
| 6070 | "abstract": true,
|
| 6071 | "docs": {
|
| 6072 | "custom": {
|
| 6073 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3key"
|
| 6074 | },
|
| 6075 | "stability": "external",
|
| 6076 | "summary": "The Amazon S3 key of the deployment package."
|
| 6077 | },
|
| 6078 | "immutable": true,
|
| 6079 | "locationInModule": {
|
| 6080 | "filename": "lib/lambda.generated.ts",
|
| 6081 | "line": 3226
|
| 6082 | },
|
| 6083 | "name": "s3Key",
|
| 6084 | "optional": true,
|
| 6085 | "type": {
|
| 6086 | "primitive": "string"
|
| 6087 | }
|
| 6088 | },
|
| 6089 | {
|
| 6090 | "abstract": true,
|
| 6091 | "docs": {
|
| 6092 | "custom": {
|
| 6093 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-s3objectversion"
|
| 6094 | },
|
| 6095 | "stability": "external",
|
| 6096 | "summary": "For versioned objects, the version of the deployment package object to use."
|
| 6097 | },
|
| 6098 | "immutable": true,
|
| 6099 | "locationInModule": {
|
| 6100 | "filename": "lib/lambda.generated.ts",
|
| 6101 | "line": 3232
|
| 6102 | },
|
| 6103 | "name": "s3ObjectVersion",
|
| 6104 | "optional": true,
|
| 6105 | "type": {
|
| 6106 | "primitive": "string"
|
| 6107 | }
|
| 6108 | },
|
| 6109 | {
|
| 6110 | "abstract": true,
|
| 6111 | "docs": {
|
| 6112 | "custom": {
|
| 6113 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile"
|
| 6114 | },
|
| 6115 | "remarks": "For JSON, you must escape quotes and special characters such as newline ( `\\n` ) with a backslash.\n\nIf you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ( [cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html) ) that simplifies sending responses. See [Using AWS Lambda with AWS CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details.",
|
| 6116 | "stability": "external",
|
| 6117 | "summary": "(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, AWS CloudFormation places it in a file named `index` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) . This zip file cannot exceed 4MB. For the `Handler` property, the first part of the handler identifier must be `index` . For example, `index.handler` ."
|
| 6118 | },
|
| 6119 | "immutable": true,
|
| 6120 | "locationInModule": {
|
| 6121 | "filename": "lib/lambda.generated.ts",
|
| 6122 | "line": 3242
|
| 6123 | },
|
| 6124 | "name": "zipFile",
|
| 6125 | "optional": true,
|
| 6126 | "type": {
|
| 6127 | "primitive": "string"
|
| 6128 | }
|
| 6129 | }
|
| 6130 | ],
|
| 6131 | "symbolId": "lib/lambda.generated:CfnFunction.CodeProperty"
|
| 6132 | },
|
| 6133 | "@aws-cdk/aws-lambda.CfnFunction.DeadLetterConfigProperty": {
|
| 6134 | "assembly": "@aws-cdk/aws-lambda",
|
| 6135 | "datatype": true,
|
| 6136 | "docs": {
|
| 6137 | "custom": {
|
| 6138 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html",
|
| 6139 | "exampleMetadata": "fixture=_generated"
|
| 6140 | },
|
| 6141 | "stability": "external",
|
| 6142 | "summary": "The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations.",
|
| 6143 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst deadLetterConfigProperty: lambda.CfnFunction.DeadLetterConfigProperty = {\n targetArn: 'targetArn',\n};"
|
| 6144 | },
|
| 6145 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.DeadLetterConfigProperty",
|
| 6146 | "kind": "interface",
|
| 6147 | "locationInModule": {
|
| 6148 | "filename": "lib/lambda.generated.ts",
|
| 6149 | "line": 3315
|
| 6150 | },
|
| 6151 | "name": "DeadLetterConfigProperty",
|
| 6152 | "namespace": "CfnFunction",
|
| 6153 | "properties": [
|
| 6154 | {
|
| 6155 | "abstract": true,
|
| 6156 | "docs": {
|
| 6157 | "custom": {
|
| 6158 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-deadletterconfig.html#cfn-lambda-function-deadletterconfig-targetarn"
|
| 6159 | },
|
| 6160 | "stability": "external",
|
| 6161 | "summary": "The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic."
|
| 6162 | },
|
| 6163 | "immutable": true,
|
| 6164 | "locationInModule": {
|
| 6165 | "filename": "lib/lambda.generated.ts",
|
| 6166 | "line": 3321
|
| 6167 | },
|
| 6168 | "name": "targetArn",
|
| 6169 | "optional": true,
|
| 6170 | "type": {
|
| 6171 | "primitive": "string"
|
| 6172 | }
|
| 6173 | }
|
| 6174 | ],
|
| 6175 | "symbolId": "lib/lambda.generated:CfnFunction.DeadLetterConfigProperty"
|
| 6176 | },
|
| 6177 | "@aws-cdk/aws-lambda.CfnFunction.EnvironmentProperty": {
|
| 6178 | "assembly": "@aws-cdk/aws-lambda",
|
| 6179 | "datatype": true,
|
| 6180 | "docs": {
|
| 6181 | "custom": {
|
| 6182 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html",
|
| 6183 | "exampleMetadata": "fixture=_generated"
|
| 6184 | },
|
| 6185 | "remarks": "You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.",
|
| 6186 | "stability": "external",
|
| 6187 | "summary": "A function's environment variable settings.",
|
| 6188 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst environmentProperty: lambda.CfnFunction.EnvironmentProperty = {\n variables: {\n variablesKey: 'variables',\n },\n};"
|
| 6189 | },
|
| 6190 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.EnvironmentProperty",
|
| 6191 | "kind": "interface",
|
| 6192 | "locationInModule": {
|
| 6193 | "filename": "lib/lambda.generated.ts",
|
| 6194 | "line": 3382
|
| 6195 | },
|
| 6196 | "name": "EnvironmentProperty",
|
| 6197 | "namespace": "CfnFunction",
|
| 6198 | "properties": [
|
| 6199 | {
|
| 6200 | "abstract": true,
|
| 6201 | "docs": {
|
| 6202 | "custom": {
|
| 6203 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-environment.html#cfn-lambda-function-environment-variables"
|
| 6204 | },
|
| 6205 | "remarks": "For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html) .",
|
| 6206 | "stability": "external",
|
| 6207 | "summary": "Environment variable key-value pairs."
|
| 6208 | },
|
| 6209 | "immutable": true,
|
| 6210 | "locationInModule": {
|
| 6211 | "filename": "lib/lambda.generated.ts",
|
| 6212 | "line": 3388
|
| 6213 | },
|
| 6214 | "name": "variables",
|
| 6215 | "optional": true,
|
| 6216 | "type": {
|
| 6217 | "union": {
|
| 6218 | "types": [
|
| 6219 | {
|
| 6220 | "fqn": "@aws-cdk/core.IResolvable"
|
| 6221 | },
|
| 6222 | {
|
| 6223 | "collection": {
|
| 6224 | "elementtype": {
|
| 6225 | "primitive": "string"
|
| 6226 | },
|
| 6227 | "kind": "map"
|
| 6228 | }
|
| 6229 | }
|
| 6230 | ]
|
| 6231 | }
|
| 6232 | }
|
| 6233 | }
|
| 6234 | ],
|
| 6235 | "symbolId": "lib/lambda.generated:CfnFunction.EnvironmentProperty"
|
| 6236 | },
|
| 6237 | "@aws-cdk/aws-lambda.CfnFunction.EphemeralStorageProperty": {
|
| 6238 | "assembly": "@aws-cdk/aws-lambda",
|
| 6239 | "datatype": true,
|
| 6240 | "docs": {
|
| 6241 | "custom": {
|
| 6242 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-ephemeralstorage.html",
|
| 6243 | "exampleMetadata": "fixture=_generated"
|
| 6244 | },
|
| 6245 | "remarks": "The default value is 512, but it can be any whole number between 512 and 10,240 MB.",
|
| 6246 | "stability": "external",
|
| 6247 | "summary": "The size of the function's `/tmp` directory in MB.",
|
| 6248 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst ephemeralStorageProperty: lambda.CfnFunction.EphemeralStorageProperty = {\n size: 123,\n};"
|
| 6249 | },
|
| 6250 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.EphemeralStorageProperty",
|
| 6251 | "kind": "interface",
|
| 6252 | "locationInModule": {
|
| 6253 | "filename": "lib/lambda.generated.ts",
|
| 6254 | "line": 3449
|
| 6255 | },
|
| 6256 | "name": "EphemeralStorageProperty",
|
| 6257 | "namespace": "CfnFunction",
|
| 6258 | "properties": [
|
| 6259 | {
|
| 6260 | "abstract": true,
|
| 6261 | "docs": {
|
| 6262 | "custom": {
|
| 6263 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-ephemeralstorage.html#cfn-lambda-function-ephemeralstorage-size"
|
| 6264 | },
|
| 6265 | "stability": "external",
|
| 6266 | "summary": "The size of the function's `/tmp` directory."
|
| 6267 | },
|
| 6268 | "immutable": true,
|
| 6269 | "locationInModule": {
|
| 6270 | "filename": "lib/lambda.generated.ts",
|
| 6271 | "line": 3455
|
| 6272 | },
|
| 6273 | "name": "size",
|
| 6274 | "type": {
|
| 6275 | "primitive": "number"
|
| 6276 | }
|
| 6277 | }
|
| 6278 | ],
|
| 6279 | "symbolId": "lib/lambda.generated:CfnFunction.EphemeralStorageProperty"
|
| 6280 | },
|
| 6281 | "@aws-cdk/aws-lambda.CfnFunction.FileSystemConfigProperty": {
|
| 6282 | "assembly": "@aws-cdk/aws-lambda",
|
| 6283 | "datatype": true,
|
| 6284 | "docs": {
|
| 6285 | "custom": {
|
| 6286 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html",
|
| 6287 | "exampleMetadata": "fixture=_generated"
|
| 6288 | },
|
| 6289 | "stability": "external",
|
| 6290 | "summary": "Details about the connection between a Lambda function and an [Amazon EFS file system](https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html) .",
|
| 6291 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst fileSystemConfigProperty: lambda.CfnFunction.FileSystemConfigProperty = {\n arn: 'arn',\n localMountPath: 'localMountPath',\n};"
|
| 6292 | },
|
| 6293 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.FileSystemConfigProperty",
|
| 6294 | "kind": "interface",
|
| 6295 | "locationInModule": {
|
| 6296 | "filename": "lib/lambda.generated.ts",
|
| 6297 | "line": 3517
|
| 6298 | },
|
| 6299 | "name": "FileSystemConfigProperty",
|
| 6300 | "namespace": "CfnFunction",
|
| 6301 | "properties": [
|
| 6302 | {
|
| 6303 | "abstract": true,
|
| 6304 | "docs": {
|
| 6305 | "custom": {
|
| 6306 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html#cfn-lambda-function-filesystemconfig-arn"
|
| 6307 | },
|
| 6308 | "stability": "external",
|
| 6309 | "summary": "The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system."
|
| 6310 | },
|
| 6311 | "immutable": true,
|
| 6312 | "locationInModule": {
|
| 6313 | "filename": "lib/lambda.generated.ts",
|
| 6314 | "line": 3523
|
| 6315 | },
|
| 6316 | "name": "arn",
|
| 6317 | "type": {
|
| 6318 | "primitive": "string"
|
| 6319 | }
|
| 6320 | },
|
| 6321 | {
|
| 6322 | "abstract": true,
|
| 6323 | "docs": {
|
| 6324 | "custom": {
|
| 6325 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-filesystemconfig.html#cfn-lambda-function-filesystemconfig-localmountpath"
|
| 6326 | },
|
| 6327 | "stability": "external",
|
| 6328 | "summary": "The path where the function can access the file system, starting with `/mnt/` ."
|
| 6329 | },
|
| 6330 | "immutable": true,
|
| 6331 | "locationInModule": {
|
| 6332 | "filename": "lib/lambda.generated.ts",
|
| 6333 | "line": 3529
|
| 6334 | },
|
| 6335 | "name": "localMountPath",
|
| 6336 | "type": {
|
| 6337 | "primitive": "string"
|
| 6338 | }
|
| 6339 | }
|
| 6340 | ],
|
| 6341 | "symbolId": "lib/lambda.generated:CfnFunction.FileSystemConfigProperty"
|
| 6342 | },
|
| 6343 | "@aws-cdk/aws-lambda.CfnFunction.ImageConfigProperty": {
|
| 6344 | "assembly": "@aws-cdk/aws-lambda",
|
| 6345 | "datatype": true,
|
| 6346 | "docs": {
|
| 6347 | "custom": {
|
| 6348 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-imageconfig.html",
|
| 6349 | "exampleMetadata": "fixture=_generated"
|
| 6350 | },
|
| 6351 | "remarks": "For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms) .",
|
| 6352 | "stability": "external",
|
| 6353 | "summary": "Configuration values that override the container image Dockerfile settings.",
|
| 6354 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst imageConfigProperty: lambda.CfnFunction.ImageConfigProperty = {\n command: ['command'],\n entryPoint: ['entryPoint'],\n workingDirectory: 'workingDirectory',\n};"
|
| 6355 | },
|
| 6356 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.ImageConfigProperty",
|
| 6357 | "kind": "interface",
|
| 6358 | "locationInModule": {
|
| 6359 | "filename": "lib/lambda.generated.ts",
|
| 6360 | "line": 3595
|
| 6361 | },
|
| 6362 | "name": "ImageConfigProperty",
|
| 6363 | "namespace": "CfnFunction",
|
| 6364 | "properties": [
|
| 6365 | {
|
| 6366 | "abstract": true,
|
| 6367 | "docs": {
|
| 6368 | "custom": {
|
| 6369 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-imageconfig.html#cfn-lambda-function-imageconfig-command"
|
| 6370 | },
|
| 6371 | "stability": "external",
|
| 6372 | "summary": "Specifies parameters that you want to pass in with ENTRYPOINT."
|
| 6373 | },
|
| 6374 | "immutable": true,
|
| 6375 | "locationInModule": {
|
| 6376 | "filename": "lib/lambda.generated.ts",
|
| 6377 | "line": 3601
|
| 6378 | },
|
| 6379 | "name": "command",
|
| 6380 | "optional": true,
|
| 6381 | "type": {
|
| 6382 | "collection": {
|
| 6383 | "elementtype": {
|
| 6384 | "primitive": "string"
|
| 6385 | },
|
| 6386 | "kind": "array"
|
| 6387 | }
|
| 6388 | }
|
| 6389 | },
|
| 6390 | {
|
| 6391 | "abstract": true,
|
| 6392 | "docs": {
|
| 6393 | "custom": {
|
| 6394 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-imageconfig.html#cfn-lambda-function-imageconfig-entrypoint"
|
| 6395 | },
|
| 6396 | "stability": "external",
|
| 6397 | "summary": "Specifies the entry point to their application, which is typically the location of the runtime executable."
|
| 6398 | },
|
| 6399 | "immutable": true,
|
| 6400 | "locationInModule": {
|
| 6401 | "filename": "lib/lambda.generated.ts",
|
| 6402 | "line": 3607
|
| 6403 | },
|
| 6404 | "name": "entryPoint",
|
| 6405 | "optional": true,
|
| 6406 | "type": {
|
| 6407 | "collection": {
|
| 6408 | "elementtype": {
|
| 6409 | "primitive": "string"
|
| 6410 | },
|
| 6411 | "kind": "array"
|
| 6412 | }
|
| 6413 | }
|
| 6414 | },
|
| 6415 | {
|
| 6416 | "abstract": true,
|
| 6417 | "docs": {
|
| 6418 | "custom": {
|
| 6419 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-imageconfig.html#cfn-lambda-function-imageconfig-workingdirectory"
|
| 6420 | },
|
| 6421 | "stability": "external",
|
| 6422 | "summary": "Specifies the working directory."
|
| 6423 | },
|
| 6424 | "immutable": true,
|
| 6425 | "locationInModule": {
|
| 6426 | "filename": "lib/lambda.generated.ts",
|
| 6427 | "line": 3613
|
| 6428 | },
|
| 6429 | "name": "workingDirectory",
|
| 6430 | "optional": true,
|
| 6431 | "type": {
|
| 6432 | "primitive": "string"
|
| 6433 | }
|
| 6434 | }
|
| 6435 | ],
|
| 6436 | "symbolId": "lib/lambda.generated:CfnFunction.ImageConfigProperty"
|
| 6437 | },
|
| 6438 | "@aws-cdk/aws-lambda.CfnFunction.SnapStartProperty": {
|
| 6439 | "assembly": "@aws-cdk/aws-lambda",
|
| 6440 | "datatype": true,
|
| 6441 | "docs": {
|
| 6442 | "custom": {
|
| 6443 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html",
|
| 6444 | "exampleMetadata": "fixture=_generated"
|
| 6445 | },
|
| 6446 | "stability": "external",
|
| 6447 | "summary": "The function's [AWS Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.",
|
| 6448 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst snapStartProperty: lambda.CfnFunction.SnapStartProperty = {\n applyOn: 'applyOn',\n};"
|
| 6449 | },
|
| 6450 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.SnapStartProperty",
|
| 6451 | "kind": "interface",
|
| 6452 | "locationInModule": {
|
| 6453 | "filename": "lib/lambda.generated.ts",
|
| 6454 | "line": 3680
|
| 6455 | },
|
| 6456 | "name": "SnapStartProperty",
|
| 6457 | "namespace": "CfnFunction",
|
| 6458 | "properties": [
|
| 6459 | {
|
| 6460 | "abstract": true,
|
| 6461 | "docs": {
|
| 6462 | "custom": {
|
| 6463 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstart.html#cfn-lambda-function-snapstart-applyon"
|
| 6464 | },
|
| 6465 | "stability": "external",
|
| 6466 | "summary": "Set `ApplyOn` to `PublishedVersions` to create a snapshot of the initialized execution environment when you publish a function version."
|
| 6467 | },
|
| 6468 | "immutable": true,
|
| 6469 | "locationInModule": {
|
| 6470 | "filename": "lib/lambda.generated.ts",
|
| 6471 | "line": 3686
|
| 6472 | },
|
| 6473 | "name": "applyOn",
|
| 6474 | "type": {
|
| 6475 | "primitive": "string"
|
| 6476 | }
|
| 6477 | }
|
| 6478 | ],
|
| 6479 | "symbolId": "lib/lambda.generated:CfnFunction.SnapStartProperty"
|
| 6480 | },
|
| 6481 | "@aws-cdk/aws-lambda.CfnFunction.SnapStartResponseProperty": {
|
| 6482 | "assembly": "@aws-cdk/aws-lambda",
|
| 6483 | "datatype": true,
|
| 6484 | "docs": {
|
| 6485 | "custom": {
|
| 6486 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html",
|
| 6487 | "exampleMetadata": "fixture=_generated"
|
| 6488 | },
|
| 6489 | "stability": "external",
|
| 6490 | "summary": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.",
|
| 6491 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst snapStartResponseProperty: lambda.CfnFunction.SnapStartResponseProperty = {\n applyOn: 'applyOn',\n optimizationStatus: 'optimizationStatus',\n};"
|
| 6492 | },
|
| 6493 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.SnapStartResponseProperty",
|
| 6494 | "kind": "interface",
|
| 6495 | "locationInModule": {
|
| 6496 | "filename": "lib/lambda.generated.ts",
|
| 6497 | "line": 3748
|
| 6498 | },
|
| 6499 | "name": "SnapStartResponseProperty",
|
| 6500 | "namespace": "CfnFunction",
|
| 6501 | "properties": [
|
| 6502 | {
|
| 6503 | "abstract": true,
|
| 6504 | "docs": {
|
| 6505 | "custom": {
|
| 6506 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html#cfn-lambda-function-snapstartresponse-applyon"
|
| 6507 | },
|
| 6508 | "stability": "external",
|
| 6509 | "summary": "When set to `PublishedVersions` , Lambda creates a snapshot of the execution environment when you publish a function version."
|
| 6510 | },
|
| 6511 | "immutable": true,
|
| 6512 | "locationInModule": {
|
| 6513 | "filename": "lib/lambda.generated.ts",
|
| 6514 | "line": 3754
|
| 6515 | },
|
| 6516 | "name": "applyOn",
|
| 6517 | "optional": true,
|
| 6518 | "type": {
|
| 6519 | "primitive": "string"
|
| 6520 | }
|
| 6521 | },
|
| 6522 | {
|
| 6523 | "abstract": true,
|
| 6524 | "docs": {
|
| 6525 | "custom": {
|
| 6526 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-snapstartresponse.html#cfn-lambda-function-snapstartresponse-optimizationstatus"
|
| 6527 | },
|
| 6528 | "stability": "external",
|
| 6529 | "summary": "When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using) , this response element indicates whether SnapStart is activated for the specified function version."
|
| 6530 | },
|
| 6531 | "immutable": true,
|
| 6532 | "locationInModule": {
|
| 6533 | "filename": "lib/lambda.generated.ts",
|
| 6534 | "line": 3760
|
| 6535 | },
|
| 6536 | "name": "optimizationStatus",
|
| 6537 | "optional": true,
|
| 6538 | "type": {
|
| 6539 | "primitive": "string"
|
| 6540 | }
|
| 6541 | }
|
| 6542 | ],
|
| 6543 | "symbolId": "lib/lambda.generated:CfnFunction.SnapStartResponseProperty"
|
| 6544 | },
|
| 6545 | "@aws-cdk/aws-lambda.CfnFunction.TracingConfigProperty": {
|
| 6546 | "assembly": "@aws-cdk/aws-lambda",
|
| 6547 | "datatype": true,
|
| 6548 | "docs": {
|
| 6549 | "custom": {
|
| 6550 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html",
|
| 6551 | "exampleMetadata": "fixture=_generated"
|
| 6552 | },
|
| 6553 | "stability": "external",
|
| 6554 | "summary": "The function's [AWS X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set `Mode` to `Active` .",
|
| 6555 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst tracingConfigProperty: lambda.CfnFunction.TracingConfigProperty = {\n mode: 'mode',\n};"
|
| 6556 | },
|
| 6557 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.TracingConfigProperty",
|
| 6558 | "kind": "interface",
|
| 6559 | "locationInModule": {
|
| 6560 | "filename": "lib/lambda.generated.ts",
|
| 6561 | "line": 3824
|
| 6562 | },
|
| 6563 | "name": "TracingConfigProperty",
|
| 6564 | "namespace": "CfnFunction",
|
| 6565 | "properties": [
|
| 6566 | {
|
| 6567 | "abstract": true,
|
| 6568 | "docs": {
|
| 6569 | "custom": {
|
| 6570 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-tracingconfig.html#cfn-lambda-function-tracingconfig-mode"
|
| 6571 | },
|
| 6572 | "stability": "external",
|
| 6573 | "summary": "The tracing mode."
|
| 6574 | },
|
| 6575 | "immutable": true,
|
| 6576 | "locationInModule": {
|
| 6577 | "filename": "lib/lambda.generated.ts",
|
| 6578 | "line": 3830
|
| 6579 | },
|
| 6580 | "name": "mode",
|
| 6581 | "optional": true,
|
| 6582 | "type": {
|
| 6583 | "primitive": "string"
|
| 6584 | }
|
| 6585 | }
|
| 6586 | ],
|
| 6587 | "symbolId": "lib/lambda.generated:CfnFunction.TracingConfigProperty"
|
| 6588 | },
|
| 6589 | "@aws-cdk/aws-lambda.CfnFunction.VpcConfigProperty": {
|
| 6590 | "assembly": "@aws-cdk/aws-lambda",
|
| 6591 | "datatype": true,
|
| 6592 | "docs": {
|
| 6593 | "custom": {
|
| 6594 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html",
|
| 6595 | "exampleMetadata": "fixture=_generated"
|
| 6596 | },
|
| 6597 | "remarks": "When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html) .\n\n> When you delete a function, AWS CloudFormation monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before AWS CloudFormation can delete the VPC's resources.\n>\n> To monitor network interfaces, AWS CloudFormation needs the `ec2:DescribeNetworkInterfaces` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, AWS CloudFormation does not wait for network interfaces to be deleted.",
|
| 6598 | "stability": "external",
|
| 6599 | "summary": "The VPC security groups and subnets that are attached to a Lambda function.",
|
| 6600 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst vpcConfigProperty: lambda.CfnFunction.VpcConfigProperty = {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n};"
|
| 6601 | },
|
| 6602 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.VpcConfigProperty",
|
| 6603 | "kind": "interface",
|
| 6604 | "locationInModule": {
|
| 6605 | "filename": "lib/lambda.generated.ts",
|
| 6606 | "line": 3895
|
| 6607 | },
|
| 6608 | "name": "VpcConfigProperty",
|
| 6609 | "namespace": "CfnFunction",
|
| 6610 | "properties": [
|
| 6611 | {
|
| 6612 | "abstract": true,
|
| 6613 | "docs": {
|
| 6614 | "custom": {
|
| 6615 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-securitygroupids"
|
| 6616 | },
|
| 6617 | "stability": "external",
|
| 6618 | "summary": "A list of VPC security group IDs."
|
| 6619 | },
|
| 6620 | "immutable": true,
|
| 6621 | "locationInModule": {
|
| 6622 | "filename": "lib/lambda.generated.ts",
|
| 6623 | "line": 3901
|
| 6624 | },
|
| 6625 | "name": "securityGroupIds",
|
| 6626 | "optional": true,
|
| 6627 | "type": {
|
| 6628 | "collection": {
|
| 6629 | "elementtype": {
|
| 6630 | "primitive": "string"
|
| 6631 | },
|
| 6632 | "kind": "array"
|
| 6633 | }
|
| 6634 | }
|
| 6635 | },
|
| 6636 | {
|
| 6637 | "abstract": true,
|
| 6638 | "docs": {
|
| 6639 | "custom": {
|
| 6640 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-vpcconfig.html#cfn-lambda-function-vpcconfig-subnetids"
|
| 6641 | },
|
| 6642 | "stability": "external",
|
| 6643 | "summary": "A list of VPC subnet IDs."
|
| 6644 | },
|
| 6645 | "immutable": true,
|
| 6646 | "locationInModule": {
|
| 6647 | "filename": "lib/lambda.generated.ts",
|
| 6648 | "line": 3907
|
| 6649 | },
|
| 6650 | "name": "subnetIds",
|
| 6651 | "optional": true,
|
| 6652 | "type": {
|
| 6653 | "collection": {
|
| 6654 | "elementtype": {
|
| 6655 | "primitive": "string"
|
| 6656 | },
|
| 6657 | "kind": "array"
|
| 6658 | }
|
| 6659 | }
|
| 6660 | }
|
| 6661 | ],
|
| 6662 | "symbolId": "lib/lambda.generated:CfnFunction.VpcConfigProperty"
|
| 6663 | },
|
| 6664 | "@aws-cdk/aws-lambda.CfnFunctionProps": {
|
| 6665 | "assembly": "@aws-cdk/aws-lambda",
|
| 6666 | "datatype": true,
|
| 6667 | "docs": {
|
| 6668 | "custom": {
|
| 6669 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html",
|
| 6670 | "exampleMetadata": "fixture=_generated"
|
| 6671 | },
|
| 6672 | "stability": "external",
|
| 6673 | "summary": "Properties for defining a `CfnFunction`.",
|
| 6674 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnFunctionProps: lambda.CfnFunctionProps = {\n code: {\n imageUri: 'imageUri',\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n s3ObjectVersion: 's3ObjectVersion',\n zipFile: 'zipFile',\n },\n role: 'role',\n\n // the properties below are optional\n architectures: ['architectures'],\n codeSigningConfigArn: 'codeSigningConfigArn',\n deadLetterConfig: {\n targetArn: 'targetArn',\n },\n description: 'description',\n environment: {\n variables: {\n variablesKey: 'variables',\n },\n },\n ephemeralStorage: {\n size: 123,\n },\n fileSystemConfigs: [{\n arn: 'arn',\n localMountPath: 'localMountPath',\n }],\n functionName: 'functionName',\n handler: 'handler',\n imageConfig: {\n command: ['command'],\n entryPoint: ['entryPoint'],\n workingDirectory: 'workingDirectory',\n },\n kmsKeyArn: 'kmsKeyArn',\n layers: ['layers'],\n memorySize: 123,\n packageType: 'packageType',\n reservedConcurrentExecutions: 123,\n runtime: 'runtime',\n snapStart: {\n applyOn: 'applyOn',\n },\n tags: [{\n key: 'key',\n value: 'value',\n }],\n timeout: 123,\n tracingConfig: {\n mode: 'mode',\n },\n vpcConfig: {\n securityGroupIds: ['securityGroupIds'],\n subnetIds: ['subnetIds'],\n },\n};"
|
| 6675 | },
|
| 6676 | "fqn": "@aws-cdk/aws-lambda.CfnFunctionProps",
|
| 6677 | "kind": "interface",
|
| 6678 | "locationInModule": {
|
| 6679 | "filename": "lib/lambda.generated.ts",
|
| 6680 | "line": 2602
|
| 6681 | },
|
| 6682 | "name": "CfnFunctionProps",
|
| 6683 | "properties": [
|
| 6684 | {
|
| 6685 | "abstract": true,
|
| 6686 | "docs": {
|
| 6687 | "custom": {
|
| 6688 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-code"
|
| 6689 | },
|
| 6690 | "stability": "external",
|
| 6691 | "summary": "The code for the function."
|
| 6692 | },
|
| 6693 | "immutable": true,
|
| 6694 | "locationInModule": {
|
| 6695 | "filename": "lib/lambda.generated.ts",
|
| 6696 | "line": 2609
|
| 6697 | },
|
| 6698 | "name": "code",
|
| 6699 | "type": {
|
| 6700 | "union": {
|
| 6701 | "types": [
|
| 6702 | {
|
| 6703 | "fqn": "@aws-cdk/core.IResolvable"
|
| 6704 | },
|
| 6705 | {
|
| 6706 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.CodeProperty"
|
| 6707 | }
|
| 6708 | ]
|
| 6709 | }
|
| 6710 | }
|
| 6711 | },
|
| 6712 | {
|
| 6713 | "abstract": true,
|
| 6714 | "docs": {
|
| 6715 | "custom": {
|
| 6716 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-role"
|
| 6717 | },
|
| 6718 | "stability": "external",
|
| 6719 | "summary": "The Amazon Resource Name (ARN) of the function's execution role."
|
| 6720 | },
|
| 6721 | "immutable": true,
|
| 6722 | "locationInModule": {
|
| 6723 | "filename": "lib/lambda.generated.ts",
|
| 6724 | "line": 2616
|
| 6725 | },
|
| 6726 | "name": "role",
|
| 6727 | "type": {
|
| 6728 | "primitive": "string"
|
| 6729 | }
|
| 6730 | },
|
| 6731 | {
|
| 6732 | "abstract": true,
|
| 6733 | "docs": {
|
| 6734 | "custom": {
|
| 6735 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-architectures"
|
| 6736 | },
|
| 6737 | "remarks": "Enter a string array with one of the valid values (arm64 or x86_64). The default value is `x86_64` .",
|
| 6738 | "stability": "external",
|
| 6739 | "summary": "The instruction set architecture that the function supports."
|
| 6740 | },
|
| 6741 | "immutable": true,
|
| 6742 | "locationInModule": {
|
| 6743 | "filename": "lib/lambda.generated.ts",
|
| 6744 | "line": 2623
|
| 6745 | },
|
| 6746 | "name": "architectures",
|
| 6747 | "optional": true,
|
| 6748 | "type": {
|
| 6749 | "collection": {
|
| 6750 | "elementtype": {
|
| 6751 | "primitive": "string"
|
| 6752 | },
|
| 6753 | "kind": "array"
|
| 6754 | }
|
| 6755 | }
|
| 6756 | },
|
| 6757 | {
|
| 6758 | "abstract": true,
|
| 6759 | "docs": {
|
| 6760 | "custom": {
|
| 6761 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-codesigningconfigarn"
|
| 6762 | },
|
| 6763 | "remarks": "A code-signing configuration\nincludes a set of signing profiles, which define the trusted publishers for this function.",
|
| 6764 | "stability": "external",
|
| 6765 | "summary": "To enable code signing for this function, specify the ARN of a code-signing configuration."
|
| 6766 | },
|
| 6767 | "immutable": true,
|
| 6768 | "locationInModule": {
|
| 6769 | "filename": "lib/lambda.generated.ts",
|
| 6770 | "line": 2631
|
| 6771 | },
|
| 6772 | "name": "codeSigningConfigArn",
|
| 6773 | "optional": true,
|
| 6774 | "type": {
|
| 6775 | "primitive": "string"
|
| 6776 | }
|
| 6777 | },
|
| 6778 | {
|
| 6779 | "abstract": true,
|
| 6780 | "docs": {
|
| 6781 | "custom": {
|
| 6782 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-deadletterconfig"
|
| 6783 | },
|
| 6784 | "remarks": "For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) .",
|
| 6785 | "stability": "external",
|
| 6786 | "summary": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing."
|
| 6787 | },
|
| 6788 | "immutable": true,
|
| 6789 | "locationInModule": {
|
| 6790 | "filename": "lib/lambda.generated.ts",
|
| 6791 | "line": 2638
|
| 6792 | },
|
| 6793 | "name": "deadLetterConfig",
|
| 6794 | "optional": true,
|
| 6795 | "type": {
|
| 6796 | "union": {
|
| 6797 | "types": [
|
| 6798 | {
|
| 6799 | "fqn": "@aws-cdk/core.IResolvable"
|
| 6800 | },
|
| 6801 | {
|
| 6802 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.DeadLetterConfigProperty"
|
| 6803 | }
|
| 6804 | ]
|
| 6805 | }
|
| 6806 | }
|
| 6807 | },
|
| 6808 | {
|
| 6809 | "abstract": true,
|
| 6810 | "docs": {
|
| 6811 | "custom": {
|
| 6812 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-description"
|
| 6813 | },
|
| 6814 | "stability": "external",
|
| 6815 | "summary": "A description of the function."
|
| 6816 | },
|
| 6817 | "immutable": true,
|
| 6818 | "locationInModule": {
|
| 6819 | "filename": "lib/lambda.generated.ts",
|
| 6820 | "line": 2645
|
| 6821 | },
|
| 6822 | "name": "description",
|
| 6823 | "optional": true,
|
| 6824 | "type": {
|
| 6825 | "primitive": "string"
|
| 6826 | }
|
| 6827 | },
|
| 6828 | {
|
| 6829 | "abstract": true,
|
| 6830 | "docs": {
|
| 6831 | "custom": {
|
| 6832 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-environment"
|
| 6833 | },
|
| 6834 | "stability": "external",
|
| 6835 | "summary": "Environment variables that are accessible from function code during execution."
|
| 6836 | },
|
| 6837 | "immutable": true,
|
| 6838 | "locationInModule": {
|
| 6839 | "filename": "lib/lambda.generated.ts",
|
| 6840 | "line": 2652
|
| 6841 | },
|
| 6842 | "name": "environment",
|
| 6843 | "optional": true,
|
| 6844 | "type": {
|
| 6845 | "union": {
|
| 6846 | "types": [
|
| 6847 | {
|
| 6848 | "fqn": "@aws-cdk/core.IResolvable"
|
| 6849 | },
|
| 6850 | {
|
| 6851 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.EnvironmentProperty"
|
| 6852 | }
|
| 6853 | ]
|
| 6854 | }
|
| 6855 | }
|
| 6856 | },
|
| 6857 | {
|
| 6858 | "abstract": true,
|
| 6859 | "docs": {
|
| 6860 | "custom": {
|
| 6861 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-ephemeralstorage"
|
| 6862 | },
|
| 6863 | "remarks": "The default value is 512, but it can be any whole number between 512 and 10,240 MB.",
|
| 6864 | "stability": "external",
|
| 6865 | "summary": "The size of the function's `/tmp` directory in MB."
|
| 6866 | },
|
| 6867 | "immutable": true,
|
| 6868 | "locationInModule": {
|
| 6869 | "filename": "lib/lambda.generated.ts",
|
| 6870 | "line": 2659
|
| 6871 | },
|
| 6872 | "name": "ephemeralStorage",
|
| 6873 | "optional": true,
|
| 6874 | "type": {
|
| 6875 | "union": {
|
| 6876 | "types": [
|
| 6877 | {
|
| 6878 | "fqn": "@aws-cdk/core.IResolvable"
|
| 6879 | },
|
| 6880 | {
|
| 6881 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.EphemeralStorageProperty"
|
| 6882 | }
|
| 6883 | ]
|
| 6884 | }
|
| 6885 | }
|
| 6886 | },
|
| 6887 | {
|
| 6888 | "abstract": true,
|
| 6889 | "docs": {
|
| 6890 | "custom": {
|
| 6891 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-filesystemconfigs"
|
| 6892 | },
|
| 6893 | "remarks": "To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a `DependsOn` attribute to ensure that the mount target is created or updated before the function.\n\nFor more information about using the `DependsOn` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) .",
|
| 6894 | "stability": "external",
|
| 6895 | "summary": "Connection settings for an Amazon EFS file system."
|
| 6896 | },
|
| 6897 | "immutable": true,
|
| 6898 | "locationInModule": {
|
| 6899 | "filename": "lib/lambda.generated.ts",
|
| 6900 | "line": 2668
|
| 6901 | },
|
| 6902 | "name": "fileSystemConfigs",
|
| 6903 | "optional": true,
|
| 6904 | "type": {
|
| 6905 | "union": {
|
| 6906 | "types": [
|
| 6907 | {
|
| 6908 | "fqn": "@aws-cdk/core.IResolvable"
|
| 6909 | },
|
| 6910 | {
|
| 6911 | "collection": {
|
| 6912 | "elementtype": {
|
| 6913 | "union": {
|
| 6914 | "types": [
|
| 6915 | {
|
| 6916 | "fqn": "@aws-cdk/core.IResolvable"
|
| 6917 | },
|
| 6918 | {
|
| 6919 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.FileSystemConfigProperty"
|
| 6920 | }
|
| 6921 | ]
|
| 6922 | }
|
| 6923 | },
|
| 6924 | "kind": "array"
|
| 6925 | }
|
| 6926 | }
|
| 6927 | ]
|
| 6928 | }
|
| 6929 | }
|
| 6930 | },
|
| 6931 | {
|
| 6932 | "abstract": true,
|
| 6933 | "docs": {
|
| 6934 | "custom": {
|
| 6935 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-functionname"
|
| 6936 | },
|
| 6937 | "remarks": "If you don't specify a name, AWS CloudFormation generates one.\n\nIf you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.",
|
| 6938 | "stability": "external",
|
| 6939 | "summary": "The name of the Lambda function, up to 64 characters in length."
|
| 6940 | },
|
| 6941 | "immutable": true,
|
| 6942 | "locationInModule": {
|
| 6943 | "filename": "lib/lambda.generated.ts",
|
| 6944 | "line": 2677
|
| 6945 | },
|
| 6946 | "name": "functionName",
|
| 6947 | "optional": true,
|
| 6948 | "type": {
|
| 6949 | "primitive": "string"
|
| 6950 | }
|
| 6951 | },
|
| 6952 | {
|
| 6953 | "abstract": true,
|
| 6954 | "docs": {
|
| 6955 | "custom": {
|
| 6956 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-handler"
|
| 6957 | },
|
| 6958 | "remarks": "Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html) .",
|
| 6959 | "stability": "external",
|
| 6960 | "summary": "The name of the method within your code that Lambda calls to run your function."
|
| 6961 | },
|
| 6962 | "immutable": true,
|
| 6963 | "locationInModule": {
|
| 6964 | "filename": "lib/lambda.generated.ts",
|
| 6965 | "line": 2684
|
| 6966 | },
|
| 6967 | "name": "handler",
|
| 6968 | "optional": true,
|
| 6969 | "type": {
|
| 6970 | "primitive": "string"
|
| 6971 | }
|
| 6972 | },
|
| 6973 | {
|
| 6974 | "abstract": true,
|
| 6975 | "docs": {
|
| 6976 | "custom": {
|
| 6977 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-imageconfig"
|
| 6978 | },
|
| 6979 | "remarks": "For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms) .",
|
| 6980 | "stability": "external",
|
| 6981 | "summary": "Configuration values that override the container image Dockerfile settings."
|
| 6982 | },
|
| 6983 | "immutable": true,
|
| 6984 | "locationInModule": {
|
| 6985 | "filename": "lib/lambda.generated.ts",
|
| 6986 | "line": 2691
|
| 6987 | },
|
| 6988 | "name": "imageConfig",
|
| 6989 | "optional": true,
|
| 6990 | "type": {
|
| 6991 | "union": {
|
| 6992 | "types": [
|
| 6993 | {
|
| 6994 | "fqn": "@aws-cdk/core.IResolvable"
|
| 6995 | },
|
| 6996 | {
|
| 6997 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.ImageConfigProperty"
|
| 6998 | }
|
| 6999 | ]
|
| 7000 | }
|
| 7001 | }
|
| 7002 | },
|
| 7003 | {
|
| 7004 | "abstract": true,
|
| 7005 | "docs": {
|
| 7006 | "custom": {
|
| 7007 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-kmskeyarn"
|
| 7008 | },
|
| 7009 | "remarks": "If it's not provided, Lambda uses a default service key.",
|
| 7010 | "stability": "external",
|
| 7011 | "summary": "The ARN of the AWS Key Management Service ( AWS KMS ) key that's used to encrypt your function's environment variables."
|
| 7012 | },
|
| 7013 | "immutable": true,
|
| 7014 | "locationInModule": {
|
| 7015 | "filename": "lib/lambda.generated.ts",
|
| 7016 | "line": 2698
|
| 7017 | },
|
| 7018 | "name": "kmsKeyArn",
|
| 7019 | "optional": true,
|
| 7020 | "type": {
|
| 7021 | "primitive": "string"
|
| 7022 | }
|
| 7023 | },
|
| 7024 | {
|
| 7025 | "abstract": true,
|
| 7026 | "docs": {
|
| 7027 | "custom": {
|
| 7028 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-layers"
|
| 7029 | },
|
| 7030 | "stability": "external",
|
| 7031 | "summary": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version."
|
| 7032 | },
|
| 7033 | "immutable": true,
|
| 7034 | "locationInModule": {
|
| 7035 | "filename": "lib/lambda.generated.ts",
|
| 7036 | "line": 2705
|
| 7037 | },
|
| 7038 | "name": "layers",
|
| 7039 | "optional": true,
|
| 7040 | "type": {
|
| 7041 | "collection": {
|
| 7042 | "elementtype": {
|
| 7043 | "primitive": "string"
|
| 7044 | },
|
| 7045 | "kind": "array"
|
| 7046 | }
|
| 7047 | }
|
| 7048 | },
|
| 7049 | {
|
| 7050 | "abstract": true,
|
| 7051 | "docs": {
|
| 7052 | "custom": {
|
| 7053 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-memorysize"
|
| 7054 | },
|
| 7055 | "stability": "external",
|
| 7056 | "summary": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB."
|
| 7057 | },
|
| 7058 | "immutable": true,
|
| 7059 | "locationInModule": {
|
| 7060 | "filename": "lib/lambda.generated.ts",
|
| 7061 | "line": 2712
|
| 7062 | },
|
| 7063 | "name": "memorySize",
|
| 7064 | "optional": true,
|
| 7065 | "type": {
|
| 7066 | "primitive": "number"
|
| 7067 | }
|
| 7068 | },
|
| 7069 | {
|
| 7070 | "abstract": true,
|
| 7071 | "docs": {
|
| 7072 | "custom": {
|
| 7073 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-packagetype"
|
| 7074 | },
|
| 7075 | "remarks": "Set to `Image` for container image and set `Zip` for .zip file archive.",
|
| 7076 | "stability": "external",
|
| 7077 | "summary": "The type of deployment package."
|
| 7078 | },
|
| 7079 | "immutable": true,
|
| 7080 | "locationInModule": {
|
| 7081 | "filename": "lib/lambda.generated.ts",
|
| 7082 | "line": 2719
|
| 7083 | },
|
| 7084 | "name": "packageType",
|
| 7085 | "optional": true,
|
| 7086 | "type": {
|
| 7087 | "primitive": "string"
|
| 7088 | }
|
| 7089 | },
|
| 7090 | {
|
| 7091 | "abstract": true,
|
| 7092 | "docs": {
|
| 7093 | "custom": {
|
| 7094 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-reservedconcurrentexecutions"
|
| 7095 | },
|
| 7096 | "stability": "external",
|
| 7097 | "summary": "The number of simultaneous executions to reserve for the function."
|
| 7098 | },
|
| 7099 | "immutable": true,
|
| 7100 | "locationInModule": {
|
| 7101 | "filename": "lib/lambda.generated.ts",
|
| 7102 | "line": 2726
|
| 7103 | },
|
| 7104 | "name": "reservedConcurrentExecutions",
|
| 7105 | "optional": true,
|
| 7106 | "type": {
|
| 7107 | "primitive": "number"
|
| 7108 | }
|
| 7109 | },
|
| 7110 | {
|
| 7111 | "abstract": true,
|
| 7112 | "docs": {
|
| 7113 | "custom": {
|
| 7114 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-runtime"
|
| 7115 | },
|
| 7116 | "stability": "external",
|
| 7117 | "summary": "The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Runtime is required if the deployment package is a .zip file archive."
|
| 7118 | },
|
| 7119 | "immutable": true,
|
| 7120 | "locationInModule": {
|
| 7121 | "filename": "lib/lambda.generated.ts",
|
| 7122 | "line": 2733
|
| 7123 | },
|
| 7124 | "name": "runtime",
|
| 7125 | "optional": true,
|
| 7126 | "type": {
|
| 7127 | "primitive": "string"
|
| 7128 | }
|
| 7129 | },
|
| 7130 | {
|
| 7131 | "abstract": true,
|
| 7132 | "docs": {
|
| 7133 | "custom": {
|
| 7134 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-snapstart"
|
| 7135 | },
|
| 7136 | "stability": "external",
|
| 7137 | "summary": "The function's [AWS Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting."
|
| 7138 | },
|
| 7139 | "immutable": true,
|
| 7140 | "locationInModule": {
|
| 7141 | "filename": "lib/lambda.generated.ts",
|
| 7142 | "line": 2740
|
| 7143 | },
|
| 7144 | "name": "snapStart",
|
| 7145 | "optional": true,
|
| 7146 | "type": {
|
| 7147 | "union": {
|
| 7148 | "types": [
|
| 7149 | {
|
| 7150 | "fqn": "@aws-cdk/core.IResolvable"
|
| 7151 | },
|
| 7152 | {
|
| 7153 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.SnapStartProperty"
|
| 7154 | }
|
| 7155 | ]
|
| 7156 | }
|
| 7157 | }
|
| 7158 | },
|
| 7159 | {
|
| 7160 | "abstract": true,
|
| 7161 | "docs": {
|
| 7162 | "custom": {
|
| 7163 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tags"
|
| 7164 | },
|
| 7165 | "stability": "external",
|
| 7166 | "summary": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function."
|
| 7167 | },
|
| 7168 | "immutable": true,
|
| 7169 | "locationInModule": {
|
| 7170 | "filename": "lib/lambda.generated.ts",
|
| 7171 | "line": 2747
|
| 7172 | },
|
| 7173 | "name": "tags",
|
| 7174 | "optional": true,
|
| 7175 | "type": {
|
| 7176 | "collection": {
|
| 7177 | "elementtype": {
|
| 7178 | "fqn": "@aws-cdk/core.CfnTag"
|
| 7179 | },
|
| 7180 | "kind": "array"
|
| 7181 | }
|
| 7182 | }
|
| 7183 | },
|
| 7184 | {
|
| 7185 | "abstract": true,
|
| 7186 | "docs": {
|
| 7187 | "custom": {
|
| 7188 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-timeout"
|
| 7189 | },
|
| 7190 | "remarks": "The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html) .",
|
| 7191 | "stability": "external",
|
| 7192 | "summary": "The amount of time (in seconds) that Lambda allows a function to run before stopping it."
|
| 7193 | },
|
| 7194 | "immutable": true,
|
| 7195 | "locationInModule": {
|
| 7196 | "filename": "lib/lambda.generated.ts",
|
| 7197 | "line": 2754
|
| 7198 | },
|
| 7199 | "name": "timeout",
|
| 7200 | "optional": true,
|
| 7201 | "type": {
|
| 7202 | "primitive": "number"
|
| 7203 | }
|
| 7204 | },
|
| 7205 | {
|
| 7206 | "abstract": true,
|
| 7207 | "docs": {
|
| 7208 | "custom": {
|
| 7209 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-tracingconfig"
|
| 7210 | },
|
| 7211 | "stability": "external",
|
| 7212 | "summary": "Set `Mode` to `Active` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) ."
|
| 7213 | },
|
| 7214 | "immutable": true,
|
| 7215 | "locationInModule": {
|
| 7216 | "filename": "lib/lambda.generated.ts",
|
| 7217 | "line": 2761
|
| 7218 | },
|
| 7219 | "name": "tracingConfig",
|
| 7220 | "optional": true,
|
| 7221 | "type": {
|
| 7222 | "union": {
|
| 7223 | "types": [
|
| 7224 | {
|
| 7225 | "fqn": "@aws-cdk/core.IResolvable"
|
| 7226 | },
|
| 7227 | {
|
| 7228 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.TracingConfigProperty"
|
| 7229 | }
|
| 7230 | ]
|
| 7231 | }
|
| 7232 | }
|
| 7233 | },
|
| 7234 | {
|
| 7235 | "abstract": true,
|
| 7236 | "docs": {
|
| 7237 | "custom": {
|
| 7238 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html#cfn-lambda-function-vpcconfig"
|
| 7239 | },
|
| 7240 | "stability": "external",
|
| 7241 | "summary": "For network connectivity to AWS resources in a [VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-network.html) , specify a list of security groups and subnets in the VPC."
|
| 7242 | },
|
| 7243 | "immutable": true,
|
| 7244 | "locationInModule": {
|
| 7245 | "filename": "lib/lambda.generated.ts",
|
| 7246 | "line": 2768
|
| 7247 | },
|
| 7248 | "name": "vpcConfig",
|
| 7249 | "optional": true,
|
| 7250 | "type": {
|
| 7251 | "union": {
|
| 7252 | "types": [
|
| 7253 | {
|
| 7254 | "fqn": "@aws-cdk/core.IResolvable"
|
| 7255 | },
|
| 7256 | {
|
| 7257 | "fqn": "@aws-cdk/aws-lambda.CfnFunction.VpcConfigProperty"
|
| 7258 | }
|
| 7259 | ]
|
| 7260 | }
|
| 7261 | }
|
| 7262 | }
|
| 7263 | ],
|
| 7264 | "symbolId": "lib/lambda.generated:CfnFunctionProps"
|
| 7265 | },
|
| 7266 | "@aws-cdk/aws-lambda.CfnLayerVersion": {
|
| 7267 | "assembly": "@aws-cdk/aws-lambda",
|
| 7268 | "base": "@aws-cdk/core.CfnResource",
|
| 7269 | "docs": {
|
| 7270 | "custom": {
|
| 7271 | "cloudformationResource": "AWS::Lambda::LayerVersion",
|
| 7272 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html",
|
| 7273 | "exampleMetadata": "fixture=_generated"
|
| 7274 | },
|
| 7275 | "remarks": "The `AWS::Lambda::LayerVersion` resource creates a [Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) from a ZIP archive.",
|
| 7276 | "stability": "external",
|
| 7277 | "summary": "A CloudFormation `AWS::Lambda::LayerVersion`.",
|
| 7278 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnLayerVersion = new lambda.CfnLayerVersion(this, 'MyCfnLayerVersion', {\n content: {\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n\n // the properties below are optional\n s3ObjectVersion: 's3ObjectVersion',\n },\n\n // the properties below are optional\n compatibleArchitectures: ['compatibleArchitectures'],\n compatibleRuntimes: ['compatibleRuntimes'],\n description: 'description',\n layerName: 'layerName',\n licenseInfo: 'licenseInfo',\n});"
|
| 7279 | },
|
| 7280 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersion",
|
| 7281 | "initializer": {
|
| 7282 | "docs": {
|
| 7283 | "stability": "external",
|
| 7284 | "summary": "Create a new `AWS::Lambda::LayerVersion`."
|
| 7285 | },
|
| 7286 | "locationInModule": {
|
| 7287 | "filename": "lib/lambda.generated.ts",
|
| 7288 | "line": 4168
|
| 7289 | },
|
| 7290 | "parameters": [
|
| 7291 | {
|
| 7292 | "docs": {
|
| 7293 | "summary": "- scope in which this resource is defined."
|
| 7294 | },
|
| 7295 | "name": "scope",
|
| 7296 | "type": {
|
| 7297 | "fqn": "@aws-cdk/core.Construct"
|
| 7298 | }
|
| 7299 | },
|
| 7300 | {
|
| 7301 | "docs": {
|
| 7302 | "summary": "- scoped id of the resource."
|
| 7303 | },
|
| 7304 | "name": "id",
|
| 7305 | "type": {
|
| 7306 | "primitive": "string"
|
| 7307 | }
|
| 7308 | },
|
| 7309 | {
|
| 7310 | "docs": {
|
| 7311 | "summary": "- resource properties."
|
| 7312 | },
|
| 7313 | "name": "props",
|
| 7314 | "type": {
|
| 7315 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionProps"
|
| 7316 | }
|
| 7317 | }
|
| 7318 | ]
|
| 7319 | },
|
| 7320 | "interfaces": [
|
| 7321 | "@aws-cdk/core.IInspectable"
|
| 7322 | ],
|
| 7323 | "kind": "class",
|
| 7324 | "locationInModule": {
|
| 7325 | "filename": "lib/lambda.generated.ts",
|
| 7326 | "line": 4090
|
| 7327 | },
|
| 7328 | "methods": [
|
| 7329 | {
|
| 7330 | "docs": {
|
| 7331 | "stability": "external",
|
| 7332 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 7333 | },
|
| 7334 | "locationInModule": {
|
| 7335 | "filename": "lib/lambda.generated.ts",
|
| 7336 | "line": 4186
|
| 7337 | },
|
| 7338 | "name": "inspect",
|
| 7339 | "overrides": "@aws-cdk/core.IInspectable",
|
| 7340 | "parameters": [
|
| 7341 | {
|
| 7342 | "docs": {
|
| 7343 | "summary": "- tree inspector to collect and process attributes."
|
| 7344 | },
|
| 7345 | "name": "inspector",
|
| 7346 | "type": {
|
| 7347 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 7348 | }
|
| 7349 | }
|
| 7350 | ]
|
| 7351 | },
|
| 7352 | {
|
| 7353 | "docs": {
|
| 7354 | "stability": "external"
|
| 7355 | },
|
| 7356 | "locationInModule": {
|
| 7357 | "filename": "lib/lambda.generated.ts",
|
| 7358 | "line": 4202
|
| 7359 | },
|
| 7360 | "name": "renderProperties",
|
| 7361 | "overrides": "@aws-cdk/core.CfnResource",
|
| 7362 | "parameters": [
|
| 7363 | {
|
| 7364 | "name": "props",
|
| 7365 | "type": {
|
| 7366 | "collection": {
|
| 7367 | "elementtype": {
|
| 7368 | "primitive": "any"
|
| 7369 | },
|
| 7370 | "kind": "map"
|
| 7371 | }
|
| 7372 | }
|
| 7373 | }
|
| 7374 | ],
|
| 7375 | "protected": true,
|
| 7376 | "returns": {
|
| 7377 | "type": {
|
| 7378 | "collection": {
|
| 7379 | "elementtype": {
|
| 7380 | "primitive": "any"
|
| 7381 | },
|
| 7382 | "kind": "map"
|
| 7383 | }
|
| 7384 | }
|
| 7385 | }
|
| 7386 | }
|
| 7387 | ],
|
| 7388 | "name": "CfnLayerVersion",
|
| 7389 | "properties": [
|
| 7390 | {
|
| 7391 | "const": true,
|
| 7392 | "docs": {
|
| 7393 | "stability": "external",
|
| 7394 | "summary": "The CloudFormation resource type name for this resource class."
|
| 7395 | },
|
| 7396 | "immutable": true,
|
| 7397 | "locationInModule": {
|
| 7398 | "filename": "lib/lambda.generated.ts",
|
| 7399 | "line": 4094
|
| 7400 | },
|
| 7401 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 7402 | "static": true,
|
| 7403 | "type": {
|
| 7404 | "primitive": "string"
|
| 7405 | }
|
| 7406 | },
|
| 7407 | {
|
| 7408 | "docs": {
|
| 7409 | "stability": "external"
|
| 7410 | },
|
| 7411 | "immutable": true,
|
| 7412 | "locationInModule": {
|
| 7413 | "filename": "lib/lambda.generated.ts",
|
| 7414 | "line": 4191
|
| 7415 | },
|
| 7416 | "name": "cfnProperties",
|
| 7417 | "overrides": "@aws-cdk/core.CfnResource",
|
| 7418 | "protected": true,
|
| 7419 | "type": {
|
| 7420 | "collection": {
|
| 7421 | "elementtype": {
|
| 7422 | "primitive": "any"
|
| 7423 | },
|
| 7424 | "kind": "map"
|
| 7425 | }
|
| 7426 | }
|
| 7427 | },
|
| 7428 | {
|
| 7429 | "docs": {
|
| 7430 | "custom": {
|
| 7431 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content"
|
| 7432 | },
|
| 7433 | "stability": "external",
|
| 7434 | "summary": "The function layer archive."
|
| 7435 | },
|
| 7436 | "locationInModule": {
|
| 7437 | "filename": "lib/lambda.generated.ts",
|
| 7438 | "line": 4120
|
| 7439 | },
|
| 7440 | "name": "content",
|
| 7441 | "type": {
|
| 7442 | "union": {
|
| 7443 | "types": [
|
| 7444 | {
|
| 7445 | "fqn": "@aws-cdk/core.IResolvable"
|
| 7446 | },
|
| 7447 | {
|
| 7448 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersion.ContentProperty"
|
| 7449 | }
|
| 7450 | ]
|
| 7451 | }
|
| 7452 | }
|
| 7453 | },
|
| 7454 | {
|
| 7455 | "docs": {
|
| 7456 | "custom": {
|
| 7457 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatiblearchitectures"
|
| 7458 | },
|
| 7459 | "stability": "external",
|
| 7460 | "summary": "A list of compatible [instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) ."
|
| 7461 | },
|
| 7462 | "locationInModule": {
|
| 7463 | "filename": "lib/lambda.generated.ts",
|
| 7464 | "line": 4127
|
| 7465 | },
|
| 7466 | "name": "compatibleArchitectures",
|
| 7467 | "optional": true,
|
| 7468 | "type": {
|
| 7469 | "collection": {
|
| 7470 | "elementtype": {
|
| 7471 | "primitive": "string"
|
| 7472 | },
|
| 7473 | "kind": "array"
|
| 7474 | }
|
| 7475 | }
|
| 7476 | },
|
| 7477 | {
|
| 7478 | "docs": {
|
| 7479 | "custom": {
|
| 7480 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes"
|
| 7481 | },
|
| 7482 | "stability": "external",
|
| 7483 | "summary": "A list of compatible [function runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Used for filtering with [ListLayers](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayers.html) and [ListLayerVersions](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayerVersions.html) ."
|
| 7484 | },
|
| 7485 | "locationInModule": {
|
| 7486 | "filename": "lib/lambda.generated.ts",
|
| 7487 | "line": 4134
|
| 7488 | },
|
| 7489 | "name": "compatibleRuntimes",
|
| 7490 | "optional": true,
|
| 7491 | "type": {
|
| 7492 | "collection": {
|
| 7493 | "elementtype": {
|
| 7494 | "primitive": "string"
|
| 7495 | },
|
| 7496 | "kind": "array"
|
| 7497 | }
|
| 7498 | }
|
| 7499 | },
|
| 7500 | {
|
| 7501 | "docs": {
|
| 7502 | "custom": {
|
| 7503 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description"
|
| 7504 | },
|
| 7505 | "stability": "external",
|
| 7506 | "summary": "The description of the version."
|
| 7507 | },
|
| 7508 | "locationInModule": {
|
| 7509 | "filename": "lib/lambda.generated.ts",
|
| 7510 | "line": 4141
|
| 7511 | },
|
| 7512 | "name": "description",
|
| 7513 | "optional": true,
|
| 7514 | "type": {
|
| 7515 | "primitive": "string"
|
| 7516 | }
|
| 7517 | },
|
| 7518 | {
|
| 7519 | "docs": {
|
| 7520 | "custom": {
|
| 7521 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername"
|
| 7522 | },
|
| 7523 | "stability": "external",
|
| 7524 | "summary": "The name or Amazon Resource Name (ARN) of the layer."
|
| 7525 | },
|
| 7526 | "locationInModule": {
|
| 7527 | "filename": "lib/lambda.generated.ts",
|
| 7528 | "line": 4148
|
| 7529 | },
|
| 7530 | "name": "layerName",
|
| 7531 | "optional": true,
|
| 7532 | "type": {
|
| 7533 | "primitive": "string"
|
| 7534 | }
|
| 7535 | },
|
| 7536 | {
|
| 7537 | "docs": {
|
| 7538 | "custom": {
|
| 7539 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo"
|
| 7540 | },
|
| 7541 | "remarks": "- An [SPDX license identifier](https://docs.aws.amazon.com/https://spdx.org/licenses/) . For example, `MIT` .\n- The URL of a license hosted on the internet. For example, `https://opensource.org/licenses/MIT` .\n- The full text of the license.",
|
| 7542 | "stability": "external",
|
| 7543 | "summary": "The layer's software license. It can be any of the following:."
|
| 7544 | },
|
| 7545 | "locationInModule": {
|
| 7546 | "filename": "lib/lambda.generated.ts",
|
| 7547 | "line": 4159
|
| 7548 | },
|
| 7549 | "name": "licenseInfo",
|
| 7550 | "optional": true,
|
| 7551 | "type": {
|
| 7552 | "primitive": "string"
|
| 7553 | }
|
| 7554 | }
|
| 7555 | ],
|
| 7556 | "symbolId": "lib/lambda.generated:CfnLayerVersion"
|
| 7557 | },
|
| 7558 | "@aws-cdk/aws-lambda.CfnLayerVersion.ContentProperty": {
|
| 7559 | "assembly": "@aws-cdk/aws-lambda",
|
| 7560 | "datatype": true,
|
| 7561 | "docs": {
|
| 7562 | "custom": {
|
| 7563 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html",
|
| 7564 | "exampleMetadata": "fixture=_generated"
|
| 7565 | },
|
| 7566 | "stability": "external",
|
| 7567 | "summary": "A ZIP archive that contains the contents of an [Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) .",
|
| 7568 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst contentProperty: lambda.CfnLayerVersion.ContentProperty = {\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n\n // the properties below are optional\n s3ObjectVersion: 's3ObjectVersion',\n};"
|
| 7569 | },
|
| 7570 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersion.ContentProperty",
|
| 7571 | "kind": "interface",
|
| 7572 | "locationInModule": {
|
| 7573 | "filename": "lib/lambda.generated.ts",
|
| 7574 | "line": 4216
|
| 7575 | },
|
| 7576 | "name": "ContentProperty",
|
| 7577 | "namespace": "CfnLayerVersion",
|
| 7578 | "properties": [
|
| 7579 | {
|
| 7580 | "abstract": true,
|
| 7581 | "docs": {
|
| 7582 | "custom": {
|
| 7583 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3bucket"
|
| 7584 | },
|
| 7585 | "stability": "external",
|
| 7586 | "summary": "The Amazon S3 bucket of the layer archive."
|
| 7587 | },
|
| 7588 | "immutable": true,
|
| 7589 | "locationInModule": {
|
| 7590 | "filename": "lib/lambda.generated.ts",
|
| 7591 | "line": 4222
|
| 7592 | },
|
| 7593 | "name": "s3Bucket",
|
| 7594 | "type": {
|
| 7595 | "primitive": "string"
|
| 7596 | }
|
| 7597 | },
|
| 7598 | {
|
| 7599 | "abstract": true,
|
| 7600 | "docs": {
|
| 7601 | "custom": {
|
| 7602 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3key"
|
| 7603 | },
|
| 7604 | "stability": "external",
|
| 7605 | "summary": "The Amazon S3 key of the layer archive."
|
| 7606 | },
|
| 7607 | "immutable": true,
|
| 7608 | "locationInModule": {
|
| 7609 | "filename": "lib/lambda.generated.ts",
|
| 7610 | "line": 4228
|
| 7611 | },
|
| 7612 | "name": "s3Key",
|
| 7613 | "type": {
|
| 7614 | "primitive": "string"
|
| 7615 | }
|
| 7616 | },
|
| 7617 | {
|
| 7618 | "abstract": true,
|
| 7619 | "docs": {
|
| 7620 | "custom": {
|
| 7621 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-layerversion-content.html#cfn-lambda-layerversion-content-s3objectversion"
|
| 7622 | },
|
| 7623 | "stability": "external",
|
| 7624 | "summary": "For versioned objects, the version of the layer archive object to use."
|
| 7625 | },
|
| 7626 | "immutable": true,
|
| 7627 | "locationInModule": {
|
| 7628 | "filename": "lib/lambda.generated.ts",
|
| 7629 | "line": 4234
|
| 7630 | },
|
| 7631 | "name": "s3ObjectVersion",
|
| 7632 | "optional": true,
|
| 7633 | "type": {
|
| 7634 | "primitive": "string"
|
| 7635 | }
|
| 7636 | }
|
| 7637 | ],
|
| 7638 | "symbolId": "lib/lambda.generated:CfnLayerVersion.ContentProperty"
|
| 7639 | },
|
| 7640 | "@aws-cdk/aws-lambda.CfnLayerVersionPermission": {
|
| 7641 | "assembly": "@aws-cdk/aws-lambda",
|
| 7642 | "base": "@aws-cdk/core.CfnResource",
|
| 7643 | "docs": {
|
| 7644 | "custom": {
|
| 7645 | "cloudformationResource": "AWS::Lambda::LayerVersionPermission",
|
| 7646 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html",
|
| 7647 | "exampleMetadata": "fixture=_generated"
|
| 7648 | },
|
| 7649 | "remarks": "The `AWS::Lambda::LayerVersionPermission` resource adds permissions to the resource-based policy of a version of an [Lambda layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) . Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.\n\n> Since the release of the [UpdateReplacePolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html) both `UpdateReplacePolicy` and `DeletionPolicy` are required to protect your Resources/LayerPermissions from deletion.",
|
| 7650 | "stability": "external",
|
| 7651 | "summary": "A CloudFormation `AWS::Lambda::LayerVersionPermission`.",
|
| 7652 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnLayerVersionPermission = new lambda.CfnLayerVersionPermission(this, 'MyCfnLayerVersionPermission', {\n action: 'action',\n layerVersionArn: 'layerVersionArn',\n principal: 'principal',\n\n // the properties below are optional\n organizationId: 'organizationId',\n});"
|
| 7653 | },
|
| 7654 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionPermission",
|
| 7655 | "initializer": {
|
| 7656 | "docs": {
|
| 7657 | "stability": "external",
|
| 7658 | "summary": "Create a new `AWS::Lambda::LayerVersionPermission`."
|
| 7659 | },
|
| 7660 | "locationInModule": {
|
| 7661 | "filename": "lib/lambda.generated.ts",
|
| 7662 | "line": 4462
|
| 7663 | },
|
| 7664 | "parameters": [
|
| 7665 | {
|
| 7666 | "docs": {
|
| 7667 | "summary": "- scope in which this resource is defined."
|
| 7668 | },
|
| 7669 | "name": "scope",
|
| 7670 | "type": {
|
| 7671 | "fqn": "@aws-cdk/core.Construct"
|
| 7672 | }
|
| 7673 | },
|
| 7674 | {
|
| 7675 | "docs": {
|
| 7676 | "summary": "- scoped id of the resource."
|
| 7677 | },
|
| 7678 | "name": "id",
|
| 7679 | "type": {
|
| 7680 | "primitive": "string"
|
| 7681 | }
|
| 7682 | },
|
| 7683 | {
|
| 7684 | "docs": {
|
| 7685 | "summary": "- resource properties."
|
| 7686 | },
|
| 7687 | "name": "props",
|
| 7688 | "type": {
|
| 7689 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionPermissionProps"
|
| 7690 | }
|
| 7691 | }
|
| 7692 | ]
|
| 7693 | },
|
| 7694 | "interfaces": [
|
| 7695 | "@aws-cdk/core.IInspectable"
|
| 7696 | ],
|
| 7697 | "kind": "class",
|
| 7698 | "locationInModule": {
|
| 7699 | "filename": "lib/lambda.generated.ts",
|
| 7700 | "line": 4402
|
| 7701 | },
|
| 7702 | "methods": [
|
| 7703 | {
|
| 7704 | "docs": {
|
| 7705 | "stability": "external",
|
| 7706 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 7707 | },
|
| 7708 | "locationInModule": {
|
| 7709 | "filename": "lib/lambda.generated.ts",
|
| 7710 | "line": 4480
|
| 7711 | },
|
| 7712 | "name": "inspect",
|
| 7713 | "overrides": "@aws-cdk/core.IInspectable",
|
| 7714 | "parameters": [
|
| 7715 | {
|
| 7716 | "docs": {
|
| 7717 | "summary": "- tree inspector to collect and process attributes."
|
| 7718 | },
|
| 7719 | "name": "inspector",
|
| 7720 | "type": {
|
| 7721 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 7722 | }
|
| 7723 | }
|
| 7724 | ]
|
| 7725 | },
|
| 7726 | {
|
| 7727 | "docs": {
|
| 7728 | "stability": "external"
|
| 7729 | },
|
| 7730 | "locationInModule": {
|
| 7731 | "filename": "lib/lambda.generated.ts",
|
| 7732 | "line": 4494
|
| 7733 | },
|
| 7734 | "name": "renderProperties",
|
| 7735 | "overrides": "@aws-cdk/core.CfnResource",
|
| 7736 | "parameters": [
|
| 7737 | {
|
| 7738 | "name": "props",
|
| 7739 | "type": {
|
| 7740 | "collection": {
|
| 7741 | "elementtype": {
|
| 7742 | "primitive": "any"
|
| 7743 | },
|
| 7744 | "kind": "map"
|
| 7745 | }
|
| 7746 | }
|
| 7747 | }
|
| 7748 | ],
|
| 7749 | "protected": true,
|
| 7750 | "returns": {
|
| 7751 | "type": {
|
| 7752 | "collection": {
|
| 7753 | "elementtype": {
|
| 7754 | "primitive": "any"
|
| 7755 | },
|
| 7756 | "kind": "map"
|
| 7757 | }
|
| 7758 | }
|
| 7759 | }
|
| 7760 | }
|
| 7761 | ],
|
| 7762 | "name": "CfnLayerVersionPermission",
|
| 7763 | "properties": [
|
| 7764 | {
|
| 7765 | "const": true,
|
| 7766 | "docs": {
|
| 7767 | "stability": "external",
|
| 7768 | "summary": "The CloudFormation resource type name for this resource class."
|
| 7769 | },
|
| 7770 | "immutable": true,
|
| 7771 | "locationInModule": {
|
| 7772 | "filename": "lib/lambda.generated.ts",
|
| 7773 | "line": 4406
|
| 7774 | },
|
| 7775 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 7776 | "static": true,
|
| 7777 | "type": {
|
| 7778 | "primitive": "string"
|
| 7779 | }
|
| 7780 | },
|
| 7781 | {
|
| 7782 | "docs": {
|
| 7783 | "stability": "external"
|
| 7784 | },
|
| 7785 | "immutable": true,
|
| 7786 | "locationInModule": {
|
| 7787 | "filename": "lib/lambda.generated.ts",
|
| 7788 | "line": 4485
|
| 7789 | },
|
| 7790 | "name": "cfnProperties",
|
| 7791 | "overrides": "@aws-cdk/core.CfnResource",
|
| 7792 | "protected": true,
|
| 7793 | "type": {
|
| 7794 | "collection": {
|
| 7795 | "elementtype": {
|
| 7796 | "primitive": "any"
|
| 7797 | },
|
| 7798 | "kind": "map"
|
| 7799 | }
|
| 7800 | }
|
| 7801 | },
|
| 7802 | {
|
| 7803 | "docs": {
|
| 7804 | "custom": {
|
| 7805 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-action"
|
| 7806 | },
|
| 7807 | "remarks": "For example, `lambda:GetLayerVersion` .",
|
| 7808 | "stability": "external",
|
| 7809 | "summary": "The API action that grants access to the layer."
|
| 7810 | },
|
| 7811 | "locationInModule": {
|
| 7812 | "filename": "lib/lambda.generated.ts",
|
| 7813 | "line": 4432
|
| 7814 | },
|
| 7815 | "name": "action",
|
| 7816 | "type": {
|
| 7817 | "primitive": "string"
|
| 7818 | }
|
| 7819 | },
|
| 7820 | {
|
| 7821 | "docs": {
|
| 7822 | "custom": {
|
| 7823 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-layerversionarn"
|
| 7824 | },
|
| 7825 | "stability": "external",
|
| 7826 | "summary": "The name or Amazon Resource Name (ARN) of the layer."
|
| 7827 | },
|
| 7828 | "locationInModule": {
|
| 7829 | "filename": "lib/lambda.generated.ts",
|
| 7830 | "line": 4439
|
| 7831 | },
|
| 7832 | "name": "layerVersionArn",
|
| 7833 | "type": {
|
| 7834 | "primitive": "string"
|
| 7835 | }
|
| 7836 | },
|
| 7837 | {
|
| 7838 | "docs": {
|
| 7839 | "custom": {
|
| 7840 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-principal"
|
| 7841 | },
|
| 7842 | "remarks": "For the last case, make sure that you really do want all AWS accounts to have usage permission to this layer.",
|
| 7843 | "stability": "external",
|
| 7844 | "summary": "An account ID, or `*` to grant layer usage permission to all accounts in an organization, or all AWS accounts (if `organizationId` is not specified)."
|
| 7845 | },
|
| 7846 | "locationInModule": {
|
| 7847 | "filename": "lib/lambda.generated.ts",
|
| 7848 | "line": 4446
|
| 7849 | },
|
| 7850 | "name": "principal",
|
| 7851 | "type": {
|
| 7852 | "primitive": "string"
|
| 7853 | }
|
| 7854 | },
|
| 7855 | {
|
| 7856 | "docs": {
|
| 7857 | "custom": {
|
| 7858 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-organizationid"
|
| 7859 | },
|
| 7860 | "stability": "external",
|
| 7861 | "summary": "With the principal set to `*` , grant permission to all accounts in the specified organization."
|
| 7862 | },
|
| 7863 | "locationInModule": {
|
| 7864 | "filename": "lib/lambda.generated.ts",
|
| 7865 | "line": 4453
|
| 7866 | },
|
| 7867 | "name": "organizationId",
|
| 7868 | "optional": true,
|
| 7869 | "type": {
|
| 7870 | "primitive": "string"
|
| 7871 | }
|
| 7872 | }
|
| 7873 | ],
|
| 7874 | "symbolId": "lib/lambda.generated:CfnLayerVersionPermission"
|
| 7875 | },
|
| 7876 | "@aws-cdk/aws-lambda.CfnLayerVersionPermissionProps": {
|
| 7877 | "assembly": "@aws-cdk/aws-lambda",
|
| 7878 | "datatype": true,
|
| 7879 | "docs": {
|
| 7880 | "custom": {
|
| 7881 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html",
|
| 7882 | "exampleMetadata": "fixture=_generated"
|
| 7883 | },
|
| 7884 | "stability": "external",
|
| 7885 | "summary": "Properties for defining a `CfnLayerVersionPermission`.",
|
| 7886 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnLayerVersionPermissionProps: lambda.CfnLayerVersionPermissionProps = {\n action: 'action',\n layerVersionArn: 'layerVersionArn',\n principal: 'principal',\n\n // the properties below are optional\n organizationId: 'organizationId',\n};"
|
| 7887 | },
|
| 7888 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionPermissionProps",
|
| 7889 | "kind": "interface",
|
| 7890 | "locationInModule": {
|
| 7891 | "filename": "lib/lambda.generated.ts",
|
| 7892 | "line": 4302
|
| 7893 | },
|
| 7894 | "name": "CfnLayerVersionPermissionProps",
|
| 7895 | "properties": [
|
| 7896 | {
|
| 7897 | "abstract": true,
|
| 7898 | "docs": {
|
| 7899 | "custom": {
|
| 7900 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-action"
|
| 7901 | },
|
| 7902 | "remarks": "For example, `lambda:GetLayerVersion` .",
|
| 7903 | "stability": "external",
|
| 7904 | "summary": "The API action that grants access to the layer."
|
| 7905 | },
|
| 7906 | "immutable": true,
|
| 7907 | "locationInModule": {
|
| 7908 | "filename": "lib/lambda.generated.ts",
|
| 7909 | "line": 4309
|
| 7910 | },
|
| 7911 | "name": "action",
|
| 7912 | "type": {
|
| 7913 | "primitive": "string"
|
| 7914 | }
|
| 7915 | },
|
| 7916 | {
|
| 7917 | "abstract": true,
|
| 7918 | "docs": {
|
| 7919 | "custom": {
|
| 7920 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-layerversionarn"
|
| 7921 | },
|
| 7922 | "stability": "external",
|
| 7923 | "summary": "The name or Amazon Resource Name (ARN) of the layer."
|
| 7924 | },
|
| 7925 | "immutable": true,
|
| 7926 | "locationInModule": {
|
| 7927 | "filename": "lib/lambda.generated.ts",
|
| 7928 | "line": 4316
|
| 7929 | },
|
| 7930 | "name": "layerVersionArn",
|
| 7931 | "type": {
|
| 7932 | "primitive": "string"
|
| 7933 | }
|
| 7934 | },
|
| 7935 | {
|
| 7936 | "abstract": true,
|
| 7937 | "docs": {
|
| 7938 | "custom": {
|
| 7939 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-principal"
|
| 7940 | },
|
| 7941 | "remarks": "For the last case, make sure that you really do want all AWS accounts to have usage permission to this layer.",
|
| 7942 | "stability": "external",
|
| 7943 | "summary": "An account ID, or `*` to grant layer usage permission to all accounts in an organization, or all AWS accounts (if `organizationId` is not specified)."
|
| 7944 | },
|
| 7945 | "immutable": true,
|
| 7946 | "locationInModule": {
|
| 7947 | "filename": "lib/lambda.generated.ts",
|
| 7948 | "line": 4323
|
| 7949 | },
|
| 7950 | "name": "principal",
|
| 7951 | "type": {
|
| 7952 | "primitive": "string"
|
| 7953 | }
|
| 7954 | },
|
| 7955 | {
|
| 7956 | "abstract": true,
|
| 7957 | "docs": {
|
| 7958 | "custom": {
|
| 7959 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversionpermission.html#cfn-lambda-layerversionpermission-organizationid"
|
| 7960 | },
|
| 7961 | "stability": "external",
|
| 7962 | "summary": "With the principal set to `*` , grant permission to all accounts in the specified organization."
|
| 7963 | },
|
| 7964 | "immutable": true,
|
| 7965 | "locationInModule": {
|
| 7966 | "filename": "lib/lambda.generated.ts",
|
| 7967 | "line": 4330
|
| 7968 | },
|
| 7969 | "name": "organizationId",
|
| 7970 | "optional": true,
|
| 7971 | "type": {
|
| 7972 | "primitive": "string"
|
| 7973 | }
|
| 7974 | }
|
| 7975 | ],
|
| 7976 | "symbolId": "lib/lambda.generated:CfnLayerVersionPermissionProps"
|
| 7977 | },
|
| 7978 | "@aws-cdk/aws-lambda.CfnLayerVersionProps": {
|
| 7979 | "assembly": "@aws-cdk/aws-lambda",
|
| 7980 | "datatype": true,
|
| 7981 | "docs": {
|
| 7982 | "custom": {
|
| 7983 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html",
|
| 7984 | "exampleMetadata": "fixture=_generated"
|
| 7985 | },
|
| 7986 | "stability": "external",
|
| 7987 | "summary": "Properties for defining a `CfnLayerVersion`.",
|
| 7988 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnLayerVersionProps: lambda.CfnLayerVersionProps = {\n content: {\n s3Bucket: 's3Bucket',\n s3Key: 's3Key',\n\n // the properties below are optional\n s3ObjectVersion: 's3ObjectVersion',\n },\n\n // the properties below are optional\n compatibleArchitectures: ['compatibleArchitectures'],\n compatibleRuntimes: ['compatibleRuntimes'],\n description: 'description',\n layerName: 'layerName',\n licenseInfo: 'licenseInfo',\n};"
|
| 7989 | },
|
| 7990 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersionProps",
|
| 7991 | "kind": "interface",
|
| 7992 | "locationInModule": {
|
| 7993 | "filename": "lib/lambda.generated.ts",
|
| 7994 | "line": 3970
|
| 7995 | },
|
| 7996 | "name": "CfnLayerVersionProps",
|
| 7997 | "properties": [
|
| 7998 | {
|
| 7999 | "abstract": true,
|
| 8000 | "docs": {
|
| 8001 | "custom": {
|
| 8002 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-content"
|
| 8003 | },
|
| 8004 | "stability": "external",
|
| 8005 | "summary": "The function layer archive."
|
| 8006 | },
|
| 8007 | "immutable": true,
|
| 8008 | "locationInModule": {
|
| 8009 | "filename": "lib/lambda.generated.ts",
|
| 8010 | "line": 3977
|
| 8011 | },
|
| 8012 | "name": "content",
|
| 8013 | "type": {
|
| 8014 | "union": {
|
| 8015 | "types": [
|
| 8016 | {
|
| 8017 | "fqn": "@aws-cdk/core.IResolvable"
|
| 8018 | },
|
| 8019 | {
|
| 8020 | "fqn": "@aws-cdk/aws-lambda.CfnLayerVersion.ContentProperty"
|
| 8021 | }
|
| 8022 | ]
|
| 8023 | }
|
| 8024 | }
|
| 8025 | },
|
| 8026 | {
|
| 8027 | "abstract": true,
|
| 8028 | "docs": {
|
| 8029 | "custom": {
|
| 8030 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatiblearchitectures"
|
| 8031 | },
|
| 8032 | "stability": "external",
|
| 8033 | "summary": "A list of compatible [instruction set architectures](https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html) ."
|
| 8034 | },
|
| 8035 | "immutable": true,
|
| 8036 | "locationInModule": {
|
| 8037 | "filename": "lib/lambda.generated.ts",
|
| 8038 | "line": 3984
|
| 8039 | },
|
| 8040 | "name": "compatibleArchitectures",
|
| 8041 | "optional": true,
|
| 8042 | "type": {
|
| 8043 | "collection": {
|
| 8044 | "elementtype": {
|
| 8045 | "primitive": "string"
|
| 8046 | },
|
| 8047 | "kind": "array"
|
| 8048 | }
|
| 8049 | }
|
| 8050 | },
|
| 8051 | {
|
| 8052 | "abstract": true,
|
| 8053 | "docs": {
|
| 8054 | "custom": {
|
| 8055 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-compatibleruntimes"
|
| 8056 | },
|
| 8057 | "stability": "external",
|
| 8058 | "summary": "A list of compatible [function runtimes](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) . Used for filtering with [ListLayers](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayers.html) and [ListLayerVersions](https://docs.aws.amazon.com/lambda/latest/dg/API_ListLayerVersions.html) ."
|
| 8059 | },
|
| 8060 | "immutable": true,
|
| 8061 | "locationInModule": {
|
| 8062 | "filename": "lib/lambda.generated.ts",
|
| 8063 | "line": 3991
|
| 8064 | },
|
| 8065 | "name": "compatibleRuntimes",
|
| 8066 | "optional": true,
|
| 8067 | "type": {
|
| 8068 | "collection": {
|
| 8069 | "elementtype": {
|
| 8070 | "primitive": "string"
|
| 8071 | },
|
| 8072 | "kind": "array"
|
| 8073 | }
|
| 8074 | }
|
| 8075 | },
|
| 8076 | {
|
| 8077 | "abstract": true,
|
| 8078 | "docs": {
|
| 8079 | "custom": {
|
| 8080 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-description"
|
| 8081 | },
|
| 8082 | "stability": "external",
|
| 8083 | "summary": "The description of the version."
|
| 8084 | },
|
| 8085 | "immutable": true,
|
| 8086 | "locationInModule": {
|
| 8087 | "filename": "lib/lambda.generated.ts",
|
| 8088 | "line": 3998
|
| 8089 | },
|
| 8090 | "name": "description",
|
| 8091 | "optional": true,
|
| 8092 | "type": {
|
| 8093 | "primitive": "string"
|
| 8094 | }
|
| 8095 | },
|
| 8096 | {
|
| 8097 | "abstract": true,
|
| 8098 | "docs": {
|
| 8099 | "custom": {
|
| 8100 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-layername"
|
| 8101 | },
|
| 8102 | "stability": "external",
|
| 8103 | "summary": "The name or Amazon Resource Name (ARN) of the layer."
|
| 8104 | },
|
| 8105 | "immutable": true,
|
| 8106 | "locationInModule": {
|
| 8107 | "filename": "lib/lambda.generated.ts",
|
| 8108 | "line": 4005
|
| 8109 | },
|
| 8110 | "name": "layerName",
|
| 8111 | "optional": true,
|
| 8112 | "type": {
|
| 8113 | "primitive": "string"
|
| 8114 | }
|
| 8115 | },
|
| 8116 | {
|
| 8117 | "abstract": true,
|
| 8118 | "docs": {
|
| 8119 | "custom": {
|
| 8120 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-layerversion.html#cfn-lambda-layerversion-licenseinfo"
|
| 8121 | },
|
| 8122 | "remarks": "- An [SPDX license identifier](https://docs.aws.amazon.com/https://spdx.org/licenses/) . For example, `MIT` .\n- The URL of a license hosted on the internet. For example, `https://opensource.org/licenses/MIT` .\n- The full text of the license.",
|
| 8123 | "stability": "external",
|
| 8124 | "summary": "The layer's software license. It can be any of the following:."
|
| 8125 | },
|
| 8126 | "immutable": true,
|
| 8127 | "locationInModule": {
|
| 8128 | "filename": "lib/lambda.generated.ts",
|
| 8129 | "line": 4016
|
| 8130 | },
|
| 8131 | "name": "licenseInfo",
|
| 8132 | "optional": true,
|
| 8133 | "type": {
|
| 8134 | "primitive": "string"
|
| 8135 | }
|
| 8136 | }
|
| 8137 | ],
|
| 8138 | "symbolId": "lib/lambda.generated:CfnLayerVersionProps"
|
| 8139 | },
|
| 8140 | "@aws-cdk/aws-lambda.CfnParametersCode": {
|
| 8141 | "assembly": "@aws-cdk/aws-lambda",
|
| 8142 | "base": "@aws-cdk/aws-lambda.Code",
|
| 8143 | "docs": {
|
| 8144 | "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.",
|
| 8145 | "stability": "stable",
|
| 8146 | "summary": "Lambda code defined using 2 CloudFormation parameters.",
|
| 8147 | "example": "const lambdaStack = new cdk.Stack(app, 'LambdaStack');\nconst lambdaCode = lambda.Code.fromCfnParameters();\nnew lambda.Function(lambdaStack, 'Lambda', {\n code: lambdaCode,\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_14_X,\n});\n// other resources that your Lambda needs, added to the lambdaStack...\n\nconst pipelineStack = new cdk.Stack(app, 'PipelineStack');\nconst pipeline = new codepipeline.Pipeline(pipelineStack, 'Pipeline');\n\n// add the source code repository containing this code to your Pipeline,\n// and the source code of the Lambda Function, if they're separate\nconst cdkSourceOutput = new codepipeline.Artifact();\nconst cdkSourceAction = new codepipeline_actions.CodeCommitSourceAction({\n repository: new codecommit.Repository(pipelineStack, 'CdkCodeRepo', {\n repositoryName: 'CdkCodeRepo',\n }),\n actionName: 'CdkCode_Source',\n output: cdkSourceOutput,\n});\nconst lambdaSourceOutput = new codepipeline.Artifact();\nconst lambdaSourceAction = new codepipeline_actions.CodeCommitSourceAction({\n repository: new codecommit.Repository(pipelineStack, 'LambdaCodeRepo', {\n repositoryName: 'LambdaCodeRepo',\n }),\n actionName: 'LambdaCode_Source',\n output: lambdaSourceOutput,\n});\npipeline.addStage({\n stageName: 'Source',\n actions: [cdkSourceAction, lambdaSourceAction],\n});\n\n// synthesize the Lambda CDK template, using CodeBuild\n// the below values are just examples, assuming your CDK code is in TypeScript/JavaScript -\n// adjust the build environment and/or commands accordingly\nconst cdkBuildProject = new codebuild.Project(pipelineStack, 'CdkBuildProject', {\n environment: {\n buildImage: codebuild.LinuxBuildImage.UBUNTU_14_04_NODEJS_10_1_0,\n },\n buildSpec: codebuild.BuildSpec.fromObject({\n version: '0.2',\n phases: {\n install: {\n commands: 'npm install',\n },\n build: {\n commands: [\n 'npm run build',\n 'npm run cdk synth LambdaStack -- -o .',\n ],\n },\n },\n artifacts: {\n files: 'LambdaStack.template.yaml',\n },\n }),\n});\nconst cdkBuildOutput = new codepipeline.Artifact();\nconst cdkBuildAction = new codepipeline_actions.CodeBuildAction({\n actionName: 'CDK_Build',\n project: cdkBuildProject,\n input: cdkSourceOutput,\n outputs: [cdkBuildOutput],\n});\n\n// build your Lambda code, using CodeBuild\n// again, this example assumes your Lambda is written in TypeScript/JavaScript -\n// make sure to adjust the build environment and/or commands if they don't match your specific situation\nconst lambdaBuildProject = new codebuild.Project(pipelineStack, 'LambdaBuildProject', {\n environment: {\n buildImage: codebuild.LinuxBuildImage.UBUNTU_14_04_NODEJS_10_1_0,\n },\n buildSpec: codebuild.BuildSpec.fromObject({\n version: '0.2',\n phases: {\n install: {\n commands: 'npm install',\n },\n build: {\n commands: 'npm run build',\n },\n },\n artifacts: {\n files: [\n 'index.js',\n 'node_modules/**/*',\n ],\n },\n }),\n});\nconst lambdaBuildOutput = new codepipeline.Artifact();\nconst lambdaBuildAction = new codepipeline_actions.CodeBuildAction({\n actionName: 'Lambda_Build',\n project: lambdaBuildProject,\n input: lambdaSourceOutput,\n outputs: [lambdaBuildOutput],\n});\n\npipeline.addStage({\n stageName: 'Build',\n actions: [cdkBuildAction, lambdaBuildAction],\n});\n\n// finally, deploy your Lambda Stack\npipeline.addStage({\n stageName: 'Deploy',\n actions: [\n new codepipeline_actions.CloudFormationCreateUpdateStackAction({\n actionName: 'Lambda_CFN_Deploy',\n templatePath: cdkBuildOutput.atPath('LambdaStack.template.yaml'),\n stackName: 'LambdaStackDeployedName',\n adminPermissions: true,\n parameterOverrides: lambdaCode.assign(lambdaBuildOutput.s3Location),\n extraInputs: [\n lambdaBuildOutput,\n ],\n }),\n ],\n});",
|
| 8148 | "custom": {
|
| 8149 | "exampleMetadata": "lit=test/integ.lambda-deployed-through-codepipeline.lit.ts infused"
|
| 8150 | }
|
| 8151 | },
|
| 8152 | "fqn": "@aws-cdk/aws-lambda.CfnParametersCode",
|
| 8153 | "initializer": {
|
| 8154 | "docs": {
|
| 8155 | "stability": "stable"
|
| 8156 | },
|
| 8157 | "locationInModule": {
|
| 8158 | "filename": "lib/code.ts",
|
| 8159 | "line": 361
|
| 8160 | },
|
| 8161 | "parameters": [
|
| 8162 | {
|
| 8163 | "name": "props",
|
| 8164 | "optional": true,
|
| 8165 | "type": {
|
| 8166 | "fqn": "@aws-cdk/aws-lambda.CfnParametersCodeProps"
|
| 8167 | }
|
| 8168 | }
|
| 8169 | ]
|
| 8170 | },
|
| 8171 | "kind": "class",
|
| 8172 | "locationInModule": {
|
| 8173 | "filename": "lib/code.ts",
|
| 8174 | "line": 356
|
| 8175 | },
|
| 8176 | "methods": [
|
| 8177 | {
|
| 8178 | "docs": {
|
| 8179 | "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.",
|
| 8180 | "stability": "stable",
|
| 8181 | "summary": "Create a parameters map from this instance's CloudFormation parameters."
|
| 8182 | },
|
| 8183 | "locationInModule": {
|
| 8184 | "filename": "lib/code.ts",
|
| 8185 | "line": 401
|
| 8186 | },
|
| 8187 | "name": "assign",
|
| 8188 | "parameters": [
|
| 8189 | {
|
| 8190 | "docs": {
|
| 8191 | "summary": "the location of the object in S3 that represents the Lambda code."
|
| 8192 | },
|
| 8193 | "name": "location",
|
| 8194 | "type": {
|
| 8195 | "fqn": "@aws-cdk/aws-s3.Location"
|
| 8196 | }
|
| 8197 | }
|
| 8198 | ],
|
| 8199 | "returns": {
|
| 8200 | "type": {
|
| 8201 | "collection": {
|
| 8202 | "elementtype": {
|
| 8203 | "primitive": "any"
|
| 8204 | },
|
| 8205 | "kind": "map"
|
| 8206 | }
|
| 8207 | }
|
| 8208 | }
|
| 8209 | },
|
| 8210 | {
|
| 8211 | "docs": {
|
| 8212 | "stability": "stable",
|
| 8213 | "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun."
|
| 8214 | },
|
| 8215 | "locationInModule": {
|
| 8216 | "filename": "lib/code.ts",
|
| 8217 | "line": 368
|
| 8218 | },
|
| 8219 | "name": "bind",
|
| 8220 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 8221 | "parameters": [
|
| 8222 | {
|
| 8223 | "name": "scope",
|
| 8224 | "type": {
|
| 8225 | "fqn": "@aws-cdk/core.Construct"
|
| 8226 | }
|
| 8227 | }
|
| 8228 | ],
|
| 8229 | "returns": {
|
| 8230 | "type": {
|
| 8231 | "fqn": "@aws-cdk/aws-lambda.CodeConfig"
|
| 8232 | }
|
| 8233 | }
|
| 8234 | }
|
| 8235 | ],
|
| 8236 | "name": "CfnParametersCode",
|
| 8237 | "properties": [
|
| 8238 | {
|
| 8239 | "docs": {
|
| 8240 | "stability": "stable"
|
| 8241 | },
|
| 8242 | "immutable": true,
|
| 8243 | "locationInModule": {
|
| 8244 | "filename": "lib/code.ts",
|
| 8245 | "line": 408
|
| 8246 | },
|
| 8247 | "name": "bucketNameParam",
|
| 8248 | "type": {
|
| 8249 | "primitive": "string"
|
| 8250 | }
|
| 8251 | },
|
| 8252 | {
|
| 8253 | "docs": {
|
| 8254 | "stability": "stable",
|
| 8255 | "summary": "Determines whether this Code is inline code or not."
|
| 8256 | },
|
| 8257 | "immutable": true,
|
| 8258 | "locationInModule": {
|
| 8259 | "filename": "lib/code.ts",
|
| 8260 | "line": 357
|
| 8261 | },
|
| 8262 | "name": "isInline",
|
| 8263 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 8264 | "type": {
|
| 8265 | "primitive": "boolean"
|
| 8266 | }
|
| 8267 | },
|
| 8268 | {
|
| 8269 | "docs": {
|
| 8270 | "stability": "stable"
|
| 8271 | },
|
| 8272 | "immutable": true,
|
| 8273 | "locationInModule": {
|
| 8274 | "filename": "lib/code.ts",
|
| 8275 | "line": 416
|
| 8276 | },
|
| 8277 | "name": "objectKeyParam",
|
| 8278 | "type": {
|
| 8279 | "primitive": "string"
|
| 8280 | }
|
| 8281 | }
|
| 8282 | ],
|
| 8283 | "symbolId": "lib/code:CfnParametersCode"
|
| 8284 | },
|
| 8285 | "@aws-cdk/aws-lambda.CfnParametersCodeProps": {
|
| 8286 | "assembly": "@aws-cdk/aws-lambda",
|
| 8287 | "datatype": true,
|
| 8288 | "docs": {
|
| 8289 | "stability": "stable",
|
| 8290 | "summary": "Construction properties for {@link CfnParametersCode}.",
|
| 8291 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const cfnParameter: cdk.CfnParameter;\nconst cfnParametersCodeProps: lambda.CfnParametersCodeProps = {\n bucketNameParam: cfnParameter,\n objectKeyParam: cfnParameter,\n};",
|
| 8292 | "custom": {
|
| 8293 | "exampleMetadata": "fixture=_generated"
|
| 8294 | }
|
| 8295 | },
|
| 8296 | "fqn": "@aws-cdk/aws-lambda.CfnParametersCodeProps",
|
| 8297 | "kind": "interface",
|
| 8298 | "locationInModule": {
|
| 8299 | "filename": "lib/code.ts",
|
| 8300 | "line": 330
|
| 8301 | },
|
| 8302 | "name": "CfnParametersCodeProps",
|
| 8303 | "properties": [
|
| 8304 | {
|
| 8305 | "abstract": true,
|
| 8306 | "docs": {
|
| 8307 | "default": "a new parameter will be created",
|
| 8308 | "remarks": "Must be of type 'String'.",
|
| 8309 | "stability": "stable",
|
| 8310 | "summary": "The CloudFormation parameter that represents the name of the S3 Bucket where the Lambda code will be located in."
|
| 8311 | },
|
| 8312 | "immutable": true,
|
| 8313 | "locationInModule": {
|
| 8314 | "filename": "lib/code.ts",
|
| 8315 | "line": 338
|
| 8316 | },
|
| 8317 | "name": "bucketNameParam",
|
| 8318 | "optional": true,
|
| 8319 | "type": {
|
| 8320 | "fqn": "@aws-cdk/core.CfnParameter"
|
| 8321 | }
|
| 8322 | },
|
| 8323 | {
|
| 8324 | "abstract": true,
|
| 8325 | "docs": {
|
| 8326 | "default": "a new parameter will be created",
|
| 8327 | "remarks": "Must be of type 'String'.",
|
| 8328 | "stability": "stable",
|
| 8329 | "summary": "The CloudFormation parameter that represents the path inside the S3 Bucket where the Lambda code will be located at."
|
| 8330 | },
|
| 8331 | "immutable": true,
|
| 8332 | "locationInModule": {
|
| 8333 | "filename": "lib/code.ts",
|
| 8334 | "line": 347
|
| 8335 | },
|
| 8336 | "name": "objectKeyParam",
|
| 8337 | "optional": true,
|
| 8338 | "type": {
|
| 8339 | "fqn": "@aws-cdk/core.CfnParameter"
|
| 8340 | }
|
| 8341 | }
|
| 8342 | ],
|
| 8343 | "symbolId": "lib/code:CfnParametersCodeProps"
|
| 8344 | },
|
| 8345 | "@aws-cdk/aws-lambda.CfnPermission": {
|
| 8346 | "assembly": "@aws-cdk/aws-lambda",
|
| 8347 | "base": "@aws-cdk/core.CfnResource",
|
| 8348 | "docs": {
|
| 8349 | "custom": {
|
| 8350 | "cloudformationResource": "AWS::Lambda::Permission",
|
| 8351 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html",
|
| 8352 | "exampleMetadata": "fixture=_generated"
|
| 8353 | },
|
| 8354 | "remarks": "The `AWS::Lambda::Permission` resource grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.\n\nTo grant permission to another account, specify the account ID as the `Principal` . To grant permission to an organization defined in AWS Organizations , specify the organization ID as the `PrincipalOrgID` . For AWS services, the principal is a domain-style identifier defined by the service, like `s3.amazonaws.com` or `sns.amazonaws.com` . For AWS services, you can also specify the ARN of the associated resource as the `SourceArn` . If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.\n\nIf your function has a function URL, you can specify the `FunctionUrlAuthType` parameter. This adds a condition to your permission that only applies when your function URL's `AuthType` matches the specified `FunctionUrlAuthType` . For more information about the `AuthType` parameter, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .\n\nThis resource adds a statement to a resource-based permission policy for the function. For more information about function policies, see [Lambda Function Policies](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html) .",
|
| 8355 | "stability": "external",
|
| 8356 | "summary": "A CloudFormation `AWS::Lambda::Permission`.",
|
| 8357 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnPermission = new lambda.CfnPermission(this, 'MyCfnPermission', {\n action: 'action',\n functionName: 'functionName',\n principal: 'principal',\n\n // the properties below are optional\n eventSourceToken: 'eventSourceToken',\n functionUrlAuthType: 'functionUrlAuthType',\n principalOrgId: 'principalOrgId',\n sourceAccount: 'sourceAccount',\n sourceArn: 'sourceArn',\n});"
|
| 8358 | },
|
| 8359 | "fqn": "@aws-cdk/aws-lambda.CfnPermission",
|
| 8360 | "initializer": {
|
| 8361 | "docs": {
|
| 8362 | "stability": "external",
|
| 8363 | "summary": "Create a new `AWS::Lambda::Permission`."
|
| 8364 | },
|
| 8365 | "locationInModule": {
|
| 8366 | "filename": "lib/lambda.generated.ts",
|
| 8367 | "line": 4755
|
| 8368 | },
|
| 8369 | "parameters": [
|
| 8370 | {
|
| 8371 | "docs": {
|
| 8372 | "summary": "- scope in which this resource is defined."
|
| 8373 | },
|
| 8374 | "name": "scope",
|
| 8375 | "type": {
|
| 8376 | "fqn": "@aws-cdk/core.Construct"
|
| 8377 | }
|
| 8378 | },
|
| 8379 | {
|
| 8380 | "docs": {
|
| 8381 | "summary": "- scoped id of the resource."
|
| 8382 | },
|
| 8383 | "name": "id",
|
| 8384 | "type": {
|
| 8385 | "primitive": "string"
|
| 8386 | }
|
| 8387 | },
|
| 8388 | {
|
| 8389 | "docs": {
|
| 8390 | "summary": "- resource properties."
|
| 8391 | },
|
| 8392 | "name": "props",
|
| 8393 | "type": {
|
| 8394 | "fqn": "@aws-cdk/aws-lambda.CfnPermissionProps"
|
| 8395 | }
|
| 8396 | }
|
| 8397 | ]
|
| 8398 | },
|
| 8399 | "interfaces": [
|
| 8400 | "@aws-cdk/core.IInspectable"
|
| 8401 | ],
|
| 8402 | "kind": "class",
|
| 8403 | "locationInModule": {
|
| 8404 | "filename": "lib/lambda.generated.ts",
|
| 8405 | "line": 4659
|
| 8406 | },
|
| 8407 | "methods": [
|
| 8408 | {
|
| 8409 | "docs": {
|
| 8410 | "stability": "external",
|
| 8411 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 8412 | },
|
| 8413 | "locationInModule": {
|
| 8414 | "filename": "lib/lambda.generated.ts",
|
| 8415 | "line": 4777
|
| 8416 | },
|
| 8417 | "name": "inspect",
|
| 8418 | "overrides": "@aws-cdk/core.IInspectable",
|
| 8419 | "parameters": [
|
| 8420 | {
|
| 8421 | "docs": {
|
| 8422 | "summary": "- tree inspector to collect and process attributes."
|
| 8423 | },
|
| 8424 | "name": "inspector",
|
| 8425 | "type": {
|
| 8426 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 8427 | }
|
| 8428 | }
|
| 8429 | ]
|
| 8430 | },
|
| 8431 | {
|
| 8432 | "docs": {
|
| 8433 | "stability": "external"
|
| 8434 | },
|
| 8435 | "locationInModule": {
|
| 8436 | "filename": "lib/lambda.generated.ts",
|
| 8437 | "line": 4795
|
| 8438 | },
|
| 8439 | "name": "renderProperties",
|
| 8440 | "overrides": "@aws-cdk/core.CfnResource",
|
| 8441 | "parameters": [
|
| 8442 | {
|
| 8443 | "name": "props",
|
| 8444 | "type": {
|
| 8445 | "collection": {
|
| 8446 | "elementtype": {
|
| 8447 | "primitive": "any"
|
| 8448 | },
|
| 8449 | "kind": "map"
|
| 8450 | }
|
| 8451 | }
|
| 8452 | }
|
| 8453 | ],
|
| 8454 | "protected": true,
|
| 8455 | "returns": {
|
| 8456 | "type": {
|
| 8457 | "collection": {
|
| 8458 | "elementtype": {
|
| 8459 | "primitive": "any"
|
| 8460 | },
|
| 8461 | "kind": "map"
|
| 8462 | }
|
| 8463 | }
|
| 8464 | }
|
| 8465 | }
|
| 8466 | ],
|
| 8467 | "name": "CfnPermission",
|
| 8468 | "properties": [
|
| 8469 | {
|
| 8470 | "const": true,
|
| 8471 | "docs": {
|
| 8472 | "stability": "external",
|
| 8473 | "summary": "The CloudFormation resource type name for this resource class."
|
| 8474 | },
|
| 8475 | "immutable": true,
|
| 8476 | "locationInModule": {
|
| 8477 | "filename": "lib/lambda.generated.ts",
|
| 8478 | "line": 4663
|
| 8479 | },
|
| 8480 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 8481 | "static": true,
|
| 8482 | "type": {
|
| 8483 | "primitive": "string"
|
| 8484 | }
|
| 8485 | },
|
| 8486 | {
|
| 8487 | "docs": {
|
| 8488 | "stability": "external"
|
| 8489 | },
|
| 8490 | "immutable": true,
|
| 8491 | "locationInModule": {
|
| 8492 | "filename": "lib/lambda.generated.ts",
|
| 8493 | "line": 4782
|
| 8494 | },
|
| 8495 | "name": "cfnProperties",
|
| 8496 | "overrides": "@aws-cdk/core.CfnResource",
|
| 8497 | "protected": true,
|
| 8498 | "type": {
|
| 8499 | "collection": {
|
| 8500 | "elementtype": {
|
| 8501 | "primitive": "any"
|
| 8502 | },
|
| 8503 | "kind": "map"
|
| 8504 | }
|
| 8505 | }
|
| 8506 | },
|
| 8507 | {
|
| 8508 | "docs": {
|
| 8509 | "custom": {
|
| 8510 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action"
|
| 8511 | },
|
| 8512 | "remarks": "For example, `lambda:InvokeFunction` or `lambda:GetFunction` .",
|
| 8513 | "stability": "external",
|
| 8514 | "summary": "The action that the principal can use on the function."
|
| 8515 | },
|
| 8516 | "locationInModule": {
|
| 8517 | "filename": "lib/lambda.generated.ts",
|
| 8518 | "line": 4689
|
| 8519 | },
|
| 8520 | "name": "action",
|
| 8521 | "type": {
|
| 8522 | "primitive": "string"
|
| 8523 | }
|
| 8524 | },
|
| 8525 | {
|
| 8526 | "docs": {
|
| 8527 | "custom": {
|
| 8528 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname"
|
| 8529 | },
|
| 8530 | "remarks": "**Name formats** - *Function name* – `my-function` (name-only), `my-function:v1` (with alias).\n- *Function ARN* – `arn:aws:lambda:us-west-2:123456789012:function:my-function` .\n- *Partial ARN* – `123456789012:function:my-function` .\n\nYou can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
| 8531 | "stability": "external",
|
| 8532 | "summary": "The name of the Lambda function, version, or alias."
|
| 8533 | },
|
| 8534 | "locationInModule": {
|
| 8535 | "filename": "lib/lambda.generated.ts",
|
| 8536 | "line": 4702
|
| 8537 | },
|
| 8538 | "name": "functionName",
|
| 8539 | "type": {
|
| 8540 | "primitive": "string"
|
| 8541 | }
|
| 8542 | },
|
| 8543 | {
|
| 8544 | "docs": {
|
| 8545 | "custom": {
|
| 8546 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal"
|
| 8547 | },
|
| 8548 | "remarks": "If you specify a service, use `SourceArn` or `SourceAccount` to limit who can invoke the function through that service.",
|
| 8549 | "stability": "external",
|
| 8550 | "summary": "The AWS service or AWS account that invokes the function."
|
| 8551 | },
|
| 8552 | "locationInModule": {
|
| 8553 | "filename": "lib/lambda.generated.ts",
|
| 8554 | "line": 4709
|
| 8555 | },
|
| 8556 | "name": "principal",
|
| 8557 | "type": {
|
| 8558 | "primitive": "string"
|
| 8559 | }
|
| 8560 | },
|
| 8561 | {
|
| 8562 | "docs": {
|
| 8563 | "custom": {
|
| 8564 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken"
|
| 8565 | },
|
| 8566 | "stability": "external",
|
| 8567 | "summary": "For Alexa Smart Home functions, a token that the invoker must supply."
|
| 8568 | },
|
| 8569 | "locationInModule": {
|
| 8570 | "filename": "lib/lambda.generated.ts",
|
| 8571 | "line": 4716
|
| 8572 | },
|
| 8573 | "name": "eventSourceToken",
|
| 8574 | "optional": true,
|
| 8575 | "type": {
|
| 8576 | "primitive": "string"
|
| 8577 | }
|
| 8578 | },
|
| 8579 | {
|
| 8580 | "docs": {
|
| 8581 | "custom": {
|
| 8582 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionurlauthtype"
|
| 8583 | },
|
| 8584 | "remarks": "Set to `AWS_IAM` if you want to restrict access to authenticated IAM users only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .",
|
| 8585 | "stability": "external",
|
| 8586 | "summary": "The type of authentication that your function URL uses."
|
| 8587 | },
|
| 8588 | "locationInModule": {
|
| 8589 | "filename": "lib/lambda.generated.ts",
|
| 8590 | "line": 4723
|
| 8591 | },
|
| 8592 | "name": "functionUrlAuthType",
|
| 8593 | "optional": true,
|
| 8594 | "type": {
|
| 8595 | "primitive": "string"
|
| 8596 | }
|
| 8597 | },
|
| 8598 | {
|
| 8599 | "docs": {
|
| 8600 | "custom": {
|
| 8601 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principalorgid"
|
| 8602 | },
|
| 8603 | "remarks": "Use this to grant permissions to all the AWS accounts under this organization.",
|
| 8604 | "stability": "external",
|
| 8605 | "summary": "The identifier for your organization in AWS Organizations ."
|
| 8606 | },
|
| 8607 | "locationInModule": {
|
| 8608 | "filename": "lib/lambda.generated.ts",
|
| 8609 | "line": 4730
|
| 8610 | },
|
| 8611 | "name": "principalOrgId",
|
| 8612 | "optional": true,
|
| 8613 | "type": {
|
| 8614 | "primitive": "string"
|
| 8615 | }
|
| 8616 | },
|
| 8617 | {
|
| 8618 | "docs": {
|
| 8619 | "custom": {
|
| 8620 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount"
|
| 8621 | },
|
| 8622 | "remarks": "Use this together with `SourceArn` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.",
|
| 8623 | "stability": "external",
|
| 8624 | "summary": "For AWS service , the ID of the AWS account that owns the resource."
|
| 8625 | },
|
| 8626 | "locationInModule": {
|
| 8627 | "filename": "lib/lambda.generated.ts",
|
| 8628 | "line": 4737
|
| 8629 | },
|
| 8630 | "name": "sourceAccount",
|
| 8631 | "optional": true,
|
| 8632 | "type": {
|
| 8633 | "primitive": "string"
|
| 8634 | }
|
| 8635 | },
|
| 8636 | {
|
| 8637 | "docs": {
|
| 8638 | "custom": {
|
| 8639 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn"
|
| 8640 | },
|
| 8641 | "remarks": "For example, an Amazon S3 bucket or Amazon SNS topic.\n\nNote that Lambda configures the comparison using the `StringLike` operator.",
|
| 8642 | "stability": "external",
|
| 8643 | "summary": "For AWS services , the ARN of the AWS resource that invokes the function."
|
| 8644 | },
|
| 8645 | "locationInModule": {
|
| 8646 | "filename": "lib/lambda.generated.ts",
|
| 8647 | "line": 4746
|
| 8648 | },
|
| 8649 | "name": "sourceArn",
|
| 8650 | "optional": true,
|
| 8651 | "type": {
|
| 8652 | "primitive": "string"
|
| 8653 | }
|
| 8654 | }
|
| 8655 | ],
|
| 8656 | "symbolId": "lib/lambda.generated:CfnPermission"
|
| 8657 | },
|
| 8658 | "@aws-cdk/aws-lambda.CfnPermissionProps": {
|
| 8659 | "assembly": "@aws-cdk/aws-lambda",
|
| 8660 | "datatype": true,
|
| 8661 | "docs": {
|
| 8662 | "custom": {
|
| 8663 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html",
|
| 8664 | "exampleMetadata": "fixture=_generated"
|
| 8665 | },
|
| 8666 | "stability": "external",
|
| 8667 | "summary": "Properties for defining a `CfnPermission`.",
|
| 8668 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnPermissionProps: lambda.CfnPermissionProps = {\n action: 'action',\n functionName: 'functionName',\n principal: 'principal',\n\n // the properties below are optional\n eventSourceToken: 'eventSourceToken',\n functionUrlAuthType: 'functionUrlAuthType',\n principalOrgId: 'principalOrgId',\n sourceAccount: 'sourceAccount',\n sourceArn: 'sourceArn',\n};"
|
| 8669 | },
|
| 8670 | "fqn": "@aws-cdk/aws-lambda.CfnPermissionProps",
|
| 8671 | "kind": "interface",
|
| 8672 | "locationInModule": {
|
| 8673 | "filename": "lib/lambda.generated.ts",
|
| 8674 | "line": 4507
|
| 8675 | },
|
| 8676 | "name": "CfnPermissionProps",
|
| 8677 | "properties": [
|
| 8678 | {
|
| 8679 | "abstract": true,
|
| 8680 | "docs": {
|
| 8681 | "custom": {
|
| 8682 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-action"
|
| 8683 | },
|
| 8684 | "remarks": "For example, `lambda:InvokeFunction` or `lambda:GetFunction` .",
|
| 8685 | "stability": "external",
|
| 8686 | "summary": "The action that the principal can use on the function."
|
| 8687 | },
|
| 8688 | "immutable": true,
|
| 8689 | "locationInModule": {
|
| 8690 | "filename": "lib/lambda.generated.ts",
|
| 8691 | "line": 4514
|
| 8692 | },
|
| 8693 | "name": "action",
|
| 8694 | "type": {
|
| 8695 | "primitive": "string"
|
| 8696 | }
|
| 8697 | },
|
| 8698 | {
|
| 8699 | "abstract": true,
|
| 8700 | "docs": {
|
| 8701 | "custom": {
|
| 8702 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionname"
|
| 8703 | },
|
| 8704 | "remarks": "**Name formats** - *Function name* – `my-function` (name-only), `my-function:v1` (with alias).\n- *Function ARN* – `arn:aws:lambda:us-west-2:123456789012:function:my-function` .\n- *Partial ARN* – `123456789012:function:my-function` .\n\nYou can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
| 8705 | "stability": "external",
|
| 8706 | "summary": "The name of the Lambda function, version, or alias."
|
| 8707 | },
|
| 8708 | "immutable": true,
|
| 8709 | "locationInModule": {
|
| 8710 | "filename": "lib/lambda.generated.ts",
|
| 8711 | "line": 4527
|
| 8712 | },
|
| 8713 | "name": "functionName",
|
| 8714 | "type": {
|
| 8715 | "primitive": "string"
|
| 8716 | }
|
| 8717 | },
|
| 8718 | {
|
| 8719 | "abstract": true,
|
| 8720 | "docs": {
|
| 8721 | "custom": {
|
| 8722 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principal"
|
| 8723 | },
|
| 8724 | "remarks": "If you specify a service, use `SourceArn` or `SourceAccount` to limit who can invoke the function through that service.",
|
| 8725 | "stability": "external",
|
| 8726 | "summary": "The AWS service or AWS account that invokes the function."
|
| 8727 | },
|
| 8728 | "immutable": true,
|
| 8729 | "locationInModule": {
|
| 8730 | "filename": "lib/lambda.generated.ts",
|
| 8731 | "line": 4534
|
| 8732 | },
|
| 8733 | "name": "principal",
|
| 8734 | "type": {
|
| 8735 | "primitive": "string"
|
| 8736 | }
|
| 8737 | },
|
| 8738 | {
|
| 8739 | "abstract": true,
|
| 8740 | "docs": {
|
| 8741 | "custom": {
|
| 8742 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-eventsourcetoken"
|
| 8743 | },
|
| 8744 | "stability": "external",
|
| 8745 | "summary": "For Alexa Smart Home functions, a token that the invoker must supply."
|
| 8746 | },
|
| 8747 | "immutable": true,
|
| 8748 | "locationInModule": {
|
| 8749 | "filename": "lib/lambda.generated.ts",
|
| 8750 | "line": 4541
|
| 8751 | },
|
| 8752 | "name": "eventSourceToken",
|
| 8753 | "optional": true,
|
| 8754 | "type": {
|
| 8755 | "primitive": "string"
|
| 8756 | }
|
| 8757 | },
|
| 8758 | {
|
| 8759 | "abstract": true,
|
| 8760 | "docs": {
|
| 8761 | "custom": {
|
| 8762 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-functionurlauthtype"
|
| 8763 | },
|
| 8764 | "remarks": "Set to `AWS_IAM` if you want to restrict access to authenticated IAM users only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .",
|
| 8765 | "stability": "external",
|
| 8766 | "summary": "The type of authentication that your function URL uses."
|
| 8767 | },
|
| 8768 | "immutable": true,
|
| 8769 | "locationInModule": {
|
| 8770 | "filename": "lib/lambda.generated.ts",
|
| 8771 | "line": 4548
|
| 8772 | },
|
| 8773 | "name": "functionUrlAuthType",
|
| 8774 | "optional": true,
|
| 8775 | "type": {
|
| 8776 | "primitive": "string"
|
| 8777 | }
|
| 8778 | },
|
| 8779 | {
|
| 8780 | "abstract": true,
|
| 8781 | "docs": {
|
| 8782 | "custom": {
|
| 8783 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-principalorgid"
|
| 8784 | },
|
| 8785 | "remarks": "Use this to grant permissions to all the AWS accounts under this organization.",
|
| 8786 | "stability": "external",
|
| 8787 | "summary": "The identifier for your organization in AWS Organizations ."
|
| 8788 | },
|
| 8789 | "immutable": true,
|
| 8790 | "locationInModule": {
|
| 8791 | "filename": "lib/lambda.generated.ts",
|
| 8792 | "line": 4555
|
| 8793 | },
|
| 8794 | "name": "principalOrgId",
|
| 8795 | "optional": true,
|
| 8796 | "type": {
|
| 8797 | "primitive": "string"
|
| 8798 | }
|
| 8799 | },
|
| 8800 | {
|
| 8801 | "abstract": true,
|
| 8802 | "docs": {
|
| 8803 | "custom": {
|
| 8804 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourceaccount"
|
| 8805 | },
|
| 8806 | "remarks": "Use this together with `SourceArn` to ensure that the specified account owns the resource. It is possible for an Amazon S3 bucket to be deleted by its owner and recreated by another account.",
|
| 8807 | "stability": "external",
|
| 8808 | "summary": "For AWS service , the ID of the AWS account that owns the resource."
|
| 8809 | },
|
| 8810 | "immutable": true,
|
| 8811 | "locationInModule": {
|
| 8812 | "filename": "lib/lambda.generated.ts",
|
| 8813 | "line": 4562
|
| 8814 | },
|
| 8815 | "name": "sourceAccount",
|
| 8816 | "optional": true,
|
| 8817 | "type": {
|
| 8818 | "primitive": "string"
|
| 8819 | }
|
| 8820 | },
|
| 8821 | {
|
| 8822 | "abstract": true,
|
| 8823 | "docs": {
|
| 8824 | "custom": {
|
| 8825 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html#cfn-lambda-permission-sourcearn"
|
| 8826 | },
|
| 8827 | "remarks": "For example, an Amazon S3 bucket or Amazon SNS topic.\n\nNote that Lambda configures the comparison using the `StringLike` operator.",
|
| 8828 | "stability": "external",
|
| 8829 | "summary": "For AWS services , the ARN of the AWS resource that invokes the function."
|
| 8830 | },
|
| 8831 | "immutable": true,
|
| 8832 | "locationInModule": {
|
| 8833 | "filename": "lib/lambda.generated.ts",
|
| 8834 | "line": 4571
|
| 8835 | },
|
| 8836 | "name": "sourceArn",
|
| 8837 | "optional": true,
|
| 8838 | "type": {
|
| 8839 | "primitive": "string"
|
| 8840 | }
|
| 8841 | }
|
| 8842 | ],
|
| 8843 | "symbolId": "lib/lambda.generated:CfnPermissionProps"
|
| 8844 | },
|
| 8845 | "@aws-cdk/aws-lambda.CfnUrl": {
|
| 8846 | "assembly": "@aws-cdk/aws-lambda",
|
| 8847 | "base": "@aws-cdk/core.CfnResource",
|
| 8848 | "docs": {
|
| 8849 | "custom": {
|
| 8850 | "cloudformationResource": "AWS::Lambda::Url",
|
| 8851 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html",
|
| 8852 | "exampleMetadata": "fixture=_generated"
|
| 8853 | },
|
| 8854 | "remarks": "The `AWS::Lambda::Url` resource creates a function URL with the specified configuration parameters. A [function URL](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) is a dedicated HTTP(S) endpoint that you can use to invoke your function.",
|
| 8855 | "stability": "external",
|
| 8856 | "summary": "A CloudFormation `AWS::Lambda::Url`.",
|
| 8857 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnUrl = new lambda.CfnUrl(this, 'MyCfnUrl', {\n authType: 'authType',\n targetFunctionArn: 'targetFunctionArn',\n\n // the properties below are optional\n cors: {\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n allowOrigins: ['allowOrigins'],\n exposeHeaders: ['exposeHeaders'],\n maxAge: 123,\n },\n invokeMode: 'invokeMode',\n qualifier: 'qualifier',\n});"
|
| 8858 | },
|
| 8859 | "fqn": "@aws-cdk/aws-lambda.CfnUrl",
|
| 8860 | "initializer": {
|
| 8861 | "docs": {
|
| 8862 | "stability": "external",
|
| 8863 | "summary": "Create a new `AWS::Lambda::Url`."
|
| 8864 | },
|
| 8865 | "locationInModule": {
|
| 8866 | "filename": "lib/lambda.generated.ts",
|
| 8867 | "line": 5006
|
| 8868 | },
|
| 8869 | "parameters": [
|
| 8870 | {
|
| 8871 | "docs": {
|
| 8872 | "summary": "- scope in which this resource is defined."
|
| 8873 | },
|
| 8874 | "name": "scope",
|
| 8875 | "type": {
|
| 8876 | "fqn": "@aws-cdk/core.Construct"
|
| 8877 | }
|
| 8878 | },
|
| 8879 | {
|
| 8880 | "docs": {
|
| 8881 | "summary": "- scoped id of the resource."
|
| 8882 | },
|
| 8883 | "name": "id",
|
| 8884 | "type": {
|
| 8885 | "primitive": "string"
|
| 8886 | }
|
| 8887 | },
|
| 8888 | {
|
| 8889 | "docs": {
|
| 8890 | "summary": "- resource properties."
|
| 8891 | },
|
| 8892 | "name": "props",
|
| 8893 | "type": {
|
| 8894 | "fqn": "@aws-cdk/aws-lambda.CfnUrlProps"
|
| 8895 | }
|
| 8896 | }
|
| 8897 | ]
|
| 8898 | },
|
| 8899 | "interfaces": [
|
| 8900 | "@aws-cdk/core.IInspectable"
|
| 8901 | ],
|
| 8902 | "kind": "class",
|
| 8903 | "locationInModule": {
|
| 8904 | "filename": "lib/lambda.generated.ts",
|
| 8905 | "line": 4921
|
| 8906 | },
|
| 8907 | "methods": [
|
| 8908 | {
|
| 8909 | "docs": {
|
| 8910 | "stability": "external",
|
| 8911 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 8912 | },
|
| 8913 | "locationInModule": {
|
| 8914 | "filename": "lib/lambda.generated.ts",
|
| 8915 | "line": 5026
|
| 8916 | },
|
| 8917 | "name": "inspect",
|
| 8918 | "overrides": "@aws-cdk/core.IInspectable",
|
| 8919 | "parameters": [
|
| 8920 | {
|
| 8921 | "docs": {
|
| 8922 | "summary": "- tree inspector to collect and process attributes."
|
| 8923 | },
|
| 8924 | "name": "inspector",
|
| 8925 | "type": {
|
| 8926 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 8927 | }
|
| 8928 | }
|
| 8929 | ]
|
| 8930 | },
|
| 8931 | {
|
| 8932 | "docs": {
|
| 8933 | "stability": "external"
|
| 8934 | },
|
| 8935 | "locationInModule": {
|
| 8936 | "filename": "lib/lambda.generated.ts",
|
| 8937 | "line": 5041
|
| 8938 | },
|
| 8939 | "name": "renderProperties",
|
| 8940 | "overrides": "@aws-cdk/core.CfnResource",
|
| 8941 | "parameters": [
|
| 8942 | {
|
| 8943 | "name": "props",
|
| 8944 | "type": {
|
| 8945 | "collection": {
|
| 8946 | "elementtype": {
|
| 8947 | "primitive": "any"
|
| 8948 | },
|
| 8949 | "kind": "map"
|
| 8950 | }
|
| 8951 | }
|
| 8952 | }
|
| 8953 | ],
|
| 8954 | "protected": true,
|
| 8955 | "returns": {
|
| 8956 | "type": {
|
| 8957 | "collection": {
|
| 8958 | "elementtype": {
|
| 8959 | "primitive": "any"
|
| 8960 | },
|
| 8961 | "kind": "map"
|
| 8962 | }
|
| 8963 | }
|
| 8964 | }
|
| 8965 | }
|
| 8966 | ],
|
| 8967 | "name": "CfnUrl",
|
| 8968 | "properties": [
|
| 8969 | {
|
| 8970 | "const": true,
|
| 8971 | "docs": {
|
| 8972 | "stability": "external",
|
| 8973 | "summary": "The CloudFormation resource type name for this resource class."
|
| 8974 | },
|
| 8975 | "immutable": true,
|
| 8976 | "locationInModule": {
|
| 8977 | "filename": "lib/lambda.generated.ts",
|
| 8978 | "line": 4925
|
| 8979 | },
|
| 8980 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 8981 | "static": true,
|
| 8982 | "type": {
|
| 8983 | "primitive": "string"
|
| 8984 | }
|
| 8985 | },
|
| 8986 | {
|
| 8987 | "docs": {
|
| 8988 | "custom": {
|
| 8989 | "cloudformationAttribute": "FunctionArn"
|
| 8990 | },
|
| 8991 | "stability": "external",
|
| 8992 | "summary": "The Amazon Resource Name (ARN) of the function."
|
| 8993 | },
|
| 8994 | "immutable": true,
|
| 8995 | "locationInModule": {
|
| 8996 | "filename": "lib/lambda.generated.ts",
|
| 8997 | "line": 4950
|
| 8998 | },
|
| 8999 | "name": "attrFunctionArn",
|
| 9000 | "type": {
|
| 9001 | "primitive": "string"
|
| 9002 | }
|
| 9003 | },
|
| 9004 | {
|
| 9005 | "docs": {
|
| 9006 | "custom": {
|
| 9007 | "cloudformationAttribute": "FunctionUrl"
|
| 9008 | },
|
| 9009 | "stability": "external",
|
| 9010 | "summary": "The HTTP URL endpoint for your function."
|
| 9011 | },
|
| 9012 | "immutable": true,
|
| 9013 | "locationInModule": {
|
| 9014 | "filename": "lib/lambda.generated.ts",
|
| 9015 | "line": 4956
|
| 9016 | },
|
| 9017 | "name": "attrFunctionUrl",
|
| 9018 | "type": {
|
| 9019 | "primitive": "string"
|
| 9020 | }
|
| 9021 | },
|
| 9022 | {
|
| 9023 | "docs": {
|
| 9024 | "stability": "external"
|
| 9025 | },
|
| 9026 | "immutable": true,
|
| 9027 | "locationInModule": {
|
| 9028 | "filename": "lib/lambda.generated.ts",
|
| 9029 | "line": 5031
|
| 9030 | },
|
| 9031 | "name": "cfnProperties",
|
| 9032 | "overrides": "@aws-cdk/core.CfnResource",
|
| 9033 | "protected": true,
|
| 9034 | "type": {
|
| 9035 | "collection": {
|
| 9036 | "elementtype": {
|
| 9037 | "primitive": "any"
|
| 9038 | },
|
| 9039 | "kind": "map"
|
| 9040 | }
|
| 9041 | }
|
| 9042 | },
|
| 9043 | {
|
| 9044 | "docs": {
|
| 9045 | "custom": {
|
| 9046 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype"
|
| 9047 | },
|
| 9048 | "remarks": "Set to `AWS_IAM` if you want to restrict access to authenticated IAM users only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .",
|
| 9049 | "stability": "external",
|
| 9050 | "summary": "The type of authentication that your function URL uses."
|
| 9051 | },
|
| 9052 | "locationInModule": {
|
| 9053 | "filename": "lib/lambda.generated.ts",
|
| 9054 | "line": 4963
|
| 9055 | },
|
| 9056 | "name": "authType",
|
| 9057 | "type": {
|
| 9058 | "primitive": "string"
|
| 9059 | }
|
| 9060 | },
|
| 9061 | {
|
| 9062 | "docs": {
|
| 9063 | "custom": {
|
| 9064 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-targetfunctionarn"
|
| 9065 | },
|
| 9066 | "remarks": "**Name formats** - *Function name* - `my-function` .\n- *Function ARN* - `arn:aws:lambda:us-west-2:123456789012:function:my-function` .\n- *Partial ARN* - `123456789012:function:my-function` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
| 9067 | "stability": "external",
|
| 9068 | "summary": "The name of the Lambda function."
|
| 9069 | },
|
| 9070 | "locationInModule": {
|
| 9071 | "filename": "lib/lambda.generated.ts",
|
| 9072 | "line": 4976
|
| 9073 | },
|
| 9074 | "name": "targetFunctionArn",
|
| 9075 | "type": {
|
| 9076 | "primitive": "string"
|
| 9077 | }
|
| 9078 | },
|
| 9079 | {
|
| 9080 | "docs": {
|
| 9081 | "custom": {
|
| 9082 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-cors"
|
| 9083 | },
|
| 9084 | "stability": "external",
|
| 9085 | "summary": "The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL."
|
| 9086 | },
|
| 9087 | "locationInModule": {
|
| 9088 | "filename": "lib/lambda.generated.ts",
|
| 9089 | "line": 4983
|
| 9090 | },
|
| 9091 | "name": "cors",
|
| 9092 | "optional": true,
|
| 9093 | "type": {
|
| 9094 | "union": {
|
| 9095 | "types": [
|
| 9096 | {
|
| 9097 | "fqn": "@aws-cdk/core.IResolvable"
|
| 9098 | },
|
| 9099 | {
|
| 9100 | "fqn": "@aws-cdk/aws-lambda.CfnUrl.CorsProperty"
|
| 9101 | }
|
| 9102 | ]
|
| 9103 | }
|
| 9104 | }
|
| 9105 | },
|
| 9106 | {
|
| 9107 | "docs": {
|
| 9108 | "custom": {
|
| 9109 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode"
|
| 9110 | },
|
| 9111 | "stability": "external",
|
| 9112 | "summary": "`AWS::Lambda::Url.InvokeMode`."
|
| 9113 | },
|
| 9114 | "locationInModule": {
|
| 9115 | "filename": "lib/lambda.generated.ts",
|
| 9116 | "line": 4990
|
| 9117 | },
|
| 9118 | "name": "invokeMode",
|
| 9119 | "optional": true,
|
| 9120 | "type": {
|
| 9121 | "primitive": "string"
|
| 9122 | }
|
| 9123 | },
|
| 9124 | {
|
| 9125 | "docs": {
|
| 9126 | "custom": {
|
| 9127 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-qualifier"
|
| 9128 | },
|
| 9129 | "stability": "external",
|
| 9130 | "summary": "The alias name."
|
| 9131 | },
|
| 9132 | "locationInModule": {
|
| 9133 | "filename": "lib/lambda.generated.ts",
|
| 9134 | "line": 4997
|
| 9135 | },
|
| 9136 | "name": "qualifier",
|
| 9137 | "optional": true,
|
| 9138 | "type": {
|
| 9139 | "primitive": "string"
|
| 9140 | }
|
| 9141 | }
|
| 9142 | ],
|
| 9143 | "symbolId": "lib/lambda.generated:CfnUrl"
|
| 9144 | },
|
| 9145 | "@aws-cdk/aws-lambda.CfnUrl.CorsProperty": {
|
| 9146 | "assembly": "@aws-cdk/aws-lambda",
|
| 9147 | "datatype": true,
|
| 9148 | "docs": {
|
| 9149 | "custom": {
|
| 9150 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html",
|
| 9151 | "exampleMetadata": "fixture=_generated"
|
| 9152 | },
|
| 9153 | "stability": "external",
|
| 9154 | "summary": "The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.",
|
| 9155 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst corsProperty: lambda.CfnUrl.CorsProperty = {\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n allowOrigins: ['allowOrigins'],\n exposeHeaders: ['exposeHeaders'],\n maxAge: 123,\n};"
|
| 9156 | },
|
| 9157 | "fqn": "@aws-cdk/aws-lambda.CfnUrl.CorsProperty",
|
| 9158 | "kind": "interface",
|
| 9159 | "locationInModule": {
|
| 9160 | "filename": "lib/lambda.generated.ts",
|
| 9161 | "line": 5055
|
| 9162 | },
|
| 9163 | "name": "CorsProperty",
|
| 9164 | "namespace": "CfnUrl",
|
| 9165 | "properties": [
|
| 9166 | {
|
| 9167 | "abstract": true,
|
| 9168 | "docs": {
|
| 9169 | "custom": {
|
| 9170 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html#cfn-lambda-url-cors-allowcredentials"
|
| 9171 | },
|
| 9172 | "remarks": "The default is `false` .",
|
| 9173 | "stability": "external",
|
| 9174 | "summary": "Whether you want to allow cookies or other credentials in requests to your function URL."
|
| 9175 | },
|
| 9176 | "immutable": true,
|
| 9177 | "locationInModule": {
|
| 9178 | "filename": "lib/lambda.generated.ts",
|
| 9179 | "line": 5061
|
| 9180 | },
|
| 9181 | "name": "allowCredentials",
|
| 9182 | "optional": true,
|
| 9183 | "type": {
|
| 9184 | "union": {
|
| 9185 | "types": [
|
| 9186 | {
|
| 9187 | "primitive": "boolean"
|
| 9188 | },
|
| 9189 | {
|
| 9190 | "fqn": "@aws-cdk/core.IResolvable"
|
| 9191 | }
|
| 9192 | ]
|
| 9193 | }
|
| 9194 | }
|
| 9195 | },
|
| 9196 | {
|
| 9197 | "abstract": true,
|
| 9198 | "docs": {
|
| 9199 | "custom": {
|
| 9200 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html#cfn-lambda-url-cors-allowheaders"
|
| 9201 | },
|
| 9202 | "remarks": "For example: `Date` , `Keep-Alive` , `X-Custom-Header` .",
|
| 9203 | "stability": "external",
|
| 9204 | "summary": "The HTTP headers that origins can include in requests to your function URL."
|
| 9205 | },
|
| 9206 | "immutable": true,
|
| 9207 | "locationInModule": {
|
| 9208 | "filename": "lib/lambda.generated.ts",
|
| 9209 | "line": 5067
|
| 9210 | },
|
| 9211 | "name": "allowHeaders",
|
| 9212 | "optional": true,
|
| 9213 | "type": {
|
| 9214 | "collection": {
|
| 9215 | "elementtype": {
|
| 9216 | "primitive": "string"
|
| 9217 | },
|
| 9218 | "kind": "array"
|
| 9219 | }
|
| 9220 | }
|
| 9221 | },
|
| 9222 | {
|
| 9223 | "abstract": true,
|
| 9224 | "docs": {
|
| 9225 | "custom": {
|
| 9226 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html#cfn-lambda-url-cors-allowmethods"
|
| 9227 | },
|
| 9228 | "remarks": "For example: `GET` , `POST` , `DELETE` , or the wildcard character ( `*` ).",
|
| 9229 | "stability": "external",
|
| 9230 | "summary": "The HTTP methods that are allowed when calling your function URL."
|
| 9231 | },
|
| 9232 | "immutable": true,
|
| 9233 | "locationInModule": {
|
| 9234 | "filename": "lib/lambda.generated.ts",
|
| 9235 | "line": 5073
|
| 9236 | },
|
| 9237 | "name": "allowMethods",
|
| 9238 | "optional": true,
|
| 9239 | "type": {
|
| 9240 | "collection": {
|
| 9241 | "elementtype": {
|
| 9242 | "primitive": "string"
|
| 9243 | },
|
| 9244 | "kind": "array"
|
| 9245 | }
|
| 9246 | }
|
| 9247 | },
|
| 9248 | {
|
| 9249 | "abstract": true,
|
| 9250 | "docs": {
|
| 9251 | "custom": {
|
| 9252 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html#cfn-lambda-url-cors-alloworigins"
|
| 9253 | },
|
| 9254 | "remarks": "You can list any number of specific origins, separated by a comma. For example: `https://www.example.com` , `http://localhost:60905` .\n\nAlternatively, you can grant access to all origins with the wildcard character ( `*` ).",
|
| 9255 | "stability": "external",
|
| 9256 | "summary": "The origins that can access your function URL."
|
| 9257 | },
|
| 9258 | "immutable": true,
|
| 9259 | "locationInModule": {
|
| 9260 | "filename": "lib/lambda.generated.ts",
|
| 9261 | "line": 5081
|
| 9262 | },
|
| 9263 | "name": "allowOrigins",
|
| 9264 | "optional": true,
|
| 9265 | "type": {
|
| 9266 | "collection": {
|
| 9267 | "elementtype": {
|
| 9268 | "primitive": "string"
|
| 9269 | },
|
| 9270 | "kind": "array"
|
| 9271 | }
|
| 9272 | }
|
| 9273 | },
|
| 9274 | {
|
| 9275 | "abstract": true,
|
| 9276 | "docs": {
|
| 9277 | "custom": {
|
| 9278 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html#cfn-lambda-url-cors-exposeheaders"
|
| 9279 | },
|
| 9280 | "remarks": "For example: `Date` , `Keep-Alive` , `X-Custom-Header` .",
|
| 9281 | "stability": "external",
|
| 9282 | "summary": "The HTTP headers in your function response that you want to expose to origins that call your function URL."
|
| 9283 | },
|
| 9284 | "immutable": true,
|
| 9285 | "locationInModule": {
|
| 9286 | "filename": "lib/lambda.generated.ts",
|
| 9287 | "line": 5087
|
| 9288 | },
|
| 9289 | "name": "exposeHeaders",
|
| 9290 | "optional": true,
|
| 9291 | "type": {
|
| 9292 | "collection": {
|
| 9293 | "elementtype": {
|
| 9294 | "primitive": "string"
|
| 9295 | },
|
| 9296 | "kind": "array"
|
| 9297 | }
|
| 9298 | }
|
| 9299 | },
|
| 9300 | {
|
| 9301 | "abstract": true,
|
| 9302 | "docs": {
|
| 9303 | "custom": {
|
| 9304 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-url-cors.html#cfn-lambda-url-cors-maxage"
|
| 9305 | },
|
| 9306 | "remarks": "By default, this is set to `0` , which means the browser will not cache results.",
|
| 9307 | "stability": "external",
|
| 9308 | "summary": "The maximum amount of time, in seconds, that browsers can cache results of a preflight request."
|
| 9309 | },
|
| 9310 | "immutable": true,
|
| 9311 | "locationInModule": {
|
| 9312 | "filename": "lib/lambda.generated.ts",
|
| 9313 | "line": 5093
|
| 9314 | },
|
| 9315 | "name": "maxAge",
|
| 9316 | "optional": true,
|
| 9317 | "type": {
|
| 9318 | "primitive": "number"
|
| 9319 | }
|
| 9320 | }
|
| 9321 | ],
|
| 9322 | "symbolId": "lib/lambda.generated:CfnUrl.CorsProperty"
|
| 9323 | },
|
| 9324 | "@aws-cdk/aws-lambda.CfnUrlProps": {
|
| 9325 | "assembly": "@aws-cdk/aws-lambda",
|
| 9326 | "datatype": true,
|
| 9327 | "docs": {
|
| 9328 | "custom": {
|
| 9329 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html",
|
| 9330 | "exampleMetadata": "fixture=_generated"
|
| 9331 | },
|
| 9332 | "stability": "external",
|
| 9333 | "summary": "Properties for defining a `CfnUrl`.",
|
| 9334 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnUrlProps: lambda.CfnUrlProps = {\n authType: 'authType',\n targetFunctionArn: 'targetFunctionArn',\n\n // the properties below are optional\n cors: {\n allowCredentials: false,\n allowHeaders: ['allowHeaders'],\n allowMethods: ['allowMethods'],\n allowOrigins: ['allowOrigins'],\n exposeHeaders: ['exposeHeaders'],\n maxAge: 123,\n },\n invokeMode: 'invokeMode',\n qualifier: 'qualifier',\n};"
|
| 9335 | },
|
| 9336 | "fqn": "@aws-cdk/aws-lambda.CfnUrlProps",
|
| 9337 | "kind": "interface",
|
| 9338 | "locationInModule": {
|
| 9339 | "filename": "lib/lambda.generated.ts",
|
| 9340 | "line": 4808
|
| 9341 | },
|
| 9342 | "name": "CfnUrlProps",
|
| 9343 | "properties": [
|
| 9344 | {
|
| 9345 | "abstract": true,
|
| 9346 | "docs": {
|
| 9347 | "custom": {
|
| 9348 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-authtype"
|
| 9349 | },
|
| 9350 | "remarks": "Set to `AWS_IAM` if you want to restrict access to authenticated IAM users only. Set to `NONE` if you want to bypass IAM authentication to create a public endpoint. For more information, see [Security and auth model for Lambda function URLs](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) .",
|
| 9351 | "stability": "external",
|
| 9352 | "summary": "The type of authentication that your function URL uses."
|
| 9353 | },
|
| 9354 | "immutable": true,
|
| 9355 | "locationInModule": {
|
| 9356 | "filename": "lib/lambda.generated.ts",
|
| 9357 | "line": 4815
|
| 9358 | },
|
| 9359 | "name": "authType",
|
| 9360 | "type": {
|
| 9361 | "primitive": "string"
|
| 9362 | }
|
| 9363 | },
|
| 9364 | {
|
| 9365 | "abstract": true,
|
| 9366 | "docs": {
|
| 9367 | "custom": {
|
| 9368 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-targetfunctionarn"
|
| 9369 | },
|
| 9370 | "remarks": "**Name formats** - *Function name* - `my-function` .\n- *Function ARN* - `arn:aws:lambda:us-west-2:123456789012:function:my-function` .\n- *Partial ARN* - `123456789012:function:my-function` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
| 9371 | "stability": "external",
|
| 9372 | "summary": "The name of the Lambda function."
|
| 9373 | },
|
| 9374 | "immutable": true,
|
| 9375 | "locationInModule": {
|
| 9376 | "filename": "lib/lambda.generated.ts",
|
| 9377 | "line": 4828
|
| 9378 | },
|
| 9379 | "name": "targetFunctionArn",
|
| 9380 | "type": {
|
| 9381 | "primitive": "string"
|
| 9382 | }
|
| 9383 | },
|
| 9384 | {
|
| 9385 | "abstract": true,
|
| 9386 | "docs": {
|
| 9387 | "custom": {
|
| 9388 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-cors"
|
| 9389 | },
|
| 9390 | "stability": "external",
|
| 9391 | "summary": "The [Cross-Origin Resource Sharing (CORS)](https://docs.aws.amazon.com/https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for your function URL."
|
| 9392 | },
|
| 9393 | "immutable": true,
|
| 9394 | "locationInModule": {
|
| 9395 | "filename": "lib/lambda.generated.ts",
|
| 9396 | "line": 4835
|
| 9397 | },
|
| 9398 | "name": "cors",
|
| 9399 | "optional": true,
|
| 9400 | "type": {
|
| 9401 | "union": {
|
| 9402 | "types": [
|
| 9403 | {
|
| 9404 | "fqn": "@aws-cdk/core.IResolvable"
|
| 9405 | },
|
| 9406 | {
|
| 9407 | "fqn": "@aws-cdk/aws-lambda.CfnUrl.CorsProperty"
|
| 9408 | }
|
| 9409 | ]
|
| 9410 | }
|
| 9411 | }
|
| 9412 | },
|
| 9413 | {
|
| 9414 | "abstract": true,
|
| 9415 | "docs": {
|
| 9416 | "custom": {
|
| 9417 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-invokemode"
|
| 9418 | },
|
| 9419 | "stability": "external",
|
| 9420 | "summary": "`AWS::Lambda::Url.InvokeMode`."
|
| 9421 | },
|
| 9422 | "immutable": true,
|
| 9423 | "locationInModule": {
|
| 9424 | "filename": "lib/lambda.generated.ts",
|
| 9425 | "line": 4842
|
| 9426 | },
|
| 9427 | "name": "invokeMode",
|
| 9428 | "optional": true,
|
| 9429 | "type": {
|
| 9430 | "primitive": "string"
|
| 9431 | }
|
| 9432 | },
|
| 9433 | {
|
| 9434 | "abstract": true,
|
| 9435 | "docs": {
|
| 9436 | "custom": {
|
| 9437 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-url.html#cfn-lambda-url-qualifier"
|
| 9438 | },
|
| 9439 | "stability": "external",
|
| 9440 | "summary": "The alias name."
|
| 9441 | },
|
| 9442 | "immutable": true,
|
| 9443 | "locationInModule": {
|
| 9444 | "filename": "lib/lambda.generated.ts",
|
| 9445 | "line": 4849
|
| 9446 | },
|
| 9447 | "name": "qualifier",
|
| 9448 | "optional": true,
|
| 9449 | "type": {
|
| 9450 | "primitive": "string"
|
| 9451 | }
|
| 9452 | }
|
| 9453 | ],
|
| 9454 | "symbolId": "lib/lambda.generated:CfnUrlProps"
|
| 9455 | },
|
| 9456 | "@aws-cdk/aws-lambda.CfnVersion": {
|
| 9457 | "assembly": "@aws-cdk/aws-lambda",
|
| 9458 | "base": "@aws-cdk/core.CfnResource",
|
| 9459 | "docs": {
|
| 9460 | "custom": {
|
| 9461 | "cloudformationResource": "AWS::Lambda::Version",
|
| 9462 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html",
|
| 9463 | "exampleMetadata": "fixture=_generated"
|
| 9464 | },
|
| 9465 | "remarks": "The `AWS::Lambda::Version` resource creates a [version](https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html) from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.",
|
| 9466 | "stability": "external",
|
| 9467 | "summary": "A CloudFormation `AWS::Lambda::Version`.",
|
| 9468 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnVersion = new lambda.CfnVersion(this, 'MyCfnVersion', {\n functionName: 'functionName',\n\n // the properties below are optional\n codeSha256: 'codeSha256',\n description: 'description',\n provisionedConcurrencyConfig: {\n provisionedConcurrentExecutions: 123,\n },\n});"
|
| 9469 | },
|
| 9470 | "fqn": "@aws-cdk/aws-lambda.CfnVersion",
|
| 9471 | "initializer": {
|
| 9472 | "docs": {
|
| 9473 | "stability": "external",
|
| 9474 | "summary": "Create a new `AWS::Lambda::Version`."
|
| 9475 | },
|
| 9476 | "locationInModule": {
|
| 9477 | "filename": "lib/lambda.generated.ts",
|
| 9478 | "line": 5342
|
| 9479 | },
|
| 9480 | "parameters": [
|
| 9481 | {
|
| 9482 | "docs": {
|
| 9483 | "summary": "- scope in which this resource is defined."
|
| 9484 | },
|
| 9485 | "name": "scope",
|
| 9486 | "type": {
|
| 9487 | "fqn": "@aws-cdk/core.Construct"
|
| 9488 | }
|
| 9489 | },
|
| 9490 | {
|
| 9491 | "docs": {
|
| 9492 | "summary": "- scoped id of the resource."
|
| 9493 | },
|
| 9494 | "name": "id",
|
| 9495 | "type": {
|
| 9496 | "primitive": "string"
|
| 9497 | }
|
| 9498 | },
|
| 9499 | {
|
| 9500 | "docs": {
|
| 9501 | "summary": "- resource properties."
|
| 9502 | },
|
| 9503 | "name": "props",
|
| 9504 | "type": {
|
| 9505 | "fqn": "@aws-cdk/aws-lambda.CfnVersionProps"
|
| 9506 | }
|
| 9507 | }
|
| 9508 | ]
|
| 9509 | },
|
| 9510 | "interfaces": [
|
| 9511 | "@aws-cdk/core.IInspectable"
|
| 9512 | ],
|
| 9513 | "kind": "class",
|
| 9514 | "locationInModule": {
|
| 9515 | "filename": "lib/lambda.generated.ts",
|
| 9516 | "line": 5270
|
| 9517 | },
|
| 9518 | "methods": [
|
| 9519 | {
|
| 9520 | "docs": {
|
| 9521 | "stability": "external",
|
| 9522 | "summary": "Examines the CloudFormation resource and discloses attributes."
|
| 9523 | },
|
| 9524 | "locationInModule": {
|
| 9525 | "filename": "lib/lambda.generated.ts",
|
| 9526 | "line": 5359
|
| 9527 | },
|
| 9528 | "name": "inspect",
|
| 9529 | "overrides": "@aws-cdk/core.IInspectable",
|
| 9530 | "parameters": [
|
| 9531 | {
|
| 9532 | "docs": {
|
| 9533 | "summary": "- tree inspector to collect and process attributes."
|
| 9534 | },
|
| 9535 | "name": "inspector",
|
| 9536 | "type": {
|
| 9537 | "fqn": "@aws-cdk/core.TreeInspector"
|
| 9538 | }
|
| 9539 | }
|
| 9540 | ]
|
| 9541 | },
|
| 9542 | {
|
| 9543 | "docs": {
|
| 9544 | "stability": "external"
|
| 9545 | },
|
| 9546 | "locationInModule": {
|
| 9547 | "filename": "lib/lambda.generated.ts",
|
| 9548 | "line": 5373
|
| 9549 | },
|
| 9550 | "name": "renderProperties",
|
| 9551 | "overrides": "@aws-cdk/core.CfnResource",
|
| 9552 | "parameters": [
|
| 9553 | {
|
| 9554 | "name": "props",
|
| 9555 | "type": {
|
| 9556 | "collection": {
|
| 9557 | "elementtype": {
|
| 9558 | "primitive": "any"
|
| 9559 | },
|
| 9560 | "kind": "map"
|
| 9561 | }
|
| 9562 | }
|
| 9563 | }
|
| 9564 | ],
|
| 9565 | "protected": true,
|
| 9566 | "returns": {
|
| 9567 | "type": {
|
| 9568 | "collection": {
|
| 9569 | "elementtype": {
|
| 9570 | "primitive": "any"
|
| 9571 | },
|
| 9572 | "kind": "map"
|
| 9573 | }
|
| 9574 | }
|
| 9575 | }
|
| 9576 | }
|
| 9577 | ],
|
| 9578 | "name": "CfnVersion",
|
| 9579 | "properties": [
|
| 9580 | {
|
| 9581 | "const": true,
|
| 9582 | "docs": {
|
| 9583 | "stability": "external",
|
| 9584 | "summary": "The CloudFormation resource type name for this resource class."
|
| 9585 | },
|
| 9586 | "immutable": true,
|
| 9587 | "locationInModule": {
|
| 9588 | "filename": "lib/lambda.generated.ts",
|
| 9589 | "line": 5274
|
| 9590 | },
|
| 9591 | "name": "CFN_RESOURCE_TYPE_NAME",
|
| 9592 | "static": true,
|
| 9593 | "type": {
|
| 9594 | "primitive": "string"
|
| 9595 | }
|
| 9596 | },
|
| 9597 | {
|
| 9598 | "docs": {
|
| 9599 | "custom": {
|
| 9600 | "cloudformationAttribute": "Version"
|
| 9601 | },
|
| 9602 | "stability": "external",
|
| 9603 | "summary": "The version number."
|
| 9604 | },
|
| 9605 | "immutable": true,
|
| 9606 | "locationInModule": {
|
| 9607 | "filename": "lib/lambda.generated.ts",
|
| 9608 | "line": 5299
|
| 9609 | },
|
| 9610 | "name": "attrVersion",
|
| 9611 | "type": {
|
| 9612 | "primitive": "string"
|
| 9613 | }
|
| 9614 | },
|
| 9615 | {
|
| 9616 | "docs": {
|
| 9617 | "stability": "external"
|
| 9618 | },
|
| 9619 | "immutable": true,
|
| 9620 | "locationInModule": {
|
| 9621 | "filename": "lib/lambda.generated.ts",
|
| 9622 | "line": 5364
|
| 9623 | },
|
| 9624 | "name": "cfnProperties",
|
| 9625 | "overrides": "@aws-cdk/core.CfnResource",
|
| 9626 | "protected": true,
|
| 9627 | "type": {
|
| 9628 | "collection": {
|
| 9629 | "elementtype": {
|
| 9630 | "primitive": "any"
|
| 9631 | },
|
| 9632 | "kind": "map"
|
| 9633 | }
|
| 9634 | }
|
| 9635 | },
|
| 9636 | {
|
| 9637 | "docs": {
|
| 9638 | "custom": {
|
| 9639 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionname"
|
| 9640 | },
|
| 9641 | "remarks": "**Name formats** - *Function name* - `MyFunction` .\n- *Function ARN* - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction` .\n- *Partial ARN* - `123456789012:function:MyFunction` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
| 9642 | "stability": "external",
|
| 9643 | "summary": "The name of the Lambda function."
|
| 9644 | },
|
| 9645 | "locationInModule": {
|
| 9646 | "filename": "lib/lambda.generated.ts",
|
| 9647 | "line": 5312
|
| 9648 | },
|
| 9649 | "name": "functionName",
|
| 9650 | "type": {
|
| 9651 | "primitive": "string"
|
| 9652 | }
|
| 9653 | },
|
| 9654 | {
|
| 9655 | "docs": {
|
| 9656 | "custom": {
|
| 9657 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256"
|
| 9658 | },
|
| 9659 | "remarks": "Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.",
|
| 9660 | "stability": "external",
|
| 9661 | "summary": "Only publish a version if the hash value matches the value that's specified."
|
| 9662 | },
|
| 9663 | "locationInModule": {
|
| 9664 | "filename": "lib/lambda.generated.ts",
|
| 9665 | "line": 5319
|
| 9666 | },
|
| 9667 | "name": "codeSha256",
|
| 9668 | "optional": true,
|
| 9669 | "type": {
|
| 9670 | "primitive": "string"
|
| 9671 | }
|
| 9672 | },
|
| 9673 | {
|
| 9674 | "docs": {
|
| 9675 | "custom": {
|
| 9676 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description"
|
| 9677 | },
|
| 9678 | "remarks": "Updates are not supported for this property.",
|
| 9679 | "stability": "external",
|
| 9680 | "summary": "A description for the version to override the description in the function configuration."
|
| 9681 | },
|
| 9682 | "locationInModule": {
|
| 9683 | "filename": "lib/lambda.generated.ts",
|
| 9684 | "line": 5326
|
| 9685 | },
|
| 9686 | "name": "description",
|
| 9687 | "optional": true,
|
| 9688 | "type": {
|
| 9689 | "primitive": "string"
|
| 9690 | }
|
| 9691 | },
|
| 9692 | {
|
| 9693 | "docs": {
|
| 9694 | "custom": {
|
| 9695 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-provisionedconcurrencyconfig"
|
| 9696 | },
|
| 9697 | "remarks": "Updates are not supported for this property.",
|
| 9698 | "stability": "external",
|
| 9699 | "summary": "Specifies a provisioned concurrency configuration for a function's version."
|
| 9700 | },
|
| 9701 | "locationInModule": {
|
| 9702 | "filename": "lib/lambda.generated.ts",
|
| 9703 | "line": 5333
|
| 9704 | },
|
| 9705 | "name": "provisionedConcurrencyConfig",
|
| 9706 | "optional": true,
|
| 9707 | "type": {
|
| 9708 | "union": {
|
| 9709 | "types": [
|
| 9710 | {
|
| 9711 | "fqn": "@aws-cdk/core.IResolvable"
|
| 9712 | },
|
| 9713 | {
|
| 9714 | "fqn": "@aws-cdk/aws-lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty"
|
| 9715 | }
|
| 9716 | ]
|
| 9717 | }
|
| 9718 | }
|
| 9719 | }
|
| 9720 | ],
|
| 9721 | "symbolId": "lib/lambda.generated:CfnVersion"
|
| 9722 | },
|
| 9723 | "@aws-cdk/aws-lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty": {
|
| 9724 | "assembly": "@aws-cdk/aws-lambda",
|
| 9725 | "datatype": true,
|
| 9726 | "docs": {
|
| 9727 | "custom": {
|
| 9728 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-version-provisionedconcurrencyconfiguration.html",
|
| 9729 | "exampleMetadata": "fixture=_generated"
|
| 9730 | },
|
| 9731 | "stability": "external",
|
| 9732 | "summary": "A [provisioned concurrency](https://docs.aws.amazon.com/lambda/latest/dg/configuration-concurrency.html) configuration for a function's version.",
|
| 9733 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst provisionedConcurrencyConfigurationProperty: lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty = {\n provisionedConcurrentExecutions: 123,\n};"
|
| 9734 | },
|
| 9735 | "fqn": "@aws-cdk/aws-lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty",
|
| 9736 | "kind": "interface",
|
| 9737 | "locationInModule": {
|
| 9738 | "filename": "lib/lambda.generated.ts",
|
| 9739 | "line": 5387
|
| 9740 | },
|
| 9741 | "name": "ProvisionedConcurrencyConfigurationProperty",
|
| 9742 | "namespace": "CfnVersion",
|
| 9743 | "properties": [
|
| 9744 | {
|
| 9745 | "abstract": true,
|
| 9746 | "docs": {
|
| 9747 | "custom": {
|
| 9748 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-version-provisionedconcurrencyconfiguration.html#cfn-lambda-version-provisionedconcurrencyconfiguration-provisionedconcurrentexecutions"
|
| 9749 | },
|
| 9750 | "stability": "external",
|
| 9751 | "summary": "The amount of provisioned concurrency to allocate for the version."
|
| 9752 | },
|
| 9753 | "immutable": true,
|
| 9754 | "locationInModule": {
|
| 9755 | "filename": "lib/lambda.generated.ts",
|
| 9756 | "line": 5393
|
| 9757 | },
|
| 9758 | "name": "provisionedConcurrentExecutions",
|
| 9759 | "type": {
|
| 9760 | "primitive": "number"
|
| 9761 | }
|
| 9762 | }
|
| 9763 | ],
|
| 9764 | "symbolId": "lib/lambda.generated:CfnVersion.ProvisionedConcurrencyConfigurationProperty"
|
| 9765 | },
|
| 9766 | "@aws-cdk/aws-lambda.CfnVersionProps": {
|
| 9767 | "assembly": "@aws-cdk/aws-lambda",
|
| 9768 | "datatype": true,
|
| 9769 | "docs": {
|
| 9770 | "custom": {
|
| 9771 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html",
|
| 9772 | "exampleMetadata": "fixture=_generated"
|
| 9773 | },
|
| 9774 | "stability": "external",
|
| 9775 | "summary": "Properties for defining a `CfnVersion`.",
|
| 9776 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst cfnVersionProps: lambda.CfnVersionProps = {\n functionName: 'functionName',\n\n // the properties below are optional\n codeSha256: 'codeSha256',\n description: 'description',\n provisionedConcurrencyConfig: {\n provisionedConcurrentExecutions: 123,\n },\n};"
|
| 9777 | },
|
| 9778 | "fqn": "@aws-cdk/aws-lambda.CfnVersionProps",
|
| 9779 | "kind": "interface",
|
| 9780 | "locationInModule": {
|
| 9781 | "filename": "lib/lambda.generated.ts",
|
| 9782 | "line": 5168
|
| 9783 | },
|
| 9784 | "name": "CfnVersionProps",
|
| 9785 | "properties": [
|
| 9786 | {
|
| 9787 | "abstract": true,
|
| 9788 | "docs": {
|
| 9789 | "custom": {
|
| 9790 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-functionname"
|
| 9791 | },
|
| 9792 | "remarks": "**Name formats** - *Function name* - `MyFunction` .\n- *Function ARN* - `arn:aws:lambda:us-west-2:123456789012:function:MyFunction` .\n- *Partial ARN* - `123456789012:function:MyFunction` .\n\nThe length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.",
|
| 9793 | "stability": "external",
|
| 9794 | "summary": "The name of the Lambda function."
|
| 9795 | },
|
| 9796 | "immutable": true,
|
| 9797 | "locationInModule": {
|
| 9798 | "filename": "lib/lambda.generated.ts",
|
| 9799 | "line": 5181
|
| 9800 | },
|
| 9801 | "name": "functionName",
|
| 9802 | "type": {
|
| 9803 | "primitive": "string"
|
| 9804 | }
|
| 9805 | },
|
| 9806 | {
|
| 9807 | "abstract": true,
|
| 9808 | "docs": {
|
| 9809 | "custom": {
|
| 9810 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-codesha256"
|
| 9811 | },
|
| 9812 | "remarks": "Use this option to avoid publishing a version if the function code has changed since you last updated it. Updates are not supported for this property.",
|
| 9813 | "stability": "external",
|
| 9814 | "summary": "Only publish a version if the hash value matches the value that's specified."
|
| 9815 | },
|
| 9816 | "immutable": true,
|
| 9817 | "locationInModule": {
|
| 9818 | "filename": "lib/lambda.generated.ts",
|
| 9819 | "line": 5188
|
| 9820 | },
|
| 9821 | "name": "codeSha256",
|
| 9822 | "optional": true,
|
| 9823 | "type": {
|
| 9824 | "primitive": "string"
|
| 9825 | }
|
| 9826 | },
|
| 9827 | {
|
| 9828 | "abstract": true,
|
| 9829 | "docs": {
|
| 9830 | "custom": {
|
| 9831 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-description"
|
| 9832 | },
|
| 9833 | "remarks": "Updates are not supported for this property.",
|
| 9834 | "stability": "external",
|
| 9835 | "summary": "A description for the version to override the description in the function configuration."
|
| 9836 | },
|
| 9837 | "immutable": true,
|
| 9838 | "locationInModule": {
|
| 9839 | "filename": "lib/lambda.generated.ts",
|
| 9840 | "line": 5195
|
| 9841 | },
|
| 9842 | "name": "description",
|
| 9843 | "optional": true,
|
| 9844 | "type": {
|
| 9845 | "primitive": "string"
|
| 9846 | }
|
| 9847 | },
|
| 9848 | {
|
| 9849 | "abstract": true,
|
| 9850 | "docs": {
|
| 9851 | "custom": {
|
| 9852 | "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-version.html#cfn-lambda-version-provisionedconcurrencyconfig"
|
| 9853 | },
|
| 9854 | "remarks": "Updates are not supported for this property.",
|
| 9855 | "stability": "external",
|
| 9856 | "summary": "Specifies a provisioned concurrency configuration for a function's version."
|
| 9857 | },
|
| 9858 | "immutable": true,
|
| 9859 | "locationInModule": {
|
| 9860 | "filename": "lib/lambda.generated.ts",
|
| 9861 | "line": 5202
|
| 9862 | },
|
| 9863 | "name": "provisionedConcurrencyConfig",
|
| 9864 | "optional": true,
|
| 9865 | "type": {
|
| 9866 | "union": {
|
| 9867 | "types": [
|
| 9868 | {
|
| 9869 | "fqn": "@aws-cdk/core.IResolvable"
|
| 9870 | },
|
| 9871 | {
|
| 9872 | "fqn": "@aws-cdk/aws-lambda.CfnVersion.ProvisionedConcurrencyConfigurationProperty"
|
| 9873 | }
|
| 9874 | ]
|
| 9875 | }
|
| 9876 | }
|
| 9877 | }
|
| 9878 | ],
|
| 9879 | "symbolId": "lib/lambda.generated:CfnVersionProps"
|
| 9880 | },
|
| 9881 | "@aws-cdk/aws-lambda.Code": {
|
| 9882 | "abstract": true,
|
| 9883 | "assembly": "@aws-cdk/aws-lambda",
|
| 9884 | "docs": {
|
| 9885 | "stability": "stable",
|
| 9886 | "summary": "Represents the Lambda Handler Code.",
|
| 9887 | "example": "import * as signer from '@aws-cdk/aws-signer';\n\nconst signingProfile = new signer.SigningProfile(this, 'SigningProfile', {\n platform: signer.Platform.AWS_LAMBDA_SHA384_ECDSA,\n});\n\nconst codeSigningConfig = new lambda.CodeSigningConfig(this, 'CodeSigningConfig', {\n signingProfiles: [signingProfile],\n});\n\nnew lambda.Function(this, 'Function', {\n codeSigningConfig,\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});",
|
| 9888 | "custom": {
|
| 9889 | "exampleMetadata": "infused"
|
| 9890 | }
|
| 9891 | },
|
| 9892 | "fqn": "@aws-cdk/aws-lambda.Code",
|
| 9893 | "initializer": {
|
| 9894 | "docs": {
|
| 9895 | "stability": "stable"
|
| 9896 | }
|
| 9897 | },
|
| 9898 | "kind": "class",
|
| 9899 | "locationInModule": {
|
| 9900 | "filename": "lib/code.ts",
|
| 9901 | "line": 15
|
| 9902 | },
|
| 9903 | "methods": [
|
| 9904 | {
|
| 9905 | "docs": {
|
| 9906 | "deprecated": "use `fromAsset`",
|
| 9907 | "stability": "deprecated",
|
| 9908 | "summary": "DEPRECATED."
|
| 9909 | },
|
| 9910 | "locationInModule": {
|
| 9911 | "filename": "lib/code.ts",
|
| 9912 | "line": 90
|
| 9913 | },
|
| 9914 | "name": "asset",
|
| 9915 | "parameters": [
|
| 9916 | {
|
| 9917 | "name": "path",
|
| 9918 | "type": {
|
| 9919 | "primitive": "string"
|
| 9920 | }
|
| 9921 | }
|
| 9922 | ],
|
| 9923 | "returns": {
|
| 9924 | "type": {
|
| 9925 | "fqn": "@aws-cdk/aws-lambda.AssetCode"
|
| 9926 | }
|
| 9927 | },
|
| 9928 | "static": true
|
| 9929 | },
|
| 9930 | {
|
| 9931 | "docs": {
|
| 9932 | "deprecated": "use `fromBucket`",
|
| 9933 | "stability": "deprecated",
|
| 9934 | "summary": "DEPRECATED."
|
| 9935 | },
|
| 9936 | "locationInModule": {
|
| 9937 | "filename": "lib/code.ts",
|
| 9938 | "line": 30
|
| 9939 | },
|
| 9940 | "name": "bucket",
|
| 9941 | "parameters": [
|
| 9942 | {
|
| 9943 | "name": "bucket",
|
| 9944 | "type": {
|
| 9945 | "fqn": "@aws-cdk/aws-s3.IBucket"
|
| 9946 | }
|
| 9947 | },
|
| 9948 | {
|
| 9949 | "name": "key",
|
| 9950 | "type": {
|
| 9951 | "primitive": "string"
|
| 9952 | }
|
| 9953 | },
|
| 9954 | {
|
| 9955 | "name": "objectVersion",
|
| 9956 | "optional": true,
|
| 9957 | "type": {
|
| 9958 | "primitive": "string"
|
| 9959 | }
|
| 9960 | }
|
| 9961 | ],
|
| 9962 | "returns": {
|
| 9963 | "type": {
|
| 9964 | "fqn": "@aws-cdk/aws-lambda.S3Code"
|
| 9965 | }
|
| 9966 | },
|
| 9967 | "static": true
|
| 9968 | },
|
| 9969 | {
|
| 9970 | "docs": {
|
| 9971 | "deprecated": "use `fromCfnParameters`",
|
| 9972 | "stability": "deprecated",
|
| 9973 | "summary": "DEPRECATED."
|
| 9974 | },
|
| 9975 | "locationInModule": {
|
| 9976 | "filename": "lib/code.ts",
|
| 9977 | "line": 108
|
| 9978 | },
|
| 9979 | "name": "cfnParameters",
|
| 9980 | "parameters": [
|
| 9981 | {
|
| 9982 | "name": "props",
|
| 9983 | "optional": true,
|
| 9984 | "type": {
|
| 9985 | "fqn": "@aws-cdk/aws-lambda.CfnParametersCodeProps"
|
| 9986 | }
|
| 9987 | }
|
| 9988 | ],
|
| 9989 | "returns": {
|
| 9990 | "type": {
|
| 9991 | "fqn": "@aws-cdk/aws-lambda.CfnParametersCode"
|
| 9992 | }
|
| 9993 | },
|
| 9994 | "static": true
|
| 9995 | },
|
| 9996 | {
|
| 9997 | "docs": {
|
| 9998 | "stability": "stable",
|
| 9999 | "summary": "Loads the function code from a local disk path."
|
| 10000 | },
|
| 10001 | "locationInModule": {
|
| 10002 | "filename": "lib/code.ts",
|
| 10003 | "line": 56
|
| 10004 | },
|
| 10005 | "name": "fromAsset",
|
| 10006 | "parameters": [
|
| 10007 | {
|
| 10008 | "docs": {
|
| 10009 | "summary": "Either a directory with the Lambda code bundle or a .zip file."
|
| 10010 | },
|
| 10011 | "name": "path",
|
| 10012 | "type": {
|
| 10013 | "primitive": "string"
|
| 10014 | }
|
| 10015 | },
|
| 10016 | {
|
| 10017 | "name": "options",
|
| 10018 | "optional": true,
|
| 10019 | "type": {
|
| 10020 | "fqn": "@aws-cdk/aws-s3-assets.AssetOptions"
|
| 10021 | }
|
| 10022 | }
|
| 10023 | ],
|
| 10024 | "returns": {
|
| 10025 | "type": {
|
| 10026 | "fqn": "@aws-cdk/aws-lambda.AssetCode"
|
| 10027 | }
|
| 10028 | },
|
| 10029 | "static": true
|
| 10030 | },
|
| 10031 | {
|
| 10032 | "docs": {
|
| 10033 | "stability": "stable",
|
| 10034 | "summary": "Create an ECR image from the specified asset and bind it as the Lambda code."
|
| 10035 | },
|
| 10036 | "locationInModule": {
|
| 10037 | "filename": "lib/code.ts",
|
| 10038 | "line": 126
|
| 10039 | },
|
| 10040 | "name": "fromAssetImage",
|
| 10041 | "parameters": [
|
| 10042 | {
|
| 10043 | "docs": {
|
| 10044 | "summary": "the directory from which the asset must be created."
|
| 10045 | },
|
| 10046 | "name": "directory",
|
| 10047 | "type": {
|
| 10048 | "primitive": "string"
|
| 10049 | }
|
| 10050 | },
|
| 10051 | {
|
| 10052 | "docs": {
|
| 10053 | "summary": "properties to further configure the selected image."
|
| 10054 | },
|
| 10055 | "name": "props",
|
| 10056 | "optional": true,
|
| 10057 | "type": {
|
| 10058 | "fqn": "@aws-cdk/aws-lambda.AssetImageCodeProps"
|
| 10059 | }
|
| 10060 | }
|
| 10061 | ],
|
| 10062 | "returns": {
|
| 10063 | "type": {
|
| 10064 | "fqn": "@aws-cdk/aws-lambda.AssetImageCode"
|
| 10065 | }
|
| 10066 | },
|
| 10067 | "static": true
|
| 10068 | },
|
| 10069 | {
|
| 10070 | "docs": {
|
| 10071 | "stability": "stable",
|
| 10072 | "summary": "Lambda handler code as an S3 object."
|
| 10073 | },
|
| 10074 | "locationInModule": {
|
| 10075 | "filename": "lib/code.ts",
|
| 10076 | "line": 22
|
| 10077 | },
|
| 10078 | "name": "fromBucket",
|
| 10079 | "parameters": [
|
| 10080 | {
|
| 10081 | "docs": {
|
| 10082 | "summary": "The S3 bucket."
|
| 10083 | },
|
| 10084 | "name": "bucket",
|
| 10085 | "type": {
|
| 10086 | "fqn": "@aws-cdk/aws-s3.IBucket"
|
| 10087 | }
|
| 10088 | },
|
| 10089 | {
|
| 10090 | "docs": {
|
| 10091 | "summary": "The object key."
|
| 10092 | },
|
| 10093 | "name": "key",
|
| 10094 | "type": {
|
| 10095 | "primitive": "string"
|
| 10096 | }
|
| 10097 | },
|
| 10098 | {
|
| 10099 | "docs": {
|
| 10100 | "summary": "Optional S3 object version."
|
| 10101 | },
|
| 10102 | "name": "objectVersion",
|
| 10103 | "optional": true,
|
| 10104 | "type": {
|
| 10105 | "primitive": "string"
|
| 10106 | }
|
| 10107 | }
|
| 10108 | ],
|
| 10109 | "returns": {
|
| 10110 | "type": {
|
| 10111 | "fqn": "@aws-cdk/aws-lambda.S3Code"
|
| 10112 | }
|
| 10113 | },
|
| 10114 | "static": true
|
| 10115 | },
|
| 10116 | {
|
| 10117 | "docs": {
|
| 10118 | "returns": "a new instance of `CfnParametersCode`",
|
| 10119 | "stability": "stable",
|
| 10120 | "summary": "Creates a new Lambda source defined using CloudFormation parameters."
|
| 10121 | },
|
| 10122 | "locationInModule": {
|
| 10123 | "filename": "lib/code.ts",
|
| 10124 | "line": 100
|
| 10125 | },
|
| 10126 | "name": "fromCfnParameters",
|
| 10127 | "parameters": [
|
| 10128 | {
|
| 10129 | "docs": {
|
| 10130 | "summary": "optional construction properties of {@link CfnParametersCode}."
|
| 10131 | },
|
| 10132 | "name": "props",
|
| 10133 | "optional": true,
|
| 10134 | "type": {
|
| 10135 | "fqn": "@aws-cdk/aws-lambda.CfnParametersCodeProps"
|
| 10136 | }
|
| 10137 | }
|
| 10138 | ],
|
| 10139 | "returns": {
|
| 10140 | "type": {
|
| 10141 | "fqn": "@aws-cdk/aws-lambda.CfnParametersCode"
|
| 10142 | }
|
| 10143 | },
|
| 10144 | "static": true
|
| 10145 | },
|
| 10146 | {
|
| 10147 | "docs": {
|
| 10148 | "remarks": "By default, the asset is expected to be located at `/asset` in the\nimage.",
|
| 10149 | "stability": "stable",
|
| 10150 | "summary": "Loads the function code from an asset created by a Docker build."
|
| 10151 | },
|
| 10152 | "locationInModule": {
|
| 10153 | "filename": "lib/code.ts",
|
| 10154 | "line": 69
|
| 10155 | },
|
| 10156 | "name": "fromDockerBuild",
|
| 10157 | "parameters": [
|
| 10158 | {
|
| 10159 | "docs": {
|
| 10160 | "summary": "The path to the directory containing the Docker file."
|
| 10161 | },
|
| 10162 | "name": "path",
|
| 10163 | "type": {
|
| 10164 | "primitive": "string"
|
| 10165 | }
|
| 10166 | },
|
| 10167 | {
|
| 10168 | "docs": {
|
| 10169 | "summary": "Docker build options."
|
| 10170 | },
|
| 10171 | "name": "options",
|
| 10172 | "optional": true,
|
| 10173 | "type": {
|
| 10174 | "fqn": "@aws-cdk/aws-lambda.DockerBuildAssetOptions"
|
| 10175 | }
|
| 10176 | }
|
| 10177 | ],
|
| 10178 | "returns": {
|
| 10179 | "type": {
|
| 10180 | "fqn": "@aws-cdk/aws-lambda.AssetCode"
|
| 10181 | }
|
| 10182 | },
|
| 10183 | "static": true
|
| 10184 | },
|
| 10185 | {
|
| 10186 | "docs": {
|
| 10187 | "stability": "stable",
|
| 10188 | "summary": "Use an existing ECR image as the Lambda code."
|
| 10189 | },
|
| 10190 | "locationInModule": {
|
| 10191 | "filename": "lib/code.ts",
|
| 10192 | "line": 117
|
| 10193 | },
|
| 10194 | "name": "fromEcrImage",
|
| 10195 | "parameters": [
|
| 10196 | {
|
| 10197 | "docs": {
|
| 10198 | "summary": "the ECR repository that the image is in."
|
| 10199 | },
|
| 10200 | "name": "repository",
|
| 10201 | "type": {
|
| 10202 | "fqn": "@aws-cdk/aws-ecr.IRepository"
|
| 10203 | }
|
| 10204 | },
|
| 10205 | {
|
| 10206 | "docs": {
|
| 10207 | "summary": "properties to further configure the selected image."
|
| 10208 | },
|
| 10209 | "name": "props",
|
| 10210 | "optional": true,
|
| 10211 | "type": {
|
| 10212 | "fqn": "@aws-cdk/aws-lambda.EcrImageCodeProps"
|
| 10213 | }
|
| 10214 | }
|
| 10215 | ],
|
| 10216 | "returns": {
|
| 10217 | "type": {
|
| 10218 | "fqn": "@aws-cdk/aws-lambda.EcrImageCode"
|
| 10219 | }
|
| 10220 | },
|
| 10221 | "static": true
|
| 10222 | },
|
| 10223 | {
|
| 10224 | "docs": {
|
| 10225 | "returns": "`LambdaInlineCode` with inline code.",
|
| 10226 | "stability": "stable",
|
| 10227 | "summary": "Inline code for Lambda handler."
|
| 10228 | },
|
| 10229 | "locationInModule": {
|
| 10230 | "filename": "lib/code.ts",
|
| 10231 | "line": 39
|
| 10232 | },
|
| 10233 | "name": "fromInline",
|
| 10234 | "parameters": [
|
| 10235 | {
|
| 10236 | "docs": {
|
| 10237 | "summary": "The actual handler code (limited to 4KiB)."
|
| 10238 | },
|
| 10239 | "name": "code",
|
| 10240 | "type": {
|
| 10241 | "primitive": "string"
|
| 10242 | }
|
| 10243 | }
|
| 10244 | ],
|
| 10245 | "returns": {
|
| 10246 | "type": {
|
| 10247 | "fqn": "@aws-cdk/aws-lambda.InlineCode"
|
| 10248 | }
|
| 10249 | },
|
| 10250 | "static": true
|
| 10251 | },
|
| 10252 | {
|
| 10253 | "docs": {
|
| 10254 | "deprecated": "use `fromInline`",
|
| 10255 | "stability": "deprecated",
|
| 10256 | "summary": "DEPRECATED."
|
| 10257 | },
|
| 10258 | "locationInModule": {
|
| 10259 | "filename": "lib/code.ts",
|
| 10260 | "line": 47
|
| 10261 | },
|
| 10262 | "name": "inline",
|
| 10263 | "parameters": [
|
| 10264 | {
|
| 10265 | "name": "code",
|
| 10266 | "type": {
|
| 10267 | "primitive": "string"
|
| 10268 | }
|
| 10269 | }
|
| 10270 | ],
|
| 10271 | "returns": {
|
| 10272 | "type": {
|
| 10273 | "fqn": "@aws-cdk/aws-lambda.InlineCode"
|
| 10274 | }
|
| 10275 | },
|
| 10276 | "static": true
|
| 10277 | },
|
| 10278 | {
|
| 10279 | "abstract": true,
|
| 10280 | "docs": {
|
| 10281 | "stability": "stable",
|
| 10282 | "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun."
|
| 10283 | },
|
| 10284 | "locationInModule": {
|
| 10285 | "filename": "lib/code.ts",
|
| 10286 | "line": 145
|
| 10287 | },
|
| 10288 | "name": "bind",
|
| 10289 | "parameters": [
|
| 10290 | {
|
| 10291 | "docs": {
|
| 10292 | "remarks": "Don't be smart about trying to down-cast or\nassume it's initialized. You may just use it as a construct scope.",
|
| 10293 | "summary": "The binding scope."
|
| 10294 | },
|
| 10295 | "name": "scope",
|
| 10296 | "type": {
|
| 10297 | "fqn": "@aws-cdk/core.Construct"
|
| 10298 | }
|
| 10299 | }
|
| 10300 | ],
|
| 10301 | "returns": {
|
| 10302 | "type": {
|
| 10303 | "fqn": "@aws-cdk/aws-lambda.CodeConfig"
|
| 10304 | }
|
| 10305 | }
|
| 10306 | },
|
| 10307 | {
|
| 10308 | "docs": {
|
| 10309 | "remarks": "Specifically it's required to allow assets to add\nmetadata for tooling like SAM CLI to be able to find their origins.",
|
| 10310 | "stability": "stable",
|
| 10311 | "summary": "Called after the CFN function resource has been created to allow the code class to bind to it."
|
| 10312 | },
|
| 10313 | "locationInModule": {
|
| 10314 | "filename": "lib/code.ts",
|
| 10315 | "line": 152
|
| 10316 | },
|
| 10317 | "name": "bindToResource",
|
| 10318 | "parameters": [
|
| 10319 | {
|
| 10320 | "name": "_resource",
|
| 10321 | "type": {
|
| 10322 | "fqn": "@aws-cdk/core.CfnResource"
|
| 10323 | }
|
| 10324 | },
|
| 10325 | {
|
| 10326 | "name": "_options",
|
| 10327 | "optional": true,
|
| 10328 | "type": {
|
| 10329 | "fqn": "@aws-cdk/aws-lambda.ResourceBindOptions"
|
| 10330 | }
|
| 10331 | }
|
| 10332 | ]
|
| 10333 | }
|
| 10334 | ],
|
| 10335 | "name": "Code",
|
| 10336 | "properties": [
|
| 10337 | {
|
| 10338 | "abstract": true,
|
| 10339 | "docs": {
|
| 10340 | "deprecated": "this value is ignored since inline is now determined based on the\nthe `inlineCode` field of `CodeConfig` returned from `bind()`.",
|
| 10341 | "stability": "deprecated",
|
| 10342 | "summary": "Determines whether this Code is inline code or not."
|
| 10343 | },
|
| 10344 | "immutable": true,
|
| 10345 | "locationInModule": {
|
| 10346 | "filename": "lib/code.ts",
|
| 10347 | "line": 136
|
| 10348 | },
|
| 10349 | "name": "isInline",
|
| 10350 | "type": {
|
| 10351 | "primitive": "boolean"
|
| 10352 | }
|
| 10353 | }
|
| 10354 | ],
|
| 10355 | "symbolId": "lib/code:Code"
|
| 10356 | },
|
| 10357 | "@aws-cdk/aws-lambda.CodeConfig": {
|
| 10358 | "assembly": "@aws-cdk/aws-lambda",
|
| 10359 | "datatype": true,
|
| 10360 | "docs": {
|
| 10361 | "stability": "stable",
|
| 10362 | "summary": "Result of binding `Code` into a `Function`.",
|
| 10363 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst codeConfig: lambda.CodeConfig = {\n image: {\n imageUri: 'imageUri',\n\n // the properties below are optional\n cmd: ['cmd'],\n entrypoint: ['entrypoint'],\n workingDirectory: 'workingDirectory',\n },\n inlineCode: 'inlineCode',\n s3Location: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n objectVersion: 'objectVersion',\n },\n};",
|
| 10364 | "custom": {
|
| 10365 | "exampleMetadata": "fixture=_generated"
|
| 10366 | }
|
| 10367 | },
|
| 10368 | "fqn": "@aws-cdk/aws-lambda.CodeConfig",
|
| 10369 | "kind": "interface",
|
| 10370 | "locationInModule": {
|
| 10371 | "filename": "lib/code.ts",
|
| 10372 | "line": 160
|
| 10373 | },
|
| 10374 | "name": "CodeConfig",
|
| 10375 | "properties": [
|
| 10376 | {
|
| 10377 | "abstract": true,
|
| 10378 | "docs": {
|
| 10379 | "default": "- code is not an ECR container image",
|
| 10380 | "stability": "stable",
|
| 10381 | "summary": "Docker image configuration (mutually exclusive with `s3Location` and `inlineCode`)."
|
| 10382 | },
|
| 10383 | "immutable": true,
|
| 10384 | "locationInModule": {
|
| 10385 | "filename": "lib/code.ts",
|
| 10386 | "line": 177
|
| 10387 | },
|
| 10388 | "name": "image",
|
| 10389 | "optional": true,
|
| 10390 | "type": {
|
| 10391 | "fqn": "@aws-cdk/aws-lambda.CodeImageConfig"
|
| 10392 | }
|
| 10393 | },
|
| 10394 | {
|
| 10395 | "abstract": true,
|
| 10396 | "docs": {
|
| 10397 | "default": "- code is not inline code",
|
| 10398 | "stability": "stable",
|
| 10399 | "summary": "Inline code (mutually exclusive with `s3Location` and `image`)."
|
| 10400 | },
|
| 10401 | "immutable": true,
|
| 10402 | "locationInModule": {
|
| 10403 | "filename": "lib/code.ts",
|
| 10404 | "line": 171
|
| 10405 | },
|
| 10406 | "name": "inlineCode",
|
| 10407 | "optional": true,
|
| 10408 | "type": {
|
| 10409 | "primitive": "string"
|
| 10410 | }
|
| 10411 | },
|
| 10412 | {
|
| 10413 | "abstract": true,
|
| 10414 | "docs": {
|
| 10415 | "default": "- code is not an s3 location",
|
| 10416 | "stability": "stable",
|
| 10417 | "summary": "The location of the code in S3 (mutually exclusive with `inlineCode` and `image`)."
|
| 10418 | },
|
| 10419 | "immutable": true,
|
| 10420 | "locationInModule": {
|
| 10421 | "filename": "lib/code.ts",
|
| 10422 | "line": 165
|
| 10423 | },
|
| 10424 | "name": "s3Location",
|
| 10425 | "optional": true,
|
| 10426 | "type": {
|
| 10427 | "fqn": "@aws-cdk/aws-s3.Location"
|
| 10428 | }
|
| 10429 | }
|
| 10430 | ],
|
| 10431 | "symbolId": "lib/code:CodeConfig"
|
| 10432 | },
|
| 10433 | "@aws-cdk/aws-lambda.CodeImageConfig": {
|
| 10434 | "assembly": "@aws-cdk/aws-lambda",
|
| 10435 | "datatype": true,
|
| 10436 | "docs": {
|
| 10437 | "stability": "stable",
|
| 10438 | "summary": "Result of the bind when an ECR image is used.",
|
| 10439 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst codeImageConfig: lambda.CodeImageConfig = {\n imageUri: 'imageUri',\n\n // the properties below are optional\n cmd: ['cmd'],\n entrypoint: ['entrypoint'],\n workingDirectory: 'workingDirectory',\n};",
|
| 10440 | "custom": {
|
| 10441 | "exampleMetadata": "fixture=_generated"
|
| 10442 | }
|
| 10443 | },
|
| 10444 | "fqn": "@aws-cdk/aws-lambda.CodeImageConfig",
|
| 10445 | "kind": "interface",
|
| 10446 | "locationInModule": {
|
| 10447 | "filename": "lib/code.ts",
|
| 10448 | "line": 183
|
| 10449 | },
|
| 10450 | "name": "CodeImageConfig",
|
| 10451 | "properties": [
|
| 10452 | {
|
| 10453 | "abstract": true,
|
| 10454 | "docs": {
|
| 10455 | "stability": "stable",
|
| 10456 | "summary": "URI to the Docker image."
|
| 10457 | },
|
| 10458 | "immutable": true,
|
| 10459 | "locationInModule": {
|
| 10460 | "filename": "lib/code.ts",
|
| 10461 | "line": 187
|
| 10462 | },
|
| 10463 | "name": "imageUri",
|
| 10464 | "type": {
|
| 10465 | "primitive": "string"
|
| 10466 | }
|
| 10467 | },
|
| 10468 | {
|
| 10469 | "abstract": true,
|
| 10470 | "docs": {
|
| 10471 | "default": "- use the CMD specified in the docker image or Dockerfile.",
|
| 10472 | "remarks": "This needs to be in the 'exec form', viz., `[ 'executable', 'param1', 'param2' ]`.",
|
| 10473 | "see": "https://docs.docker.com/engine/reference/builder/#cmd",
|
| 10474 | "stability": "stable",
|
| 10475 | "summary": "Specify or override the CMD on the specified Docker image or Dockerfile."
|
| 10476 | },
|
| 10477 | "immutable": true,
|
| 10478 | "locationInModule": {
|
| 10479 | "filename": "lib/code.ts",
|
| 10480 | "line": 195
|
| 10481 | },
|
| 10482 | "name": "cmd",
|
| 10483 | "optional": true,
|
| 10484 | "type": {
|
| 10485 | "collection": {
|
| 10486 | "elementtype": {
|
| 10487 | "primitive": "string"
|
| 10488 | },
|
| 10489 | "kind": "array"
|
| 10490 | }
|
| 10491 | }
|
| 10492 | },
|
| 10493 | {
|
| 10494 | "abstract": true,
|
| 10495 | "docs": {
|
| 10496 | "default": "- use the ENTRYPOINT in the docker image or Dockerfile.",
|
| 10497 | "remarks": "An ENTRYPOINT allows you to configure a container that will run as an executable.\nThis needs to be in the 'exec form', viz., `[ 'executable', 'param1', 'param2' ]`.",
|
| 10498 | "see": "https://docs.docker.com/engine/reference/builder/#entrypoint",
|
| 10499 | "stability": "stable",
|
| 10500 | "summary": "Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile."
|
| 10501 | },
|
| 10502 | "immutable": true,
|
| 10503 | "locationInModule": {
|
| 10504 | "filename": "lib/code.ts",
|
| 10505 | "line": 204
|
| 10506 | },
|
| 10507 | "name": "entrypoint",
|
| 10508 | "optional": true,
|
| 10509 | "type": {
|
| 10510 | "collection": {
|
| 10511 | "elementtype": {
|
| 10512 | "primitive": "string"
|
| 10513 | },
|
| 10514 | "kind": "array"
|
| 10515 | }
|
| 10516 | }
|
| 10517 | },
|
| 10518 | {
|
| 10519 | "abstract": true,
|
| 10520 | "docs": {
|
| 10521 | "default": "- use the WORKDIR in the docker image or Dockerfile.",
|
| 10522 | "remarks": "A WORKDIR allows you to configure the working directory the container will use.",
|
| 10523 | "see": "https://docs.docker.com/engine/reference/builder/#workdir",
|
| 10524 | "stability": "stable",
|
| 10525 | "summary": "Specify or override the WORKDIR on the specified Docker image or Dockerfile."
|
| 10526 | },
|
| 10527 | "immutable": true,
|
| 10528 | "locationInModule": {
|
| 10529 | "filename": "lib/code.ts",
|
| 10530 | "line": 212
|
| 10531 | },
|
| 10532 | "name": "workingDirectory",
|
| 10533 | "optional": true,
|
| 10534 | "type": {
|
| 10535 | "primitive": "string"
|
| 10536 | }
|
| 10537 | }
|
| 10538 | ],
|
| 10539 | "symbolId": "lib/code:CodeImageConfig"
|
| 10540 | },
|
| 10541 | "@aws-cdk/aws-lambda.CodeSigningConfig": {
|
| 10542 | "assembly": "@aws-cdk/aws-lambda",
|
| 10543 | "base": "@aws-cdk/core.Resource",
|
| 10544 | "docs": {
|
| 10545 | "custom": {
|
| 10546 | "resource": "AWS::Lambda::CodeSigningConfig",
|
| 10547 | "exampleMetadata": "infused"
|
| 10548 | },
|
| 10549 | "stability": "stable",
|
| 10550 | "summary": "Defines a Code Signing Config.",
|
| 10551 | "example": "import * as signer from '@aws-cdk/aws-signer';\n\nconst signingProfile = new signer.SigningProfile(this, 'SigningProfile', {\n platform: signer.Platform.AWS_LAMBDA_SHA384_ECDSA,\n});\n\nconst codeSigningConfig = new lambda.CodeSigningConfig(this, 'CodeSigningConfig', {\n signingProfiles: [signingProfile],\n});\n\nnew lambda.Function(this, 'Function', {\n codeSigningConfig,\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});"
|
| 10552 | },
|
| 10553 | "fqn": "@aws-cdk/aws-lambda.CodeSigningConfig",
|
| 10554 | "initializer": {
|
| 10555 | "docs": {
|
| 10556 | "stability": "stable"
|
| 10557 | },
|
| 10558 | "locationInModule": {
|
| 10559 | "filename": "lib/code-signing-config.ts",
|
| 10560 | "line": 101
|
| 10561 | },
|
| 10562 | "parameters": [
|
| 10563 | {
|
| 10564 | "name": "scope",
|
| 10565 | "type": {
|
| 10566 | "fqn": "constructs.Construct"
|
| 10567 | }
|
| 10568 | },
|
| 10569 | {
|
| 10570 | "name": "id",
|
| 10571 | "type": {
|
| 10572 | "primitive": "string"
|
| 10573 | }
|
| 10574 | },
|
| 10575 | {
|
| 10576 | "name": "props",
|
| 10577 | "type": {
|
| 10578 | "fqn": "@aws-cdk/aws-lambda.CodeSigningConfigProps"
|
| 10579 | }
|
| 10580 | }
|
| 10581 | ]
|
| 10582 | },
|
| 10583 | "interfaces": [
|
| 10584 | "@aws-cdk/aws-lambda.ICodeSigningConfig"
|
| 10585 | ],
|
| 10586 | "kind": "class",
|
| 10587 | "locationInModule": {
|
| 10588 | "filename": "lib/code-signing-config.ts",
|
| 10589 | "line": 73
|
| 10590 | },
|
| 10591 | "methods": [
|
| 10592 | {
|
| 10593 | "docs": {
|
| 10594 | "stability": "stable",
|
| 10595 | "summary": "Creates a Signing Profile construct that represents an external Signing Profile."
|
| 10596 | },
|
| 10597 | "locationInModule": {
|
| 10598 | "filename": "lib/code-signing-config.ts",
|
| 10599 | "line": 81
|
| 10600 | },
|
| 10601 | "name": "fromCodeSigningConfigArn",
|
| 10602 | "parameters": [
|
| 10603 | {
|
| 10604 | "docs": {
|
| 10605 | "summary": "The parent creating construct (usually `this`)."
|
| 10606 | },
|
| 10607 | "name": "scope",
|
| 10608 | "type": {
|
| 10609 | "fqn": "constructs.Construct"
|
| 10610 | }
|
| 10611 | },
|
| 10612 | {
|
| 10613 | "docs": {
|
| 10614 | "summary": "The construct's name."
|
| 10615 | },
|
| 10616 | "name": "id",
|
| 10617 | "type": {
|
| 10618 | "primitive": "string"
|
| 10619 | }
|
| 10620 | },
|
| 10621 | {
|
| 10622 | "docs": {
|
| 10623 | "summary": "The ARN of code signing config."
|
| 10624 | },
|
| 10625 | "name": "codeSigningConfigArn",
|
| 10626 | "type": {
|
| 10627 | "primitive": "string"
|
| 10628 | }
|
| 10629 | }
|
| 10630 | ],
|
| 10631 | "returns": {
|
| 10632 | "type": {
|
| 10633 | "fqn": "@aws-cdk/aws-lambda.ICodeSigningConfig"
|
| 10634 | }
|
| 10635 | },
|
| 10636 | "static": true
|
| 10637 | }
|
| 10638 | ],
|
| 10639 | "name": "CodeSigningConfig",
|
| 10640 | "properties": [
|
| 10641 | {
|
| 10642 | "docs": {
|
| 10643 | "stability": "stable",
|
| 10644 | "summary": "The ARN of Code Signing Config."
|
| 10645 | },
|
| 10646 | "immutable": true,
|
| 10647 | "locationInModule": {
|
| 10648 | "filename": "lib/code-signing-config.ts",
|
| 10649 | "line": 98
|
| 10650 | },
|
| 10651 | "name": "codeSigningConfigArn",
|
| 10652 | "overrides": "@aws-cdk/aws-lambda.ICodeSigningConfig",
|
| 10653 | "type": {
|
| 10654 | "primitive": "string"
|
| 10655 | }
|
| 10656 | },
|
| 10657 | {
|
| 10658 | "docs": {
|
| 10659 | "stability": "stable",
|
| 10660 | "summary": "The id of Code Signing Config."
|
| 10661 | },
|
| 10662 | "immutable": true,
|
| 10663 | "locationInModule": {
|
| 10664 | "filename": "lib/code-signing-config.ts",
|
| 10665 | "line": 99
|
| 10666 | },
|
| 10667 | "name": "codeSigningConfigId",
|
| 10668 | "overrides": "@aws-cdk/aws-lambda.ICodeSigningConfig",
|
| 10669 | "type": {
|
| 10670 | "primitive": "string"
|
| 10671 | }
|
| 10672 | }
|
| 10673 | ],
|
| 10674 | "symbolId": "lib/code-signing-config:CodeSigningConfig"
|
| 10675 | },
|
| 10676 | "@aws-cdk/aws-lambda.CodeSigningConfigProps": {
|
| 10677 | "assembly": "@aws-cdk/aws-lambda",
|
| 10678 | "datatype": true,
|
| 10679 | "docs": {
|
| 10680 | "stability": "stable",
|
| 10681 | "summary": "Construction properties for a Code Signing Config object.",
|
| 10682 | "example": "import * as signer from '@aws-cdk/aws-signer';\n\nconst signingProfile = new signer.SigningProfile(this, 'SigningProfile', {\n platform: signer.Platform.AWS_LAMBDA_SHA384_ECDSA,\n});\n\nconst codeSigningConfig = new lambda.CodeSigningConfig(this, 'CodeSigningConfig', {\n signingProfiles: [signingProfile],\n});\n\nnew lambda.Function(this, 'Function', {\n codeSigningConfig,\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});",
|
| 10683 | "custom": {
|
| 10684 | "exampleMetadata": "infused"
|
| 10685 | }
|
| 10686 | },
|
| 10687 | "fqn": "@aws-cdk/aws-lambda.CodeSigningConfigProps",
|
| 10688 | "kind": "interface",
|
| 10689 | "locationInModule": {
|
| 10690 | "filename": "lib/code-signing-config.ts",
|
| 10691 | "line": 42
|
| 10692 | },
|
| 10693 | "name": "CodeSigningConfigProps",
|
| 10694 | "properties": [
|
| 10695 | {
|
| 10696 | "abstract": true,
|
| 10697 | "docs": {
|
| 10698 | "stability": "stable",
|
| 10699 | "summary": "List of signing profiles that defines a trusted user who can sign a code package."
|
| 10700 | },
|
| 10701 | "immutable": true,
|
| 10702 | "locationInModule": {
|
| 10703 | "filename": "lib/code-signing-config.ts",
|
| 10704 | "line": 47
|
| 10705 | },
|
| 10706 | "name": "signingProfiles",
|
| 10707 | "type": {
|
| 10708 | "collection": {
|
| 10709 | "elementtype": {
|
| 10710 | "fqn": "@aws-cdk/aws-signer.ISigningProfile"
|
| 10711 | },
|
| 10712 | "kind": "array"
|
| 10713 | }
|
| 10714 | }
|
| 10715 | },
|
| 10716 | {
|
| 10717 | "abstract": true,
|
| 10718 | "docs": {
|
| 10719 | "default": "- No description.",
|
| 10720 | "stability": "stable",
|
| 10721 | "summary": "Code signing configuration description."
|
| 10722 | },
|
| 10723 | "immutable": true,
|
| 10724 | "locationInModule": {
|
| 10725 | "filename": "lib/code-signing-config.ts",
|
| 10726 | "line": 65
|
| 10727 | },
|
| 10728 | "name": "description",
|
| 10729 | "optional": true,
|
| 10730 | "type": {
|
| 10731 | "primitive": "string"
|
| 10732 | }
|
| 10733 | },
|
| 10734 | {
|
| 10735 | "abstract": true,
|
| 10736 | "docs": {
|
| 10737 | "default": "UntrustedArtifactOnDeployment.WARN",
|
| 10738 | "remarks": "If you set the policy to Enforce, Lambda blocks the deployment request\nif signature validation checks fail.\nIf you set the policy to Warn, Lambda allows the deployment and\ncreates a CloudWatch log.",
|
| 10739 | "stability": "stable",
|
| 10740 | "summary": "Code signing configuration policy for deployment validation failure."
|
| 10741 | },
|
| 10742 | "immutable": true,
|
| 10743 | "locationInModule": {
|
| 10744 | "filename": "lib/code-signing-config.ts",
|
| 10745 | "line": 58
|
| 10746 | },
|
| 10747 | "name": "untrustedArtifactOnDeployment",
|
| 10748 | "optional": true,
|
| 10749 | "type": {
|
| 10750 | "fqn": "@aws-cdk/aws-lambda.UntrustedArtifactOnDeployment"
|
| 10751 | }
|
| 10752 | }
|
| 10753 | ],
|
| 10754 | "symbolId": "lib/code-signing-config:CodeSigningConfigProps"
|
| 10755 | },
|
| 10756 | "@aws-cdk/aws-lambda.DestinationConfig": {
|
| 10757 | "assembly": "@aws-cdk/aws-lambda",
|
| 10758 | "datatype": true,
|
| 10759 | "docs": {
|
| 10760 | "stability": "stable",
|
| 10761 | "summary": "A destination configuration.",
|
| 10762 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst destinationConfig: lambda.DestinationConfig = {\n destination: 'destination',\n};",
|
| 10763 | "custom": {
|
| 10764 | "exampleMetadata": "fixture=_generated"
|
| 10765 | }
|
| 10766 | },
|
| 10767 | "fqn": "@aws-cdk/aws-lambda.DestinationConfig",
|
| 10768 | "kind": "interface",
|
| 10769 | "locationInModule": {
|
| 10770 | "filename": "lib/destination.ts",
|
| 10771 | "line": 11
|
| 10772 | },
|
| 10773 | "name": "DestinationConfig",
|
| 10774 | "properties": [
|
| 10775 | {
|
| 10776 | "abstract": true,
|
| 10777 | "docs": {
|
| 10778 | "stability": "stable",
|
| 10779 | "summary": "The Amazon Resource Name (ARN) of the destination resource."
|
| 10780 | },
|
| 10781 | "immutable": true,
|
| 10782 | "locationInModule": {
|
| 10783 | "filename": "lib/destination.ts",
|
| 10784 | "line": 15
|
| 10785 | },
|
| 10786 | "name": "destination",
|
| 10787 | "type": {
|
| 10788 | "primitive": "string"
|
| 10789 | }
|
| 10790 | }
|
| 10791 | ],
|
| 10792 | "symbolId": "lib/destination:DestinationConfig"
|
| 10793 | },
|
| 10794 | "@aws-cdk/aws-lambda.DestinationOptions": {
|
| 10795 | "assembly": "@aws-cdk/aws-lambda",
|
| 10796 | "datatype": true,
|
| 10797 | "docs": {
|
| 10798 | "stability": "stable",
|
| 10799 | "summary": "Options when binding a destination to a function.",
|
| 10800 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst destinationOptions: lambda.DestinationOptions = {\n type: lambda.DestinationType.FAILURE,\n};",
|
| 10801 | "custom": {
|
| 10802 | "exampleMetadata": "fixture=_generated"
|
| 10803 | }
|
| 10804 | },
|
| 10805 | "fqn": "@aws-cdk/aws-lambda.DestinationOptions",
|
| 10806 | "kind": "interface",
|
| 10807 | "locationInModule": {
|
| 10808 | "filename": "lib/destination.ts",
|
| 10809 | "line": 36
|
| 10810 | },
|
| 10811 | "name": "DestinationOptions",
|
| 10812 | "properties": [
|
| 10813 | {
|
| 10814 | "abstract": true,
|
| 10815 | "docs": {
|
| 10816 | "stability": "stable",
|
| 10817 | "summary": "The destination type."
|
| 10818 | },
|
| 10819 | "immutable": true,
|
| 10820 | "locationInModule": {
|
| 10821 | "filename": "lib/destination.ts",
|
| 10822 | "line": 40
|
| 10823 | },
|
| 10824 | "name": "type",
|
| 10825 | "type": {
|
| 10826 | "fqn": "@aws-cdk/aws-lambda.DestinationType"
|
| 10827 | }
|
| 10828 | }
|
| 10829 | ],
|
| 10830 | "symbolId": "lib/destination:DestinationOptions"
|
| 10831 | },
|
| 10832 | "@aws-cdk/aws-lambda.DestinationType": {
|
| 10833 | "assembly": "@aws-cdk/aws-lambda",
|
| 10834 | "docs": {
|
| 10835 | "stability": "stable",
|
| 10836 | "summary": "The type of destination."
|
| 10837 | },
|
| 10838 | "fqn": "@aws-cdk/aws-lambda.DestinationType",
|
| 10839 | "kind": "enum",
|
| 10840 | "locationInModule": {
|
| 10841 | "filename": "lib/destination.ts",
|
| 10842 | "line": 21
|
| 10843 | },
|
| 10844 | "members": [
|
| 10845 | {
|
| 10846 | "docs": {
|
| 10847 | "stability": "stable",
|
| 10848 | "summary": "Failure."
|
| 10849 | },
|
| 10850 | "name": "FAILURE"
|
| 10851 | },
|
| 10852 | {
|
| 10853 | "docs": {
|
| 10854 | "stability": "stable",
|
| 10855 | "summary": "Success."
|
| 10856 | },
|
| 10857 | "name": "SUCCESS"
|
| 10858 | }
|
| 10859 | ],
|
| 10860 | "name": "DestinationType",
|
| 10861 | "symbolId": "lib/destination:DestinationType"
|
| 10862 | },
|
| 10863 | "@aws-cdk/aws-lambda.DlqDestinationConfig": {
|
| 10864 | "assembly": "@aws-cdk/aws-lambda",
|
| 10865 | "datatype": true,
|
| 10866 | "docs": {
|
| 10867 | "stability": "stable",
|
| 10868 | "summary": "A destination configuration.",
|
| 10869 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst dlqDestinationConfig: lambda.DlqDestinationConfig = {\n destination: 'destination',\n};",
|
| 10870 | "custom": {
|
| 10871 | "exampleMetadata": "fixture=_generated"
|
| 10872 | }
|
| 10873 | },
|
| 10874 | "fqn": "@aws-cdk/aws-lambda.DlqDestinationConfig",
|
| 10875 | "kind": "interface",
|
| 10876 | "locationInModule": {
|
| 10877 | "filename": "lib/dlq.ts",
|
| 10878 | "line": 7
|
| 10879 | },
|
| 10880 | "name": "DlqDestinationConfig",
|
| 10881 | "properties": [
|
| 10882 | {
|
| 10883 | "abstract": true,
|
| 10884 | "docs": {
|
| 10885 | "stability": "stable",
|
| 10886 | "summary": "The Amazon Resource Name (ARN) of the destination resource."
|
| 10887 | },
|
| 10888 | "immutable": true,
|
| 10889 | "locationInModule": {
|
| 10890 | "filename": "lib/dlq.ts",
|
| 10891 | "line": 11
|
| 10892 | },
|
| 10893 | "name": "destination",
|
| 10894 | "type": {
|
| 10895 | "primitive": "string"
|
| 10896 | }
|
| 10897 | }
|
| 10898 | ],
|
| 10899 | "symbolId": "lib/dlq:DlqDestinationConfig"
|
| 10900 | },
|
| 10901 | "@aws-cdk/aws-lambda.DockerBuildAssetOptions": {
|
| 10902 | "assembly": "@aws-cdk/aws-lambda",
|
| 10903 | "datatype": true,
|
| 10904 | "docs": {
|
| 10905 | "stability": "stable",
|
| 10906 | "summary": "Options when creating an asset from a Docker build.",
|
| 10907 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst dockerBuildAssetOptions: lambda.DockerBuildAssetOptions = {\n buildArgs: {\n buildArgsKey: 'buildArgs',\n },\n file: 'file',\n imagePath: 'imagePath',\n outputPath: 'outputPath',\n platform: 'platform',\n};",
|
| 10908 | "custom": {
|
| 10909 | "exampleMetadata": "fixture=_generated"
|
| 10910 | }
|
| 10911 | },
|
| 10912 | "fqn": "@aws-cdk/aws-lambda.DockerBuildAssetOptions",
|
| 10913 | "interfaces": [
|
| 10914 | "@aws-cdk/core.DockerBuildOptions"
|
| 10915 | ],
|
| 10916 | "kind": "interface",
|
| 10917 | "locationInModule": {
|
| 10918 | "filename": "lib/code.ts",
|
| 10919 | "line": 571
|
| 10920 | },
|
| 10921 | "name": "DockerBuildAssetOptions",
|
| 10922 | "properties": [
|
| 10923 | {
|
| 10924 | "abstract": true,
|
| 10925 | "docs": {
|
| 10926 | "default": "/asset",
|
| 10927 | "stability": "stable",
|
| 10928 | "summary": "The path in the Docker image where the asset is located after the build operation."
|
| 10929 | },
|
| 10930 | "immutable": true,
|
| 10931 | "locationInModule": {
|
| 10932 | "filename": "lib/code.ts",
|
| 10933 | "line": 578
|
| 10934 | },
|
| 10935 | "name": "imagePath",
|
| 10936 | "optional": true,
|
| 10937 | "type": {
|
| 10938 | "primitive": "string"
|
| 10939 | }
|
| 10940 | },
|
| 10941 | {
|
| 10942 | "abstract": true,
|
| 10943 | "docs": {
|
| 10944 | "default": "- a unique temporary directory in the system temp directory",
|
| 10945 | "stability": "stable",
|
| 10946 | "summary": "The path on the local filesystem where the asset will be copied using `docker cp`."
|
| 10947 | },
|
| 10948 | "immutable": true,
|
| 10949 | "locationInModule": {
|
| 10950 | "filename": "lib/code.ts",
|
| 10951 | "line": 586
|
| 10952 | },
|
| 10953 | "name": "outputPath",
|
| 10954 | "optional": true,
|
| 10955 | "type": {
|
| 10956 | "primitive": "string"
|
| 10957 | }
|
| 10958 | }
|
| 10959 | ],
|
| 10960 | "symbolId": "lib/code:DockerBuildAssetOptions"
|
| 10961 | },
|
| 10962 | "@aws-cdk/aws-lambda.DockerImageCode": {
|
| 10963 | "abstract": true,
|
| 10964 | "assembly": "@aws-cdk/aws-lambda",
|
| 10965 | "docs": {
|
| 10966 | "stability": "stable",
|
| 10967 | "summary": "Code property for the DockerImageFunction construct.",
|
| 10968 | "example": "new lambda.DockerImageFunction(this, 'AssetFunction', {\n code: lambda.DockerImageCode.fromImageAsset(path.join(__dirname, 'docker-handler')),\n});",
|
| 10969 | "custom": {
|
| 10970 | "exampleMetadata": "infused"
|
| 10971 | }
|
| 10972 | },
|
| 10973 | "fqn": "@aws-cdk/aws-lambda.DockerImageCode",
|
| 10974 | "initializer": {
|
| 10975 | "docs": {
|
| 10976 | "stability": "stable"
|
| 10977 | }
|
| 10978 | },
|
| 10979 | "kind": "class",
|
| 10980 | "locationInModule": {
|
| 10981 | "filename": "lib/image-function.ts",
|
| 10982 | "line": 23
|
| 10983 | },
|
| 10984 | "methods": [
|
| 10985 | {
|
| 10986 | "docs": {
|
| 10987 | "stability": "stable",
|
| 10988 | "summary": "Use an existing ECR image as the Lambda code."
|
| 10989 | },
|
| 10990 | "locationInModule": {
|
| 10991 | "filename": "lib/image-function.ts",
|
| 10992 | "line": 29
|
| 10993 | },
|
| 10994 | "name": "fromEcr",
|
| 10995 | "parameters": [
|
| 10996 | {
|
| 10997 | "docs": {
|
| 10998 | "summary": "the ECR repository that the image is in."
|
| 10999 | },
|
| 11000 | "name": "repository",
|
| 11001 | "type": {
|
| 11002 | "fqn": "@aws-cdk/aws-ecr.IRepository"
|
| 11003 | }
|
| 11004 | },
|
| 11005 | {
|
| 11006 | "docs": {
|
| 11007 | "summary": "properties to further configure the selected image."
|
| 11008 | },
|
| 11009 | "name": "props",
|
| 11010 | "optional": true,
|
| 11011 | "type": {
|
| 11012 | "fqn": "@aws-cdk/aws-lambda.EcrImageCodeProps"
|
| 11013 | }
|
| 11014 | }
|
| 11015 | ],
|
| 11016 | "returns": {
|
| 11017 | "type": {
|
| 11018 | "fqn": "@aws-cdk/aws-lambda.DockerImageCode"
|
| 11019 | }
|
| 11020 | },
|
| 11021 | "static": true
|
| 11022 | },
|
| 11023 | {
|
| 11024 | "docs": {
|
| 11025 | "stability": "stable",
|
| 11026 | "summary": "Create an ECR image from the specified asset and bind it as the Lambda code."
|
| 11027 | },
|
| 11028 | "locationInModule": {
|
| 11029 | "filename": "lib/image-function.ts",
|
| 11030 | "line": 42
|
| 11031 | },
|
| 11032 | "name": "fromImageAsset",
|
| 11033 | "parameters": [
|
| 11034 | {
|
| 11035 | "docs": {
|
| 11036 | "summary": "the directory from which the asset must be created."
|
| 11037 | },
|
| 11038 | "name": "directory",
|
| 11039 | "type": {
|
| 11040 | "primitive": "string"
|
| 11041 | }
|
| 11042 | },
|
| 11043 | {
|
| 11044 | "docs": {
|
| 11045 | "summary": "properties to further configure the selected image."
|
| 11046 | },
|
| 11047 | "name": "props",
|
| 11048 | "optional": true,
|
| 11049 | "type": {
|
| 11050 | "fqn": "@aws-cdk/aws-lambda.AssetImageCodeProps"
|
| 11051 | }
|
| 11052 | }
|
| 11053 | ],
|
| 11054 | "returns": {
|
| 11055 | "type": {
|
| 11056 | "fqn": "@aws-cdk/aws-lambda.DockerImageCode"
|
| 11057 | }
|
| 11058 | },
|
| 11059 | "static": true
|
| 11060 | }
|
| 11061 | ],
|
| 11062 | "name": "DockerImageCode",
|
| 11063 | "symbolId": "lib/image-function:DockerImageCode"
|
| 11064 | },
|
| 11065 | "@aws-cdk/aws-lambda.DockerImageFunction": {
|
| 11066 | "assembly": "@aws-cdk/aws-lambda",
|
| 11067 | "base": "@aws-cdk/aws-lambda.Function",
|
| 11068 | "docs": {
|
| 11069 | "stability": "stable",
|
| 11070 | "summary": "Create a lambda function where the handler is a docker image.",
|
| 11071 | "example": "new lambda.DockerImageFunction(this, 'AssetFunction', {\n code: lambda.DockerImageCode.fromImageAsset(path.join(__dirname, 'docker-handler')),\n});",
|
| 11072 | "custom": {
|
| 11073 | "exampleMetadata": "infused"
|
| 11074 | }
|
| 11075 | },
|
| 11076 | "fqn": "@aws-cdk/aws-lambda.DockerImageFunction",
|
| 11077 | "initializer": {
|
| 11078 | "docs": {
|
| 11079 | "stability": "stable"
|
| 11080 | },
|
| 11081 | "locationInModule": {
|
| 11082 | "filename": "lib/image-function.ts",
|
| 11083 | "line": 61
|
| 11084 | },
|
| 11085 | "parameters": [
|
| 11086 | {
|
| 11087 | "name": "scope",
|
| 11088 | "type": {
|
| 11089 | "fqn": "constructs.Construct"
|
| 11090 | }
|
| 11091 | },
|
| 11092 | {
|
| 11093 | "name": "id",
|
| 11094 | "type": {
|
| 11095 | "primitive": "string"
|
| 11096 | }
|
| 11097 | },
|
| 11098 | {
|
| 11099 | "name": "props",
|
| 11100 | "type": {
|
| 11101 | "fqn": "@aws-cdk/aws-lambda.DockerImageFunctionProps"
|
| 11102 | }
|
| 11103 | }
|
| 11104 | ]
|
| 11105 | },
|
| 11106 | "kind": "class",
|
| 11107 | "locationInModule": {
|
| 11108 | "filename": "lib/image-function.ts",
|
| 11109 | "line": 60
|
| 11110 | },
|
| 11111 | "name": "DockerImageFunction",
|
| 11112 | "symbolId": "lib/image-function:DockerImageFunction"
|
| 11113 | },
|
| 11114 | "@aws-cdk/aws-lambda.DockerImageFunctionProps": {
|
| 11115 | "assembly": "@aws-cdk/aws-lambda",
|
| 11116 | "datatype": true,
|
| 11117 | "docs": {
|
| 11118 | "stability": "stable",
|
| 11119 | "summary": "Properties to configure a new DockerImageFunction construct.",
|
| 11120 | "example": "new lambda.DockerImageFunction(this, 'AssetFunction', {\n code: lambda.DockerImageCode.fromImageAsset(path.join(__dirname, 'docker-handler')),\n});",
|
| 11121 | "custom": {
|
| 11122 | "exampleMetadata": "infused"
|
| 11123 | }
|
| 11124 | },
|
| 11125 | "fqn": "@aws-cdk/aws-lambda.DockerImageFunctionProps",
|
| 11126 | "interfaces": [
|
| 11127 | "@aws-cdk/aws-lambda.FunctionOptions"
|
| 11128 | ],
|
| 11129 | "kind": "interface",
|
| 11130 | "locationInModule": {
|
| 11131 | "filename": "lib/image-function.ts",
|
| 11132 | "line": 11
|
| 11133 | },
|
| 11134 | "name": "DockerImageFunctionProps",
|
| 11135 | "properties": [
|
| 11136 | {
|
| 11137 | "abstract": true,
|
| 11138 | "docs": {
|
| 11139 | "remarks": "You can point to a file in an\nAmazon Simple Storage Service (Amazon S3) bucket or specify your source\ncode as inline text.",
|
| 11140 | "stability": "stable",
|
| 11141 | "summary": "The source code of your Lambda function."
|
| 11142 | },
|
| 11143 | "immutable": true,
|
| 11144 | "locationInModule": {
|
| 11145 | "filename": "lib/image-function.ts",
|
| 11146 | "line": 17
|
| 11147 | },
|
| 11148 | "name": "code",
|
| 11149 | "type": {
|
| 11150 | "fqn": "@aws-cdk/aws-lambda.DockerImageCode"
|
| 11151 | }
|
| 11152 | }
|
| 11153 | ],
|
| 11154 | "symbolId": "lib/image-function:DockerImageFunctionProps"
|
| 11155 | },
|
| 11156 | "@aws-cdk/aws-lambda.EcrImageCode": {
|
| 11157 | "assembly": "@aws-cdk/aws-lambda",
|
| 11158 | "base": "@aws-cdk/aws-lambda.Code",
|
| 11159 | "docs": {
|
| 11160 | "stability": "stable",
|
| 11161 | "summary": "Represents a Docker image in ECR that can be bound as Lambda Code.",
|
| 11162 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ecr from '@aws-cdk/aws-ecr';\nimport * as lambda from '@aws-cdk/aws-lambda';\n\ndeclare const repository: ecr.Repository;\nconst ecrImageCode = new lambda.EcrImageCode(repository, /* all optional props */ {\n cmd: ['cmd'],\n entrypoint: ['entrypoint'],\n tag: 'tag',\n tagOrDigest: 'tagOrDigest',\n workingDirectory: 'workingDirectory',\n});",
|
| 11163 | "custom": {
|
| 11164 | "exampleMetadata": "fixture=_generated"
|
| 11165 | }
|
| 11166 | },
|
| 11167 | "fqn": "@aws-cdk/aws-lambda.EcrImageCode",
|
| 11168 | "initializer": {
|
| 11169 | "docs": {
|
| 11170 | "stability": "stable"
|
| 11171 | },
|
| 11172 | "locationInModule": {
|
| 11173 | "filename": "lib/code.ts",
|
| 11174 | "line": 474
|
| 11175 | },
|
| 11176 | "parameters": [
|
| 11177 | {
|
| 11178 | "name": "repository",
|
| 11179 | "type": {
|
| 11180 | "fqn": "@aws-cdk/aws-ecr.IRepository"
|
| 11181 | }
|
| 11182 | },
|
| 11183 | {
|
| 11184 | "name": "props",
|
| 11185 | "optional": true,
|
| 11186 | "type": {
|
| 11187 | "fqn": "@aws-cdk/aws-lambda.EcrImageCodeProps"
|
| 11188 | }
|
| 11189 | }
|
| 11190 | ]
|
| 11191 | },
|
| 11192 | "kind": "class",
|
| 11193 | "locationInModule": {
|
| 11194 | "filename": "lib/code.ts",
|
| 11195 | "line": 471
|
| 11196 | },
|
| 11197 | "methods": [
|
| 11198 | {
|
| 11199 | "docs": {
|
| 11200 | "stability": "stable",
|
| 11201 | "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun."
|
| 11202 | },
|
| 11203 | "locationInModule": {
|
| 11204 | "filename": "lib/code.ts",
|
| 11205 | "line": 478
|
| 11206 | },
|
| 11207 | "name": "bind",
|
| 11208 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 11209 | "parameters": [
|
| 11210 | {
|
| 11211 | "name": "_",
|
| 11212 | "type": {
|
| 11213 | "fqn": "@aws-cdk/core.Construct"
|
| 11214 | }
|
| 11215 | }
|
| 11216 | ],
|
| 11217 | "returns": {
|
| 11218 | "type": {
|
| 11219 | "fqn": "@aws-cdk/aws-lambda.CodeConfig"
|
| 11220 | }
|
| 11221 | }
|
| 11222 | }
|
| 11223 | ],
|
| 11224 | "name": "EcrImageCode",
|
| 11225 | "properties": [
|
| 11226 | {
|
| 11227 | "docs": {
|
| 11228 | "stability": "stable",
|
| 11229 | "summary": "Determines whether this Code is inline code or not."
|
| 11230 | },
|
| 11231 | "immutable": true,
|
| 11232 | "locationInModule": {
|
| 11233 | "filename": "lib/code.ts",
|
| 11234 | "line": 472
|
| 11235 | },
|
| 11236 | "name": "isInline",
|
| 11237 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 11238 | "type": {
|
| 11239 | "primitive": "boolean"
|
| 11240 | }
|
| 11241 | }
|
| 11242 | ],
|
| 11243 | "symbolId": "lib/code:EcrImageCode"
|
| 11244 | },
|
| 11245 | "@aws-cdk/aws-lambda.EcrImageCodeProps": {
|
| 11246 | "assembly": "@aws-cdk/aws-lambda",
|
| 11247 | "datatype": true,
|
| 11248 | "docs": {
|
| 11249 | "stability": "stable",
|
| 11250 | "summary": "Properties to initialize a new EcrImageCode.",
|
| 11251 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst ecrImageCodeProps: lambda.EcrImageCodeProps = {\n cmd: ['cmd'],\n entrypoint: ['entrypoint'],\n tag: 'tag',\n tagOrDigest: 'tagOrDigest',\n workingDirectory: 'workingDirectory',\n};",
|
| 11252 | "custom": {
|
| 11253 | "exampleMetadata": "fixture=_generated"
|
| 11254 | }
|
| 11255 | },
|
| 11256 | "fqn": "@aws-cdk/aws-lambda.EcrImageCodeProps",
|
| 11257 | "kind": "interface",
|
| 11258 | "locationInModule": {
|
| 11259 | "filename": "lib/code.ts",
|
| 11260 | "line": 428
|
| 11261 | },
|
| 11262 | "name": "EcrImageCodeProps",
|
| 11263 | "properties": [
|
| 11264 | {
|
| 11265 | "abstract": true,
|
| 11266 | "docs": {
|
| 11267 | "default": "- use the CMD specified in the docker image or Dockerfile.",
|
| 11268 | "remarks": "This needs to be in the 'exec form', viz., `[ 'executable', 'param1', 'param2' ]`.",
|
| 11269 | "see": "https://docs.docker.com/engine/reference/builder/#cmd",
|
| 11270 | "stability": "stable",
|
| 11271 | "summary": "Specify or override the CMD on the specified Docker image or Dockerfile."
|
| 11272 | },
|
| 11273 | "immutable": true,
|
| 11274 | "locationInModule": {
|
| 11275 | "filename": "lib/code.ts",
|
| 11276 | "line": 435
|
| 11277 | },
|
| 11278 | "name": "cmd",
|
| 11279 | "optional": true,
|
| 11280 | "type": {
|
| 11281 | "collection": {
|
| 11282 | "elementtype": {
|
| 11283 | "primitive": "string"
|
| 11284 | },
|
| 11285 | "kind": "array"
|
| 11286 | }
|
| 11287 | }
|
| 11288 | },
|
| 11289 | {
|
| 11290 | "abstract": true,
|
| 11291 | "docs": {
|
| 11292 | "default": "- use the ENTRYPOINT in the docker image or Dockerfile.",
|
| 11293 | "remarks": "An ENTRYPOINT allows you to configure a container that will run as an executable.\nThis needs to be in the 'exec form', viz., `[ 'executable', 'param1', 'param2' ]`.",
|
| 11294 | "see": "https://docs.docker.com/engine/reference/builder/#entrypoint",
|
| 11295 | "stability": "stable",
|
| 11296 | "summary": "Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile."
|
| 11297 | },
|
| 11298 | "immutable": true,
|
| 11299 | "locationInModule": {
|
| 11300 | "filename": "lib/code.ts",
|
| 11301 | "line": 444
|
| 11302 | },
|
| 11303 | "name": "entrypoint",
|
| 11304 | "optional": true,
|
| 11305 | "type": {
|
| 11306 | "collection": {
|
| 11307 | "elementtype": {
|
| 11308 | "primitive": "string"
|
| 11309 | },
|
| 11310 | "kind": "array"
|
| 11311 | }
|
| 11312 | }
|
| 11313 | },
|
| 11314 | {
|
| 11315 | "abstract": true,
|
| 11316 | "docs": {
|
| 11317 | "default": "'latest'",
|
| 11318 | "deprecated": "use `tagOrDigest`",
|
| 11319 | "stability": "deprecated",
|
| 11320 | "summary": "The image tag to use when pulling the image from ECR."
|
| 11321 | },
|
| 11322 | "immutable": true,
|
| 11323 | "locationInModule": {
|
| 11324 | "filename": "lib/code.ts",
|
| 11325 | "line": 459
|
| 11326 | },
|
| 11327 | "name": "tag",
|
| 11328 | "optional": true,
|
| 11329 | "type": {
|
| 11330 | "primitive": "string"
|
| 11331 | }
|
| 11332 | },
|
| 11333 | {
|
| 11334 | "abstract": true,
|
| 11335 | "docs": {
|
| 11336 | "default": "'latest'",
|
| 11337 | "stability": "stable",
|
| 11338 | "summary": "The image tag or digest to use when pulling the image from ECR (digests must start with `sha256:`)."
|
| 11339 | },
|
| 11340 | "immutable": true,
|
| 11341 | "locationInModule": {
|
| 11342 | "filename": "lib/code.ts",
|
| 11343 | "line": 465
|
| 11344 | },
|
| 11345 | "name": "tagOrDigest",
|
| 11346 | "optional": true,
|
| 11347 | "type": {
|
| 11348 | "primitive": "string"
|
| 11349 | }
|
| 11350 | },
|
| 11351 | {
|
| 11352 | "abstract": true,
|
| 11353 | "docs": {
|
| 11354 | "default": "- use the WORKDIR in the docker image or Dockerfile.",
|
| 11355 | "remarks": "A WORKDIR allows you to configure the working directory the container will use.",
|
| 11356 | "see": "https://docs.docker.com/engine/reference/builder/#workdir",
|
| 11357 | "stability": "stable",
|
| 11358 | "summary": "Specify or override the WORKDIR on the specified Docker image or Dockerfile."
|
| 11359 | },
|
| 11360 | "immutable": true,
|
| 11361 | "locationInModule": {
|
| 11362 | "filename": "lib/code.ts",
|
| 11363 | "line": 452
|
| 11364 | },
|
| 11365 | "name": "workingDirectory",
|
| 11366 | "optional": true,
|
| 11367 | "type": {
|
| 11368 | "primitive": "string"
|
| 11369 | }
|
| 11370 | }
|
| 11371 | ],
|
| 11372 | "symbolId": "lib/code:EcrImageCodeProps"
|
| 11373 | },
|
| 11374 | "@aws-cdk/aws-lambda.EnvironmentOptions": {
|
| 11375 | "assembly": "@aws-cdk/aws-lambda",
|
| 11376 | "datatype": true,
|
| 11377 | "docs": {
|
| 11378 | "stability": "stable",
|
| 11379 | "summary": "Environment variables options.",
|
| 11380 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst environmentOptions: lambda.EnvironmentOptions = {\n removeInEdge: false,\n};",
|
| 11381 | "custom": {
|
| 11382 | "exampleMetadata": "fixture=_generated"
|
| 11383 | }
|
| 11384 | },
|
| 11385 | "fqn": "@aws-cdk/aws-lambda.EnvironmentOptions",
|
| 11386 | "kind": "interface",
|
| 11387 | "locationInModule": {
|
| 11388 | "filename": "lib/function.ts",
|
| 11389 | "line": 1223
|
| 11390 | },
|
| 11391 | "name": "EnvironmentOptions",
|
| 11392 | "properties": [
|
| 11393 | {
|
| 11394 | "abstract": true,
|
| 11395 | "docs": {
|
| 11396 | "custom": {
|
| 11397 | "Edge": "will throw"
|
| 11398 | },
|
| 11399 | "default": "false - using the function in Lambda",
|
| 11400 | "remarks": "If not set, an error will be thrown.",
|
| 11401 | "see": "https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-requirements-limits.html#lambda-requirements-lambda-function-configuration",
|
| 11402 | "stability": "stable",
|
| 11403 | "summary": "When used in Lambda@Edge via edgeArn() API, these environment variables will be removed."
|
| 11404 | },
|
| 11405 | "immutable": true,
|
| 11406 | "locationInModule": {
|
| 11407 | "filename": "lib/function.ts",
|
| 11408 | "line": 1231
|
| 11409 | },
|
| 11410 | "name": "removeInEdge",
|
| 11411 | "optional": true,
|
| 11412 | "type": {
|
| 11413 | "primitive": "boolean"
|
| 11414 | }
|
| 11415 | }
|
| 11416 | ],
|
| 11417 | "symbolId": "lib/function:EnvironmentOptions"
|
| 11418 | },
|
| 11419 | "@aws-cdk/aws-lambda.EventInvokeConfig": {
|
| 11420 | "assembly": "@aws-cdk/aws-lambda",
|
| 11421 | "base": "@aws-cdk/core.Resource",
|
| 11422 | "docs": {
|
| 11423 | "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.",
|
| 11424 | "stability": "stable",
|
| 11425 | "summary": "Configure options for asynchronous invocation on a version or an alias.",
|
| 11426 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const destination: lambda.IDestination;\ndeclare const function_: lambda.Function;\nconst eventInvokeConfig = new lambda.EventInvokeConfig(this, 'MyEventInvokeConfig', {\n function: function_,\n\n // the properties below are optional\n maxEventAge: cdk.Duration.minutes(30),\n onFailure: destination,\n onSuccess: destination,\n qualifier: 'qualifier',\n retryAttempts: 123,\n});",
|
| 11427 | "custom": {
|
| 11428 | "exampleMetadata": "fixture=_generated"
|
| 11429 | }
|
| 11430 | },
|
| 11431 | "fqn": "@aws-cdk/aws-lambda.EventInvokeConfig",
|
| 11432 | "initializer": {
|
| 11433 | "docs": {
|
| 11434 | "stability": "stable"
|
| 11435 | },
|
| 11436 | "locationInModule": {
|
| 11437 | "filename": "lib/event-invoke-config.ts",
|
| 11438 | "line": 73
|
| 11439 | },
|
| 11440 | "parameters": [
|
| 11441 | {
|
| 11442 | "name": "scope",
|
| 11443 | "type": {
|
| 11444 | "fqn": "constructs.Construct"
|
| 11445 | }
|
| 11446 | },
|
| 11447 | {
|
| 11448 | "name": "id",
|
| 11449 | "type": {
|
| 11450 | "primitive": "string"
|
| 11451 | }
|
| 11452 | },
|
| 11453 | {
|
| 11454 | "name": "props",
|
| 11455 | "type": {
|
| 11456 | "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigProps"
|
| 11457 | }
|
| 11458 | }
|
| 11459 | ]
|
| 11460 | },
|
| 11461 | "kind": "class",
|
| 11462 | "locationInModule": {
|
| 11463 | "filename": "lib/event-invoke-config.ts",
|
| 11464 | "line": 72
|
| 11465 | },
|
| 11466 | "name": "EventInvokeConfig",
|
| 11467 | "symbolId": "lib/event-invoke-config:EventInvokeConfig"
|
| 11468 | },
|
| 11469 | "@aws-cdk/aws-lambda.EventInvokeConfigOptions": {
|
| 11470 | "assembly": "@aws-cdk/aws-lambda",
|
| 11471 | "datatype": true,
|
| 11472 | "docs": {
|
| 11473 | "stability": "stable",
|
| 11474 | "summary": "Options to add an EventInvokeConfig to a function.",
|
| 11475 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const destination: lambda.IDestination;\nconst eventInvokeConfigOptions: lambda.EventInvokeConfigOptions = {\n maxEventAge: cdk.Duration.minutes(30),\n onFailure: destination,\n onSuccess: destination,\n retryAttempts: 123,\n};",
|
| 11476 | "custom": {
|
| 11477 | "exampleMetadata": "fixture=_generated"
|
| 11478 | }
|
| 11479 | },
|
| 11480 | "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions",
|
| 11481 | "kind": "interface",
|
| 11482 | "locationInModule": {
|
| 11483 | "filename": "lib/event-invoke-config.ts",
|
| 11484 | "line": 10
|
| 11485 | },
|
| 11486 | "name": "EventInvokeConfigOptions",
|
| 11487 | "properties": [
|
| 11488 | {
|
| 11489 | "abstract": true,
|
| 11490 | "docs": {
|
| 11491 | "default": "Duration.hours(6)",
|
| 11492 | "remarks": "Minimum: 60 seconds\nMaximum: 6 hours",
|
| 11493 | "stability": "stable",
|
| 11494 | "summary": "The maximum age of a request that Lambda sends to a function for processing."
|
| 11495 | },
|
| 11496 | "immutable": true,
|
| 11497 | "locationInModule": {
|
| 11498 | "filename": "lib/event-invoke-config.ts",
|
| 11499 | "line": 34
|
| 11500 | },
|
| 11501 | "name": "maxEventAge",
|
| 11502 | "optional": true,
|
| 11503 | "type": {
|
| 11504 | "fqn": "@aws-cdk/core.Duration"
|
| 11505 | }
|
| 11506 | },
|
| 11507 | {
|
| 11508 | "abstract": true,
|
| 11509 | "docs": {
|
| 11510 | "default": "- no destination",
|
| 11511 | "stability": "stable",
|
| 11512 | "summary": "The destination for failed invocations."
|
| 11513 | },
|
| 11514 | "immutable": true,
|
| 11515 | "locationInModule": {
|
| 11516 | "filename": "lib/event-invoke-config.ts",
|
| 11517 | "line": 16
|
| 11518 | },
|
| 11519 | "name": "onFailure",
|
| 11520 | "optional": true,
|
| 11521 | "type": {
|
| 11522 | "fqn": "@aws-cdk/aws-lambda.IDestination"
|
| 11523 | }
|
| 11524 | },
|
| 11525 | {
|
| 11526 | "abstract": true,
|
| 11527 | "docs": {
|
| 11528 | "default": "- no destination",
|
| 11529 | "stability": "stable",
|
| 11530 | "summary": "The destination for successful invocations."
|
| 11531 | },
|
| 11532 | "immutable": true,
|
| 11533 | "locationInModule": {
|
| 11534 | "filename": "lib/event-invoke-config.ts",
|
| 11535 | "line": 23
|
| 11536 | },
|
| 11537 | "name": "onSuccess",
|
| 11538 | "optional": true,
|
| 11539 | "type": {
|
| 11540 | "fqn": "@aws-cdk/aws-lambda.IDestination"
|
| 11541 | }
|
| 11542 | },
|
| 11543 | {
|
| 11544 | "abstract": true,
|
| 11545 | "docs": {
|
| 11546 | "default": "2",
|
| 11547 | "remarks": "Minimum: 0\nMaximum: 2",
|
| 11548 | "stability": "stable",
|
| 11549 | "summary": "The maximum number of times to retry when the function returns an error."
|
| 11550 | },
|
| 11551 | "immutable": true,
|
| 11552 | "locationInModule": {
|
| 11553 | "filename": "lib/event-invoke-config.ts",
|
| 11554 | "line": 44
|
| 11555 | },
|
| 11556 | "name": "retryAttempts",
|
| 11557 | "optional": true,
|
| 11558 | "type": {
|
| 11559 | "primitive": "number"
|
| 11560 | }
|
| 11561 | }
|
| 11562 | ],
|
| 11563 | "symbolId": "lib/event-invoke-config:EventInvokeConfigOptions"
|
| 11564 | },
|
| 11565 | "@aws-cdk/aws-lambda.EventInvokeConfigProps": {
|
| 11566 | "assembly": "@aws-cdk/aws-lambda",
|
| 11567 | "datatype": true,
|
| 11568 | "docs": {
|
| 11569 | "stability": "stable",
|
| 11570 | "summary": "Properties for an EventInvokeConfig.",
|
| 11571 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const destination: lambda.IDestination;\ndeclare const function_: lambda.Function;\nconst eventInvokeConfigProps: lambda.EventInvokeConfigProps = {\n function: function_,\n\n // the properties below are optional\n maxEventAge: cdk.Duration.minutes(30),\n onFailure: destination,\n onSuccess: destination,\n qualifier: 'qualifier',\n retryAttempts: 123,\n};",
|
| 11572 | "custom": {
|
| 11573 | "exampleMetadata": "fixture=_generated"
|
| 11574 | }
|
| 11575 | },
|
| 11576 | "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigProps",
|
| 11577 | "interfaces": [
|
| 11578 | "@aws-cdk/aws-lambda.EventInvokeConfigOptions"
|
| 11579 | ],
|
| 11580 | "kind": "interface",
|
| 11581 | "locationInModule": {
|
| 11582 | "filename": "lib/event-invoke-config.ts",
|
| 11583 | "line": 50
|
| 11584 | },
|
| 11585 | "name": "EventInvokeConfigProps",
|
| 11586 | "properties": [
|
| 11587 | {
|
| 11588 | "abstract": true,
|
| 11589 | "docs": {
|
| 11590 | "stability": "stable",
|
| 11591 | "summary": "The Lambda function."
|
| 11592 | },
|
| 11593 | "immutable": true,
|
| 11594 | "locationInModule": {
|
| 11595 | "filename": "lib/event-invoke-config.ts",
|
| 11596 | "line": 54
|
| 11597 | },
|
| 11598 | "name": "function",
|
| 11599 | "type": {
|
| 11600 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 11601 | }
|
| 11602 | },
|
| 11603 | {
|
| 11604 | "abstract": true,
|
| 11605 | "docs": {
|
| 11606 | "default": "- latest version",
|
| 11607 | "stability": "stable",
|
| 11608 | "summary": "The qualifier."
|
| 11609 | },
|
| 11610 | "immutable": true,
|
| 11611 | "locationInModule": {
|
| 11612 | "filename": "lib/event-invoke-config.ts",
|
| 11613 | "line": 61
|
| 11614 | },
|
| 11615 | "name": "qualifier",
|
| 11616 | "optional": true,
|
| 11617 | "type": {
|
| 11618 | "primitive": "string"
|
| 11619 | }
|
| 11620 | }
|
| 11621 | ],
|
| 11622 | "symbolId": "lib/event-invoke-config:EventInvokeConfigProps"
|
| 11623 | },
|
| 11624 | "@aws-cdk/aws-lambda.EventSourceMapping": {
|
| 11625 | "assembly": "@aws-cdk/aws-lambda",
|
| 11626 | "base": "@aws-cdk/core.Resource",
|
| 11627 | "docs": {
|
| 11628 | "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.",
|
| 11629 | "stability": "stable",
|
| 11630 | "summary": "Defines a Lambda EventSourceMapping resource.",
|
| 11631 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const eventSourceDlq: lambda.IEventSourceDlq;\ndeclare const function_: lambda.Function;\ndeclare const sourceAccessConfigurationType: lambda.SourceAccessConfigurationType;\nconst eventSourceMapping = new lambda.EventSourceMapping(this, 'MyEventSourceMapping', {\n target: function_,\n\n // the properties below are optional\n batchSize: 123,\n bisectBatchOnError: false,\n enabled: false,\n eventSourceArn: 'eventSourceArn',\n kafkaBootstrapServers: ['kafkaBootstrapServers'],\n kafkaTopic: 'kafkaTopic',\n maxBatchingWindow: cdk.Duration.minutes(30),\n maxRecordAge: cdk.Duration.minutes(30),\n onFailure: eventSourceDlq,\n parallelizationFactor: 123,\n reportBatchItemFailures: false,\n retryAttempts: 123,\n sourceAccessConfigurations: [{\n type: sourceAccessConfigurationType,\n uri: 'uri',\n }],\n startingPosition: lambda.StartingPosition.TRIM_HORIZON,\n tumblingWindow: cdk.Duration.minutes(30),\n});",
|
| 11632 | "custom": {
|
| 11633 | "exampleMetadata": "fixture=_generated"
|
| 11634 | }
|
| 11635 | },
|
| 11636 | "fqn": "@aws-cdk/aws-lambda.EventSourceMapping",
|
| 11637 | "initializer": {
|
| 11638 | "docs": {
|
| 11639 | "stability": "stable"
|
| 11640 | },
|
| 11641 | "locationInModule": {
|
| 11642 | "filename": "lib/event-source-mapping.ts",
|
| 11643 | "line": 263
|
| 11644 | },
|
| 11645 | "parameters": [
|
| 11646 | {
|
| 11647 | "name": "scope",
|
| 11648 | "type": {
|
| 11649 | "fqn": "constructs.Construct"
|
| 11650 | }
|
| 11651 | },
|
| 11652 | {
|
| 11653 | "name": "id",
|
| 11654 | "type": {
|
| 11655 | "primitive": "string"
|
| 11656 | }
|
| 11657 | },
|
| 11658 | {
|
| 11659 | "name": "props",
|
| 11660 | "type": {
|
| 11661 | "fqn": "@aws-cdk/aws-lambda.EventSourceMappingProps"
|
| 11662 | }
|
| 11663 | }
|
| 11664 | ]
|
| 11665 | },
|
| 11666 | "interfaces": [
|
| 11667 | "@aws-cdk/aws-lambda.IEventSourceMapping"
|
| 11668 | ],
|
| 11669 | "kind": "class",
|
| 11670 | "locationInModule": {
|
| 11671 | "filename": "lib/event-source-mapping.ts",
|
| 11672 | "line": 249
|
| 11673 | },
|
| 11674 | "methods": [
|
| 11675 | {
|
| 11676 | "docs": {
|
| 11677 | "stability": "stable",
|
| 11678 | "summary": "Import an event source into this stack from its event source id."
|
| 11679 | },
|
| 11680 | "locationInModule": {
|
| 11681 | "filename": "lib/event-source-mapping.ts",
|
| 11682 | "line": 254
|
| 11683 | },
|
| 11684 | "name": "fromEventSourceMappingId",
|
| 11685 | "parameters": [
|
| 11686 | {
|
| 11687 | "name": "scope",
|
| 11688 | "type": {
|
| 11689 | "fqn": "constructs.Construct"
|
| 11690 | }
|
| 11691 | },
|
| 11692 | {
|
| 11693 | "name": "id",
|
| 11694 | "type": {
|
| 11695 | "primitive": "string"
|
| 11696 | }
|
| 11697 | },
|
| 11698 | {
|
| 11699 | "name": "eventSourceMappingId",
|
| 11700 | "type": {
|
| 11701 | "primitive": "string"
|
| 11702 | }
|
| 11703 | }
|
| 11704 | ],
|
| 11705 | "returns": {
|
| 11706 | "type": {
|
| 11707 | "fqn": "@aws-cdk/aws-lambda.IEventSourceMapping"
|
| 11708 | }
|
| 11709 | },
|
| 11710 | "static": true
|
| 11711 | }
|
| 11712 | ],
|
| 11713 | "name": "EventSourceMapping",
|
| 11714 | "properties": [
|
| 11715 | {
|
| 11716 | "docs": {
|
| 11717 | "stability": "stable",
|
| 11718 | "summary": "The identifier for this EventSourceMapping."
|
| 11719 | },
|
| 11720 | "immutable": true,
|
| 11721 | "locationInModule": {
|
| 11722 | "filename": "lib/event-source-mapping.ts",
|
| 11723 | "line": 261
|
| 11724 | },
|
| 11725 | "name": "eventSourceMappingId",
|
| 11726 | "overrides": "@aws-cdk/aws-lambda.IEventSourceMapping",
|
| 11727 | "type": {
|
| 11728 | "primitive": "string"
|
| 11729 | }
|
| 11730 | }
|
| 11731 | ],
|
| 11732 | "symbolId": "lib/event-source-mapping:EventSourceMapping"
|
| 11733 | },
|
| 11734 | "@aws-cdk/aws-lambda.EventSourceMappingOptions": {
|
| 11735 | "assembly": "@aws-cdk/aws-lambda",
|
| 11736 | "datatype": true,
|
| 11737 | "docs": {
|
| 11738 | "stability": "stable",
|
| 11739 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const eventSourceDlq: lambda.IEventSourceDlq;\ndeclare const sourceAccessConfigurationType: lambda.SourceAccessConfigurationType;\nconst eventSourceMappingOptions: lambda.EventSourceMappingOptions = {\n batchSize: 123,\n bisectBatchOnError: false,\n enabled: false,\n eventSourceArn: 'eventSourceArn',\n kafkaBootstrapServers: ['kafkaBootstrapServers'],\n kafkaTopic: 'kafkaTopic',\n maxBatchingWindow: cdk.Duration.minutes(30),\n maxRecordAge: cdk.Duration.minutes(30),\n onFailure: eventSourceDlq,\n parallelizationFactor: 123,\n reportBatchItemFailures: false,\n retryAttempts: 123,\n sourceAccessConfigurations: [{\n type: sourceAccessConfigurationType,\n uri: 'uri',\n }],\n startingPosition: lambda.StartingPosition.TRIM_HORIZON,\n tumblingWindow: cdk.Duration.minutes(30),\n};",
|
| 11740 | "custom": {
|
| 11741 | "exampleMetadata": "fixture=_generated"
|
| 11742 | }
|
| 11743 | },
|
| 11744 | "fqn": "@aws-cdk/aws-lambda.EventSourceMappingOptions",
|
| 11745 | "kind": "interface",
|
| 11746 | "locationInModule": {
|
| 11747 | "filename": "lib/event-source-mapping.ts",
|
| 11748 | "line": 77
|
| 11749 | },
|
| 11750 | "name": "EventSourceMappingOptions",
|
| 11751 | "properties": [
|
| 11752 | {
|
| 11753 | "abstract": true,
|
| 11754 | "docs": {
|
| 11755 | "default": "- Amazon Kinesis, Amazon DynamoDB, and Amazon MSK is 100 records.\nThe default for Amazon SQS is 10 messages. For standard SQS queues, the maximum is 10,000. For FIFO SQS queues, the maximum is 10.",
|
| 11756 | "remarks": "Your function receives an\nevent with all the retrieved records.\n\nValid Range: Minimum value of 1. Maximum value of 10000.",
|
| 11757 | "stability": "stable",
|
| 11758 | "summary": "The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function."
|
| 11759 | },
|
| 11760 | "immutable": true,
|
| 11761 | "locationInModule": {
|
| 11762 | "filename": "lib/event-source-mapping.ts",
|
| 11763 | "line": 96
|
| 11764 | },
|
| 11765 | "name": "batchSize",
|
| 11766 | "optional": true,
|
| 11767 | "type": {
|
| 11768 | "primitive": "number"
|
| 11769 | }
|
| 11770 | },
|
| 11771 | {
|
| 11772 | "abstract": true,
|
| 11773 | "docs": {
|
| 11774 | "default": "false",
|
| 11775 | "stability": "stable",
|
| 11776 | "summary": "If the function returns an error, split the batch in two and retry."
|
| 11777 | },
|
| 11778 | "immutable": true,
|
| 11779 | "locationInModule": {
|
| 11780 | "filename": "lib/event-source-mapping.ts",
|
| 11781 | "line": 103
|
| 11782 | },
|
| 11783 | "name": "bisectBatchOnError",
|
| 11784 | "optional": true,
|
| 11785 | "type": {
|
| 11786 | "primitive": "boolean"
|
| 11787 | }
|
| 11788 | },
|
| 11789 | {
|
| 11790 | "abstract": true,
|
| 11791 | "docs": {
|
| 11792 | "default": "true",
|
| 11793 | "stability": "stable",
|
| 11794 | "summary": "Set to false to disable the event source upon creation."
|
| 11795 | },
|
| 11796 | "immutable": true,
|
| 11797 | "locationInModule": {
|
| 11798 | "filename": "lib/event-source-mapping.ts",
|
| 11799 | "line": 117
|
| 11800 | },
|
| 11801 | "name": "enabled",
|
| 11802 | "optional": true,
|
| 11803 | "type": {
|
| 11804 | "primitive": "boolean"
|
| 11805 | }
|
| 11806 | },
|
| 11807 | {
|
| 11808 | "abstract": true,
|
| 11809 | "docs": {
|
| 11810 | "default": "- not set if using a self managed Kafka cluster, throws an error otherwise",
|
| 11811 | "remarks": "Any record added to\nthis stream can invoke the Lambda function.",
|
| 11812 | "stability": "stable",
|
| 11813 | "summary": "The Amazon Resource Name (ARN) of the event source."
|
| 11814 | },
|
| 11815 | "immutable": true,
|
| 11816 | "locationInModule": {
|
| 11817 | "filename": "lib/event-source-mapping.ts",
|
| 11818 | "line": 84
|
| 11819 | },
|
| 11820 | "name": "eventSourceArn",
|
| 11821 | "optional": true,
|
| 11822 | "type": {
|
| 11823 | "primitive": "string"
|
| 11824 | }
|
| 11825 | },
|
| 11826 | {
|
| 11827 | "abstract": true,
|
| 11828 | "docs": {
|
| 11829 | "default": "- none",
|
| 11830 | "remarks": "They are in the format `abc.example.com:9096`.",
|
| 11831 | "stability": "stable",
|
| 11832 | "summary": "A list of host and port pairs that are the addresses of the Kafka brokers in a self managed \"bootstrap\" Kafka cluster that a Kafka client connects to initially to bootstrap itself."
|
| 11833 | },
|
| 11834 | "immutable": true,
|
| 11835 | "locationInModule": {
|
| 11836 | "filename": "lib/event-source-mapping.ts",
|
| 11837 | "line": 204
|
| 11838 | },
|
| 11839 | "name": "kafkaBootstrapServers",
|
| 11840 | "optional": true,
|
| 11841 | "type": {
|
| 11842 | "collection": {
|
| 11843 | "elementtype": {
|
| 11844 | "primitive": "string"
|
| 11845 | },
|
| 11846 | "kind": "array"
|
| 11847 | }
|
| 11848 | }
|
| 11849 | },
|
| 11850 | {
|
| 11851 | "abstract": true,
|
| 11852 | "docs": {
|
| 11853 | "default": "- no topic",
|
| 11854 | "stability": "stable",
|
| 11855 | "summary": "The name of the Kafka topic."
|
| 11856 | },
|
| 11857 | "immutable": true,
|
| 11858 | "locationInModule": {
|
| 11859 | "filename": "lib/event-source-mapping.ts",
|
| 11860 | "line": 184
|
| 11861 | },
|
| 11862 | "name": "kafkaTopic",
|
| 11863 | "optional": true,
|
| 11864 | "type": {
|
| 11865 | "primitive": "string"
|
| 11866 | }
|
| 11867 | },
|
| 11868 | {
|
| 11869 | "abstract": true,
|
| 11870 | "docs": {
|
| 11871 | "default": "Duration.seconds(0)",
|
| 11872 | "remarks": "Maximum of Duration.minutes(5)",
|
| 11873 | "stability": "stable",
|
| 11874 | "summary": "The maximum amount of time to gather records before invoking the function."
|
| 11875 | },
|
| 11876 | "immutable": true,
|
| 11877 | "locationInModule": {
|
| 11878 | "filename": "lib/event-source-mapping.ts",
|
| 11879 | "line": 144
|
| 11880 | },
|
| 11881 | "name": "maxBatchingWindow",
|
| 11882 | "optional": true,
|
| 11883 | "type": {
|
| 11884 | "fqn": "@aws-cdk/core.Duration"
|
| 11885 | }
|
| 11886 | },
|
| 11887 | {
|
| 11888 | "abstract": true,
|
| 11889 | "docs": {
|
| 11890 | "default": "- infinite or until the record expires.",
|
| 11891 | "remarks": "Valid Range:\n* Minimum value of 60 seconds\n* Maximum value of 7 days",
|
| 11892 | "stability": "stable",
|
| 11893 | "summary": "The maximum age of a record that Lambda sends to a function for processing."
|
| 11894 | },
|
| 11895 | "immutable": true,
|
| 11896 | "locationInModule": {
|
| 11897 | "filename": "lib/event-source-mapping.ts",
|
| 11898 | "line": 154
|
| 11899 | },
|
| 11900 | "name": "maxRecordAge",
|
| 11901 | "optional": true,
|
| 11902 | "type": {
|
| 11903 | "fqn": "@aws-cdk/core.Duration"
|
| 11904 | }
|
| 11905 | },
|
| 11906 | {
|
| 11907 | "abstract": true,
|
| 11908 | "docs": {
|
| 11909 | "default": "discarded records are ignored",
|
| 11910 | "stability": "stable",
|
| 11911 | "summary": "An Amazon SQS queue or Amazon SNS topic destination for discarded records."
|
| 11912 | },
|
| 11913 | "immutable": true,
|
| 11914 | "locationInModule": {
|
| 11915 | "filename": "lib/event-source-mapping.ts",
|
| 11916 | "line": 110
|
| 11917 | },
|
| 11918 | "name": "onFailure",
|
| 11919 | "optional": true,
|
| 11920 | "type": {
|
| 11921 | "fqn": "@aws-cdk/aws-lambda.IEventSourceDlq"
|
| 11922 | }
|
| 11923 | },
|
| 11924 | {
|
| 11925 | "abstract": true,
|
| 11926 | "docs": {
|
| 11927 | "default": "1",
|
| 11928 | "remarks": "Valid Range:\n* Minimum value of 1\n* Maximum value of 10",
|
| 11929 | "stability": "stable",
|
| 11930 | "summary": "The number of batches to process from each shard concurrently."
|
| 11931 | },
|
| 11932 | "immutable": true,
|
| 11933 | "locationInModule": {
|
| 11934 | "filename": "lib/event-source-mapping.ts",
|
| 11935 | "line": 177
|
| 11936 | },
|
| 11937 | "name": "parallelizationFactor",
|
| 11938 | "optional": true,
|
| 11939 | "type": {
|
| 11940 | "primitive": "number"
|
| 11941 | }
|
| 11942 | },
|
| 11943 | {
|
| 11944 | "abstract": true,
|
| 11945 | "docs": {
|
| 11946 | "default": "false",
|
| 11947 | "see": "https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting",
|
| 11948 | "stability": "stable",
|
| 11949 | "summary": "Allow functions to return partially successful responses for a batch of records."
|
| 11950 | },
|
| 11951 | "immutable": true,
|
| 11952 | "locationInModule": {
|
| 11953 | "filename": "lib/event-source-mapping.ts",
|
| 11954 | "line": 136
|
| 11955 | },
|
| 11956 | "name": "reportBatchItemFailures",
|
| 11957 | "optional": true,
|
| 11958 | "type": {
|
| 11959 | "primitive": "boolean"
|
| 11960 | }
|
| 11961 | },
|
| 11962 | {
|
| 11963 | "abstract": true,
|
| 11964 | "docs": {
|
| 11965 | "default": "- infinite or until the record expires.",
|
| 11966 | "remarks": "Set to `undefined` if you want lambda to keep retrying infinitely or until\nthe record expires.\n\nValid Range:\n* Minimum value of 0\n* Maximum value of 10000",
|
| 11967 | "stability": "stable",
|
| 11968 | "summary": "The maximum number of times to retry when the function returns an error."
|
| 11969 | },
|
| 11970 | "immutable": true,
|
| 11971 | "locationInModule": {
|
| 11972 | "filename": "lib/event-source-mapping.ts",
|
| 11973 | "line": 167
|
| 11974 | },
|
| 11975 | "name": "retryAttempts",
|
| 11976 | "optional": true,
|
| 11977 | "type": {
|
| 11978 | "primitive": "number"
|
| 11979 | }
|
| 11980 | },
|
| 11981 | {
|
| 11982 | "abstract": true,
|
| 11983 | "docs": {
|
| 11984 | "default": "- none",
|
| 11985 | "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html",
|
| 11986 | "stability": "stable",
|
| 11987 | "summary": "Specific settings like the authentication protocol or the VPC components to secure access to your event source."
|
| 11988 | },
|
| 11989 | "immutable": true,
|
| 11990 | "locationInModule": {
|
| 11991 | "filename": "lib/event-source-mapping.ts",
|
| 11992 | "line": 212
|
| 11993 | },
|
| 11994 | "name": "sourceAccessConfigurations",
|
| 11995 | "optional": true,
|
| 11996 | "type": {
|
| 11997 | "collection": {
|
| 11998 | "elementtype": {
|
| 11999 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfiguration"
|
| 12000 | },
|
| 12001 | "kind": "array"
|
| 12002 | }
|
| 12003 | }
|
| 12004 | },
|
| 12005 | {
|
| 12006 | "abstract": true,
|
| 12007 | "docs": {
|
| 12008 | "default": "- Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources.",
|
| 12009 | "see": "https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType",
|
| 12010 | "stability": "stable",
|
| 12011 | "summary": "The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading."
|
| 12012 | },
|
| 12013 | "immutable": true,
|
| 12014 | "locationInModule": {
|
| 12015 | "filename": "lib/event-source-mapping.ts",
|
| 12016 | "line": 127
|
| 12017 | },
|
| 12018 | "name": "startingPosition",
|
| 12019 | "optional": true,
|
| 12020 | "type": {
|
| 12021 | "fqn": "@aws-cdk/aws-lambda.StartingPosition"
|
| 12022 | }
|
| 12023 | },
|
| 12024 | {
|
| 12025 | "abstract": true,
|
| 12026 | "docs": {
|
| 12027 | "default": "- None",
|
| 12028 | "see": "https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-windows\n\nValid Range: 0 - 15 minutes",
|
| 12029 | "stability": "stable",
|
| 12030 | "summary": "The size of the tumbling windows to group records sent to DynamoDB or Kinesis."
|
| 12031 | },
|
| 12032 | "immutable": true,
|
| 12033 | "locationInModule": {
|
| 12034 | "filename": "lib/event-source-mapping.ts",
|
| 12035 | "line": 195
|
| 12036 | },
|
| 12037 | "name": "tumblingWindow",
|
| 12038 | "optional": true,
|
| 12039 | "type": {
|
| 12040 | "fqn": "@aws-cdk/core.Duration"
|
| 12041 | }
|
| 12042 | }
|
| 12043 | ],
|
| 12044 | "symbolId": "lib/event-source-mapping:EventSourceMappingOptions"
|
| 12045 | },
|
| 12046 | "@aws-cdk/aws-lambda.EventSourceMappingProps": {
|
| 12047 | "assembly": "@aws-cdk/aws-lambda",
|
| 12048 | "datatype": true,
|
| 12049 | "docs": {
|
| 12050 | "stability": "stable",
|
| 12051 | "summary": "Properties for declaring a new event source mapping.",
|
| 12052 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const eventSourceDlq: lambda.IEventSourceDlq;\ndeclare const function_: lambda.Function;\ndeclare const sourceAccessConfigurationType: lambda.SourceAccessConfigurationType;\nconst eventSourceMappingProps: lambda.EventSourceMappingProps = {\n target: function_,\n\n // the properties below are optional\n batchSize: 123,\n bisectBatchOnError: false,\n enabled: false,\n eventSourceArn: 'eventSourceArn',\n kafkaBootstrapServers: ['kafkaBootstrapServers'],\n kafkaTopic: 'kafkaTopic',\n maxBatchingWindow: cdk.Duration.minutes(30),\n maxRecordAge: cdk.Duration.minutes(30),\n onFailure: eventSourceDlq,\n parallelizationFactor: 123,\n reportBatchItemFailures: false,\n retryAttempts: 123,\n sourceAccessConfigurations: [{\n type: sourceAccessConfigurationType,\n uri: 'uri',\n }],\n startingPosition: lambda.StartingPosition.TRIM_HORIZON,\n tumblingWindow: cdk.Duration.minutes(30),\n};",
|
| 12053 | "custom": {
|
| 12054 | "exampleMetadata": "fixture=_generated"
|
| 12055 | }
|
| 12056 | },
|
| 12057 | "fqn": "@aws-cdk/aws-lambda.EventSourceMappingProps",
|
| 12058 | "interfaces": [
|
| 12059 | "@aws-cdk/aws-lambda.EventSourceMappingOptions"
|
| 12060 | ],
|
| 12061 | "kind": "interface",
|
| 12062 | "locationInModule": {
|
| 12063 | "filename": "lib/event-source-mapping.ts",
|
| 12064 | "line": 218
|
| 12065 | },
|
| 12066 | "name": "EventSourceMappingProps",
|
| 12067 | "properties": [
|
| 12068 | {
|
| 12069 | "abstract": true,
|
| 12070 | "docs": {
|
| 12071 | "stability": "stable",
|
| 12072 | "summary": "The target AWS Lambda function."
|
| 12073 | },
|
| 12074 | "immutable": true,
|
| 12075 | "locationInModule": {
|
| 12076 | "filename": "lib/event-source-mapping.ts",
|
| 12077 | "line": 222
|
| 12078 | },
|
| 12079 | "name": "target",
|
| 12080 | "type": {
|
| 12081 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 12082 | }
|
| 12083 | }
|
| 12084 | ],
|
| 12085 | "symbolId": "lib/event-source-mapping:EventSourceMappingProps"
|
| 12086 | },
|
| 12087 | "@aws-cdk/aws-lambda.FileSystem": {
|
| 12088 | "assembly": "@aws-cdk/aws-lambda",
|
| 12089 | "docs": {
|
| 12090 | "stability": "stable",
|
| 12091 | "summary": "Represents the filesystem for the Lambda function.",
|
| 12092 | "example": "import * as ec2 from '@aws-cdk/aws-ec2';\nimport * as efs from '@aws-cdk/aws-efs';\n\n// create a new VPC\nconst vpc = new ec2.Vpc(this, 'VPC');\n\n// create a new Amazon EFS filesystem\nconst fileSystem = new efs.FileSystem(this, '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(this, 'MyLambda', {\n // mount the access point to /mnt/msg in the lambda runtime environment\n filesystem: lambda.FileSystem.fromEfsAccessPoint(accessPoint, '/mnt/msg'),\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n vpc,\n});",
|
| 12093 | "custom": {
|
| 12094 | "exampleMetadata": "infused"
|
| 12095 | }
|
| 12096 | },
|
| 12097 | "fqn": "@aws-cdk/aws-lambda.FileSystem",
|
| 12098 | "initializer": {
|
| 12099 | "docs": {
|
| 12100 | "stability": "stable"
|
| 12101 | },
|
| 12102 | "locationInModule": {
|
| 12103 | "filename": "lib/filesystem.ts",
|
| 12104 | "line": 82
|
| 12105 | },
|
| 12106 | "parameters": [
|
| 12107 | {
|
| 12108 | "docs": {
|
| 12109 | "summary": "the FileSystem configurations for the Lambda function."
|
| 12110 | },
|
| 12111 | "name": "config",
|
| 12112 | "type": {
|
| 12113 | "fqn": "@aws-cdk/aws-lambda.FileSystemConfig"
|
| 12114 | }
|
| 12115 | }
|
| 12116 | ],
|
| 12117 | "protected": true
|
| 12118 | },
|
| 12119 | "kind": "class",
|
| 12120 | "locationInModule": {
|
| 12121 | "filename": "lib/filesystem.ts",
|
| 12122 | "line": 45
|
| 12123 | },
|
| 12124 | "methods": [
|
| 12125 | {
|
| 12126 | "docs": {
|
| 12127 | "stability": "stable",
|
| 12128 | "summary": "mount the filesystem from Amazon EFS."
|
| 12129 | },
|
| 12130 | "locationInModule": {
|
| 12131 | "filename": "lib/filesystem.ts",
|
| 12132 | "line": 51
|
| 12133 | },
|
| 12134 | "name": "fromEfsAccessPoint",
|
| 12135 | "parameters": [
|
| 12136 | {
|
| 12137 | "docs": {
|
| 12138 | "summary": "the Amazon EFS access point."
|
| 12139 | },
|
| 12140 | "name": "ap",
|
| 12141 | "type": {
|
| 12142 | "fqn": "@aws-cdk/aws-efs.IAccessPoint"
|
| 12143 | }
|
| 12144 | },
|
| 12145 | {
|
| 12146 | "docs": {
|
| 12147 | "summary": "the target path in the lambda runtime environment."
|
| 12148 | },
|
| 12149 | "name": "mountPath",
|
| 12150 | "type": {
|
| 12151 | "primitive": "string"
|
| 12152 | }
|
| 12153 | }
|
| 12154 | ],
|
| 12155 | "returns": {
|
| 12156 | "type": {
|
| 12157 | "fqn": "@aws-cdk/aws-lambda.FileSystem"
|
| 12158 | }
|
| 12159 | },
|
| 12160 | "static": true
|
| 12161 | }
|
| 12162 | ],
|
| 12163 | "name": "FileSystem",
|
| 12164 | "properties": [
|
| 12165 | {
|
| 12166 | "docs": {
|
| 12167 | "stability": "stable",
|
| 12168 | "summary": "the FileSystem configurations for the Lambda function."
|
| 12169 | },
|
| 12170 | "immutable": true,
|
| 12171 | "locationInModule": {
|
| 12172 | "filename": "lib/filesystem.ts",
|
| 12173 | "line": 82
|
| 12174 | },
|
| 12175 | "name": "config",
|
| 12176 | "type": {
|
| 12177 | "fqn": "@aws-cdk/aws-lambda.FileSystemConfig"
|
| 12178 | }
|
| 12179 | }
|
| 12180 | ],
|
| 12181 | "symbolId": "lib/filesystem:FileSystem"
|
| 12182 | },
|
| 12183 | "@aws-cdk/aws-lambda.FileSystemConfig": {
|
| 12184 | "assembly": "@aws-cdk/aws-lambda",
|
| 12185 | "datatype": true,
|
| 12186 | "docs": {
|
| 12187 | "stability": "stable",
|
| 12188 | "summary": "FileSystem configurations for the Lambda function.",
|
| 12189 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const connections: ec2.Connections;\ndeclare const dependable: cdk.IDependable;\ndeclare const policyStatement: iam.PolicyStatement;\nconst fileSystemConfig: lambda.FileSystemConfig = {\n arn: 'arn',\n localMountPath: 'localMountPath',\n\n // the properties below are optional\n connections: connections,\n dependency: [dependable],\n policies: [policyStatement],\n};",
|
| 12190 | "custom": {
|
| 12191 | "exampleMetadata": "fixture=_generated"
|
| 12192 | }
|
| 12193 | },
|
| 12194 | "fqn": "@aws-cdk/aws-lambda.FileSystemConfig",
|
| 12195 | "kind": "interface",
|
| 12196 | "locationInModule": {
|
| 12197 | "filename": "lib/filesystem.ts",
|
| 12198 | "line": 9
|
| 12199 | },
|
| 12200 | "name": "FileSystemConfig",
|
| 12201 | "properties": [
|
| 12202 | {
|
| 12203 | "abstract": true,
|
| 12204 | "docs": {
|
| 12205 | "stability": "stable",
|
| 12206 | "summary": "ARN of the access point."
|
| 12207 | },
|
| 12208 | "immutable": true,
|
| 12209 | "locationInModule": {
|
| 12210 | "filename": "lib/filesystem.ts",
|
| 12211 | "line": 18
|
| 12212 | },
|
| 12213 | "name": "arn",
|
| 12214 | "type": {
|
| 12215 | "primitive": "string"
|
| 12216 | }
|
| 12217 | },
|
| 12218 | {
|
| 12219 | "abstract": true,
|
| 12220 | "docs": {
|
| 12221 | "stability": "stable",
|
| 12222 | "summary": "mount path in the lambda runtime environment."
|
| 12223 | },
|
| 12224 | "immutable": true,
|
| 12225 | "locationInModule": {
|
| 12226 | "filename": "lib/filesystem.ts",
|
| 12227 | "line": 13
|
| 12228 | },
|
| 12229 | "name": "localMountPath",
|
| 12230 | "type": {
|
| 12231 | "primitive": "string"
|
| 12232 | }
|
| 12233 | },
|
| 12234 | {
|
| 12235 | "abstract": true,
|
| 12236 | "docs": {
|
| 12237 | "default": "- no connections required to add extra ingress rules for Lambda function",
|
| 12238 | "stability": "stable",
|
| 12239 | "summary": "connections object used to allow ingress traffic from lambda function."
|
| 12240 | },
|
| 12241 | "immutable": true,
|
| 12242 | "locationInModule": {
|
| 12243 | "filename": "lib/filesystem.ts",
|
| 12244 | "line": 32
|
| 12245 | },
|
| 12246 | "name": "connections",
|
| 12247 | "optional": true,
|
| 12248 | "type": {
|
| 12249 | "fqn": "@aws-cdk/aws-ec2.Connections"
|
| 12250 | }
|
| 12251 | },
|
| 12252 | {
|
| 12253 | "abstract": true,
|
| 12254 | "docs": {
|
| 12255 | "default": "- no dependency",
|
| 12256 | "stability": "stable",
|
| 12257 | "summary": "array of IDependable that lambda function depends on."
|
| 12258 | },
|
| 12259 | "immutable": true,
|
| 12260 | "locationInModule": {
|
| 12261 | "filename": "lib/filesystem.ts",
|
| 12262 | "line": 25
|
| 12263 | },
|
| 12264 | "name": "dependency",
|
| 12265 | "optional": true,
|
| 12266 | "type": {
|
| 12267 | "collection": {
|
| 12268 | "elementtype": {
|
| 12269 | "fqn": "@aws-cdk/core.IDependable"
|
| 12270 | },
|
| 12271 | "kind": "array"
|
| 12272 | }
|
| 12273 | }
|
| 12274 | },
|
| 12275 | {
|
| 12276 | "abstract": true,
|
| 12277 | "docs": {
|
| 12278 | "default": "- no additional policies required",
|
| 12279 | "stability": "stable",
|
| 12280 | "summary": "additional IAM policies required for the lambda function."
|
| 12281 | },
|
| 12282 | "immutable": true,
|
| 12283 | "locationInModule": {
|
| 12284 | "filename": "lib/filesystem.ts",
|
| 12285 | "line": 39
|
| 12286 | },
|
| 12287 | "name": "policies",
|
| 12288 | "optional": true,
|
| 12289 | "type": {
|
| 12290 | "collection": {
|
| 12291 | "elementtype": {
|
| 12292 | "fqn": "@aws-cdk/aws-iam.PolicyStatement"
|
| 12293 | },
|
| 12294 | "kind": "array"
|
| 12295 | }
|
| 12296 | }
|
| 12297 | }
|
| 12298 | ],
|
| 12299 | "symbolId": "lib/filesystem:FileSystemConfig"
|
| 12300 | },
|
| 12301 | "@aws-cdk/aws-lambda.Function": {
|
| 12302 | "assembly": "@aws-cdk/aws-lambda",
|
| 12303 | "base": "@aws-cdk/aws-lambda.FunctionBase",
|
| 12304 | "docs": {
|
| 12305 | "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.",
|
| 12306 | "stability": "stable",
|
| 12307 | "summary": "Deploys a file from inside the construct library as a function.",
|
| 12308 | "example": "import * as signer from '@aws-cdk/aws-signer';\n\nconst signingProfile = new signer.SigningProfile(this, 'SigningProfile', {\n platform: signer.Platform.AWS_LAMBDA_SHA384_ECDSA,\n});\n\nconst codeSigningConfig = new lambda.CodeSigningConfig(this, 'CodeSigningConfig', {\n signingProfiles: [signingProfile],\n});\n\nnew lambda.Function(this, 'Function', {\n codeSigningConfig,\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});",
|
| 12309 | "custom": {
|
| 12310 | "exampleMetadata": "infused"
|
| 12311 | }
|
| 12312 | },
|
| 12313 | "fqn": "@aws-cdk/aws-lambda.Function",
|
| 12314 | "initializer": {
|
| 12315 | "docs": {
|
| 12316 | "stability": "stable"
|
| 12317 | },
|
| 12318 | "locationInModule": {
|
| 12319 | "filename": "lib/function.ts",
|
| 12320 | "line": 658
|
| 12321 | },
|
| 12322 | "parameters": [
|
| 12323 | {
|
| 12324 | "name": "scope",
|
| 12325 | "type": {
|
| 12326 | "fqn": "constructs.Construct"
|
| 12327 | }
|
| 12328 | },
|
| 12329 | {
|
| 12330 | "name": "id",
|
| 12331 | "type": {
|
| 12332 | "primitive": "string"
|
| 12333 | }
|
| 12334 | },
|
| 12335 | {
|
| 12336 | "name": "props",
|
| 12337 | "type": {
|
| 12338 | "fqn": "@aws-cdk/aws-lambda.FunctionProps"
|
| 12339 | }
|
| 12340 | }
|
| 12341 | ]
|
| 12342 | },
|
| 12343 | "kind": "class",
|
| 12344 | "locationInModule": {
|
| 12345 | "filename": "lib/function.ts",
|
| 12346 | "line": 397
|
| 12347 | },
|
| 12348 | "methods": [
|
| 12349 | {
|
| 12350 | "docs": {
|
| 12351 | "remarks": "See 'currentVersion' section in the module README for more details.",
|
| 12352 | "stability": "stable",
|
| 12353 | "summary": "Record whether specific properties in the `AWS::Lambda::Function` resource should also be associated to the Version resource."
|
| 12354 | },
|
| 12355 | "locationInModule": {
|
| 12356 | "filename": "lib/function.ts",
|
| 12357 | "line": 452
|
| 12358 | },
|
| 12359 | "name": "classifyVersionProperty",
|
| 12360 | "parameters": [
|
| 12361 | {
|
| 12362 | "docs": {
|
| 12363 | "summary": "The property to classify."
|
| 12364 | },
|
| 12365 | "name": "propertyName",
|
| 12366 | "type": {
|
| 12367 | "primitive": "string"
|
| 12368 | }
|
| 12369 | },
|
| 12370 | {
|
| 12371 | "docs": {
|
| 12372 | "summary": "whether the property should be associated to the version or not."
|
| 12373 | },
|
| 12374 | "name": "locked",
|
| 12375 | "type": {
|
| 12376 | "primitive": "boolean"
|
| 12377 | }
|
| 12378 | }
|
| 12379 | ],
|
| 12380 | "static": true
|
| 12381 | },
|
| 12382 | {
|
| 12383 | "docs": {
|
| 12384 | "stability": "stable",
|
| 12385 | "summary": "Import a lambda function into the CDK using its ARN."
|
| 12386 | },
|
| 12387 | "locationInModule": {
|
| 12388 | "filename": "lib/function.ts",
|
| 12389 | "line": 473
|
| 12390 | },
|
| 12391 | "name": "fromFunctionArn",
|
| 12392 | "parameters": [
|
| 12393 | {
|
| 12394 | "name": "scope",
|
| 12395 | "type": {
|
| 12396 | "fqn": "constructs.Construct"
|
| 12397 | }
|
| 12398 | },
|
| 12399 | {
|
| 12400 | "name": "id",
|
| 12401 | "type": {
|
| 12402 | "primitive": "string"
|
| 12403 | }
|
| 12404 | },
|
| 12405 | {
|
| 12406 | "name": "functionArn",
|
| 12407 | "type": {
|
| 12408 | "primitive": "string"
|
| 12409 | }
|
| 12410 | }
|
| 12411 | ],
|
| 12412 | "returns": {
|
| 12413 | "type": {
|
| 12414 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 12415 | }
|
| 12416 | },
|
| 12417 | "static": true
|
| 12418 | },
|
| 12419 | {
|
| 12420 | "docs": {
|
| 12421 | "stability": "stable",
|
| 12422 | "summary": "Creates a Lambda function object which represents a function not defined within this stack."
|
| 12423 | },
|
| 12424 | "locationInModule": {
|
| 12425 | "filename": "lib/function.ts",
|
| 12426 | "line": 485
|
| 12427 | },
|
| 12428 | "name": "fromFunctionAttributes",
|
| 12429 | "parameters": [
|
| 12430 | {
|
| 12431 | "docs": {
|
| 12432 | "summary": "The parent construct."
|
| 12433 | },
|
| 12434 | "name": "scope",
|
| 12435 | "type": {
|
| 12436 | "fqn": "constructs.Construct"
|
| 12437 | }
|
| 12438 | },
|
| 12439 | {
|
| 12440 | "docs": {
|
| 12441 | "summary": "The name of the lambda construct."
|
| 12442 | },
|
| 12443 | "name": "id",
|
| 12444 | "type": {
|
| 12445 | "primitive": "string"
|
| 12446 | }
|
| 12447 | },
|
| 12448 | {
|
| 12449 | "docs": {
|
| 12450 | "summary": "the attributes of the function to import."
|
| 12451 | },
|
| 12452 | "name": "attrs",
|
| 12453 | "type": {
|
| 12454 | "fqn": "@aws-cdk/aws-lambda.FunctionAttributes"
|
| 12455 | }
|
| 12456 | }
|
| 12457 | ],
|
| 12458 | "returns": {
|
| 12459 | "type": {
|
| 12460 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 12461 | }
|
| 12462 | },
|
| 12463 | "static": true
|
| 12464 | },
|
| 12465 | {
|
| 12466 | "docs": {
|
| 12467 | "stability": "stable",
|
| 12468 | "summary": "Import a lambda function into the CDK using its name."
|
| 12469 | },
|
| 12470 | "locationInModule": {
|
| 12471 | "filename": "lib/function.ts",
|
| 12472 | "line": 459
|
| 12473 | },
|
| 12474 | "name": "fromFunctionName",
|
| 12475 | "parameters": [
|
| 12476 | {
|
| 12477 | "name": "scope",
|
| 12478 | "type": {
|
| 12479 | "fqn": "constructs.Construct"
|
| 12480 | }
|
| 12481 | },
|
| 12482 | {
|
| 12483 | "name": "id",
|
| 12484 | "type": {
|
| 12485 | "primitive": "string"
|
| 12486 | }
|
| 12487 | },
|
| 12488 | {
|
| 12489 | "name": "functionName",
|
| 12490 | "type": {
|
| 12491 | "primitive": "string"
|
| 12492 | }
|
| 12493 | }
|
| 12494 | ],
|
| 12495 | "returns": {
|
| 12496 | "type": {
|
| 12497 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 12498 | }
|
| 12499 | },
|
| 12500 | "static": true
|
| 12501 | },
|
| 12502 | {
|
| 12503 | "docs": {
|
| 12504 | "stability": "stable",
|
| 12505 | "summary": "Return the given named metric for this Lambda."
|
| 12506 | },
|
| 12507 | "locationInModule": {
|
| 12508 | "filename": "lib/function.ts",
|
| 12509 | "line": 527
|
| 12510 | },
|
| 12511 | "name": "metricAll",
|
| 12512 | "parameters": [
|
| 12513 | {
|
| 12514 | "name": "metricName",
|
| 12515 | "type": {
|
| 12516 | "primitive": "string"
|
| 12517 | }
|
| 12518 | },
|
| 12519 | {
|
| 12520 | "name": "props",
|
| 12521 | "optional": true,
|
| 12522 | "type": {
|
| 12523 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 12524 | }
|
| 12525 | }
|
| 12526 | ],
|
| 12527 | "returns": {
|
| 12528 | "type": {
|
| 12529 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 12530 | }
|
| 12531 | },
|
| 12532 | "static": true
|
| 12533 | },
|
| 12534 | {
|
| 12535 | "docs": {
|
| 12536 | "default": "max over 5 minutes",
|
| 12537 | "stability": "stable",
|
| 12538 | "summary": "Metric for the number of concurrent executions across all Lambdas."
|
| 12539 | },
|
| 12540 | "locationInModule": {
|
| 12541 | "filename": "lib/function.ts",
|
| 12542 | "line": 575
|
| 12543 | },
|
| 12544 | "name": "metricAllConcurrentExecutions",
|
| 12545 | "parameters": [
|
| 12546 | {
|
| 12547 | "name": "props",
|
| 12548 | "optional": true,
|
| 12549 | "type": {
|
| 12550 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 12551 | }
|
| 12552 | }
|
| 12553 | ],
|
| 12554 | "returns": {
|
| 12555 | "type": {
|
| 12556 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 12557 | }
|
| 12558 | },
|
| 12559 | "static": true
|
| 12560 | },
|
| 12561 | {
|
| 12562 | "docs": {
|
| 12563 | "default": "average over 5 minutes",
|
| 12564 | "stability": "stable",
|
| 12565 | "summary": "Metric for the Duration executing all Lambdas."
|
| 12566 | },
|
| 12567 | "locationInModule": {
|
| 12568 | "filename": "lib/function.ts",
|
| 12569 | "line": 548
|
| 12570 | },
|
| 12571 | "name": "metricAllDuration",
|
| 12572 | "parameters": [
|
| 12573 | {
|
| 12574 | "name": "props",
|
| 12575 | "optional": true,
|
| 12576 | "type": {
|
| 12577 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 12578 | }
|
| 12579 | }
|
| 12580 | ],
|
| 12581 | "returns": {
|
| 12582 | "type": {
|
| 12583 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 12584 | }
|
| 12585 | },
|
| 12586 | "static": true
|
| 12587 | },
|
| 12588 | {
|
| 12589 | "docs": {
|
| 12590 | "default": "sum over 5 minutes",
|
| 12591 | "stability": "stable",
|
| 12592 | "summary": "Metric for the number of Errors executing all Lambdas."
|
| 12593 | },
|
| 12594 | "locationInModule": {
|
| 12595 | "filename": "lib/function.ts",
|
| 12596 | "line": 539
|
| 12597 | },
|
| 12598 | "name": "metricAllErrors",
|
| 12599 | "parameters": [
|
| 12600 | {
|
| 12601 | "name": "props",
|
| 12602 | "optional": true,
|
| 12603 | "type": {
|
| 12604 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 12605 | }
|
| 12606 | }
|
| 12607 | ],
|
| 12608 | "returns": {
|
| 12609 | "type": {
|
| 12610 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 12611 | }
|
| 12612 | },
|
| 12613 | "static": true
|
| 12614 | },
|
| 12615 | {
|
| 12616 | "docs": {
|
| 12617 | "default": "sum over 5 minutes",
|
| 12618 | "stability": "stable",
|
| 12619 | "summary": "Metric for the number of invocations of all Lambdas."
|
| 12620 | },
|
| 12621 | "locationInModule": {
|
| 12622 | "filename": "lib/function.ts",
|
| 12623 | "line": 557
|
| 12624 | },
|
| 12625 | "name": "metricAllInvocations",
|
| 12626 | "parameters": [
|
| 12627 | {
|
| 12628 | "name": "props",
|
| 12629 | "optional": true,
|
| 12630 | "type": {
|
| 12631 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 12632 | }
|
| 12633 | }
|
| 12634 | ],
|
| 12635 | "returns": {
|
| 12636 | "type": {
|
| 12637 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 12638 | }
|
| 12639 | },
|
| 12640 | "static": true
|
| 12641 | },
|
| 12642 | {
|
| 12643 | "docs": {
|
| 12644 | "default": "sum over 5 minutes",
|
| 12645 | "stability": "stable",
|
| 12646 | "summary": "Metric for the number of throttled invocations of all Lambdas."
|
| 12647 | },
|
| 12648 | "locationInModule": {
|
| 12649 | "filename": "lib/function.ts",
|
| 12650 | "line": 566
|
| 12651 | },
|
| 12652 | "name": "metricAllThrottles",
|
| 12653 | "parameters": [
|
| 12654 | {
|
| 12655 | "name": "props",
|
| 12656 | "optional": true,
|
| 12657 | "type": {
|
| 12658 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 12659 | }
|
| 12660 | }
|
| 12661 | ],
|
| 12662 | "returns": {
|
| 12663 | "type": {
|
| 12664 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 12665 | }
|
| 12666 | },
|
| 12667 | "static": true
|
| 12668 | },
|
| 12669 | {
|
| 12670 | "docs": {
|
| 12671 | "default": "max over 5 minutes",
|
| 12672 | "stability": "stable",
|
| 12673 | "summary": "Metric for the number of unreserved concurrent executions across all Lambdas."
|
| 12674 | },
|
| 12675 | "locationInModule": {
|
| 12676 | "filename": "lib/function.ts",
|
| 12677 | "line": 590
|
| 12678 | },
|
| 12679 | "name": "metricAllUnreservedConcurrentExecutions",
|
| 12680 | "parameters": [
|
| 12681 | {
|
| 12682 | "name": "props",
|
| 12683 | "optional": true,
|
| 12684 | "type": {
|
| 12685 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 12686 | }
|
| 12687 | }
|
| 12688 | ],
|
| 12689 | "returns": {
|
| 12690 | "type": {
|
| 12691 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 12692 | }
|
| 12693 | },
|
| 12694 | "static": true
|
| 12695 | },
|
| 12696 | {
|
| 12697 | "docs": {
|
| 12698 | "remarks": "The alias will automatically be updated to point to the latest version of\nthe function as it is being updated during a deployment.\n\n```ts\ndeclare const fn: lambda.Function;\n\nfn.addAlias('Live');\n\n// Is equivalent to\n\nnew lambda.Alias(this, 'AliasLive', {\n aliasName: 'Live',\n version: fn.currentVersion,\n});",
|
| 12699 | "stability": "stable",
|
| 12700 | "summary": "Defines an alias for this function."
|
| 12701 | },
|
| 12702 | "locationInModule": {
|
| 12703 | "filename": "lib/function.ts",
|
| 12704 | "line": 991
|
| 12705 | },
|
| 12706 | "name": "addAlias",
|
| 12707 | "parameters": [
|
| 12708 | {
|
| 12709 | "docs": {
|
| 12710 | "summary": "The name of the alias."
|
| 12711 | },
|
| 12712 | "name": "aliasName",
|
| 12713 | "type": {
|
| 12714 | "primitive": "string"
|
| 12715 | }
|
| 12716 | },
|
| 12717 | {
|
| 12718 | "docs": {
|
| 12719 | "summary": "Alias options."
|
| 12720 | },
|
| 12721 | "name": "options",
|
| 12722 | "optional": true,
|
| 12723 | "type": {
|
| 12724 | "fqn": "@aws-cdk/aws-lambda.AliasOptions"
|
| 12725 | }
|
| 12726 | }
|
| 12727 | ],
|
| 12728 | "returns": {
|
| 12729 | "type": {
|
| 12730 | "fqn": "@aws-cdk/aws-lambda.Alias"
|
| 12731 | }
|
| 12732 | }
|
| 12733 | },
|
| 12734 | {
|
| 12735 | "docs": {
|
| 12736 | "remarks": "If this is a ref to a Lambda function, this operation results in a no-op.",
|
| 12737 | "stability": "stable",
|
| 12738 | "summary": "Adds an environment variable to this Lambda function."
|
| 12739 | },
|
| 12740 | "locationInModule": {
|
| 12741 | "filename": "lib/function.ts",
|
| 12742 | "line": 899
|
| 12743 | },
|
| 12744 | "name": "addEnvironment",
|
| 12745 | "parameters": [
|
| 12746 | {
|
| 12747 | "docs": {
|
| 12748 | "summary": "The environment variable key."
|
| 12749 | },
|
| 12750 | "name": "key",
|
| 12751 | "type": {
|
| 12752 | "primitive": "string"
|
| 12753 | }
|
| 12754 | },
|
| 12755 | {
|
| 12756 | "docs": {
|
| 12757 | "summary": "The environment variable's value."
|
| 12758 | },
|
| 12759 | "name": "value",
|
| 12760 | "type": {
|
| 12761 | "primitive": "string"
|
| 12762 | }
|
| 12763 | },
|
| 12764 | {
|
| 12765 | "docs": {
|
| 12766 | "summary": "Environment variable options."
|
| 12767 | },
|
| 12768 | "name": "options",
|
| 12769 | "optional": true,
|
| 12770 | "type": {
|
| 12771 | "fqn": "@aws-cdk/aws-lambda.EnvironmentOptions"
|
| 12772 | }
|
| 12773 | }
|
| 12774 | ],
|
| 12775 | "returns": {
|
| 12776 | "type": {
|
| 12777 | "fqn": "@aws-cdk/aws-lambda.Function"
|
| 12778 | }
|
| 12779 | }
|
| 12780 | },
|
| 12781 | {
|
| 12782 | "docs": {
|
| 12783 | "custom": {
|
| 12784 | "throws": "if there are already 5 layers on this function, or the layer is incompatible with this function's runtime."
|
| 12785 | },
|
| 12786 | "stability": "stable",
|
| 12787 | "summary": "Adds one or more Lambda Layers to this Lambda function."
|
| 12788 | },
|
| 12789 | "locationInModule": {
|
| 12790 | "filename": "lib/function.ts",
|
| 12791 | "line": 911
|
| 12792 | },
|
| 12793 | "name": "addLayers",
|
| 12794 | "parameters": [
|
| 12795 | {
|
| 12796 | "docs": {
|
| 12797 | "summary": "the layers to be added."
|
| 12798 | },
|
| 12799 | "name": "layers",
|
| 12800 | "type": {
|
| 12801 | "fqn": "@aws-cdk/aws-lambda.ILayerVersion"
|
| 12802 | },
|
| 12803 | "variadic": true
|
| 12804 | }
|
| 12805 | ],
|
| 12806 | "variadic": true
|
| 12807 | },
|
| 12808 | {
|
| 12809 | "docs": {
|
| 12810 | "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.",
|
| 12811 | "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.",
|
| 12812 | "returns": "A new Version object.",
|
| 12813 | "stability": "deprecated",
|
| 12814 | "summary": "Add a new version for this Lambda."
|
| 12815 | },
|
| 12816 | "locationInModule": {
|
| 12817 | "filename": "lib/function.ts",
|
| 12818 | "line": 954
|
| 12819 | },
|
| 12820 | "name": "addVersion",
|
| 12821 | "parameters": [
|
| 12822 | {
|
| 12823 | "docs": {
|
| 12824 | "summary": "A unique name for this version."
|
| 12825 | },
|
| 12826 | "name": "name",
|
| 12827 | "type": {
|
| 12828 | "primitive": "string"
|
| 12829 | }
|
| 12830 | },
|
| 12831 | {
|
| 12832 | "docs": {
|
| 12833 | "summary": "The SHA-256 hash of the most recently deployed Lambda source code, or omit to skip validation."
|
| 12834 | },
|
| 12835 | "name": "codeSha256",
|
| 12836 | "optional": true,
|
| 12837 | "type": {
|
| 12838 | "primitive": "string"
|
| 12839 | }
|
| 12840 | },
|
| 12841 | {
|
| 12842 | "docs": {
|
| 12843 | "summary": "A description for this version."
|
| 12844 | },
|
| 12845 | "name": "description",
|
| 12846 | "optional": true,
|
| 12847 | "type": {
|
| 12848 | "primitive": "string"
|
| 12849 | }
|
| 12850 | },
|
| 12851 | {
|
| 12852 | "docs": {
|
| 12853 | "summary": "A provisioned concurrency configuration for a function's version."
|
| 12854 | },
|
| 12855 | "name": "provisionedExecutions",
|
| 12856 | "optional": true,
|
| 12857 | "type": {
|
| 12858 | "primitive": "number"
|
| 12859 | }
|
| 12860 | },
|
| 12861 | {
|
| 12862 | "docs": {
|
| 12863 | "summary": "configuration for this version when it is invoked asynchronously."
|
| 12864 | },
|
| 12865 | "name": "asyncInvokeConfig",
|
| 12866 | "optional": true,
|
| 12867 | "type": {
|
| 12868 | "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions"
|
| 12869 | }
|
| 12870 | }
|
| 12871 | ],
|
| 12872 | "returns": {
|
| 12873 | "type": {
|
| 12874 | "fqn": "@aws-cdk/aws-lambda.Version"
|
| 12875 | }
|
| 12876 | }
|
| 12877 | }
|
| 12878 | ],
|
| 12879 | "name": "Function",
|
| 12880 | "properties": [
|
| 12881 | {
|
| 12882 | "docs": {
|
| 12883 | "stability": "stable",
|
| 12884 | "summary": "The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64)."
|
| 12885 | },
|
| 12886 | "immutable": true,
|
| 12887 | "locationInModule": {
|
| 12888 | "filename": "lib/function.ts",
|
| 12889 | "line": 632
|
| 12890 | },
|
| 12891 | "name": "architecture",
|
| 12892 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 12893 | "type": {
|
| 12894 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 12895 | }
|
| 12896 | },
|
| 12897 | {
|
| 12898 | "docs": {
|
| 12899 | "remarks": "True for new Lambdas, false for version $LATEST and imported Lambdas\nfrom different accounts.",
|
| 12900 | "stability": "stable",
|
| 12901 | "summary": "Whether the addPermission() call adds any permissions."
|
| 12902 | },
|
| 12903 | "immutable": true,
|
| 12904 | "locationInModule": {
|
| 12905 | "filename": "lib/function.ts",
|
| 12906 | "line": 641
|
| 12907 | },
|
| 12908 | "name": "canCreatePermissions",
|
| 12909 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 12910 | "protected": true,
|
| 12911 | "type": {
|
| 12912 | "primitive": "boolean"
|
| 12913 | }
|
| 12914 | },
|
| 12915 | {
|
| 12916 | "docs": {
|
| 12917 | "remarks": "You can specify options for this version using the `currentVersionOptions`\nprop when initializing the `lambda.Function`.",
|
| 12918 | "stability": "stable",
|
| 12919 | "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."
|
| 12920 | },
|
| 12921 | "immutable": true,
|
| 12922 | "locationInModule": {
|
| 12923 | "filename": "lib/function.ts",
|
| 12924 | "line": 407
|
| 12925 | },
|
| 12926 | "name": "currentVersion",
|
| 12927 | "type": {
|
| 12928 | "fqn": "@aws-cdk/aws-lambda.Version"
|
| 12929 | }
|
| 12930 | },
|
| 12931 | {
|
| 12932 | "docs": {
|
| 12933 | "stability": "stable",
|
| 12934 | "summary": "ARN of this function."
|
| 12935 | },
|
| 12936 | "immutable": true,
|
| 12937 | "locationInModule": {
|
| 12938 | "filename": "lib/function.ts",
|
| 12939 | "line": 602
|
| 12940 | },
|
| 12941 | "name": "functionArn",
|
| 12942 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 12943 | "type": {
|
| 12944 | "primitive": "string"
|
| 12945 | }
|
| 12946 | },
|
| 12947 | {
|
| 12948 | "docs": {
|
| 12949 | "stability": "stable",
|
| 12950 | "summary": "Name of this function."
|
| 12951 | },
|
| 12952 | "immutable": true,
|
| 12953 | "locationInModule": {
|
| 12954 | "filename": "lib/function.ts",
|
| 12955 | "line": 597
|
| 12956 | },
|
| 12957 | "name": "functionName",
|
| 12958 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 12959 | "type": {
|
| 12960 | "primitive": "string"
|
| 12961 | }
|
| 12962 | },
|
| 12963 | {
|
| 12964 | "docs": {
|
| 12965 | "stability": "stable",
|
| 12966 | "summary": "The principal this Lambda Function is running as."
|
| 12967 | },
|
| 12968 | "immutable": true,
|
| 12969 | "locationInModule": {
|
| 12970 | "filename": "lib/function.ts",
|
| 12971 | "line": 617
|
| 12972 | },
|
| 12973 | "name": "grantPrincipal",
|
| 12974 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 12975 | "type": {
|
| 12976 | "fqn": "@aws-cdk/aws-iam.IPrincipal"
|
| 12977 | }
|
| 12978 | },
|
| 12979 | {
|
| 12980 | "docs": {
|
| 12981 | "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.",
|
| 12982 | "stability": "stable",
|
| 12983 | "summary": "The LogGroup where the Lambda function's logs are made available."
|
| 12984 | },
|
| 12985 | "immutable": true,
|
| 12986 | "locationInModule": {
|
| 12987 | "filename": "lib/function.ts",
|
| 12988 | "line": 1005
|
| 12989 | },
|
| 12990 | "name": "logGroup",
|
| 12991 | "type": {
|
| 12992 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
| 12993 | }
|
| 12994 | },
|
| 12995 | {
|
| 12996 | "docs": {
|
| 12997 | "stability": "stable",
|
| 12998 | "summary": "The construct node where permissions are attached."
|
| 12999 | },
|
| 13000 | "immutable": true,
|
| 13001 | "locationInModule": {
|
| 13002 | "filename": "lib/function.ts",
|
| 13003 | "line": 639
|
| 13004 | },
|
| 13005 | "name": "permissionsNode",
|
| 13006 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 13007 | "type": {
|
| 13008 | "fqn": "@aws-cdk/core.ConstructNode"
|
| 13009 | }
|
| 13010 | },
|
| 13011 | {
|
| 13012 | "docs": {
|
| 13013 | "stability": "stable",
|
| 13014 | "summary": "The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()."
|
| 13015 | },
|
| 13016 | "immutable": true,
|
| 13017 | "locationInModule": {
|
| 13018 | "filename": "lib/function.ts",
|
| 13019 | "line": 438
|
| 13020 | },
|
| 13021 | "name": "resourceArnsForGrantInvoke",
|
| 13022 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 13023 | "type": {
|
| 13024 | "collection": {
|
| 13025 | "elementtype": {
|
| 13026 | "primitive": "string"
|
| 13027 | },
|
| 13028 | "kind": "array"
|
| 13029 | }
|
| 13030 | }
|
| 13031 | },
|
| 13032 | {
|
| 13033 | "docs": {
|
| 13034 | "stability": "stable",
|
| 13035 | "summary": "The runtime configured for this lambda."
|
| 13036 | },
|
| 13037 | "immutable": true,
|
| 13038 | "locationInModule": {
|
| 13039 | "filename": "lib/function.ts",
|
| 13040 | "line": 612
|
| 13041 | },
|
| 13042 | "name": "runtime",
|
| 13043 | "type": {
|
| 13044 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 13045 | }
|
| 13046 | },
|
| 13047 | {
|
| 13048 | "docs": {
|
| 13049 | "stability": "stable",
|
| 13050 | "summary": "The DLQ (as queue) associated with this Lambda Function (this is an optional attribute)."
|
| 13051 | },
|
| 13052 | "immutable": true,
|
| 13053 | "locationInModule": {
|
| 13054 | "filename": "lib/function.ts",
|
| 13055 | "line": 622
|
| 13056 | },
|
| 13057 | "name": "deadLetterQueue",
|
| 13058 | "optional": true,
|
| 13059 | "type": {
|
| 13060 | "fqn": "@aws-cdk/aws-sqs.IQueue"
|
| 13061 | }
|
| 13062 | },
|
| 13063 | {
|
| 13064 | "docs": {
|
| 13065 | "stability": "stable",
|
| 13066 | "summary": "The DLQ (as topic) associated with this Lambda Function (this is an optional attribute)."
|
| 13067 | },
|
| 13068 | "immutable": true,
|
| 13069 | "locationInModule": {
|
| 13070 | "filename": "lib/function.ts",
|
| 13071 | "line": 627
|
| 13072 | },
|
| 13073 | "name": "deadLetterTopic",
|
| 13074 | "optional": true,
|
| 13075 | "type": {
|
| 13076 | "fqn": "@aws-cdk/aws-sns.ITopic"
|
| 13077 | }
|
| 13078 | },
|
| 13079 | {
|
| 13080 | "docs": {
|
| 13081 | "stability": "stable",
|
| 13082 | "summary": "Execution role associated with this function."
|
| 13083 | },
|
| 13084 | "immutable": true,
|
| 13085 | "locationInModule": {
|
| 13086 | "filename": "lib/function.ts",
|
| 13087 | "line": 607
|
| 13088 | },
|
| 13089 | "name": "role",
|
| 13090 | "optional": true,
|
| 13091 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 13092 | "type": {
|
| 13093 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 13094 | }
|
| 13095 | },
|
| 13096 | {
|
| 13097 | "docs": {
|
| 13098 | "stability": "stable",
|
| 13099 | "summary": "The timeout configured for this lambda."
|
| 13100 | },
|
| 13101 | "immutable": true,
|
| 13102 | "locationInModule": {
|
| 13103 | "filename": "lib/function.ts",
|
| 13104 | "line": 637
|
| 13105 | },
|
| 13106 | "name": "timeout",
|
| 13107 | "optional": true,
|
| 13108 | "type": {
|
| 13109 | "fqn": "@aws-cdk/core.Duration"
|
| 13110 | }
|
| 13111 | }
|
| 13112 | ],
|
| 13113 | "symbolId": "lib/function:Function"
|
| 13114 | },
|
| 13115 | "@aws-cdk/aws-lambda.FunctionAttributes": {
|
| 13116 | "assembly": "@aws-cdk/aws-lambda",
|
| 13117 | "datatype": true,
|
| 13118 | "docs": {
|
| 13119 | "stability": "stable",
|
| 13120 | "summary": "Represents a Lambda function defined outside of this stack.",
|
| 13121 | "example": "const fn = lambda.Function.fromFunctionAttributes(this, 'Function', {\n functionArn: 'arn:aws:lambda:us-east-1:123456789012:function:MyFn',\n // The following are optional properties for specific use cases and should be used with caution:\n\n // Use Case: imported function is in the same account as the stack. This tells the CDK that it\n // can modify the function's permissions.\n sameEnvironment: true,\n\n // Use Case: imported function is in a different account and user commits to ensuring that the\n // imported function has the correct permissions outside the CDK.\n skipPermissions: true,\n});",
|
| 13122 | "custom": {
|
| 13123 | "exampleMetadata": "infused"
|
| 13124 | }
|
| 13125 | },
|
| 13126 | "fqn": "@aws-cdk/aws-lambda.FunctionAttributes",
|
| 13127 | "kind": "interface",
|
| 13128 | "locationInModule": {
|
| 13129 | "filename": "lib/function-base.ts",
|
| 13130 | "line": 161
|
| 13131 | },
|
| 13132 | "name": "FunctionAttributes",
|
| 13133 | "properties": [
|
| 13134 | {
|
| 13135 | "abstract": true,
|
| 13136 | "docs": {
|
| 13137 | "remarks": "Format: arn:<partition>:lambda:<region>:<account-id>:function:<function-name>",
|
| 13138 | "stability": "stable",
|
| 13139 | "summary": "The ARN of the Lambda function."
|
| 13140 | },
|
| 13141 | "immutable": true,
|
| 13142 | "locationInModule": {
|
| 13143 | "filename": "lib/function-base.ts",
|
| 13144 | "line": 167
|
| 13145 | },
|
| 13146 | "name": "functionArn",
|
| 13147 | "type": {
|
| 13148 | "primitive": "string"
|
| 13149 | }
|
| 13150 | },
|
| 13151 | {
|
| 13152 | "abstract": true,
|
| 13153 | "docs": {
|
| 13154 | "default": "- Architecture.X86_64",
|
| 13155 | "stability": "stable",
|
| 13156 | "summary": "The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64)."
|
| 13157 | },
|
| 13158 | "immutable": true,
|
| 13159 | "locationInModule": {
|
| 13160 | "filename": "lib/function-base.ts",
|
| 13161 | "line": 225
|
| 13162 | },
|
| 13163 | "name": "architecture",
|
| 13164 | "optional": true,
|
| 13165 | "type": {
|
| 13166 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 13167 | }
|
| 13168 | },
|
| 13169 | {
|
| 13170 | "abstract": true,
|
| 13171 | "docs": {
|
| 13172 | "remarks": "If the role is not specified, any role-related operations will no-op.",
|
| 13173 | "stability": "stable",
|
| 13174 | "summary": "The IAM execution role associated with this function."
|
| 13175 | },
|
| 13176 | "immutable": true,
|
| 13177 | "locationInModule": {
|
| 13178 | "filename": "lib/function-base.ts",
|
| 13179 | "line": 174
|
| 13180 | },
|
| 13181 | "name": "role",
|
| 13182 | "optional": true,
|
| 13183 | "type": {
|
| 13184 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 13185 | }
|
| 13186 | },
|
| 13187 | {
|
| 13188 | "abstract": true,
|
| 13189 | "docs": {
|
| 13190 | "default": "- depends: true, if the Stack is configured with an explicit `env` (account and region) and the account is the same as this function.\nFor environment-agnostic stacks this will default to `false`.",
|
| 13191 | "remarks": "This affects certain behaviours such as, whether this function's permission can be modified.\nWhen not configured, the CDK attempts to auto-determine this. For environment agnostic stacks, i.e., stacks\nwhere the account is not specified with the `env` property, this is determined to be false.\n\nSet this to property *ONLY IF* the imported function is in the same account as the stack\nit's imported in.",
|
| 13192 | "stability": "stable",
|
| 13193 | "summary": "Setting this property informs the CDK that the imported function is in the same environment as the stack."
|
| 13194 | },
|
| 13195 | "immutable": true,
|
| 13196 | "locationInModule": {
|
| 13197 | "filename": "lib/function-base.ts",
|
| 13198 | "line": 205
|
| 13199 | },
|
| 13200 | "name": "sameEnvironment",
|
| 13201 | "optional": true,
|
| 13202 | "type": {
|
| 13203 | "primitive": "boolean"
|
| 13204 | }
|
| 13205 | },
|
| 13206 | {
|
| 13207 | "abstract": true,
|
| 13208 | "docs": {
|
| 13209 | "remarks": "This needs to be given in order to support allowing connections\nto this Lambda.",
|
| 13210 | "stability": "stable",
|
| 13211 | "summary": "The security group of this Lambda, if in a VPC."
|
| 13212 | },
|
| 13213 | "immutable": true,
|
| 13214 | "locationInModule": {
|
| 13215 | "filename": "lib/function-base.ts",
|
| 13216 | "line": 192
|
| 13217 | },
|
| 13218 | "name": "securityGroup",
|
| 13219 | "optional": true,
|
| 13220 | "type": {
|
| 13221 | "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
|
| 13222 | }
|
| 13223 | },
|
| 13224 | {
|
| 13225 | "abstract": true,
|
| 13226 | "docs": {
|
| 13227 | "deprecated": "use `securityGroup` instead",
|
| 13228 | "remarks": "This needs to be given in order to support allowing connections\nto this Lambda.",
|
| 13229 | "stability": "deprecated",
|
| 13230 | "summary": "Id of the security group of this Lambda, if in a VPC."
|
| 13231 | },
|
| 13232 | "immutable": true,
|
| 13233 | "locationInModule": {
|
| 13234 | "filename": "lib/function-base.ts",
|
| 13235 | "line": 184
|
| 13236 | },
|
| 13237 | "name": "securityGroupId",
|
| 13238 | "optional": true,
|
| 13239 | "type": {
|
| 13240 | "primitive": "string"
|
| 13241 | }
|
| 13242 | },
|
| 13243 | {
|
| 13244 | "abstract": true,
|
| 13245 | "docs": {
|
| 13246 | "default": "false",
|
| 13247 | "remarks": "When not configured, the CDK attempts to auto-determine whether or not\nadditional permissions are necessary on the function when grant APIs are used. If the CDK tried to add\npermissions on an imported lambda, it will fail.\n\nSet this property *ONLY IF* you are committing to manage the imported function's permissions outside of\nCDK. You are acknowledging that your CDK code alone will have insufficient permissions to access the\nimported function.",
|
| 13248 | "stability": "stable",
|
| 13249 | "summary": "Setting this property informs the CDK that the imported function ALREADY HAS the necessary permissions for what you are trying to do."
|
| 13250 | },
|
| 13251 | "immutable": true,
|
| 13252 | "locationInModule": {
|
| 13253 | "filename": "lib/function-base.ts",
|
| 13254 | "line": 219
|
| 13255 | },
|
| 13256 | "name": "skipPermissions",
|
| 13257 | "optional": true,
|
| 13258 | "type": {
|
| 13259 | "primitive": "boolean"
|
| 13260 | }
|
| 13261 | }
|
| 13262 | ],
|
| 13263 | "symbolId": "lib/function-base:FunctionAttributes"
|
| 13264 | },
|
| 13265 | "@aws-cdk/aws-lambda.FunctionBase": {
|
| 13266 | "abstract": true,
|
| 13267 | "assembly": "@aws-cdk/aws-lambda",
|
| 13268 | "base": "@aws-cdk/core.Resource",
|
| 13269 | "docs": {
|
| 13270 | "stability": "stable"
|
| 13271 | },
|
| 13272 | "fqn": "@aws-cdk/aws-lambda.FunctionBase",
|
| 13273 | "initializer": {
|
| 13274 | "docs": {
|
| 13275 | "stability": "stable"
|
| 13276 | },
|
| 13277 | "locationInModule": {
|
| 13278 | "filename": "lib/resource.ts",
|
| 13279 | "line": 150
|
| 13280 | },
|
| 13281 | "parameters": [
|
| 13282 | {
|
| 13283 | "name": "scope",
|
| 13284 | "type": {
|
| 13285 | "fqn": "constructs.Construct"
|
| 13286 | }
|
| 13287 | },
|
| 13288 | {
|
| 13289 | "name": "id",
|
| 13290 | "type": {
|
| 13291 | "primitive": "string"
|
| 13292 | }
|
| 13293 | },
|
| 13294 | {
|
| 13295 | "name": "props",
|
| 13296 | "optional": true,
|
| 13297 | "type": {
|
| 13298 | "fqn": "@aws-cdk/core.ResourceProps"
|
| 13299 | }
|
| 13300 | }
|
| 13301 | ]
|
| 13302 | },
|
| 13303 | "interfaces": [
|
| 13304 | "@aws-cdk/aws-lambda.IFunction",
|
| 13305 | "@aws-cdk/aws-ec2.IClientVpnConnectionHandler"
|
| 13306 | ],
|
| 13307 | "kind": "class",
|
| 13308 | "locationInModule": {
|
| 13309 | "filename": "lib/function-base.ts",
|
| 13310 | "line": 228
|
| 13311 | },
|
| 13312 | "methods": [
|
| 13313 | {
|
| 13314 | "docs": {
|
| 13315 | "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```\nimport { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';\nmyFunction.addEventSource(new SqsEventSource(myQueue));\n```",
|
| 13316 | "stability": "stable",
|
| 13317 | "summary": "Adds an event source to this function."
|
| 13318 | },
|
| 13319 | "locationInModule": {
|
| 13320 | "filename": "lib/function-base.ts",
|
| 13321 | "line": 452
|
| 13322 | },
|
| 13323 | "name": "addEventSource",
|
| 13324 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13325 | "parameters": [
|
| 13326 | {
|
| 13327 | "name": "source",
|
| 13328 | "type": {
|
| 13329 | "fqn": "@aws-cdk/aws-lambda.IEventSource"
|
| 13330 | }
|
| 13331 | }
|
| 13332 | ]
|
| 13333 | },
|
| 13334 | {
|
| 13335 | "docs": {
|
| 13336 | "stability": "stable",
|
| 13337 | "summary": "Adds an event source that maps to this AWS Lambda function."
|
| 13338 | },
|
| 13339 | "locationInModule": {
|
| 13340 | "filename": "lib/function-base.ts",
|
| 13341 | "line": 407
|
| 13342 | },
|
| 13343 | "name": "addEventSourceMapping",
|
| 13344 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13345 | "parameters": [
|
| 13346 | {
|
| 13347 | "name": "id",
|
| 13348 | "type": {
|
| 13349 | "primitive": "string"
|
| 13350 | }
|
| 13351 | },
|
| 13352 | {
|
| 13353 | "name": "options",
|
| 13354 | "type": {
|
| 13355 | "fqn": "@aws-cdk/aws-lambda.EventSourceMappingOptions"
|
| 13356 | }
|
| 13357 | }
|
| 13358 | ],
|
| 13359 | "returns": {
|
| 13360 | "type": {
|
| 13361 | "fqn": "@aws-cdk/aws-lambda.EventSourceMapping"
|
| 13362 | }
|
| 13363 | }
|
| 13364 | },
|
| 13365 | {
|
| 13366 | "docs": {
|
| 13367 | "stability": "stable",
|
| 13368 | "summary": "Adds a url to this lambda function."
|
| 13369 | },
|
| 13370 | "locationInModule": {
|
| 13371 | "filename": "lib/function-base.ts",
|
| 13372 | "line": 467
|
| 13373 | },
|
| 13374 | "name": "addFunctionUrl",
|
| 13375 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13376 | "parameters": [
|
| 13377 | {
|
| 13378 | "name": "options",
|
| 13379 | "optional": true,
|
| 13380 | "type": {
|
| 13381 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlOptions"
|
| 13382 | }
|
| 13383 | }
|
| 13384 | ],
|
| 13385 | "returns": {
|
| 13386 | "type": {
|
| 13387 | "fqn": "@aws-cdk/aws-lambda.FunctionUrl"
|
| 13388 | }
|
| 13389 | }
|
| 13390 | },
|
| 13391 | {
|
| 13392 | "docs": {
|
| 13393 | "see": "Permission for details.",
|
| 13394 | "stability": "stable",
|
| 13395 | "summary": "Adds a permission to the Lambda resource policy."
|
| 13396 | },
|
| 13397 | "locationInModule": {
|
| 13398 | "filename": "lib/function-base.ts",
|
| 13399 | "line": 343
|
| 13400 | },
|
| 13401 | "name": "addPermission",
|
| 13402 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13403 | "parameters": [
|
| 13404 | {
|
| 13405 | "docs": {
|
| 13406 | "summary": "The id for the permission construct."
|
| 13407 | },
|
| 13408 | "name": "id",
|
| 13409 | "type": {
|
| 13410 | "primitive": "string"
|
| 13411 | }
|
| 13412 | },
|
| 13413 | {
|
| 13414 | "docs": {
|
| 13415 | "summary": "The permission to grant to this Lambda function."
|
| 13416 | },
|
| 13417 | "name": "permission",
|
| 13418 | "type": {
|
| 13419 | "fqn": "@aws-cdk/aws-lambda.Permission"
|
| 13420 | }
|
| 13421 | }
|
| 13422 | ]
|
| 13423 | },
|
| 13424 | {
|
| 13425 | "docs": {
|
| 13426 | "stability": "stable",
|
| 13427 | "summary": "Adds a statement to the IAM role assumed by the instance."
|
| 13428 | },
|
| 13429 | "locationInModule": {
|
| 13430 | "filename": "lib/function-base.ts",
|
| 13431 | "line": 370
|
| 13432 | },
|
| 13433 | "name": "addToRolePolicy",
|
| 13434 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13435 | "parameters": [
|
| 13436 | {
|
| 13437 | "name": "statement",
|
| 13438 | "type": {
|
| 13439 | "fqn": "@aws-cdk/aws-iam.PolicyStatement"
|
| 13440 | }
|
| 13441 | }
|
| 13442 | ]
|
| 13443 | },
|
| 13444 | {
|
| 13445 | "docs": {
|
| 13446 | "stability": "stable",
|
| 13447 | "summary": "Configures options for asynchronous invocation."
|
| 13448 | },
|
| 13449 | "locationInModule": {
|
| 13450 | "filename": "lib/function-base.ts",
|
| 13451 | "line": 456
|
| 13452 | },
|
| 13453 | "name": "configureAsyncInvoke",
|
| 13454 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13455 | "parameters": [
|
| 13456 | {
|
| 13457 | "name": "options",
|
| 13458 | "type": {
|
| 13459 | "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions"
|
| 13460 | }
|
| 13461 | }
|
| 13462 | ]
|
| 13463 | },
|
| 13464 | {
|
| 13465 | "docs": {
|
| 13466 | "remarks": "- function.currentVersion is invoked before or after the permission is created.\n\nThis applies only to permissions on Lambda functions, not versions or aliases.\nThis function is overridden as a noOp for QualifiedFunctionBase.",
|
| 13467 | "stability": "stable",
|
| 13468 | "summary": "A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function."
|
| 13469 | },
|
| 13470 | "locationInModule": {
|
| 13471 | "filename": "lib/function-base.ts",
|
| 13472 | "line": 319
|
| 13473 | },
|
| 13474 | "name": "considerWarningOnInvokeFunctionPermissions",
|
| 13475 | "parameters": [
|
| 13476 | {
|
| 13477 | "name": "scope",
|
| 13478 | "type": {
|
| 13479 | "fqn": "@aws-cdk/core.Construct"
|
| 13480 | }
|
| 13481 | },
|
| 13482 | {
|
| 13483 | "name": "action",
|
| 13484 | "type": {
|
| 13485 | "primitive": "string"
|
| 13486 | }
|
| 13487 | }
|
| 13488 | ]
|
| 13489 | },
|
| 13490 | {
|
| 13491 | "docs": {
|
| 13492 | "stability": "stable",
|
| 13493 | "summary": "Grant the given identity permissions to invoke this Lambda."
|
| 13494 | },
|
| 13495 | "locationInModule": {
|
| 13496 | "filename": "lib/function-base.ts",
|
| 13497 | "line": 417
|
| 13498 | },
|
| 13499 | "name": "grantInvoke",
|
| 13500 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13501 | "parameters": [
|
| 13502 | {
|
| 13503 | "name": "grantee",
|
| 13504 | "type": {
|
| 13505 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
| 13506 | }
|
| 13507 | }
|
| 13508 | ],
|
| 13509 | "returns": {
|
| 13510 | "type": {
|
| 13511 | "fqn": "@aws-cdk/aws-iam.Grant"
|
| 13512 | }
|
| 13513 | }
|
| 13514 | },
|
| 13515 | {
|
| 13516 | "docs": {
|
| 13517 | "stability": "stable",
|
| 13518 | "summary": "Grant the given identity permissions to invoke this Lambda Function URL."
|
| 13519 | },
|
| 13520 | "locationInModule": {
|
| 13521 | "filename": "lib/function-base.ts",
|
| 13522 | "line": 438
|
| 13523 | },
|
| 13524 | "name": "grantInvokeUrl",
|
| 13525 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13526 | "parameters": [
|
| 13527 | {
|
| 13528 | "name": "grantee",
|
| 13529 | "type": {
|
| 13530 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
| 13531 | }
|
| 13532 | }
|
| 13533 | ],
|
| 13534 | "returns": {
|
| 13535 | "type": {
|
| 13536 | "fqn": "@aws-cdk/aws-iam.Grant"
|
| 13537 | }
|
| 13538 | }
|
| 13539 | },
|
| 13540 | {
|
| 13541 | "docs": {
|
| 13542 | "stability": "stable",
|
| 13543 | "summary": "Return the given named metric for this Function."
|
| 13544 | },
|
| 13545 | "locationInModule": {
|
| 13546 | "filename": "lib/lambda-augmentations.generated.ts",
|
| 13547 | "line": 41
|
| 13548 | },
|
| 13549 | "name": "metric",
|
| 13550 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13551 | "parameters": [
|
| 13552 | {
|
| 13553 | "name": "metricName",
|
| 13554 | "type": {
|
| 13555 | "primitive": "string"
|
| 13556 | }
|
| 13557 | },
|
| 13558 | {
|
| 13559 | "name": "props",
|
| 13560 | "optional": true,
|
| 13561 | "type": {
|
| 13562 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 13563 | }
|
| 13564 | }
|
| 13565 | ],
|
| 13566 | "returns": {
|
| 13567 | "type": {
|
| 13568 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 13569 | }
|
| 13570 | }
|
| 13571 | },
|
| 13572 | {
|
| 13573 | "docs": {
|
| 13574 | "remarks": "Average over 5 minutes",
|
| 13575 | "stability": "stable",
|
| 13576 | "summary": "How long execution of this Lambda takes."
|
| 13577 | },
|
| 13578 | "locationInModule": {
|
| 13579 | "filename": "lib/lambda-augmentations.generated.ts",
|
| 13580 | "line": 65
|
| 13581 | },
|
| 13582 | "name": "metricDuration",
|
| 13583 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13584 | "parameters": [
|
| 13585 | {
|
| 13586 | "name": "props",
|
| 13587 | "optional": true,
|
| 13588 | "type": {
|
| 13589 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 13590 | }
|
| 13591 | }
|
| 13592 | ],
|
| 13593 | "returns": {
|
| 13594 | "type": {
|
| 13595 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 13596 | }
|
| 13597 | }
|
| 13598 | },
|
| 13599 | {
|
| 13600 | "docs": {
|
| 13601 | "remarks": "Sum over 5 minutes",
|
| 13602 | "stability": "stable",
|
| 13603 | "summary": "How many invocations of this Lambda fail."
|
| 13604 | },
|
| 13605 | "locationInModule": {
|
| 13606 | "filename": "lib/lambda-augmentations.generated.ts",
|
| 13607 | "line": 59
|
| 13608 | },
|
| 13609 | "name": "metricErrors",
|
| 13610 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13611 | "parameters": [
|
| 13612 | {
|
| 13613 | "name": "props",
|
| 13614 | "optional": true,
|
| 13615 | "type": {
|
| 13616 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 13617 | }
|
| 13618 | }
|
| 13619 | ],
|
| 13620 | "returns": {
|
| 13621 | "type": {
|
| 13622 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 13623 | }
|
| 13624 | }
|
| 13625 | },
|
| 13626 | {
|
| 13627 | "docs": {
|
| 13628 | "remarks": "Sum over 5 minutes",
|
| 13629 | "stability": "stable",
|
| 13630 | "summary": "How often this Lambda is invoked."
|
| 13631 | },
|
| 13632 | "locationInModule": {
|
| 13633 | "filename": "lib/lambda-augmentations.generated.ts",
|
| 13634 | "line": 53
|
| 13635 | },
|
| 13636 | "name": "metricInvocations",
|
| 13637 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13638 | "parameters": [
|
| 13639 | {
|
| 13640 | "name": "props",
|
| 13641 | "optional": true,
|
| 13642 | "type": {
|
| 13643 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 13644 | }
|
| 13645 | }
|
| 13646 | ],
|
| 13647 | "returns": {
|
| 13648 | "type": {
|
| 13649 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 13650 | }
|
| 13651 | }
|
| 13652 | },
|
| 13653 | {
|
| 13654 | "docs": {
|
| 13655 | "remarks": "Sum over 5 minutes",
|
| 13656 | "stability": "stable",
|
| 13657 | "summary": "How often this Lambda is throttled."
|
| 13658 | },
|
| 13659 | "locationInModule": {
|
| 13660 | "filename": "lib/lambda-augmentations.generated.ts",
|
| 13661 | "line": 47
|
| 13662 | },
|
| 13663 | "name": "metricThrottles",
|
| 13664 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13665 | "parameters": [
|
| 13666 | {
|
| 13667 | "name": "props",
|
| 13668 | "optional": true,
|
| 13669 | "type": {
|
| 13670 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 13671 | }
|
| 13672 | }
|
| 13673 | ],
|
| 13674 | "returns": {
|
| 13675 | "type": {
|
| 13676 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 13677 | }
|
| 13678 | }
|
| 13679 | },
|
| 13680 | {
|
| 13681 | "docs": {
|
| 13682 | "stability": "stable"
|
| 13683 | },
|
| 13684 | "locationInModule": {
|
| 13685 | "filename": "lib/function-base.ts",
|
| 13686 | "line": 330
|
| 13687 | },
|
| 13688 | "name": "warnInvokeFunctionPermissions",
|
| 13689 | "parameters": [
|
| 13690 | {
|
| 13691 | "name": "scope",
|
| 13692 | "type": {
|
| 13693 | "fqn": "@aws-cdk/core.Construct"
|
| 13694 | }
|
| 13695 | }
|
| 13696 | ],
|
| 13697 | "protected": true
|
| 13698 | }
|
| 13699 | ],
|
| 13700 | "name": "FunctionBase",
|
| 13701 | "properties": [
|
| 13702 | {
|
| 13703 | "abstract": true,
|
| 13704 | "docs": {
|
| 13705 | "stability": "stable",
|
| 13706 | "summary": "The architecture of this Lambda Function."
|
| 13707 | },
|
| 13708 | "immutable": true,
|
| 13709 | "locationInModule": {
|
| 13710 | "filename": "lib/function-base.ts",
|
| 13711 | "line": 259
|
| 13712 | },
|
| 13713 | "name": "architecture",
|
| 13714 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13715 | "type": {
|
| 13716 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 13717 | }
|
| 13718 | },
|
| 13719 | {
|
| 13720 | "abstract": true,
|
| 13721 | "docs": {
|
| 13722 | "remarks": "True for new Lambdas, false for version $LATEST and imported Lambdas\nfrom different accounts.",
|
| 13723 | "stability": "stable",
|
| 13724 | "summary": "Whether the addPermission() call adds any permissions."
|
| 13725 | },
|
| 13726 | "immutable": true,
|
| 13727 | "locationInModule": {
|
| 13728 | "filename": "lib/function-base.ts",
|
| 13729 | "line": 267
|
| 13730 | },
|
| 13731 | "name": "canCreatePermissions",
|
| 13732 | "protected": true,
|
| 13733 | "type": {
|
| 13734 | "primitive": "boolean"
|
| 13735 | }
|
| 13736 | },
|
| 13737 | {
|
| 13738 | "docs": {
|
| 13739 | "remarks": "Will fail if not a VPC-enabled Lambda Function",
|
| 13740 | "stability": "stable",
|
| 13741 | "summary": "Access the Connections object."
|
| 13742 | },
|
| 13743 | "immutable": true,
|
| 13744 | "locationInModule": {
|
| 13745 | "filename": "lib/function-base.ts",
|
| 13746 | "line": 383
|
| 13747 | },
|
| 13748 | "name": "connections",
|
| 13749 | "overrides": "@aws-cdk/aws-ec2.IConnectable",
|
| 13750 | "type": {
|
| 13751 | "fqn": "@aws-cdk/aws-ec2.Connections"
|
| 13752 | }
|
| 13753 | },
|
| 13754 | {
|
| 13755 | "abstract": true,
|
| 13756 | "docs": {
|
| 13757 | "stability": "stable",
|
| 13758 | "summary": "The ARN fo the function."
|
| 13759 | },
|
| 13760 | "immutable": true,
|
| 13761 | "locationInModule": {
|
| 13762 | "filename": "lib/function-base.ts",
|
| 13763 | "line": 242
|
| 13764 | },
|
| 13765 | "name": "functionArn",
|
| 13766 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13767 | "type": {
|
| 13768 | "primitive": "string"
|
| 13769 | }
|
| 13770 | },
|
| 13771 | {
|
| 13772 | "abstract": true,
|
| 13773 | "docs": {
|
| 13774 | "stability": "stable",
|
| 13775 | "summary": "The name of the function."
|
| 13776 | },
|
| 13777 | "immutable": true,
|
| 13778 | "locationInModule": {
|
| 13779 | "filename": "lib/function-base.ts",
|
| 13780 | "line": 237
|
| 13781 | },
|
| 13782 | "name": "functionName",
|
| 13783 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13784 | "type": {
|
| 13785 | "primitive": "string"
|
| 13786 | }
|
| 13787 | },
|
| 13788 | {
|
| 13789 | "abstract": true,
|
| 13790 | "docs": {
|
| 13791 | "stability": "stable",
|
| 13792 | "summary": "The principal this Lambda Function is running as."
|
| 13793 | },
|
| 13794 | "immutable": true,
|
| 13795 | "locationInModule": {
|
| 13796 | "filename": "lib/function-base.ts",
|
| 13797 | "line": 232
|
| 13798 | },
|
| 13799 | "name": "grantPrincipal",
|
| 13800 | "overrides": "@aws-cdk/aws-iam.IGrantable",
|
| 13801 | "type": {
|
| 13802 | "fqn": "@aws-cdk/aws-iam.IPrincipal"
|
| 13803 | }
|
| 13804 | },
|
| 13805 | {
|
| 13806 | "docs": {
|
| 13807 | "remarks": "If this is is `false`, trying to access the `connections` object will fail.",
|
| 13808 | "stability": "stable",
|
| 13809 | "summary": "Whether or not this Lambda function was bound to a VPC."
|
| 13810 | },
|
| 13811 | "immutable": true,
|
| 13812 | "locationInModule": {
|
| 13813 | "filename": "lib/function-base.ts",
|
| 13814 | "line": 403
|
| 13815 | },
|
| 13816 | "name": "isBoundToVpc",
|
| 13817 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13818 | "type": {
|
| 13819 | "primitive": "boolean"
|
| 13820 | }
|
| 13821 | },
|
| 13822 | {
|
| 13823 | "docs": {
|
| 13824 | "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.",
|
| 13825 | "stability": "stable",
|
| 13826 | "summary": "The `$LATEST` version of this function."
|
| 13827 | },
|
| 13828 | "immutable": true,
|
| 13829 | "locationInModule": {
|
| 13830 | "filename": "lib/function-base.ts",
|
| 13831 | "line": 391
|
| 13832 | },
|
| 13833 | "name": "latestVersion",
|
| 13834 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13835 | "type": {
|
| 13836 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 13837 | }
|
| 13838 | },
|
| 13839 | {
|
| 13840 | "abstract": true,
|
| 13841 | "docs": {
|
| 13842 | "stability": "stable",
|
| 13843 | "summary": "The construct node where permissions are attached."
|
| 13844 | },
|
| 13845 | "immutable": true,
|
| 13846 | "locationInModule": {
|
| 13847 | "filename": "lib/function-base.ts",
|
| 13848 | "line": 254
|
| 13849 | },
|
| 13850 | "name": "permissionsNode",
|
| 13851 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13852 | "type": {
|
| 13853 | "fqn": "@aws-cdk/core.ConstructNode"
|
| 13854 | }
|
| 13855 | },
|
| 13856 | {
|
| 13857 | "abstract": true,
|
| 13858 | "docs": {
|
| 13859 | "stability": "stable",
|
| 13860 | "summary": "The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()."
|
| 13861 | },
|
| 13862 | "immutable": true,
|
| 13863 | "locationInModule": {
|
| 13864 | "filename": "lib/function-base.ts",
|
| 13865 | "line": 272
|
| 13866 | },
|
| 13867 | "name": "resourceArnsForGrantInvoke",
|
| 13868 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13869 | "type": {
|
| 13870 | "collection": {
|
| 13871 | "elementtype": {
|
| 13872 | "primitive": "string"
|
| 13873 | },
|
| 13874 | "kind": "array"
|
| 13875 | }
|
| 13876 | }
|
| 13877 | },
|
| 13878 | {
|
| 13879 | "abstract": true,
|
| 13880 | "docs": {
|
| 13881 | "remarks": "Undefined if the function was imported without a role.",
|
| 13882 | "stability": "stable",
|
| 13883 | "summary": "The IAM role associated with this function."
|
| 13884 | },
|
| 13885 | "immutable": true,
|
| 13886 | "locationInModule": {
|
| 13887 | "filename": "lib/function-base.ts",
|
| 13888 | "line": 249
|
| 13889 | },
|
| 13890 | "name": "role",
|
| 13891 | "optional": true,
|
| 13892 | "overrides": "@aws-cdk/aws-lambda.IFunction",
|
| 13893 | "type": {
|
| 13894 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 13895 | }
|
| 13896 | }
|
| 13897 | ],
|
| 13898 | "symbolId": "lib/function-base:FunctionBase"
|
| 13899 | },
|
| 13900 | "@aws-cdk/aws-lambda.FunctionOptions": {
|
| 13901 | "assembly": "@aws-cdk/aws-lambda",
|
| 13902 | "datatype": true,
|
| 13903 | "docs": {
|
| 13904 | "stability": "stable",
|
| 13905 | "summary": "Non runtime options.",
|
| 13906 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as codeguruprofiler from '@aws-cdk/aws-codeguruprofiler';\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as sns from '@aws-cdk/aws-sns';\nimport * as sqs from '@aws-cdk/aws-sqs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const architecture: lambda.Architecture;\ndeclare const codeSigningConfig: lambda.CodeSigningConfig;\ndeclare const destination: lambda.IDestination;\ndeclare const eventSource: lambda.IEventSource;\ndeclare const fileSystem: lambda.FileSystem;\ndeclare const key: kms.Key;\ndeclare const lambdaInsightsVersion: lambda.LambdaInsightsVersion;\ndeclare const layerVersion: lambda.LayerVersion;\ndeclare const policyStatement: iam.PolicyStatement;\ndeclare const profilingGroup: codeguruprofiler.ProfilingGroup;\ndeclare const queue: sqs.Queue;\ndeclare const role: iam.Role;\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const size: cdk.Size;\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const topic: sns.Topic;\ndeclare const vpc: ec2.Vpc;\nconst functionOptions: lambda.FunctionOptions = {\n allowAllOutbound: false,\n allowPublicSubnet: false,\n architecture: architecture,\n architectures: [architecture],\n codeSigningConfig: codeSigningConfig,\n currentVersionOptions: {\n codeSha256: 'codeSha256',\n description: 'description',\n maxEventAge: cdk.Duration.minutes(30),\n onFailure: destination,\n onSuccess: destination,\n provisionedConcurrentExecutions: 123,\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n retryAttempts: 123,\n },\n deadLetterQueue: queue,\n deadLetterQueueEnabled: false,\n deadLetterTopic: topic,\n description: 'description',\n environment: {\n environmentKey: 'environment',\n },\n environmentEncryption: key,\n ephemeralStorageSize: size,\n events: [eventSource],\n filesystem: fileSystem,\n functionName: 'functionName',\n initialPolicy: [policyStatement],\n insightsVersion: lambdaInsightsVersion,\n layers: [layerVersion],\n logRetention: logs.RetentionDays.ONE_DAY,\n logRetentionRetryOptions: {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n },\n logRetentionRole: role,\n maxEventAge: cdk.Duration.minutes(30),\n memorySize: 123,\n onFailure: destination,\n onSuccess: destination,\n profiling: false,\n profilingGroup: profilingGroup,\n reservedConcurrentExecutions: 123,\n retryAttempts: 123,\n role: role,\n securityGroup: securityGroup,\n securityGroups: [securityGroup],\n timeout: cdk.Duration.minutes(30),\n tracing: lambda.Tracing.ACTIVE,\n vpc: vpc,\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n};",
|
| 13907 | "custom": {
|
| 13908 | "exampleMetadata": "fixture=_generated"
|
| 13909 | }
|
| 13910 | },
|
| 13911 | "fqn": "@aws-cdk/aws-lambda.FunctionOptions",
|
| 13912 | "interfaces": [
|
| 13913 | "@aws-cdk/aws-lambda.EventInvokeConfigOptions"
|
| 13914 | ],
|
| 13915 | "kind": "interface",
|
| 13916 | "locationInModule": {
|
| 13917 | "filename": "lib/function.ts",
|
| 13918 | "line": 56
|
| 13919 | },
|
| 13920 | "name": "FunctionOptions",
|
| 13921 | "properties": [
|
| 13922 | {
|
| 13923 | "abstract": true,
|
| 13924 | "docs": {
|
| 13925 | "default": "true",
|
| 13926 | "remarks": "If set to false, you must individually add traffic rules to allow the\nLambda to connect to network targets.",
|
| 13927 | "stability": "stable",
|
| 13928 | "summary": "Whether to allow the Lambda to send all network traffic."
|
| 13929 | },
|
| 13930 | "immutable": true,
|
| 13931 | "locationInModule": {
|
| 13932 | "filename": "lib/function.ts",
|
| 13933 | "line": 190
|
| 13934 | },
|
| 13935 | "name": "allowAllOutbound",
|
| 13936 | "optional": true,
|
| 13937 | "type": {
|
| 13938 | "primitive": "boolean"
|
| 13939 | }
|
| 13940 | },
|
| 13941 | {
|
| 13942 | "abstract": true,
|
| 13943 | "docs": {
|
| 13944 | "default": "false",
|
| 13945 | "remarks": "Use this property to acknowledge this limitation and still place the function in a public subnet.",
|
| 13946 | "see": "https://stackoverflow.com/questions/52992085/why-cant-an-aws-lambda-function-inside-a-public-subnet-in-a-vpc-connect-to-the/52994841#52994841",
|
| 13947 | "stability": "stable",
|
| 13948 | "summary": "Lambda Functions in a public subnet can NOT access the internet."
|
| 13949 | },
|
| 13950 | "immutable": true,
|
| 13951 | "locationInModule": {
|
| 13952 | "filename": "lib/function.ts",
|
| 13953 | "line": 324
|
| 13954 | },
|
| 13955 | "name": "allowPublicSubnet",
|
| 13956 | "optional": true,
|
| 13957 | "type": {
|
| 13958 | "primitive": "boolean"
|
| 13959 | }
|
| 13960 | },
|
| 13961 | {
|
| 13962 | "abstract": true,
|
| 13963 | "docs": {
|
| 13964 | "default": "Architecture.X86_64",
|
| 13965 | "stability": "stable",
|
| 13966 | "summary": "The system architectures compatible with this lambda function."
|
| 13967 | },
|
| 13968 | "immutable": true,
|
| 13969 | "locationInModule": {
|
| 13970 | "filename": "lib/function.ts",
|
| 13971 | "line": 351
|
| 13972 | },
|
| 13973 | "name": "architecture",
|
| 13974 | "optional": true,
|
| 13975 | "type": {
|
| 13976 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 13977 | }
|
| 13978 | },
|
| 13979 | {
|
| 13980 | "abstract": true,
|
| 13981 | "docs": {
|
| 13982 | "default": "[Architecture.X86_64]",
|
| 13983 | "deprecated": "use `architecture`",
|
| 13984 | "stability": "deprecated",
|
| 13985 | "summary": "DEPRECATED."
|
| 13986 | },
|
| 13987 | "immutable": true,
|
| 13988 | "locationInModule": {
|
| 13989 | "filename": "lib/function.ts",
|
| 13990 | "line": 345
|
| 13991 | },
|
| 13992 | "name": "architectures",
|
| 13993 | "optional": true,
|
| 13994 | "type": {
|
| 13995 | "collection": {
|
| 13996 | "elementtype": {
|
| 13997 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 13998 | },
|
| 13999 | "kind": "array"
|
| 14000 | }
|
| 14001 | }
|
| 14002 | },
|
| 14003 | {
|
| 14004 | "abstract": true,
|
| 14005 | "docs": {
|
| 14006 | "default": "- Not Sign the Code",
|
| 14007 | "stability": "stable",
|
| 14008 | "summary": "Code signing config associated with this function."
|
| 14009 | },
|
| 14010 | "immutable": true,
|
| 14011 | "locationInModule": {
|
| 14012 | "filename": "lib/function.ts",
|
| 14013 | "line": 338
|
| 14014 | },
|
| 14015 | "name": "codeSigningConfig",
|
| 14016 | "optional": true,
|
| 14017 | "type": {
|
| 14018 | "fqn": "@aws-cdk/aws-lambda.ICodeSigningConfig"
|
| 14019 | }
|
| 14020 | },
|
| 14021 | {
|
| 14022 | "abstract": true,
|
| 14023 | "docs": {
|
| 14024 | "default": "- default options as described in `VersionOptions`",
|
| 14025 | "stability": "stable",
|
| 14026 | "summary": "Options for the `lambda.Version` resource automatically created by the `fn.currentVersion` method."
|
| 14027 | },
|
| 14028 | "immutable": true,
|
| 14029 | "locationInModule": {
|
| 14030 | "filename": "lib/function.ts",
|
| 14031 | "line": 308
|
| 14032 | },
|
| 14033 | "name": "currentVersionOptions",
|
| 14034 | "optional": true,
|
| 14035 | "type": {
|
| 14036 | "fqn": "@aws-cdk/aws-lambda.VersionOptions"
|
| 14037 | }
|
| 14038 | },
|
| 14039 | {
|
| 14040 | "abstract": true,
|
| 14041 | "docs": {
|
| 14042 | "default": "- SQS queue with 14 day retention period if `deadLetterQueueEnabled` is `true`",
|
| 14043 | "remarks": "If SNS topic is desired, specify `deadLetterTopic` property instead.",
|
| 14044 | "stability": "stable",
|
| 14045 | "summary": "The SQS queue to use if DLQ is enabled."
|
| 14046 | },
|
| 14047 | "immutable": true,
|
| 14048 | "locationInModule": {
|
| 14049 | "filename": "lib/function.ts",
|
| 14050 | "line": 206
|
| 14051 | },
|
| 14052 | "name": "deadLetterQueue",
|
| 14053 | "optional": true,
|
| 14054 | "type": {
|
| 14055 | "fqn": "@aws-cdk/aws-sqs.IQueue"
|
| 14056 | }
|
| 14057 | },
|
| 14058 | {
|
| 14059 | "abstract": true,
|
| 14060 | "docs": {
|
| 14061 | "default": "- false unless `deadLetterQueue` is set, which implies DLQ is enabled.",
|
| 14062 | "remarks": "If `deadLetterQueue` is undefined,\nan SQS queue with default options will be defined for your Function.",
|
| 14063 | "stability": "stable",
|
| 14064 | "summary": "Enabled DLQ."
|
| 14065 | },
|
| 14066 | "immutable": true,
|
| 14067 | "locationInModule": {
|
| 14068 | "filename": "lib/function.ts",
|
| 14069 | "line": 198
|
| 14070 | },
|
| 14071 | "name": "deadLetterQueueEnabled",
|
| 14072 | "optional": true,
|
| 14073 | "type": {
|
| 14074 | "primitive": "boolean"
|
| 14075 | }
|
| 14076 | },
|
| 14077 | {
|
| 14078 | "abstract": true,
|
| 14079 | "docs": {
|
| 14080 | "default": "- no SNS topic",
|
| 14081 | "remarks": "Note that if `deadLetterQueueEnabled` is set to `true`, an SQS queue will be created\nrather than an SNS topic. Using an SNS topic as a DLQ requires this property to be set explicitly.",
|
| 14082 | "stability": "stable",
|
| 14083 | "summary": "The SNS topic to use as a DLQ."
|
| 14084 | },
|
| 14085 | "immutable": true,
|
| 14086 | "locationInModule": {
|
| 14087 | "filename": "lib/function.ts",
|
| 14088 | "line": 215
|
| 14089 | },
|
| 14090 | "name": "deadLetterTopic",
|
| 14091 | "optional": true,
|
| 14092 | "type": {
|
| 14093 | "fqn": "@aws-cdk/aws-sns.ITopic"
|
| 14094 | }
|
| 14095 | },
|
| 14096 | {
|
| 14097 | "abstract": true,
|
| 14098 | "docs": {
|
| 14099 | "default": "- No description.",
|
| 14100 | "stability": "stable",
|
| 14101 | "summary": "A description of the function."
|
| 14102 | },
|
| 14103 | "immutable": true,
|
| 14104 | "locationInModule": {
|
| 14105 | "filename": "lib/function.ts",
|
| 14106 | "line": 62
|
| 14107 | },
|
| 14108 | "name": "description",
|
| 14109 | "optional": true,
|
| 14110 | "type": {
|
| 14111 | "primitive": "string"
|
| 14112 | }
|
| 14113 | },
|
| 14114 | {
|
| 14115 | "abstract": true,
|
| 14116 | "docs": {
|
| 14117 | "default": "- No environment variables.",
|
| 14118 | "remarks": "Use environment variables to apply configuration changes, such\nas test and production environment configurations, without changing your\nLambda function source code.",
|
| 14119 | "stability": "stable",
|
| 14120 | "summary": "Key-value pairs that Lambda caches and makes available for your Lambda functions."
|
| 14121 | },
|
| 14122 | "immutable": true,
|
| 14123 | "locationInModule": {
|
| 14124 | "filename": "lib/function.ts",
|
| 14125 | "line": 81
|
| 14126 | },
|
| 14127 | "name": "environment",
|
| 14128 | "optional": true,
|
| 14129 | "type": {
|
| 14130 | "collection": {
|
| 14131 | "elementtype": {
|
| 14132 | "primitive": "string"
|
| 14133 | },
|
| 14134 | "kind": "map"
|
| 14135 | }
|
| 14136 | }
|
| 14137 | },
|
| 14138 | {
|
| 14139 | "abstract": true,
|
| 14140 | "docs": {
|
| 14141 | "default": "- AWS Lambda creates and uses an AWS managed customer master key (CMK).",
|
| 14142 | "stability": "stable",
|
| 14143 | "summary": "The AWS KMS key that's used to encrypt your function's environment variables."
|
| 14144 | },
|
| 14145 | "immutable": true,
|
| 14146 | "locationInModule": {
|
| 14147 | "filename": "lib/function.ts",
|
| 14148 | "line": 331
|
| 14149 | },
|
| 14150 | "name": "environmentEncryption",
|
| 14151 | "optional": true,
|
| 14152 | "type": {
|
| 14153 | "fqn": "@aws-cdk/aws-kms.IKey"
|
| 14154 | }
|
| 14155 | },
|
| 14156 | {
|
| 14157 | "abstract": true,
|
| 14158 | "docs": {
|
| 14159 | "default": "512 MiB",
|
| 14160 | "stability": "stable",
|
| 14161 | "summary": "The size of the function’s /tmp directory in MiB."
|
| 14162 | },
|
| 14163 | "immutable": true,
|
| 14164 | "locationInModule": {
|
| 14165 | "filename": "lib/function.ts",
|
| 14166 | "line": 106
|
| 14167 | },
|
| 14168 | "name": "ephemeralStorageSize",
|
| 14169 | "optional": true,
|
| 14170 | "type": {
|
| 14171 | "fqn": "@aws-cdk/core.Size"
|
| 14172 | }
|
| 14173 | },
|
| 14174 | {
|
| 14175 | "abstract": true,
|
| 14176 | "docs": {
|
| 14177 | "default": "- No event sources.",
|
| 14178 | "remarks": "You can also add event sources using `addEventSource`.",
|
| 14179 | "stability": "stable",
|
| 14180 | "summary": "Event sources for this function."
|
| 14181 | },
|
| 14182 | "immutable": true,
|
| 14183 | "locationInModule": {
|
| 14184 | "filename": "lib/function.ts",
|
| 14185 | "line": 276
|
| 14186 | },
|
| 14187 | "name": "events",
|
| 14188 | "optional": true,
|
| 14189 | "type": {
|
| 14190 | "collection": {
|
| 14191 | "elementtype": {
|
| 14192 | "fqn": "@aws-cdk/aws-lambda.IEventSource"
|
| 14193 | },
|
| 14194 | "kind": "array"
|
| 14195 | }
|
| 14196 | }
|
| 14197 | },
|
| 14198 | {
|
| 14199 | "abstract": true,
|
| 14200 | "docs": {
|
| 14201 | "default": "- will not mount any filesystem",
|
| 14202 | "stability": "stable",
|
| 14203 | "summary": "The filesystem configuration for the lambda function."
|
| 14204 | },
|
| 14205 | "immutable": true,
|
| 14206 | "locationInModule": {
|
| 14207 | "filename": "lib/function.ts",
|
| 14208 | "line": 315
|
| 14209 | },
|
| 14210 | "name": "filesystem",
|
| 14211 | "optional": true,
|
| 14212 | "type": {
|
| 14213 | "fqn": "@aws-cdk/aws-lambda.FileSystem"
|
| 14214 | }
|
| 14215 | },
|
| 14216 | {
|
| 14217 | "abstract": true,
|
| 14218 | "docs": {
|
| 14219 | "default": "- AWS CloudFormation generates a unique physical ID and uses that\nID for the function's name. For more information, see Name Type.",
|
| 14220 | "stability": "stable",
|
| 14221 | "summary": "A name for the function."
|
| 14222 | },
|
| 14223 | "immutable": true,
|
| 14224 | "locationInModule": {
|
| 14225 | "filename": "lib/function.ts",
|
| 14226 | "line": 89
|
| 14227 | },
|
| 14228 | "name": "functionName",
|
| 14229 | "optional": true,
|
| 14230 | "type": {
|
| 14231 | "primitive": "string"
|
| 14232 | }
|
| 14233 | },
|
| 14234 | {
|
| 14235 | "abstract": true,
|
| 14236 | "docs": {
|
| 14237 | "default": "- No policy statements are added to the created Lambda role.",
|
| 14238 | "remarks": "You can call `addToRolePolicy` to the created lambda to add statements post creation.",
|
| 14239 | "stability": "stable",
|
| 14240 | "summary": "Initial policy statements to add to the created Lambda Role."
|
| 14241 | },
|
| 14242 | "immutable": true,
|
| 14243 | "locationInModule": {
|
| 14244 | "filename": "lib/function.ts",
|
| 14245 | "line": 115
|
| 14246 | },
|
| 14247 | "name": "initialPolicy",
|
| 14248 | "optional": true,
|
| 14249 | "type": {
|
| 14250 | "collection": {
|
| 14251 | "elementtype": {
|
| 14252 | "fqn": "@aws-cdk/aws-iam.PolicyStatement"
|
| 14253 | },
|
| 14254 | "kind": "array"
|
| 14255 | }
|
| 14256 | }
|
| 14257 | },
|
| 14258 | {
|
| 14259 | "abstract": true,
|
| 14260 | "docs": {
|
| 14261 | "default": "- No Lambda Insights",
|
| 14262 | "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-Getting-Started-docker.html",
|
| 14263 | "stability": "stable",
|
| 14264 | "summary": "Specify the version of CloudWatch Lambda insights to use for monitoring."
|
| 14265 | },
|
| 14266 | "immutable": true,
|
| 14267 | "locationInModule": {
|
| 14268 | "filename": "lib/function.ts",
|
| 14269 | "line": 250
|
| 14270 | },
|
| 14271 | "name": "insightsVersion",
|
| 14272 | "optional": true,
|
| 14273 | "type": {
|
| 14274 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion"
|
| 14275 | }
|
| 14276 | },
|
| 14277 | {
|
| 14278 | "abstract": true,
|
| 14279 | "docs": {
|
| 14280 | "default": "- No layers.",
|
| 14281 | "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 multiple functions.",
|
| 14282 | "stability": "stable",
|
| 14283 | "summary": "A list of layers to add to the function's execution environment."
|
| 14284 | },
|
| 14285 | "immutable": true,
|
| 14286 | "locationInModule": {
|
| 14287 | "filename": "lib/function.ts",
|
| 14288 | "line": 259
|
| 14289 | },
|
| 14290 | "name": "layers",
|
| 14291 | "optional": true,
|
| 14292 | "type": {
|
| 14293 | "collection": {
|
| 14294 | "elementtype": {
|
| 14295 | "fqn": "@aws-cdk/aws-lambda.ILayerVersion"
|
| 14296 | },
|
| 14297 | "kind": "array"
|
| 14298 | }
|
| 14299 | }
|
| 14300 | },
|
| 14301 | {
|
| 14302 | "abstract": true,
|
| 14303 | "docs": {
|
| 14304 | "default": "logs.RetentionDays.INFINITE",
|
| 14305 | "remarks": "When updating\nthis property, unsetting it doesn't remove the log retention policy. To\nremove the retention policy, set the value to `INFINITE`.",
|
| 14306 | "stability": "stable",
|
| 14307 | "summary": "The number of days log events are kept in CloudWatch Logs."
|
| 14308 | },
|
| 14309 | "immutable": true,
|
| 14310 | "locationInModule": {
|
| 14311 | "filename": "lib/function.ts",
|
| 14312 | "line": 285
|
| 14313 | },
|
| 14314 | "name": "logRetention",
|
| 14315 | "optional": true,
|
| 14316 | "type": {
|
| 14317 | "fqn": "@aws-cdk/aws-logs.RetentionDays"
|
| 14318 | }
|
| 14319 | },
|
| 14320 | {
|
| 14321 | "abstract": true,
|
| 14322 | "docs": {
|
| 14323 | "default": "- Default AWS SDK retry options.",
|
| 14324 | "remarks": "These options control the retry policy when interacting with CloudWatch APIs.",
|
| 14325 | "stability": "stable",
|
| 14326 | "summary": "When log retention is specified, a custom resource attempts to create the CloudWatch log group."
|
| 14327 | },
|
| 14328 | "immutable": true,
|
| 14329 | "locationInModule": {
|
| 14330 | "filename": "lib/function.ts",
|
| 14331 | "line": 301
|
| 14332 | },
|
| 14333 | "name": "logRetentionRetryOptions",
|
| 14334 | "optional": true,
|
| 14335 | "type": {
|
| 14336 | "fqn": "@aws-cdk/aws-lambda.LogRetentionRetryOptions"
|
| 14337 | }
|
| 14338 | },
|
| 14339 | {
|
| 14340 | "abstract": true,
|
| 14341 | "docs": {
|
| 14342 | "default": "- A new role is created.",
|
| 14343 | "stability": "stable",
|
| 14344 | "summary": "The IAM role for the Lambda function associated with the custom resource that sets the retention policy."
|
| 14345 | },
|
| 14346 | "immutable": true,
|
| 14347 | "locationInModule": {
|
| 14348 | "filename": "lib/function.ts",
|
| 14349 | "line": 293
|
| 14350 | },
|
| 14351 | "name": "logRetentionRole",
|
| 14352 | "optional": true,
|
| 14353 | "type": {
|
| 14354 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 14355 | }
|
| 14356 | },
|
| 14357 | {
|
| 14358 | "abstract": true,
|
| 14359 | "docs": {
|
| 14360 | "default": "128",
|
| 14361 | "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.",
|
| 14362 | "stability": "stable",
|
| 14363 | "summary": "The amount of memory, in MB, that is allocated to your Lambda function."
|
| 14364 | },
|
| 14365 | "immutable": true,
|
| 14366 | "locationInModule": {
|
| 14367 | "filename": "lib/function.ts",
|
| 14368 | "line": 99
|
| 14369 | },
|
| 14370 | "name": "memorySize",
|
| 14371 | "optional": true,
|
| 14372 | "type": {
|
| 14373 | "primitive": "number"
|
| 14374 | }
|
| 14375 | },
|
| 14376 | {
|
| 14377 | "abstract": true,
|
| 14378 | "docs": {
|
| 14379 | "default": "- No profiling.",
|
| 14380 | "see": "https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html",
|
| 14381 | "stability": "stable",
|
| 14382 | "summary": "Enable profiling."
|
| 14383 | },
|
| 14384 | "immutable": true,
|
| 14385 | "locationInModule": {
|
| 14386 | "filename": "lib/function.ts",
|
| 14387 | "line": 230
|
| 14388 | },
|
| 14389 | "name": "profiling",
|
| 14390 | "optional": true,
|
| 14391 | "type": {
|
| 14392 | "primitive": "boolean"
|
| 14393 | }
|
| 14394 | },
|
| 14395 | {
|
| 14396 | "abstract": true,
|
| 14397 | "docs": {
|
| 14398 | "default": "- A new profiling group will be created if `profiling` is set.",
|
| 14399 | "see": "https://docs.aws.amazon.com/codeguru/latest/profiler-ug/setting-up-lambda.html",
|
| 14400 | "stability": "stable",
|
| 14401 | "summary": "Profiling Group."
|
| 14402 | },
|
| 14403 | "immutable": true,
|
| 14404 | "locationInModule": {
|
| 14405 | "filename": "lib/function.ts",
|
| 14406 | "line": 238
|
| 14407 | },
|
| 14408 | "name": "profilingGroup",
|
| 14409 | "optional": true,
|
| 14410 | "type": {
|
| 14411 | "fqn": "@aws-cdk/aws-codeguruprofiler.IProfilingGroup"
|
| 14412 | }
|
| 14413 | },
|
| 14414 | {
|
| 14415 | "abstract": true,
|
| 14416 | "docs": {
|
| 14417 | "default": "- No specific limit - account limit.",
|
| 14418 | "see": "https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html",
|
| 14419 | "stability": "stable",
|
| 14420 | "summary": "The maximum of concurrent executions you want to reserve for the function."
|
| 14421 | },
|
| 14422 | "immutable": true,
|
| 14423 | "locationInModule": {
|
| 14424 | "filename": "lib/function.ts",
|
| 14425 | "line": 267
|
| 14426 | },
|
| 14427 | "name": "reservedConcurrentExecutions",
|
| 14428 | "optional": true,
|
| 14429 | "type": {
|
| 14430 | "primitive": "number"
|
| 14431 | }
|
| 14432 | },
|
| 14433 | {
|
| 14434 | "abstract": true,
|
| 14435 | "docs": {
|
| 14436 | "default": "- A unique role will be generated for this lambda function.\nBoth supplied and generated roles can always be changed by calling `addToRolePolicy`.",
|
| 14437 | "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\".",
|
| 14438 | "stability": "stable",
|
| 14439 | "summary": "Lambda execution role."
|
| 14440 | },
|
| 14441 | "immutable": true,
|
| 14442 | "locationInModule": {
|
| 14443 | "filename": "lib/function.ts",
|
| 14444 | "line": 133
|
| 14445 | },
|
| 14446 | "name": "role",
|
| 14447 | "optional": true,
|
| 14448 | "type": {
|
| 14449 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 14450 | }
|
| 14451 | },
|
| 14452 | {
|
| 14453 | "abstract": true,
|
| 14454 | "docs": {
|
| 14455 | "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.",
|
| 14456 | "deprecated": "- This property is deprecated, use securityGroups instead",
|
| 14457 | "remarks": "Only used if 'vpc' is supplied.\n\nUse securityGroups property instead.\nFunction constructor will throw an error if both are specified.",
|
| 14458 | "stability": "deprecated",
|
| 14459 | "summary": "What security group to associate with the Lambda's network interfaces. This property is being deprecated, consider using securityGroups instead."
|
| 14460 | },
|
| 14461 | "immutable": true,
|
| 14462 | "locationInModule": {
|
| 14463 | "filename": "lib/function.ts",
|
| 14464 | "line": 169
|
| 14465 | },
|
| 14466 | "name": "securityGroup",
|
| 14467 | "optional": true,
|
| 14468 | "type": {
|
| 14469 | "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
|
| 14470 | }
|
| 14471 | },
|
| 14472 | {
|
| 14473 | "abstract": true,
|
| 14474 | "docs": {
|
| 14475 | "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.",
|
| 14476 | "remarks": "Only used if 'vpc' is supplied.",
|
| 14477 | "stability": "stable",
|
| 14478 | "summary": "The list of security groups to associate with the Lambda's network interfaces."
|
| 14479 | },
|
| 14480 | "immutable": true,
|
| 14481 | "locationInModule": {
|
| 14482 | "filename": "lib/function.ts",
|
| 14483 | "line": 180
|
| 14484 | },
|
| 14485 | "name": "securityGroups",
|
| 14486 | "optional": true,
|
| 14487 | "type": {
|
| 14488 | "collection": {
|
| 14489 | "elementtype": {
|
| 14490 | "fqn": "@aws-cdk/aws-ec2.ISecurityGroup"
|
| 14491 | },
|
| 14492 | "kind": "array"
|
| 14493 | }
|
| 14494 | }
|
| 14495 | },
|
| 14496 | {
|
| 14497 | "abstract": true,
|
| 14498 | "docs": {
|
| 14499 | "default": "Duration.seconds(3)",
|
| 14500 | "remarks": "Because the execution time affects cost, set this value\nbased on the function's expected execution time.",
|
| 14501 | "stability": "stable",
|
| 14502 | "summary": "The function execution time (in seconds) after which Lambda terminates the function."
|
| 14503 | },
|
| 14504 | "immutable": true,
|
| 14505 | "locationInModule": {
|
| 14506 | "filename": "lib/function.ts",
|
| 14507 | "line": 71
|
| 14508 | },
|
| 14509 | "name": "timeout",
|
| 14510 | "optional": true,
|
| 14511 | "type": {
|
| 14512 | "fqn": "@aws-cdk/core.Duration"
|
| 14513 | }
|
| 14514 | },
|
| 14515 | {
|
| 14516 | "abstract": true,
|
| 14517 | "docs": {
|
| 14518 | "default": "Tracing.Disabled",
|
| 14519 | "stability": "stable",
|
| 14520 | "summary": "Enable AWS X-Ray Tracing for Lambda Function."
|
| 14521 | },
|
| 14522 | "immutable": true,
|
| 14523 | "locationInModule": {
|
| 14524 | "filename": "lib/function.ts",
|
| 14525 | "line": 222
|
| 14526 | },
|
| 14527 | "name": "tracing",
|
| 14528 | "optional": true,
|
| 14529 | "type": {
|
| 14530 | "fqn": "@aws-cdk/aws-lambda.Tracing"
|
| 14531 | }
|
| 14532 | },
|
| 14533 | {
|
| 14534 | "abstract": true,
|
| 14535 | "docs": {
|
| 14536 | "default": "- Function is not placed within a VPC.",
|
| 14537 | "remarks": "Specify this if the Lambda function needs to access resources in a VPC.",
|
| 14538 | "stability": "stable",
|
| 14539 | "summary": "VPC network to place Lambda network interfaces."
|
| 14540 | },
|
| 14541 | "immutable": true,
|
| 14542 | "locationInModule": {
|
| 14543 | "filename": "lib/function.ts",
|
| 14544 | "line": 142
|
| 14545 | },
|
| 14546 | "name": "vpc",
|
| 14547 | "optional": true,
|
| 14548 | "type": {
|
| 14549 | "fqn": "@aws-cdk/aws-ec2.IVpc"
|
| 14550 | }
|
| 14551 | },
|
| 14552 | {
|
| 14553 | "abstract": true,
|
| 14554 | "docs": {
|
| 14555 | "default": "- the Vpc default strategy if not specified",
|
| 14556 | "remarks": "Only used if 'vpc' is supplied. Note: internet access for Lambdas\nrequires a NAT gateway, so picking Public subnets is not allowed.",
|
| 14557 | "stability": "stable",
|
| 14558 | "summary": "Where to place the network interfaces within the VPC."
|
| 14559 | },
|
| 14560 | "immutable": true,
|
| 14561 | "locationInModule": {
|
| 14562 | "filename": "lib/function.ts",
|
| 14563 | "line": 152
|
| 14564 | },
|
| 14565 | "name": "vpcSubnets",
|
| 14566 | "optional": true,
|
| 14567 | "type": {
|
| 14568 | "fqn": "@aws-cdk/aws-ec2.SubnetSelection"
|
| 14569 | }
|
| 14570 | }
|
| 14571 | ],
|
| 14572 | "symbolId": "lib/function:FunctionOptions"
|
| 14573 | },
|
| 14574 | "@aws-cdk/aws-lambda.FunctionProps": {
|
| 14575 | "assembly": "@aws-cdk/aws-lambda",
|
| 14576 | "datatype": true,
|
| 14577 | "docs": {
|
| 14578 | "stability": "stable",
|
| 14579 | "example": "import * as lambda from '@aws-cdk/aws-lambda';\n\nconst fn = new lambda.Function(this, 'MyFunc', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.Code.fromInline(`exports.handler = handler.toString()`),\n});\n\nconst rule = new events.Rule(this, 'rule', {\n eventPattern: {\n source: [\"aws.ec2\"],\n },\n});\n\nconst queue = new sqs.Queue(this, 'Queue');\n\nrule.addTarget(new targets.LambdaFunction(fn, {\n deadLetterQueue: queue, // Optional: add a dead letter queue\n maxEventAge: cdk.Duration.hours(2), // Optional: set the maxEventAge retry policy\n retryAttempts: 2, // Optional: set the max number of retry attempts\n}));",
|
| 14580 | "custom": {
|
| 14581 | "exampleMetadata": "infused"
|
| 14582 | }
|
| 14583 | },
|
| 14584 | "fqn": "@aws-cdk/aws-lambda.FunctionProps",
|
| 14585 | "interfaces": [
|
| 14586 | "@aws-cdk/aws-lambda.FunctionOptions"
|
| 14587 | ],
|
| 14588 | "kind": "interface",
|
| 14589 | "locationInModule": {
|
| 14590 | "filename": "lib/function.ts",
|
| 14591 | "line": 354
|
| 14592 | },
|
| 14593 | "name": "FunctionProps",
|
| 14594 | "properties": [
|
| 14595 | {
|
| 14596 | "abstract": true,
|
| 14597 | "docs": {
|
| 14598 | "remarks": "You can point to a file in an\nAmazon Simple Storage Service (Amazon S3) bucket or specify your source\ncode as inline text.",
|
| 14599 | "stability": "stable",
|
| 14600 | "summary": "The source code of your Lambda function."
|
| 14601 | },
|
| 14602 | "immutable": true,
|
| 14603 | "locationInModule": {
|
| 14604 | "filename": "lib/function.ts",
|
| 14605 | "line": 369
|
| 14606 | },
|
| 14607 | "name": "code",
|
| 14608 | "type": {
|
| 14609 | "fqn": "@aws-cdk/aws-lambda.Code"
|
| 14610 | }
|
| 14611 | },
|
| 14612 | {
|
| 14613 | "abstract": true,
|
| 14614 | "docs": {
|
| 14615 | "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\nUse `Handler.FROM_IMAGE` when defining a function from a Docker image.\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.",
|
| 14616 | "stability": "stable",
|
| 14617 | "summary": "The name of the method within your code that Lambda calls to execute your function."
|
| 14618 | },
|
| 14619 | "immutable": true,
|
| 14620 | "locationInModule": {
|
| 14621 | "filename": "lib/function.ts",
|
| 14622 | "line": 383
|
| 14623 | },
|
| 14624 | "name": "handler",
|
| 14625 | "type": {
|
| 14626 | "primitive": "string"
|
| 14627 | }
|
| 14628 | },
|
| 14629 | {
|
| 14630 | "abstract": true,
|
| 14631 | "docs": {
|
| 14632 | "remarks": "For valid values, see the Runtime property in the AWS Lambda Developer\nGuide.\n\nUse `Runtime.FROM_IMAGE` when when defining a function from a Docker image.",
|
| 14633 | "stability": "stable",
|
| 14634 | "summary": "The runtime environment for the Lambda function that you are uploading."
|
| 14635 | },
|
| 14636 | "immutable": true,
|
| 14637 | "locationInModule": {
|
| 14638 | "filename": "lib/function.ts",
|
| 14639 | "line": 362
|
| 14640 | },
|
| 14641 | "name": "runtime",
|
| 14642 | "type": {
|
| 14643 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 14644 | }
|
| 14645 | }
|
| 14646 | ],
|
| 14647 | "symbolId": "lib/function:FunctionProps"
|
| 14648 | },
|
| 14649 | "@aws-cdk/aws-lambda.FunctionUrl": {
|
| 14650 | "assembly": "@aws-cdk/aws-lambda",
|
| 14651 | "base": "@aws-cdk/core.Resource",
|
| 14652 | "docs": {
|
| 14653 | "custom": {
|
| 14654 | "resource": "AWS::Lambda::Url",
|
| 14655 | "exampleMetadata": "infused"
|
| 14656 | },
|
| 14657 | "stability": "stable",
|
| 14658 | "summary": "Defines a Lambda function url.",
|
| 14659 | "example": "// Can be a Function or an Alias\ndeclare const fn: lambda.Function;\ndeclare const myRole: iam.Role;\n\nconst fnUrl = fn.addFunctionUrl();\nfnUrl.grantInvokeUrl(myRole);\n\nnew CfnOutput(this, 'TheUrl', {\n // The .url attributes will return the unique Function URL\n value: fnUrl.url,\n});"
|
| 14660 | },
|
| 14661 | "fqn": "@aws-cdk/aws-lambda.FunctionUrl",
|
| 14662 | "initializer": {
|
| 14663 | "docs": {
|
| 14664 | "stability": "stable"
|
| 14665 | },
|
| 14666 | "locationInModule": {
|
| 14667 | "filename": "lib/function-url.ts",
|
| 14668 | "line": 181
|
| 14669 | },
|
| 14670 | "parameters": [
|
| 14671 | {
|
| 14672 | "name": "scope",
|
| 14673 | "type": {
|
| 14674 | "fqn": "constructs.Construct"
|
| 14675 | }
|
| 14676 | },
|
| 14677 | {
|
| 14678 | "name": "id",
|
| 14679 | "type": {
|
| 14680 | "primitive": "string"
|
| 14681 | }
|
| 14682 | },
|
| 14683 | {
|
| 14684 | "name": "props",
|
| 14685 | "type": {
|
| 14686 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlProps"
|
| 14687 | }
|
| 14688 | }
|
| 14689 | ]
|
| 14690 | },
|
| 14691 | "interfaces": [
|
| 14692 | "@aws-cdk/aws-lambda.IFunctionUrl"
|
| 14693 | ],
|
| 14694 | "kind": "class",
|
| 14695 | "locationInModule": {
|
| 14696 | "filename": "lib/function-url.ts",
|
| 14697 | "line": 168
|
| 14698 | },
|
| 14699 | "methods": [
|
| 14700 | {
|
| 14701 | "docs": {
|
| 14702 | "stability": "stable",
|
| 14703 | "summary": "Grant the given identity permissions to invoke this Lambda Function URL."
|
| 14704 | },
|
| 14705 | "locationInModule": {
|
| 14706 | "filename": "lib/function-url.ts",
|
| 14707 | "line": 219
|
| 14708 | },
|
| 14709 | "name": "grantInvokeUrl",
|
| 14710 | "overrides": "@aws-cdk/aws-lambda.IFunctionUrl",
|
| 14711 | "parameters": [
|
| 14712 | {
|
| 14713 | "name": "grantee",
|
| 14714 | "type": {
|
| 14715 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
| 14716 | }
|
| 14717 | }
|
| 14718 | ],
|
| 14719 | "returns": {
|
| 14720 | "type": {
|
| 14721 | "fqn": "@aws-cdk/aws-iam.Grant"
|
| 14722 | }
|
| 14723 | }
|
| 14724 | }
|
| 14725 | ],
|
| 14726 | "name": "FunctionUrl",
|
| 14727 | "properties": [
|
| 14728 | {
|
| 14729 | "docs": {
|
| 14730 | "stability": "stable",
|
| 14731 | "summary": "The ARN of the function this URL refers to."
|
| 14732 | },
|
| 14733 | "immutable": true,
|
| 14734 | "locationInModule": {
|
| 14735 | "filename": "lib/function-url.ts",
|
| 14736 | "line": 177
|
| 14737 | },
|
| 14738 | "name": "functionArn",
|
| 14739 | "overrides": "@aws-cdk/aws-lambda.IFunctionUrl",
|
| 14740 | "type": {
|
| 14741 | "primitive": "string"
|
| 14742 | }
|
| 14743 | },
|
| 14744 | {
|
| 14745 | "docs": {
|
| 14746 | "stability": "stable",
|
| 14747 | "summary": "The url of the Lambda function."
|
| 14748 | },
|
| 14749 | "immutable": true,
|
| 14750 | "locationInModule": {
|
| 14751 | "filename": "lib/function-url.ts",
|
| 14752 | "line": 172
|
| 14753 | },
|
| 14754 | "name": "url",
|
| 14755 | "overrides": "@aws-cdk/aws-lambda.IFunctionUrl",
|
| 14756 | "type": {
|
| 14757 | "primitive": "string"
|
| 14758 | }
|
| 14759 | }
|
| 14760 | ],
|
| 14761 | "symbolId": "lib/function-url:FunctionUrl"
|
| 14762 | },
|
| 14763 | "@aws-cdk/aws-lambda.FunctionUrlAuthType": {
|
| 14764 | "assembly": "@aws-cdk/aws-lambda",
|
| 14765 | "docs": {
|
| 14766 | "stability": "stable",
|
| 14767 | "summary": "The auth types for a function url.",
|
| 14768 | "example": "// Can be a Function or an Alias\ndeclare const fn: lambda.Function;\n\nconst fnUrl = fn.addFunctionUrl({\n authType: lambda.FunctionUrlAuthType.NONE,\n});\n\nnew CfnOutput(this, 'TheUrl', {\n value: fnUrl.url,\n});",
|
| 14769 | "custom": {
|
| 14770 | "exampleMetadata": "infused"
|
| 14771 | }
|
| 14772 | },
|
| 14773 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlAuthType",
|
| 14774 | "kind": "enum",
|
| 14775 | "locationInModule": {
|
| 14776 | "filename": "lib/function-url.ts",
|
| 14777 | "line": 12
|
| 14778 | },
|
| 14779 | "members": [
|
| 14780 | {
|
| 14781 | "docs": {
|
| 14782 | "stability": "stable",
|
| 14783 | "summary": "Restrict access to authenticated IAM users only."
|
| 14784 | },
|
| 14785 | "name": "AWS_IAM"
|
| 14786 | },
|
| 14787 | {
|
| 14788 | "docs": {
|
| 14789 | "stability": "stable",
|
| 14790 | "summary": "Bypass IAM authentication to create a public endpoint."
|
| 14791 | },
|
| 14792 | "name": "NONE"
|
| 14793 | }
|
| 14794 | ],
|
| 14795 | "name": "FunctionUrlAuthType",
|
| 14796 | "symbolId": "lib/function-url:FunctionUrlAuthType"
|
| 14797 | },
|
| 14798 | "@aws-cdk/aws-lambda.FunctionUrlCorsOptions": {
|
| 14799 | "assembly": "@aws-cdk/aws-lambda",
|
| 14800 | "datatype": true,
|
| 14801 | "docs": {
|
| 14802 | "stability": "stable",
|
| 14803 | "summary": "Specifies a cross-origin access property for a function URL.",
|
| 14804 | "example": "declare const fn: lambda.Function;\n\nfn.addFunctionUrl({\n authType: lambda.FunctionUrlAuthType.NONE,\n cors: {\n // Allow this to be called from websites on https://example.com.\n // Can also be ['*'] to allow all domain.\n allowedOrigins: ['https://example.com'],\n\n // More options are possible here, see the documentation for FunctionUrlCorsOptions\n },\n});",
|
| 14805 | "custom": {
|
| 14806 | "exampleMetadata": "infused"
|
| 14807 | }
|
| 14808 | },
|
| 14809 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlCorsOptions",
|
| 14810 | "kind": "interface",
|
| 14811 | "locationInModule": {
|
| 14812 | "filename": "lib/function-url.ts",
|
| 14813 | "line": 65
|
| 14814 | },
|
| 14815 | "name": "FunctionUrlCorsOptions",
|
| 14816 | "properties": [
|
| 14817 | {
|
| 14818 | "abstract": true,
|
| 14819 | "docs": {
|
| 14820 | "default": "false",
|
| 14821 | "stability": "stable",
|
| 14822 | "summary": "Whether to allow cookies or other credentials in requests to your function URL."
|
| 14823 | },
|
| 14824 | "immutable": true,
|
| 14825 | "locationInModule": {
|
| 14826 | "filename": "lib/function-url.ts",
|
| 14827 | "line": 71
|
| 14828 | },
|
| 14829 | "name": "allowCredentials",
|
| 14830 | "optional": true,
|
| 14831 | "type": {
|
| 14832 | "primitive": "boolean"
|
| 14833 | }
|
| 14834 | },
|
| 14835 | {
|
| 14836 | "abstract": true,
|
| 14837 | "docs": {
|
| 14838 | "default": "- No headers allowed.",
|
| 14839 | "stability": "stable",
|
| 14840 | "summary": "Headers that are specified in the Access-Control-Request-Headers header."
|
| 14841 | },
|
| 14842 | "immutable": true,
|
| 14843 | "locationInModule": {
|
| 14844 | "filename": "lib/function-url.ts",
|
| 14845 | "line": 78
|
| 14846 | },
|
| 14847 | "name": "allowedHeaders",
|
| 14848 | "optional": true,
|
| 14849 | "type": {
|
| 14850 | "collection": {
|
| 14851 | "elementtype": {
|
| 14852 | "primitive": "string"
|
| 14853 | },
|
| 14854 | "kind": "array"
|
| 14855 | }
|
| 14856 | }
|
| 14857 | },
|
| 14858 | {
|
| 14859 | "abstract": true,
|
| 14860 | "docs": {
|
| 14861 | "default": "- [HttpMethod.ALL]",
|
| 14862 | "stability": "stable",
|
| 14863 | "summary": "An HTTP method that you allow the origin to execute."
|
| 14864 | },
|
| 14865 | "immutable": true,
|
| 14866 | "locationInModule": {
|
| 14867 | "filename": "lib/function-url.ts",
|
| 14868 | "line": 85
|
| 14869 | },
|
| 14870 | "name": "allowedMethods",
|
| 14871 | "optional": true,
|
| 14872 | "type": {
|
| 14873 | "collection": {
|
| 14874 | "elementtype": {
|
| 14875 | "fqn": "@aws-cdk/aws-lambda.HttpMethod"
|
| 14876 | },
|
| 14877 | "kind": "array"
|
| 14878 | }
|
| 14879 | }
|
| 14880 | },
|
| 14881 | {
|
| 14882 | "abstract": true,
|
| 14883 | "docs": {
|
| 14884 | "default": "- No origins allowed.",
|
| 14885 | "stability": "stable",
|
| 14886 | "summary": "One or more origins you want customers to be able to access the bucket from."
|
| 14887 | },
|
| 14888 | "immutable": true,
|
| 14889 | "locationInModule": {
|
| 14890 | "filename": "lib/function-url.ts",
|
| 14891 | "line": 92
|
| 14892 | },
|
| 14893 | "name": "allowedOrigins",
|
| 14894 | "optional": true,
|
| 14895 | "type": {
|
| 14896 | "collection": {
|
| 14897 | "elementtype": {
|
| 14898 | "primitive": "string"
|
| 14899 | },
|
| 14900 | "kind": "array"
|
| 14901 | }
|
| 14902 | }
|
| 14903 | },
|
| 14904 | {
|
| 14905 | "abstract": true,
|
| 14906 | "docs": {
|
| 14907 | "default": "- No headers exposed.",
|
| 14908 | "stability": "stable",
|
| 14909 | "summary": "One or more headers in the response that you want customers to be able to access from their applications."
|
| 14910 | },
|
| 14911 | "immutable": true,
|
| 14912 | "locationInModule": {
|
| 14913 | "filename": "lib/function-url.ts",
|
| 14914 | "line": 99
|
| 14915 | },
|
| 14916 | "name": "exposedHeaders",
|
| 14917 | "optional": true,
|
| 14918 | "type": {
|
| 14919 | "collection": {
|
| 14920 | "elementtype": {
|
| 14921 | "primitive": "string"
|
| 14922 | },
|
| 14923 | "kind": "array"
|
| 14924 | }
|
| 14925 | }
|
| 14926 | },
|
| 14927 | {
|
| 14928 | "abstract": true,
|
| 14929 | "docs": {
|
| 14930 | "default": "- Browser default of 5 seconds.",
|
| 14931 | "stability": "stable",
|
| 14932 | "summary": "The time in seconds that your browser is to cache the preflight response for the specified resource."
|
| 14933 | },
|
| 14934 | "immutable": true,
|
| 14935 | "locationInModule": {
|
| 14936 | "filename": "lib/function-url.ts",
|
| 14937 | "line": 106
|
| 14938 | },
|
| 14939 | "name": "maxAge",
|
| 14940 | "optional": true,
|
| 14941 | "type": {
|
| 14942 | "fqn": "@aws-cdk/core.Duration"
|
| 14943 | }
|
| 14944 | }
|
| 14945 | ],
|
| 14946 | "symbolId": "lib/function-url:FunctionUrlCorsOptions"
|
| 14947 | },
|
| 14948 | "@aws-cdk/aws-lambda.FunctionUrlOptions": {
|
| 14949 | "assembly": "@aws-cdk/aws-lambda",
|
| 14950 | "datatype": true,
|
| 14951 | "docs": {
|
| 14952 | "stability": "stable",
|
| 14953 | "summary": "Options to add a url to a Lambda function.",
|
| 14954 | "example": "// Can be a Function or an Alias\ndeclare const fn: lambda.Function;\n\nconst fnUrl = fn.addFunctionUrl({\n authType: lambda.FunctionUrlAuthType.NONE,\n});\n\nnew CfnOutput(this, 'TheUrl', {\n value: fnUrl.url,\n});",
|
| 14955 | "custom": {
|
| 14956 | "exampleMetadata": "infused"
|
| 14957 | }
|
| 14958 | },
|
| 14959 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlOptions",
|
| 14960 | "kind": "interface",
|
| 14961 | "locationInModule": {
|
| 14962 | "filename": "lib/function-url.ts",
|
| 14963 | "line": 136
|
| 14964 | },
|
| 14965 | "name": "FunctionUrlOptions",
|
| 14966 | "properties": [
|
| 14967 | {
|
| 14968 | "abstract": true,
|
| 14969 | "docs": {
|
| 14970 | "default": "FunctionUrlAuthType.AWS_IAM",
|
| 14971 | "stability": "stable",
|
| 14972 | "summary": "The type of authentication that your function URL uses."
|
| 14973 | },
|
| 14974 | "immutable": true,
|
| 14975 | "locationInModule": {
|
| 14976 | "filename": "lib/function-url.ts",
|
| 14977 | "line": 142
|
| 14978 | },
|
| 14979 | "name": "authType",
|
| 14980 | "optional": true,
|
| 14981 | "type": {
|
| 14982 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlAuthType"
|
| 14983 | }
|
| 14984 | },
|
| 14985 | {
|
| 14986 | "abstract": true,
|
| 14987 | "docs": {
|
| 14988 | "default": "- No CORS configuration.",
|
| 14989 | "stability": "stable",
|
| 14990 | "summary": "The cross-origin resource sharing (CORS) settings for your function URL."
|
| 14991 | },
|
| 14992 | "immutable": true,
|
| 14993 | "locationInModule": {
|
| 14994 | "filename": "lib/function-url.ts",
|
| 14995 | "line": 149
|
| 14996 | },
|
| 14997 | "name": "cors",
|
| 14998 | "optional": true,
|
| 14999 | "type": {
|
| 15000 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlCorsOptions"
|
| 15001 | }
|
| 15002 | }
|
| 15003 | ],
|
| 15004 | "symbolId": "lib/function-url:FunctionUrlOptions"
|
| 15005 | },
|
| 15006 | "@aws-cdk/aws-lambda.FunctionUrlProps": {
|
| 15007 | "assembly": "@aws-cdk/aws-lambda",
|
| 15008 | "datatype": true,
|
| 15009 | "docs": {
|
| 15010 | "stability": "stable",
|
| 15011 | "summary": "Properties for a FunctionUrl.",
|
| 15012 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const function_: lambda.Function;\nconst functionUrlProps: lambda.FunctionUrlProps = {\n function: function_,\n\n // the properties below are optional\n authType: lambda.FunctionUrlAuthType.AWS_IAM,\n cors: {\n allowCredentials: false,\n allowedHeaders: ['allowedHeaders'],\n allowedMethods: [lambda.HttpMethod.GET],\n allowedOrigins: ['allowedOrigins'],\n exposedHeaders: ['exposedHeaders'],\n maxAge: cdk.Duration.minutes(30),\n },\n};",
|
| 15013 | "custom": {
|
| 15014 | "exampleMetadata": "fixture=_generated"
|
| 15015 | }
|
| 15016 | },
|
| 15017 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlProps",
|
| 15018 | "interfaces": [
|
| 15019 | "@aws-cdk/aws-lambda.FunctionUrlOptions"
|
| 15020 | ],
|
| 15021 | "kind": "interface",
|
| 15022 | "locationInModule": {
|
| 15023 | "filename": "lib/function-url.ts",
|
| 15024 | "line": 155
|
| 15025 | },
|
| 15026 | "name": "FunctionUrlProps",
|
| 15027 | "properties": [
|
| 15028 | {
|
| 15029 | "abstract": true,
|
| 15030 | "docs": {
|
| 15031 | "remarks": "It can also be an `Alias` but not a `Version`.",
|
| 15032 | "stability": "stable",
|
| 15033 | "summary": "The function to which this url refers."
|
| 15034 | },
|
| 15035 | "immutable": true,
|
| 15036 | "locationInModule": {
|
| 15037 | "filename": "lib/function-url.ts",
|
| 15038 | "line": 160
|
| 15039 | },
|
| 15040 | "name": "function",
|
| 15041 | "type": {
|
| 15042 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 15043 | }
|
| 15044 | }
|
| 15045 | ],
|
| 15046 | "symbolId": "lib/function-url:FunctionUrlProps"
|
| 15047 | },
|
| 15048 | "@aws-cdk/aws-lambda.FunctionVersionUpgrade": {
|
| 15049 | "assembly": "@aws-cdk/aws-lambda",
|
| 15050 | "docs": {
|
| 15051 | "remarks": "This can be necessary when the feature flag\nchanges the function hash, as such changes must be associated with a new\nversion. This aspect will change the function description in these cases,\nwhich \"validates\" the new function hash.",
|
| 15052 | "stability": "stable",
|
| 15053 | "summary": "Aspect for upgrading function versions when the feature flag provided feature flag present.",
|
| 15054 | "example": "const stack = new Stack();\nAspects.of(stack).add(new lambda.FunctionVersionUpgrade(LAMBDA_RECOGNIZE_VERSION_PROPS));",
|
| 15055 | "custom": {
|
| 15056 | "exampleMetadata": "infused"
|
| 15057 | }
|
| 15058 | },
|
| 15059 | "fqn": "@aws-cdk/aws-lambda.FunctionVersionUpgrade",
|
| 15060 | "initializer": {
|
| 15061 | "docs": {
|
| 15062 | "stability": "stable"
|
| 15063 | },
|
| 15064 | "locationInModule": {
|
| 15065 | "filename": "lib/function.ts",
|
| 15066 | "line": 1293
|
| 15067 | },
|
| 15068 | "parameters": [
|
| 15069 | {
|
| 15070 | "name": "featureFlag",
|
| 15071 | "type": {
|
| 15072 | "primitive": "string"
|
| 15073 | }
|
| 15074 | },
|
| 15075 | {
|
| 15076 | "name": "enabled",
|
| 15077 | "optional": true,
|
| 15078 | "type": {
|
| 15079 | "primitive": "boolean"
|
| 15080 | }
|
| 15081 | }
|
| 15082 | ]
|
| 15083 | },
|
| 15084 | "interfaces": [
|
| 15085 | "@aws-cdk/core.IAspect"
|
| 15086 | ],
|
| 15087 | "kind": "class",
|
| 15088 | "locationInModule": {
|
| 15089 | "filename": "lib/function.ts",
|
| 15090 | "line": 1292
|
| 15091 | },
|
| 15092 | "methods": [
|
| 15093 | {
|
| 15094 | "docs": {
|
| 15095 | "stability": "stable",
|
| 15096 | "summary": "All aspects can visit an IConstruct."
|
| 15097 | },
|
| 15098 | "locationInModule": {
|
| 15099 | "filename": "lib/function.ts",
|
| 15100 | "line": 1295
|
| 15101 | },
|
| 15102 | "name": "visit",
|
| 15103 | "overrides": "@aws-cdk/core.IAspect",
|
| 15104 | "parameters": [
|
| 15105 | {
|
| 15106 | "name": "node",
|
| 15107 | "type": {
|
| 15108 | "fqn": "@aws-cdk/core.IConstruct"
|
| 15109 | }
|
| 15110 | }
|
| 15111 | ]
|
| 15112 | }
|
| 15113 | ],
|
| 15114 | "name": "FunctionVersionUpgrade",
|
| 15115 | "symbolId": "lib/function:FunctionVersionUpgrade"
|
| 15116 | },
|
| 15117 | "@aws-cdk/aws-lambda.Handler": {
|
| 15118 | "assembly": "@aws-cdk/aws-lambda",
|
| 15119 | "docs": {
|
| 15120 | "stability": "stable",
|
| 15121 | "summary": "Lambda function handler."
|
| 15122 | },
|
| 15123 | "fqn": "@aws-cdk/aws-lambda.Handler",
|
| 15124 | "kind": "class",
|
| 15125 | "locationInModule": {
|
| 15126 | "filename": "lib/handler.ts",
|
| 15127 | "line": 4
|
| 15128 | },
|
| 15129 | "name": "Handler",
|
| 15130 | "properties": [
|
| 15131 | {
|
| 15132 | "const": true,
|
| 15133 | "docs": {
|
| 15134 | "stability": "stable",
|
| 15135 | "summary": "A special handler when the function handler is part of a Docker image."
|
| 15136 | },
|
| 15137 | "immutable": true,
|
| 15138 | "locationInModule": {
|
| 15139 | "filename": "lib/handler.ts",
|
| 15140 | "line": 8
|
| 15141 | },
|
| 15142 | "name": "FROM_IMAGE",
|
| 15143 | "static": true,
|
| 15144 | "type": {
|
| 15145 | "primitive": "string"
|
| 15146 | }
|
| 15147 | }
|
| 15148 | ],
|
| 15149 | "symbolId": "lib/handler:Handler"
|
| 15150 | },
|
| 15151 | "@aws-cdk/aws-lambda.HttpMethod": {
|
| 15152 | "assembly": "@aws-cdk/aws-lambda",
|
| 15153 | "docs": {
|
| 15154 | "stability": "stable",
|
| 15155 | "summary": "All http request methods."
|
| 15156 | },
|
| 15157 | "fqn": "@aws-cdk/aws-lambda.HttpMethod",
|
| 15158 | "kind": "enum",
|
| 15159 | "locationInModule": {
|
| 15160 | "filename": "lib/function-url.ts",
|
| 15161 | "line": 27
|
| 15162 | },
|
| 15163 | "members": [
|
| 15164 | {
|
| 15165 | "docs": {
|
| 15166 | "stability": "stable",
|
| 15167 | "summary": "The GET method requests a representation of the specified resource."
|
| 15168 | },
|
| 15169 | "name": "GET"
|
| 15170 | },
|
| 15171 | {
|
| 15172 | "docs": {
|
| 15173 | "stability": "stable",
|
| 15174 | "summary": "The PUT method replaces all current representations of the target resource with the request payload."
|
| 15175 | },
|
| 15176 | "name": "PUT"
|
| 15177 | },
|
| 15178 | {
|
| 15179 | "docs": {
|
| 15180 | "stability": "stable",
|
| 15181 | "summary": "The HEAD method asks for a response identical to that of a GET request, but without the response body."
|
| 15182 | },
|
| 15183 | "name": "HEAD"
|
| 15184 | },
|
| 15185 | {
|
| 15186 | "docs": {
|
| 15187 | "stability": "stable",
|
| 15188 | "summary": "The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server."
|
| 15189 | },
|
| 15190 | "name": "POST"
|
| 15191 | },
|
| 15192 | {
|
| 15193 | "docs": {
|
| 15194 | "stability": "stable",
|
| 15195 | "summary": "The DELETE method deletes the specified resource."
|
| 15196 | },
|
| 15197 | "name": "DELETE"
|
| 15198 | },
|
| 15199 | {
|
| 15200 | "docs": {
|
| 15201 | "stability": "stable",
|
| 15202 | "summary": "The PATCH method applies partial modifications to a resource."
|
| 15203 | },
|
| 15204 | "name": "PATCH"
|
| 15205 | },
|
| 15206 | {
|
| 15207 | "docs": {
|
| 15208 | "stability": "stable",
|
| 15209 | "summary": "The OPTIONS method describes the communication options for the target resource."
|
| 15210 | },
|
| 15211 | "name": "OPTIONS"
|
| 15212 | },
|
| 15213 | {
|
| 15214 | "docs": {
|
| 15215 | "stability": "stable",
|
| 15216 | "summary": "The wildcard entry to allow all methods."
|
| 15217 | },
|
| 15218 | "name": "ALL"
|
| 15219 | }
|
| 15220 | ],
|
| 15221 | "name": "HttpMethod",
|
| 15222 | "symbolId": "lib/function-url:HttpMethod"
|
| 15223 | },
|
| 15224 | "@aws-cdk/aws-lambda.IAlias": {
|
| 15225 | "assembly": "@aws-cdk/aws-lambda",
|
| 15226 | "docs": {
|
| 15227 | "stability": "stable"
|
| 15228 | },
|
| 15229 | "fqn": "@aws-cdk/aws-lambda.IAlias",
|
| 15230 | "interfaces": [
|
| 15231 | "@aws-cdk/aws-lambda.IFunction"
|
| 15232 | ],
|
| 15233 | "kind": "interface",
|
| 15234 | "locationInModule": {
|
| 15235 | "filename": "lib/alias.ts",
|
| 15236 | "line": 14
|
| 15237 | },
|
| 15238 | "name": "IAlias",
|
| 15239 | "properties": [
|
| 15240 | {
|
| 15241 | "abstract": true,
|
| 15242 | "docs": {
|
| 15243 | "custom": {
|
| 15244 | "attribute": "true"
|
| 15245 | },
|
| 15246 | "stability": "stable",
|
| 15247 | "summary": "Name of this alias."
|
| 15248 | },
|
| 15249 | "immutable": true,
|
| 15250 | "locationInModule": {
|
| 15251 | "filename": "lib/alias.ts",
|
| 15252 | "line": 20
|
| 15253 | },
|
| 15254 | "name": "aliasName",
|
| 15255 | "type": {
|
| 15256 | "primitive": "string"
|
| 15257 | }
|
| 15258 | },
|
| 15259 | {
|
| 15260 | "abstract": true,
|
| 15261 | "docs": {
|
| 15262 | "stability": "stable",
|
| 15263 | "summary": "The underlying Lambda function version."
|
| 15264 | },
|
| 15265 | "immutable": true,
|
| 15266 | "locationInModule": {
|
| 15267 | "filename": "lib/alias.ts",
|
| 15268 | "line": 25
|
| 15269 | },
|
| 15270 | "name": "version",
|
| 15271 | "type": {
|
| 15272 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 15273 | }
|
| 15274 | }
|
| 15275 | ],
|
| 15276 | "symbolId": "lib/alias:IAlias"
|
| 15277 | },
|
| 15278 | "@aws-cdk/aws-lambda.ICodeSigningConfig": {
|
| 15279 | "assembly": "@aws-cdk/aws-lambda",
|
| 15280 | "docs": {
|
| 15281 | "stability": "stable",
|
| 15282 | "summary": "A Code Signing Config."
|
| 15283 | },
|
| 15284 | "fqn": "@aws-cdk/aws-lambda.ICodeSigningConfig",
|
| 15285 | "interfaces": [
|
| 15286 | "@aws-cdk/core.IResource"
|
| 15287 | ],
|
| 15288 | "kind": "interface",
|
| 15289 | "locationInModule": {
|
| 15290 | "filename": "lib/code-signing-config.ts",
|
| 15291 | "line": 25
|
| 15292 | },
|
| 15293 | "name": "ICodeSigningConfig",
|
| 15294 | "properties": [
|
| 15295 | {
|
| 15296 | "abstract": true,
|
| 15297 | "docs": {
|
| 15298 | "custom": {
|
| 15299 | "attribute": "true"
|
| 15300 | },
|
| 15301 | "stability": "stable",
|
| 15302 | "summary": "The ARN of Code Signing Config."
|
| 15303 | },
|
| 15304 | "immutable": true,
|
| 15305 | "locationInModule": {
|
| 15306 | "filename": "lib/code-signing-config.ts",
|
| 15307 | "line": 30
|
| 15308 | },
|
| 15309 | "name": "codeSigningConfigArn",
|
| 15310 | "type": {
|
| 15311 | "primitive": "string"
|
| 15312 | }
|
| 15313 | },
|
| 15314 | {
|
| 15315 | "abstract": true,
|
| 15316 | "docs": {
|
| 15317 | "custom": {
|
| 15318 | "attribute": "true"
|
| 15319 | },
|
| 15320 | "stability": "stable",
|
| 15321 | "summary": "The id of Code Signing Config."
|
| 15322 | },
|
| 15323 | "immutable": true,
|
| 15324 | "locationInModule": {
|
| 15325 | "filename": "lib/code-signing-config.ts",
|
| 15326 | "line": 36
|
| 15327 | },
|
| 15328 | "name": "codeSigningConfigId",
|
| 15329 | "type": {
|
| 15330 | "primitive": "string"
|
| 15331 | }
|
| 15332 | }
|
| 15333 | ],
|
| 15334 | "symbolId": "lib/code-signing-config:ICodeSigningConfig"
|
| 15335 | },
|
| 15336 | "@aws-cdk/aws-lambda.IDestination": {
|
| 15337 | "assembly": "@aws-cdk/aws-lambda",
|
| 15338 | "docs": {
|
| 15339 | "stability": "stable",
|
| 15340 | "summary": "A Lambda destination."
|
| 15341 | },
|
| 15342 | "fqn": "@aws-cdk/aws-lambda.IDestination",
|
| 15343 | "kind": "interface",
|
| 15344 | "locationInModule": {
|
| 15345 | "filename": "lib/destination.ts",
|
| 15346 | "line": 46
|
| 15347 | },
|
| 15348 | "methods": [
|
| 15349 | {
|
| 15350 | "abstract": true,
|
| 15351 | "docs": {
|
| 15352 | "stability": "stable",
|
| 15353 | "summary": "Binds this destination to the Lambda function."
|
| 15354 | },
|
| 15355 | "locationInModule": {
|
| 15356 | "filename": "lib/destination.ts",
|
| 15357 | "line": 50
|
| 15358 | },
|
| 15359 | "name": "bind",
|
| 15360 | "parameters": [
|
| 15361 | {
|
| 15362 | "name": "scope",
|
| 15363 | "type": {
|
| 15364 | "fqn": "@aws-cdk/core.Construct"
|
| 15365 | }
|
| 15366 | },
|
| 15367 | {
|
| 15368 | "name": "fn",
|
| 15369 | "type": {
|
| 15370 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 15371 | }
|
| 15372 | },
|
| 15373 | {
|
| 15374 | "name": "options",
|
| 15375 | "optional": true,
|
| 15376 | "type": {
|
| 15377 | "fqn": "@aws-cdk/aws-lambda.DestinationOptions"
|
| 15378 | }
|
| 15379 | }
|
| 15380 | ],
|
| 15381 | "returns": {
|
| 15382 | "type": {
|
| 15383 | "fqn": "@aws-cdk/aws-lambda.DestinationConfig"
|
| 15384 | }
|
| 15385 | }
|
| 15386 | }
|
| 15387 | ],
|
| 15388 | "name": "IDestination",
|
| 15389 | "symbolId": "lib/destination:IDestination"
|
| 15390 | },
|
| 15391 | "@aws-cdk/aws-lambda.IEventSource": {
|
| 15392 | "assembly": "@aws-cdk/aws-lambda",
|
| 15393 | "docs": {
|
| 15394 | "stability": "stable",
|
| 15395 | "summary": "An abstract class which represents an AWS Lambda event source."
|
| 15396 | },
|
| 15397 | "fqn": "@aws-cdk/aws-lambda.IEventSource",
|
| 15398 | "kind": "interface",
|
| 15399 | "locationInModule": {
|
| 15400 | "filename": "lib/event-source.ts",
|
| 15401 | "line": 6
|
| 15402 | },
|
| 15403 | "methods": [
|
| 15404 | {
|
| 15405 | "abstract": true,
|
| 15406 | "docs": {
|
| 15407 | "stability": "stable",
|
| 15408 | "summary": "Called by `lambda.addEventSource` to allow the event source to bind to this function."
|
| 15409 | },
|
| 15410 | "locationInModule": {
|
| 15411 | "filename": "lib/event-source.ts",
|
| 15412 | "line": 13
|
| 15413 | },
|
| 15414 | "name": "bind",
|
| 15415 | "parameters": [
|
| 15416 | {
|
| 15417 | "docs": {
|
| 15418 | "summary": "That lambda function to bind to."
|
| 15419 | },
|
| 15420 | "name": "target",
|
| 15421 | "type": {
|
| 15422 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 15423 | }
|
| 15424 | }
|
| 15425 | ]
|
| 15426 | }
|
| 15427 | ],
|
| 15428 | "name": "IEventSource",
|
| 15429 | "symbolId": "lib/event-source:IEventSource"
|
| 15430 | },
|
| 15431 | "@aws-cdk/aws-lambda.IEventSourceDlq": {
|
| 15432 | "assembly": "@aws-cdk/aws-lambda",
|
| 15433 | "docs": {
|
| 15434 | "stability": "stable",
|
| 15435 | "summary": "A DLQ for an event source."
|
| 15436 | },
|
| 15437 | "fqn": "@aws-cdk/aws-lambda.IEventSourceDlq",
|
| 15438 | "kind": "interface",
|
| 15439 | "locationInModule": {
|
| 15440 | "filename": "lib/dlq.ts",
|
| 15441 | "line": 17
|
| 15442 | },
|
| 15443 | "methods": [
|
| 15444 | {
|
| 15445 | "abstract": true,
|
| 15446 | "docs": {
|
| 15447 | "stability": "stable",
|
| 15448 | "summary": "Returns the DLQ destination config of the DLQ."
|
| 15449 | },
|
| 15450 | "locationInModule": {
|
| 15451 | "filename": "lib/dlq.ts",
|
| 15452 | "line": 21
|
| 15453 | },
|
| 15454 | "name": "bind",
|
| 15455 | "parameters": [
|
| 15456 | {
|
| 15457 | "name": "target",
|
| 15458 | "type": {
|
| 15459 | "fqn": "@aws-cdk/aws-lambda.IEventSourceMapping"
|
| 15460 | }
|
| 15461 | },
|
| 15462 | {
|
| 15463 | "name": "targetHandler",
|
| 15464 | "type": {
|
| 15465 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 15466 | }
|
| 15467 | }
|
| 15468 | ],
|
| 15469 | "returns": {
|
| 15470 | "type": {
|
| 15471 | "fqn": "@aws-cdk/aws-lambda.DlqDestinationConfig"
|
| 15472 | }
|
| 15473 | }
|
| 15474 | }
|
| 15475 | ],
|
| 15476 | "name": "IEventSourceDlq",
|
| 15477 | "symbolId": "lib/dlq:IEventSourceDlq"
|
| 15478 | },
|
| 15479 | "@aws-cdk/aws-lambda.IEventSourceMapping": {
|
| 15480 | "assembly": "@aws-cdk/aws-lambda",
|
| 15481 | "docs": {
|
| 15482 | "see": "https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html",
|
| 15483 | "stability": "stable",
|
| 15484 | "summary": "Represents an event source mapping for a lambda function."
|
| 15485 | },
|
| 15486 | "fqn": "@aws-cdk/aws-lambda.IEventSourceMapping",
|
| 15487 | "interfaces": [
|
| 15488 | "@aws-cdk/core.IResource"
|
| 15489 | ],
|
| 15490 | "kind": "interface",
|
| 15491 | "locationInModule": {
|
| 15492 | "filename": "lib/event-source-mapping.ts",
|
| 15493 | "line": 229
|
| 15494 | },
|
| 15495 | "name": "IEventSourceMapping",
|
| 15496 | "properties": [
|
| 15497 | {
|
| 15498 | "abstract": true,
|
| 15499 | "docs": {
|
| 15500 | "custom": {
|
| 15501 | "attribute": "true"
|
| 15502 | },
|
| 15503 | "stability": "stable",
|
| 15504 | "summary": "The identifier for this EventSourceMapping."
|
| 15505 | },
|
| 15506 | "immutable": true,
|
| 15507 | "locationInModule": {
|
| 15508 | "filename": "lib/event-source-mapping.ts",
|
| 15509 | "line": 234
|
| 15510 | },
|
| 15511 | "name": "eventSourceMappingId",
|
| 15512 | "type": {
|
| 15513 | "primitive": "string"
|
| 15514 | }
|
| 15515 | }
|
| 15516 | ],
|
| 15517 | "symbolId": "lib/event-source-mapping:IEventSourceMapping"
|
| 15518 | },
|
| 15519 | "@aws-cdk/aws-lambda.IFunction": {
|
| 15520 | "assembly": "@aws-cdk/aws-lambda",
|
| 15521 | "docs": {
|
| 15522 | "stability": "stable"
|
| 15523 | },
|
| 15524 | "fqn": "@aws-cdk/aws-lambda.IFunction",
|
| 15525 | "interfaces": [
|
| 15526 | "@aws-cdk/core.IResource",
|
| 15527 | "@aws-cdk/aws-ec2.IConnectable",
|
| 15528 | "@aws-cdk/aws-iam.IGrantable"
|
| 15529 | ],
|
| 15530 | "kind": "interface",
|
| 15531 | "locationInModule": {
|
| 15532 | "filename": "lib/function-base.ts",
|
| 15533 | "line": 21
|
| 15534 | },
|
| 15535 | "methods": [
|
| 15536 | {
|
| 15537 | "abstract": true,
|
| 15538 | "docs": {
|
| 15539 | "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```\nimport { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources';\nmyFunction.addEventSource(new SqsEventSource(myQueue));\n```",
|
| 15540 | "stability": "stable",
|
| 15541 | "summary": "Adds an event source to this function."
|
| 15542 | },
|
| 15543 | "locationInModule": {
|
| 15544 | "filename": "lib/function-base.ts",
|
| 15545 | "line": 145
|
| 15546 | },
|
| 15547 | "name": "addEventSource",
|
| 15548 | "parameters": [
|
| 15549 | {
|
| 15550 | "name": "source",
|
| 15551 | "type": {
|
| 15552 | "fqn": "@aws-cdk/aws-lambda.IEventSource"
|
| 15553 | }
|
| 15554 | }
|
| 15555 | ]
|
| 15556 | },
|
| 15557 | {
|
| 15558 | "abstract": true,
|
| 15559 | "docs": {
|
| 15560 | "stability": "stable",
|
| 15561 | "summary": "Adds an event source that maps to this AWS Lambda function."
|
| 15562 | },
|
| 15563 | "locationInModule": {
|
| 15564 | "filename": "lib/function-base.ts",
|
| 15565 | "line": 84
|
| 15566 | },
|
| 15567 | "name": "addEventSourceMapping",
|
| 15568 | "parameters": [
|
| 15569 | {
|
| 15570 | "docs": {
|
| 15571 | "summary": "construct ID."
|
| 15572 | },
|
| 15573 | "name": "id",
|
| 15574 | "type": {
|
| 15575 | "primitive": "string"
|
| 15576 | }
|
| 15577 | },
|
| 15578 | {
|
| 15579 | "docs": {
|
| 15580 | "summary": "mapping options."
|
| 15581 | },
|
| 15582 | "name": "options",
|
| 15583 | "type": {
|
| 15584 | "fqn": "@aws-cdk/aws-lambda.EventSourceMappingOptions"
|
| 15585 | }
|
| 15586 | }
|
| 15587 | ],
|
| 15588 | "returns": {
|
| 15589 | "type": {
|
| 15590 | "fqn": "@aws-cdk/aws-lambda.EventSourceMapping"
|
| 15591 | }
|
| 15592 | }
|
| 15593 | },
|
| 15594 | {
|
| 15595 | "abstract": true,
|
| 15596 | "docs": {
|
| 15597 | "stability": "stable",
|
| 15598 | "summary": "Adds a url to this lambda function."
|
| 15599 | },
|
| 15600 | "locationInModule": {
|
| 15601 | "filename": "lib/function-base.ts",
|
| 15602 | "line": 155
|
| 15603 | },
|
| 15604 | "name": "addFunctionUrl",
|
| 15605 | "parameters": [
|
| 15606 | {
|
| 15607 | "name": "options",
|
| 15608 | "optional": true,
|
| 15609 | "type": {
|
| 15610 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlOptions"
|
| 15611 | }
|
| 15612 | }
|
| 15613 | ],
|
| 15614 | "returns": {
|
| 15615 | "type": {
|
| 15616 | "fqn": "@aws-cdk/aws-lambda.FunctionUrl"
|
| 15617 | }
|
| 15618 | }
|
| 15619 | },
|
| 15620 | {
|
| 15621 | "abstract": true,
|
| 15622 | "docs": {
|
| 15623 | "see": "Permission for details.",
|
| 15624 | "stability": "stable",
|
| 15625 | "summary": "Adds a permission to the Lambda resource policy."
|
| 15626 | },
|
| 15627 | "locationInModule": {
|
| 15628 | "filename": "lib/function-base.ts",
|
| 15629 | "line": 91
|
| 15630 | },
|
| 15631 | "name": "addPermission",
|
| 15632 | "parameters": [
|
| 15633 | {
|
| 15634 | "docs": {
|
| 15635 | "summary": "The id for the permission construct."
|
| 15636 | },
|
| 15637 | "name": "id",
|
| 15638 | "type": {
|
| 15639 | "primitive": "string"
|
| 15640 | }
|
| 15641 | },
|
| 15642 | {
|
| 15643 | "docs": {
|
| 15644 | "summary": "The permission to grant to this Lambda function."
|
| 15645 | },
|
| 15646 | "name": "permission",
|
| 15647 | "type": {
|
| 15648 | "fqn": "@aws-cdk/aws-lambda.Permission"
|
| 15649 | }
|
| 15650 | }
|
| 15651 | ]
|
| 15652 | },
|
| 15653 | {
|
| 15654 | "abstract": true,
|
| 15655 | "docs": {
|
| 15656 | "stability": "stable",
|
| 15657 | "summary": "Adds a statement to the IAM role assumed by the instance."
|
| 15658 | },
|
| 15659 | "locationInModule": {
|
| 15660 | "filename": "lib/function-base.ts",
|
| 15661 | "line": 96
|
| 15662 | },
|
| 15663 | "name": "addToRolePolicy",
|
| 15664 | "parameters": [
|
| 15665 | {
|
| 15666 | "name": "statement",
|
| 15667 | "type": {
|
| 15668 | "fqn": "@aws-cdk/aws-iam.PolicyStatement"
|
| 15669 | }
|
| 15670 | }
|
| 15671 | ]
|
| 15672 | },
|
| 15673 | {
|
| 15674 | "abstract": true,
|
| 15675 | "docs": {
|
| 15676 | "stability": "stable",
|
| 15677 | "summary": "Configures options for asynchronous invocation."
|
| 15678 | },
|
| 15679 | "locationInModule": {
|
| 15680 | "filename": "lib/function-base.ts",
|
| 15681 | "line": 150
|
| 15682 | },
|
| 15683 | "name": "configureAsyncInvoke",
|
| 15684 | "parameters": [
|
| 15685 | {
|
| 15686 | "name": "options",
|
| 15687 | "type": {
|
| 15688 | "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions"
|
| 15689 | }
|
| 15690 | }
|
| 15691 | ]
|
| 15692 | },
|
| 15693 | {
|
| 15694 | "abstract": true,
|
| 15695 | "docs": {
|
| 15696 | "stability": "stable",
|
| 15697 | "summary": "Grant the given identity permissions to invoke this Lambda."
|
| 15698 | },
|
| 15699 | "locationInModule": {
|
| 15700 | "filename": "lib/function-base.ts",
|
| 15701 | "line": 101
|
| 15702 | },
|
| 15703 | "name": "grantInvoke",
|
| 15704 | "parameters": [
|
| 15705 | {
|
| 15706 | "name": "identity",
|
| 15707 | "type": {
|
| 15708 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
| 15709 | }
|
| 15710 | }
|
| 15711 | ],
|
| 15712 | "returns": {
|
| 15713 | "type": {
|
| 15714 | "fqn": "@aws-cdk/aws-iam.Grant"
|
| 15715 | }
|
| 15716 | }
|
| 15717 | },
|
| 15718 | {
|
| 15719 | "abstract": true,
|
| 15720 | "docs": {
|
| 15721 | "stability": "stable",
|
| 15722 | "summary": "Grant the given identity permissions to invoke this Lambda Function URL."
|
| 15723 | },
|
| 15724 | "locationInModule": {
|
| 15725 | "filename": "lib/function-base.ts",
|
| 15726 | "line": 106
|
| 15727 | },
|
| 15728 | "name": "grantInvokeUrl",
|
| 15729 | "parameters": [
|
| 15730 | {
|
| 15731 | "name": "identity",
|
| 15732 | "type": {
|
| 15733 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
| 15734 | }
|
| 15735 | }
|
| 15736 | ],
|
| 15737 | "returns": {
|
| 15738 | "type": {
|
| 15739 | "fqn": "@aws-cdk/aws-iam.Grant"
|
| 15740 | }
|
| 15741 | }
|
| 15742 | },
|
| 15743 | {
|
| 15744 | "abstract": true,
|
| 15745 | "docs": {
|
| 15746 | "stability": "stable",
|
| 15747 | "summary": "Return the given named metric for this Lambda Return the given named metric for this Function."
|
| 15748 | },
|
| 15749 | "locationInModule": {
|
| 15750 | "filename": "lib/function-base.ts",
|
| 15751 | "line": 111
|
| 15752 | },
|
| 15753 | "name": "metric",
|
| 15754 | "parameters": [
|
| 15755 | {
|
| 15756 | "name": "metricName",
|
| 15757 | "type": {
|
| 15758 | "primitive": "string"
|
| 15759 | }
|
| 15760 | },
|
| 15761 | {
|
| 15762 | "name": "props",
|
| 15763 | "optional": true,
|
| 15764 | "type": {
|
| 15765 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 15766 | }
|
| 15767 | }
|
| 15768 | ],
|
| 15769 | "returns": {
|
| 15770 | "type": {
|
| 15771 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 15772 | }
|
| 15773 | }
|
| 15774 | },
|
| 15775 | {
|
| 15776 | "abstract": true,
|
| 15777 | "docs": {
|
| 15778 | "default": "average over 5 minutes",
|
| 15779 | "remarks": "Average over 5 minutes",
|
| 15780 | "stability": "stable",
|
| 15781 | "summary": "Metric for the Duration of this Lambda How long execution of this Lambda takes."
|
| 15782 | },
|
| 15783 | "locationInModule": {
|
| 15784 | "filename": "lib/function-base.ts",
|
| 15785 | "line": 118
|
| 15786 | },
|
| 15787 | "name": "metricDuration",
|
| 15788 | "parameters": [
|
| 15789 | {
|
| 15790 | "name": "props",
|
| 15791 | "optional": true,
|
| 15792 | "type": {
|
| 15793 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 15794 | }
|
| 15795 | }
|
| 15796 | ],
|
| 15797 | "returns": {
|
| 15798 | "type": {
|
| 15799 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 15800 | }
|
| 15801 | }
|
| 15802 | },
|
| 15803 | {
|
| 15804 | "abstract": true,
|
| 15805 | "docs": {
|
| 15806 | "remarks": "Sum over 5 minutes",
|
| 15807 | "stability": "stable",
|
| 15808 | "summary": "How many invocations of this Lambda fail."
|
| 15809 | },
|
| 15810 | "locationInModule": {
|
| 15811 | "filename": "lib/lambda-augmentations.generated.ts",
|
| 15812 | "line": 29
|
| 15813 | },
|
| 15814 | "name": "metricErrors",
|
| 15815 | "parameters": [
|
| 15816 | {
|
| 15817 | "name": "props",
|
| 15818 | "optional": true,
|
| 15819 | "type": {
|
| 15820 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 15821 | }
|
| 15822 | }
|
| 15823 | ],
|
| 15824 | "returns": {
|
| 15825 | "type": {
|
| 15826 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 15827 | }
|
| 15828 | }
|
| 15829 | },
|
| 15830 | {
|
| 15831 | "abstract": true,
|
| 15832 | "docs": {
|
| 15833 | "default": "sum over 5 minutes",
|
| 15834 | "remarks": "Sum over 5 minutes",
|
| 15835 | "stability": "stable",
|
| 15836 | "summary": "Metric for the number of invocations of this Lambda How often this Lambda is invoked."
|
| 15837 | },
|
| 15838 | "locationInModule": {
|
| 15839 | "filename": "lib/function-base.ts",
|
| 15840 | "line": 125
|
| 15841 | },
|
| 15842 | "name": "metricInvocations",
|
| 15843 | "parameters": [
|
| 15844 | {
|
| 15845 | "name": "props",
|
| 15846 | "optional": true,
|
| 15847 | "type": {
|
| 15848 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 15849 | }
|
| 15850 | }
|
| 15851 | ],
|
| 15852 | "returns": {
|
| 15853 | "type": {
|
| 15854 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 15855 | }
|
| 15856 | }
|
| 15857 | },
|
| 15858 | {
|
| 15859 | "abstract": true,
|
| 15860 | "docs": {
|
| 15861 | "default": "sum over 5 minutes",
|
| 15862 | "remarks": "Sum over 5 minutes",
|
| 15863 | "stability": "stable",
|
| 15864 | "summary": "Metric for the number of throttled invocations of this Lambda How often this Lambda is throttled."
|
| 15865 | },
|
| 15866 | "locationInModule": {
|
| 15867 | "filename": "lib/function-base.ts",
|
| 15868 | "line": 132
|
| 15869 | },
|
| 15870 | "name": "metricThrottles",
|
| 15871 | "parameters": [
|
| 15872 | {
|
| 15873 | "name": "props",
|
| 15874 | "optional": true,
|
| 15875 | "type": {
|
| 15876 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 15877 | }
|
| 15878 | }
|
| 15879 | ],
|
| 15880 | "returns": {
|
| 15881 | "type": {
|
| 15882 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 15883 | }
|
| 15884 | }
|
| 15885 | }
|
| 15886 | ],
|
| 15887 | "name": "IFunction",
|
| 15888 | "properties": [
|
| 15889 | {
|
| 15890 | "abstract": true,
|
| 15891 | "docs": {
|
| 15892 | "stability": "stable",
|
| 15893 | "summary": "The system architectures compatible with this lambda function."
|
| 15894 | },
|
| 15895 | "immutable": true,
|
| 15896 | "locationInModule": {
|
| 15897 | "filename": "lib/function-base.ts",
|
| 15898 | "line": 69
|
| 15899 | },
|
| 15900 | "name": "architecture",
|
| 15901 | "type": {
|
| 15902 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 15903 | }
|
| 15904 | },
|
| 15905 | {
|
| 15906 | "abstract": true,
|
| 15907 | "docs": {
|
| 15908 | "custom": {
|
| 15909 | "attribute": "true"
|
| 15910 | },
|
| 15911 | "stability": "stable",
|
| 15912 | "summary": "The ARN of the function."
|
| 15913 | },
|
| 15914 | "immutable": true,
|
| 15915 | "locationInModule": {
|
| 15916 | "filename": "lib/function-base.ts",
|
| 15917 | "line": 35
|
| 15918 | },
|
| 15919 | "name": "functionArn",
|
| 15920 | "type": {
|
| 15921 | "primitive": "string"
|
| 15922 | }
|
| 15923 | },
|
| 15924 | {
|
| 15925 | "abstract": true,
|
| 15926 | "docs": {
|
| 15927 | "custom": {
|
| 15928 | "attribute": "true"
|
| 15929 | },
|
| 15930 | "stability": "stable",
|
| 15931 | "summary": "The name of the function."
|
| 15932 | },
|
| 15933 | "immutable": true,
|
| 15934 | "locationInModule": {
|
| 15935 | "filename": "lib/function-base.ts",
|
| 15936 | "line": 28
|
| 15937 | },
|
| 15938 | "name": "functionName",
|
| 15939 | "type": {
|
| 15940 | "primitive": "string"
|
| 15941 | }
|
| 15942 | },
|
| 15943 | {
|
| 15944 | "abstract": true,
|
| 15945 | "docs": {
|
| 15946 | "remarks": "If this is is `false`, trying to access the `connections` object will fail.",
|
| 15947 | "stability": "stable",
|
| 15948 | "summary": "Whether or not this Lambda function was bound to a VPC."
|
| 15949 | },
|
| 15950 | "immutable": true,
|
| 15951 | "locationInModule": {
|
| 15952 | "filename": "lib/function-base.ts",
|
| 15953 | "line": 47
|
| 15954 | },
|
| 15955 | "name": "isBoundToVpc",
|
| 15956 | "type": {
|
| 15957 | "primitive": "boolean"
|
| 15958 | }
|
| 15959 | },
|
| 15960 | {
|
| 15961 | "abstract": true,
|
| 15962 | "docs": {
|
| 15963 | "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.",
|
| 15964 | "stability": "stable",
|
| 15965 | "summary": "The `$LATEST` version of this function."
|
| 15966 | },
|
| 15967 | "immutable": true,
|
| 15968 | "locationInModule": {
|
| 15969 | "filename": "lib/function-base.ts",
|
| 15970 | "line": 59
|
| 15971 | },
|
| 15972 | "name": "latestVersion",
|
| 15973 | "type": {
|
| 15974 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 15975 | }
|
| 15976 | },
|
| 15977 | {
|
| 15978 | "abstract": true,
|
| 15979 | "docs": {
|
| 15980 | "stability": "stable",
|
| 15981 | "summary": "The construct node where permissions are attached."
|
| 15982 | },
|
| 15983 | "immutable": true,
|
| 15984 | "locationInModule": {
|
| 15985 | "filename": "lib/function-base.ts",
|
| 15986 | "line": 64
|
| 15987 | },
|
| 15988 | "name": "permissionsNode",
|
| 15989 | "type": {
|
| 15990 | "fqn": "@aws-cdk/core.ConstructNode"
|
| 15991 | }
|
| 15992 | },
|
| 15993 | {
|
| 15994 | "abstract": true,
|
| 15995 | "docs": {
|
| 15996 | "remarks": "This property is for cdk modules to consume only. You should not need to use this property.\nInstead, use grantInvoke() directly.",
|
| 15997 | "stability": "stable",
|
| 15998 | "summary": "The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()."
|
| 15999 | },
|
| 16000 | "immutable": true,
|
| 16001 | "locationInModule": {
|
| 16002 | "filename": "lib/function-base.ts",
|
| 16003 | "line": 77
|
| 16004 | },
|
| 16005 | "name": "resourceArnsForGrantInvoke",
|
| 16006 | "type": {
|
| 16007 | "collection": {
|
| 16008 | "elementtype": {
|
| 16009 | "primitive": "string"
|
| 16010 | },
|
| 16011 | "kind": "array"
|
| 16012 | }
|
| 16013 | }
|
| 16014 | },
|
| 16015 | {
|
| 16016 | "abstract": true,
|
| 16017 | "docs": {
|
| 16018 | "stability": "stable",
|
| 16019 | "summary": "The IAM role associated with this function."
|
| 16020 | },
|
| 16021 | "immutable": true,
|
| 16022 | "locationInModule": {
|
| 16023 | "filename": "lib/function-base.ts",
|
| 16024 | "line": 40
|
| 16025 | },
|
| 16026 | "name": "role",
|
| 16027 | "optional": true,
|
| 16028 | "type": {
|
| 16029 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 16030 | }
|
| 16031 | }
|
| 16032 | ],
|
| 16033 | "symbolId": "lib/function-base:IFunction"
|
| 16034 | },
|
| 16035 | "@aws-cdk/aws-lambda.IFunctionUrl": {
|
| 16036 | "assembly": "@aws-cdk/aws-lambda",
|
| 16037 | "docs": {
|
| 16038 | "stability": "stable",
|
| 16039 | "summary": "A Lambda function Url."
|
| 16040 | },
|
| 16041 | "fqn": "@aws-cdk/aws-lambda.IFunctionUrl",
|
| 16042 | "interfaces": [
|
| 16043 | "@aws-cdk/core.IResource"
|
| 16044 | ],
|
| 16045 | "kind": "interface",
|
| 16046 | "locationInModule": {
|
| 16047 | "filename": "lib/function-url.ts",
|
| 16048 | "line": 112
|
| 16049 | },
|
| 16050 | "methods": [
|
| 16051 | {
|
| 16052 | "abstract": true,
|
| 16053 | "docs": {
|
| 16054 | "stability": "stable",
|
| 16055 | "summary": "Grant the given identity permissions to invoke this Lambda Function URL."
|
| 16056 | },
|
| 16057 | "locationInModule": {
|
| 16058 | "filename": "lib/function-url.ts",
|
| 16059 | "line": 130
|
| 16060 | },
|
| 16061 | "name": "grantInvokeUrl",
|
| 16062 | "parameters": [
|
| 16063 | {
|
| 16064 | "name": "identity",
|
| 16065 | "type": {
|
| 16066 | "fqn": "@aws-cdk/aws-iam.IGrantable"
|
| 16067 | }
|
| 16068 | }
|
| 16069 | ],
|
| 16070 | "returns": {
|
| 16071 | "type": {
|
| 16072 | "fqn": "@aws-cdk/aws-iam.Grant"
|
| 16073 | }
|
| 16074 | }
|
| 16075 | }
|
| 16076 | ],
|
| 16077 | "name": "IFunctionUrl",
|
| 16078 | "properties": [
|
| 16079 | {
|
| 16080 | "abstract": true,
|
| 16081 | "docs": {
|
| 16082 | "custom": {
|
| 16083 | "attribute": "FunctionArn"
|
| 16084 | },
|
| 16085 | "stability": "stable",
|
| 16086 | "summary": "The ARN of the function this URL refers to."
|
| 16087 | },
|
| 16088 | "immutable": true,
|
| 16089 | "locationInModule": {
|
| 16090 | "filename": "lib/function-url.ts",
|
| 16091 | "line": 125
|
| 16092 | },
|
| 16093 | "name": "functionArn",
|
| 16094 | "type": {
|
| 16095 | "primitive": "string"
|
| 16096 | }
|
| 16097 | },
|
| 16098 | {
|
| 16099 | "abstract": true,
|
| 16100 | "docs": {
|
| 16101 | "custom": {
|
| 16102 | "attribute": "FunctionUrl"
|
| 16103 | },
|
| 16104 | "stability": "stable",
|
| 16105 | "summary": "The url of the Lambda function."
|
| 16106 | },
|
| 16107 | "immutable": true,
|
| 16108 | "locationInModule": {
|
| 16109 | "filename": "lib/function-url.ts",
|
| 16110 | "line": 118
|
| 16111 | },
|
| 16112 | "name": "url",
|
| 16113 | "type": {
|
| 16114 | "primitive": "string"
|
| 16115 | }
|
| 16116 | }
|
| 16117 | ],
|
| 16118 | "symbolId": "lib/function-url:IFunctionUrl"
|
| 16119 | },
|
| 16120 | "@aws-cdk/aws-lambda.ILayerVersion": {
|
| 16121 | "assembly": "@aws-cdk/aws-lambda",
|
| 16122 | "docs": {
|
| 16123 | "stability": "stable"
|
| 16124 | },
|
| 16125 | "fqn": "@aws-cdk/aws-lambda.ILayerVersion",
|
| 16126 | "interfaces": [
|
| 16127 | "@aws-cdk/core.IResource"
|
| 16128 | ],
|
| 16129 | "kind": "interface",
|
| 16130 | "locationInModule": {
|
| 16131 | "filename": "lib/layers.ts",
|
| 16132 | "line": 64
|
| 16133 | },
|
| 16134 | "methods": [
|
| 16135 | {
|
| 16136 | "abstract": true,
|
| 16137 | "docs": {
|
| 16138 | "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.",
|
| 16139 | "stability": "stable",
|
| 16140 | "summary": "Add permission for this layer version to specific entities."
|
| 16141 | },
|
| 16142 | "locationInModule": {
|
| 16143 | "filename": "lib/layers.ts",
|
| 16144 | "line": 89
|
| 16145 | },
|
| 16146 | "name": "addPermission",
|
| 16147 | "parameters": [
|
| 16148 | {
|
| 16149 | "docs": {
|
| 16150 | "summary": "the ID of the grant in the construct tree."
|
| 16151 | },
|
| 16152 | "name": "id",
|
| 16153 | "type": {
|
| 16154 | "primitive": "string"
|
| 16155 | }
|
| 16156 | },
|
| 16157 | {
|
| 16158 | "docs": {
|
| 16159 | "summary": "the identification of the grantee."
|
| 16160 | },
|
| 16161 | "name": "permission",
|
| 16162 | "type": {
|
| 16163 | "fqn": "@aws-cdk/aws-lambda.LayerVersionPermission"
|
| 16164 | }
|
| 16165 | }
|
| 16166 | ]
|
| 16167 | }
|
| 16168 | ],
|
| 16169 | "name": "ILayerVersion",
|
| 16170 | "properties": [
|
| 16171 | {
|
| 16172 | "abstract": true,
|
| 16173 | "docs": {
|
| 16174 | "custom": {
|
| 16175 | "attribute": "true"
|
| 16176 | },
|
| 16177 | "stability": "stable",
|
| 16178 | "summary": "The ARN of the Lambda Layer version that this Layer defines."
|
| 16179 | },
|
| 16180 | "immutable": true,
|
| 16181 | "locationInModule": {
|
| 16182 | "filename": "lib/layers.ts",
|
| 16183 | "line": 69
|
| 16184 | },
|
| 16185 | "name": "layerVersionArn",
|
| 16186 | "type": {
|
| 16187 | "primitive": "string"
|
| 16188 | }
|
| 16189 | },
|
| 16190 | {
|
| 16191 | "abstract": true,
|
| 16192 | "docs": {
|
| 16193 | "default": "Runtime.All",
|
| 16194 | "stability": "stable",
|
| 16195 | "summary": "The runtimes compatible with this Layer."
|
| 16196 | },
|
| 16197 | "immutable": true,
|
| 16198 | "locationInModule": {
|
| 16199 | "filename": "lib/layers.ts",
|
| 16200 | "line": 76
|
| 16201 | },
|
| 16202 | "name": "compatibleRuntimes",
|
| 16203 | "optional": true,
|
| 16204 | "type": {
|
| 16205 | "collection": {
|
| 16206 | "elementtype": {
|
| 16207 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 16208 | },
|
| 16209 | "kind": "array"
|
| 16210 | }
|
| 16211 | }
|
| 16212 | }
|
| 16213 | ],
|
| 16214 | "symbolId": "lib/layers:ILayerVersion"
|
| 16215 | },
|
| 16216 | "@aws-cdk/aws-lambda.IScalableFunctionAttribute": {
|
| 16217 | "assembly": "@aws-cdk/aws-lambda",
|
| 16218 | "docs": {
|
| 16219 | "stability": "stable",
|
| 16220 | "summary": "Interface for scalable attributes."
|
| 16221 | },
|
| 16222 | "fqn": "@aws-cdk/aws-lambda.IScalableFunctionAttribute",
|
| 16223 | "interfaces": [
|
| 16224 | "@aws-cdk/core.IConstruct"
|
| 16225 | ],
|
| 16226 | "kind": "interface",
|
| 16227 | "locationInModule": {
|
| 16228 | "filename": "lib/scalable-attribute-api.ts",
|
| 16229 | "line": 8
|
| 16230 | },
|
| 16231 | "methods": [
|
| 16232 | {
|
| 16233 | "abstract": true,
|
| 16234 | "docs": {
|
| 16235 | "stability": "stable",
|
| 16236 | "summary": "Scale out or in based on schedule."
|
| 16237 | },
|
| 16238 | "locationInModule": {
|
| 16239 | "filename": "lib/scalable-attribute-api.ts",
|
| 16240 | "line": 18
|
| 16241 | },
|
| 16242 | "name": "scaleOnSchedule",
|
| 16243 | "parameters": [
|
| 16244 | {
|
| 16245 | "name": "id",
|
| 16246 | "type": {
|
| 16247 | "primitive": "string"
|
| 16248 | }
|
| 16249 | },
|
| 16250 | {
|
| 16251 | "name": "actions",
|
| 16252 | "type": {
|
| 16253 | "fqn": "@aws-cdk/aws-applicationautoscaling.ScalingSchedule"
|
| 16254 | }
|
| 16255 | }
|
| 16256 | ]
|
| 16257 | },
|
| 16258 | {
|
| 16259 | "abstract": true,
|
| 16260 | "docs": {
|
| 16261 | "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",
|
| 16262 | "stability": "stable",
|
| 16263 | "summary": "Scale out or in to keep utilization at a given level."
|
| 16264 | },
|
| 16265 | "locationInModule": {
|
| 16266 | "filename": "lib/scalable-attribute-api.ts",
|
| 16267 | "line": 14
|
| 16268 | },
|
| 16269 | "name": "scaleOnUtilization",
|
| 16270 | "parameters": [
|
| 16271 | {
|
| 16272 | "name": "options",
|
| 16273 | "type": {
|
| 16274 | "fqn": "@aws-cdk/aws-lambda.UtilizationScalingOptions"
|
| 16275 | }
|
| 16276 | }
|
| 16277 | ]
|
| 16278 | }
|
| 16279 | ],
|
| 16280 | "name": "IScalableFunctionAttribute",
|
| 16281 | "symbolId": "lib/scalable-attribute-api:IScalableFunctionAttribute"
|
| 16282 | },
|
| 16283 | "@aws-cdk/aws-lambda.IVersion": {
|
| 16284 | "assembly": "@aws-cdk/aws-lambda",
|
| 16285 | "docs": {
|
| 16286 | "stability": "stable"
|
| 16287 | },
|
| 16288 | "fqn": "@aws-cdk/aws-lambda.IVersion",
|
| 16289 | "interfaces": [
|
| 16290 | "@aws-cdk/aws-lambda.IFunction"
|
| 16291 | ],
|
| 16292 | "kind": "interface",
|
| 16293 | "locationInModule": {
|
| 16294 | "filename": "lib/lambda-version.ts",
|
| 16295 | "line": 12
|
| 16296 | },
|
| 16297 | "methods": [
|
| 16298 | {
|
| 16299 | "abstract": true,
|
| 16300 | "docs": {
|
| 16301 | "deprecated": "Calling `addAlias` on a `Version` object will cause the Alias to be replaced on every function update. Call `function.addAlias()` or `new Alias()` instead.",
|
| 16302 | "stability": "deprecated",
|
| 16303 | "summary": "Defines an alias for this version."
|
| 16304 | },
|
| 16305 | "locationInModule": {
|
| 16306 | "filename": "lib/lambda-version.ts",
|
| 16307 | "line": 36
|
| 16308 | },
|
| 16309 | "name": "addAlias",
|
| 16310 | "parameters": [
|
| 16311 | {
|
| 16312 | "docs": {
|
| 16313 | "summary": "The name of the alias."
|
| 16314 | },
|
| 16315 | "name": "aliasName",
|
| 16316 | "type": {
|
| 16317 | "primitive": "string"
|
| 16318 | }
|
| 16319 | },
|
| 16320 | {
|
| 16321 | "docs": {
|
| 16322 | "summary": "Alias options."
|
| 16323 | },
|
| 16324 | "name": "options",
|
| 16325 | "optional": true,
|
| 16326 | "type": {
|
| 16327 | "fqn": "@aws-cdk/aws-lambda.AliasOptions"
|
| 16328 | }
|
| 16329 | }
|
| 16330 | ],
|
| 16331 | "returns": {
|
| 16332 | "type": {
|
| 16333 | "fqn": "@aws-cdk/aws-lambda.Alias"
|
| 16334 | }
|
| 16335 | }
|
| 16336 | }
|
| 16337 | ],
|
| 16338 | "name": "IVersion",
|
| 16339 | "properties": [
|
| 16340 | {
|
| 16341 | "abstract": true,
|
| 16342 | "docs": {
|
| 16343 | "stability": "stable",
|
| 16344 | "summary": "The ARN of the version for Lambda@Edge."
|
| 16345 | },
|
| 16346 | "immutable": true,
|
| 16347 | "locationInModule": {
|
| 16348 | "filename": "lib/lambda-version.ts",
|
| 16349 | "line": 27
|
| 16350 | },
|
| 16351 | "name": "edgeArn",
|
| 16352 | "type": {
|
| 16353 | "primitive": "string"
|
| 16354 | }
|
| 16355 | },
|
| 16356 | {
|
| 16357 | "abstract": true,
|
| 16358 | "docs": {
|
| 16359 | "stability": "stable",
|
| 16360 | "summary": "The underlying AWS Lambda function."
|
| 16361 | },
|
| 16362 | "immutable": true,
|
| 16363 | "locationInModule": {
|
| 16364 | "filename": "lib/lambda-version.ts",
|
| 16365 | "line": 22
|
| 16366 | },
|
| 16367 | "name": "lambda",
|
| 16368 | "type": {
|
| 16369 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 16370 | }
|
| 16371 | },
|
| 16372 | {
|
| 16373 | "abstract": true,
|
| 16374 | "docs": {
|
| 16375 | "custom": {
|
| 16376 | "attribute": "true"
|
| 16377 | },
|
| 16378 | "stability": "stable",
|
| 16379 | "summary": "The most recently deployed version of this function."
|
| 16380 | },
|
| 16381 | "immutable": true,
|
| 16382 | "locationInModule": {
|
| 16383 | "filename": "lib/lambda-version.ts",
|
| 16384 | "line": 17
|
| 16385 | },
|
| 16386 | "name": "version",
|
| 16387 | "type": {
|
| 16388 | "primitive": "string"
|
| 16389 | }
|
| 16390 | }
|
| 16391 | ],
|
| 16392 | "symbolId": "lib/lambda-version:IVersion"
|
| 16393 | },
|
| 16394 | "@aws-cdk/aws-lambda.InlineCode": {
|
| 16395 | "assembly": "@aws-cdk/aws-lambda",
|
| 16396 | "base": "@aws-cdk/aws-lambda.Code",
|
| 16397 | "docs": {
|
| 16398 | "stability": "stable",
|
| 16399 | "summary": "Lambda code from an inline string (limited to 4KiB).",
|
| 16400 | "example": "const layer = new lambda.LayerVersion(stack, 'MyLayer', {\n code: lambda.Code.fromAsset(path.join(__dirname, 'layer-code')),\n compatibleRuntimes: [lambda.Runtime.NODEJS_14_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_14_X,\n layers: [layer],\n});",
|
| 16401 | "custom": {
|
| 16402 | "exampleMetadata": "lit=test/integ.layer-version.lit.ts infused"
|
| 16403 | }
|
| 16404 | },
|
| 16405 | "fqn": "@aws-cdk/aws-lambda.InlineCode",
|
| 16406 | "initializer": {
|
| 16407 | "docs": {
|
| 16408 | "stability": "stable"
|
| 16409 | },
|
| 16410 | "locationInModule": {
|
| 16411 | "filename": "lib/code.ts",
|
| 16412 | "line": 249
|
| 16413 | },
|
| 16414 | "parameters": [
|
| 16415 | {
|
| 16416 | "name": "code",
|
| 16417 | "type": {
|
| 16418 | "primitive": "string"
|
| 16419 | }
|
| 16420 | }
|
| 16421 | ]
|
| 16422 | },
|
| 16423 | "kind": "class",
|
| 16424 | "locationInModule": {
|
| 16425 | "filename": "lib/code.ts",
|
| 16426 | "line": 246
|
| 16427 | },
|
| 16428 | "methods": [
|
| 16429 | {
|
| 16430 | "docs": {
|
| 16431 | "stability": "stable",
|
| 16432 | "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun."
|
| 16433 | },
|
| 16434 | "locationInModule": {
|
| 16435 | "filename": "lib/code.ts",
|
| 16436 | "line": 261
|
| 16437 | },
|
| 16438 | "name": "bind",
|
| 16439 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 16440 | "parameters": [
|
| 16441 | {
|
| 16442 | "name": "_scope",
|
| 16443 | "type": {
|
| 16444 | "fqn": "@aws-cdk/core.Construct"
|
| 16445 | }
|
| 16446 | }
|
| 16447 | ],
|
| 16448 | "returns": {
|
| 16449 | "type": {
|
| 16450 | "fqn": "@aws-cdk/aws-lambda.CodeConfig"
|
| 16451 | }
|
| 16452 | }
|
| 16453 | }
|
| 16454 | ],
|
| 16455 | "name": "InlineCode",
|
| 16456 | "properties": [
|
| 16457 | {
|
| 16458 | "docs": {
|
| 16459 | "stability": "stable",
|
| 16460 | "summary": "Determines whether this Code is inline code or not."
|
| 16461 | },
|
| 16462 | "immutable": true,
|
| 16463 | "locationInModule": {
|
| 16464 | "filename": "lib/code.ts",
|
| 16465 | "line": 247
|
| 16466 | },
|
| 16467 | "name": "isInline",
|
| 16468 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 16469 | "type": {
|
| 16470 | "primitive": "boolean"
|
| 16471 | }
|
| 16472 | }
|
| 16473 | ],
|
| 16474 | "symbolId": "lib/code:InlineCode"
|
| 16475 | },
|
| 16476 | "@aws-cdk/aws-lambda.LambdaInsightsVersion": {
|
| 16477 | "abstract": true,
|
| 16478 | "assembly": "@aws-cdk/aws-lambda",
|
| 16479 | "docs": {
|
| 16480 | "stability": "stable",
|
| 16481 | "summary": "Version of CloudWatch Lambda Insights.",
|
| 16482 | "example": "const layerArn = 'arn:aws:lambda:us-east-1:580247275435:layer:LambdaInsightsExtension:14';\nnew lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n insightsVersion: lambda.LambdaInsightsVersion.fromInsightVersionArn(layerArn),\n});",
|
| 16483 | "custom": {
|
| 16484 | "exampleMetadata": "infused"
|
| 16485 | }
|
| 16486 | },
|
| 16487 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion",
|
| 16488 | "initializer": {
|
| 16489 | "docs": {
|
| 16490 | "stability": "stable"
|
| 16491 | }
|
| 16492 | },
|
| 16493 | "kind": "class",
|
| 16494 | "locationInModule": {
|
| 16495 | "filename": "lib/lambda-insights.ts",
|
| 16496 | "line": 23
|
| 16497 | },
|
| 16498 | "methods": [
|
| 16499 | {
|
| 16500 | "docs": {
|
| 16501 | "remarks": "Make sure the ARN is associated\nwith same region as your function",
|
| 16502 | "see": "https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Lambda-Insights-extension-versions.html",
|
| 16503 | "stability": "stable",
|
| 16504 | "summary": "Use the insights extension associated with the provided ARN."
|
| 16505 | },
|
| 16506 | "locationInModule": {
|
| 16507 | "filename": "lib/lambda-insights.ts",
|
| 16508 | "line": 61
|
| 16509 | },
|
| 16510 | "name": "fromInsightVersionArn",
|
| 16511 | "parameters": [
|
| 16512 | {
|
| 16513 | "name": "arn",
|
| 16514 | "type": {
|
| 16515 | "primitive": "string"
|
| 16516 | }
|
| 16517 | }
|
| 16518 | ],
|
| 16519 | "returns": {
|
| 16520 | "type": {
|
| 16521 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion"
|
| 16522 | }
|
| 16523 | },
|
| 16524 | "static": true
|
| 16525 | }
|
| 16526 | ],
|
| 16527 | "name": "LambdaInsightsVersion",
|
| 16528 | "properties": [
|
| 16529 | {
|
| 16530 | "const": true,
|
| 16531 | "docs": {
|
| 16532 | "stability": "stable",
|
| 16533 | "summary": "Version 1.0.119.0."
|
| 16534 | },
|
| 16535 | "immutable": true,
|
| 16536 | "locationInModule": {
|
| 16537 | "filename": "lib/lambda-insights.ts",
|
| 16538 | "line": 48
|
| 16539 | },
|
| 16540 | "name": "VERSION_1_0_119_0",
|
| 16541 | "static": true,
|
| 16542 | "type": {
|
| 16543 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion"
|
| 16544 | }
|
| 16545 | },
|
| 16546 | {
|
| 16547 | "const": true,
|
| 16548 | "docs": {
|
| 16549 | "stability": "stable",
|
| 16550 | "summary": "Version 1.0.135.0."
|
| 16551 | },
|
| 16552 | "immutable": true,
|
| 16553 | "locationInModule": {
|
| 16554 | "filename": "lib/lambda-insights.ts",
|
| 16555 | "line": 53
|
| 16556 | },
|
| 16557 | "name": "VERSION_1_0_135_0",
|
| 16558 | "static": true,
|
| 16559 | "type": {
|
| 16560 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion"
|
| 16561 | }
|
| 16562 | },
|
| 16563 | {
|
| 16564 | "const": true,
|
| 16565 | "docs": {
|
| 16566 | "stability": "stable",
|
| 16567 | "summary": "Version 1.0.54.0."
|
| 16568 | },
|
| 16569 | "immutable": true,
|
| 16570 | "locationInModule": {
|
| 16571 | "filename": "lib/lambda-insights.ts",
|
| 16572 | "line": 28
|
| 16573 | },
|
| 16574 | "name": "VERSION_1_0_54_0",
|
| 16575 | "static": true,
|
| 16576 | "type": {
|
| 16577 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion"
|
| 16578 | }
|
| 16579 | },
|
| 16580 | {
|
| 16581 | "const": true,
|
| 16582 | "docs": {
|
| 16583 | "stability": "stable",
|
| 16584 | "summary": "Version 1.0.86.0."
|
| 16585 | },
|
| 16586 | "immutable": true,
|
| 16587 | "locationInModule": {
|
| 16588 | "filename": "lib/lambda-insights.ts",
|
| 16589 | "line": 33
|
| 16590 | },
|
| 16591 | "name": "VERSION_1_0_86_0",
|
| 16592 | "static": true,
|
| 16593 | "type": {
|
| 16594 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion"
|
| 16595 | }
|
| 16596 | },
|
| 16597 | {
|
| 16598 | "const": true,
|
| 16599 | "docs": {
|
| 16600 | "stability": "stable",
|
| 16601 | "summary": "Version 1.0.89.0."
|
| 16602 | },
|
| 16603 | "immutable": true,
|
| 16604 | "locationInModule": {
|
| 16605 | "filename": "lib/lambda-insights.ts",
|
| 16606 | "line": 38
|
| 16607 | },
|
| 16608 | "name": "VERSION_1_0_89_0",
|
| 16609 | "static": true,
|
| 16610 | "type": {
|
| 16611 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion"
|
| 16612 | }
|
| 16613 | },
|
| 16614 | {
|
| 16615 | "const": true,
|
| 16616 | "docs": {
|
| 16617 | "stability": "stable",
|
| 16618 | "summary": "Version 1.0.98.0."
|
| 16619 | },
|
| 16620 | "immutable": true,
|
| 16621 | "locationInModule": {
|
| 16622 | "filename": "lib/lambda-insights.ts",
|
| 16623 | "line": 43
|
| 16624 | },
|
| 16625 | "name": "VERSION_1_0_98_0",
|
| 16626 | "static": true,
|
| 16627 | "type": {
|
| 16628 | "fqn": "@aws-cdk/aws-lambda.LambdaInsightsVersion"
|
| 16629 | }
|
| 16630 | },
|
| 16631 | {
|
| 16632 | "docs": {
|
| 16633 | "stability": "stable",
|
| 16634 | "summary": "The arn of the Lambda Insights extension."
|
| 16635 | },
|
| 16636 | "immutable": true,
|
| 16637 | "locationInModule": {
|
| 16638 | "filename": "lib/lambda-insights.ts",
|
| 16639 | "line": 98
|
| 16640 | },
|
| 16641 | "name": "layerVersionArn",
|
| 16642 | "type": {
|
| 16643 | "primitive": "string"
|
| 16644 | }
|
| 16645 | }
|
| 16646 | ],
|
| 16647 | "symbolId": "lib/lambda-insights:LambdaInsightsVersion"
|
| 16648 | },
|
| 16649 | "@aws-cdk/aws-lambda.LambdaRuntimeProps": {
|
| 16650 | "assembly": "@aws-cdk/aws-lambda",
|
| 16651 | "datatype": true,
|
| 16652 | "docs": {
|
| 16653 | "stability": "stable",
|
| 16654 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst lambdaRuntimeProps: lambda.LambdaRuntimeProps = {\n bundlingDockerImage: 'bundlingDockerImage',\n supportsCodeGuruProfiling: false,\n supportsInlineCode: false,\n};",
|
| 16655 | "custom": {
|
| 16656 | "exampleMetadata": "fixture=_generated"
|
| 16657 | }
|
| 16658 | },
|
| 16659 | "fqn": "@aws-cdk/aws-lambda.LambdaRuntimeProps",
|
| 16660 | "kind": "interface",
|
| 16661 | "locationInModule": {
|
| 16662 | "filename": "lib/runtime.ts",
|
| 16663 | "line": 3
|
| 16664 | },
|
| 16665 | "name": "LambdaRuntimeProps",
|
| 16666 | "properties": [
|
| 16667 | {
|
| 16668 | "abstract": true,
|
| 16669 | "docs": {
|
| 16670 | "default": "- the latest docker image \"amazon/public.ecr.aws/sam/build-<runtime>\" from https://gallery.ecr.aws",
|
| 16671 | "stability": "stable",
|
| 16672 | "summary": "The Docker image name to be used for bundling in this runtime."
|
| 16673 | },
|
| 16674 | "immutable": true,
|
| 16675 | "locationInModule": {
|
| 16676 | "filename": "lib/runtime.ts",
|
| 16677 | "line": 14
|
| 16678 | },
|
| 16679 | "name": "bundlingDockerImage",
|
| 16680 | "optional": true,
|
| 16681 | "type": {
|
| 16682 | "primitive": "string"
|
| 16683 | }
|
| 16684 | },
|
| 16685 | {
|
| 16686 | "abstract": true,
|
| 16687 | "docs": {
|
| 16688 | "default": "false",
|
| 16689 | "stability": "stable",
|
| 16690 | "summary": "Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler."
|
| 16691 | },
|
| 16692 | "immutable": true,
|
| 16693 | "locationInModule": {
|
| 16694 | "filename": "lib/runtime.ts",
|
| 16695 | "line": 20
|
| 16696 | },
|
| 16697 | "name": "supportsCodeGuruProfiling",
|
| 16698 | "optional": true,
|
| 16699 | "type": {
|
| 16700 | "primitive": "boolean"
|
| 16701 | }
|
| 16702 | },
|
| 16703 | {
|
| 16704 | "abstract": true,
|
| 16705 | "docs": {
|
| 16706 | "default": "false",
|
| 16707 | "stability": "stable",
|
| 16708 | "summary": "Whether the ``ZipFile`` (aka inline code) property can be used with this runtime."
|
| 16709 | },
|
| 16710 | "immutable": true,
|
| 16711 | "locationInModule": {
|
| 16712 | "filename": "lib/runtime.ts",
|
| 16713 | "line": 8
|
| 16714 | },
|
| 16715 | "name": "supportsInlineCode",
|
| 16716 | "optional": true,
|
| 16717 | "type": {
|
| 16718 | "primitive": "boolean"
|
| 16719 | }
|
| 16720 | }
|
| 16721 | ],
|
| 16722 | "symbolId": "lib/runtime:LambdaRuntimeProps"
|
| 16723 | },
|
| 16724 | "@aws-cdk/aws-lambda.LayerVersion": {
|
| 16725 | "assembly": "@aws-cdk/aws-lambda",
|
| 16726 | "base": "@aws-cdk/core.Resource",
|
| 16727 | "docs": {
|
| 16728 | "stability": "stable",
|
| 16729 | "summary": "Defines a new Lambda Layer version.",
|
| 16730 | "example": "new lambda.LayerVersion(this, 'MyLayer', {\n removalPolicy: RemovalPolicy.RETAIN,\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n compatibleArchitectures: [lambda.Architecture.X86_64, lambda.Architecture.ARM_64],\n});",
|
| 16731 | "custom": {
|
| 16732 | "exampleMetadata": "infused"
|
| 16733 | }
|
| 16734 | },
|
| 16735 | "fqn": "@aws-cdk/aws-lambda.LayerVersion",
|
| 16736 | "initializer": {
|
| 16737 | "docs": {
|
| 16738 | "stability": "stable"
|
| 16739 | },
|
| 16740 | "locationInModule": {
|
| 16741 | "filename": "lib/layers.ts",
|
| 16742 | "line": 184
|
| 16743 | },
|
| 16744 | "parameters": [
|
| 16745 | {
|
| 16746 | "name": "scope",
|
| 16747 | "type": {
|
| 16748 | "fqn": "constructs.Construct"
|
| 16749 | }
|
| 16750 | },
|
| 16751 | {
|
| 16752 | "name": "id",
|
| 16753 | "type": {
|
| 16754 | "primitive": "string"
|
| 16755 | }
|
| 16756 | },
|
| 16757 | {
|
| 16758 | "name": "props",
|
| 16759 | "type": {
|
| 16760 | "fqn": "@aws-cdk/aws-lambda.LayerVersionProps"
|
| 16761 | }
|
| 16762 | }
|
| 16763 | ]
|
| 16764 | },
|
| 16765 | "interfaces": [
|
| 16766 | "@aws-cdk/aws-lambda.ILayerVersion"
|
| 16767 | ],
|
| 16768 | "kind": "class",
|
| 16769 | "locationInModule": {
|
| 16770 | "filename": "lib/layers.ts",
|
| 16771 | "line": 149
|
| 16772 | },
|
| 16773 | "methods": [
|
| 16774 | {
|
| 16775 | "docs": {
|
| 16776 | "remarks": "Assumes it is compatible with all Lambda runtimes.",
|
| 16777 | "stability": "stable",
|
| 16778 | "summary": "Imports a layer version by ARN."
|
| 16779 | },
|
| 16780 | "locationInModule": {
|
| 16781 | "filename": "lib/layers.ts",
|
| 16782 | "line": 154
|
| 16783 | },
|
| 16784 | "name": "fromLayerVersionArn",
|
| 16785 | "parameters": [
|
| 16786 | {
|
| 16787 | "name": "scope",
|
| 16788 | "type": {
|
| 16789 | "fqn": "constructs.Construct"
|
| 16790 | }
|
| 16791 | },
|
| 16792 | {
|
| 16793 | "name": "id",
|
| 16794 | "type": {
|
| 16795 | "primitive": "string"
|
| 16796 | }
|
| 16797 | },
|
| 16798 | {
|
| 16799 | "name": "layerVersionArn",
|
| 16800 | "type": {
|
| 16801 | "primitive": "string"
|
| 16802 | }
|
| 16803 | }
|
| 16804 | ],
|
| 16805 | "returns": {
|
| 16806 | "type": {
|
| 16807 | "fqn": "@aws-cdk/aws-lambda.ILayerVersion"
|
| 16808 | }
|
| 16809 | },
|
| 16810 | "static": true
|
| 16811 | },
|
| 16812 | {
|
| 16813 | "docs": {
|
| 16814 | "stability": "stable",
|
| 16815 | "summary": "Imports a Layer that has been defined externally."
|
| 16816 | },
|
| 16817 | "locationInModule": {
|
| 16818 | "filename": "lib/layers.ts",
|
| 16819 | "line": 168
|
| 16820 | },
|
| 16821 | "name": "fromLayerVersionAttributes",
|
| 16822 | "parameters": [
|
| 16823 | {
|
| 16824 | "docs": {
|
| 16825 | "summary": "the parent Construct that will use the imported layer."
|
| 16826 | },
|
| 16827 | "name": "scope",
|
| 16828 | "type": {
|
| 16829 | "fqn": "constructs.Construct"
|
| 16830 | }
|
| 16831 | },
|
| 16832 | {
|
| 16833 | "docs": {
|
| 16834 | "summary": "the id of the imported layer in the construct tree."
|
| 16835 | },
|
| 16836 | "name": "id",
|
| 16837 | "type": {
|
| 16838 | "primitive": "string"
|
| 16839 | }
|
| 16840 | },
|
| 16841 | {
|
| 16842 | "docs": {
|
| 16843 | "summary": "the properties of the imported layer."
|
| 16844 | },
|
| 16845 | "name": "attrs",
|
| 16846 | "type": {
|
| 16847 | "fqn": "@aws-cdk/aws-lambda.LayerVersionAttributes"
|
| 16848 | }
|
| 16849 | }
|
| 16850 | ],
|
| 16851 | "returns": {
|
| 16852 | "type": {
|
| 16853 | "fqn": "@aws-cdk/aws-lambda.ILayerVersion"
|
| 16854 | }
|
| 16855 | },
|
| 16856 | "static": true
|
| 16857 | },
|
| 16858 | {
|
| 16859 | "docs": {
|
| 16860 | "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.",
|
| 16861 | "stability": "stable",
|
| 16862 | "summary": "Add permission for this layer version to specific entities."
|
| 16863 | },
|
| 16864 | "locationInModule": {
|
| 16865 | "filename": "lib/layers.ts",
|
| 16866 | "line": 99
|
| 16867 | },
|
| 16868 | "name": "addPermission",
|
| 16869 | "overrides": "@aws-cdk/aws-lambda.ILayerVersion",
|
| 16870 | "parameters": [
|
| 16871 | {
|
| 16872 | "name": "id",
|
| 16873 | "type": {
|
| 16874 | "primitive": "string"
|
| 16875 | }
|
| 16876 | },
|
| 16877 | {
|
| 16878 | "name": "permission",
|
| 16879 | "type": {
|
| 16880 | "fqn": "@aws-cdk/aws-lambda.LayerVersionPermission"
|
| 16881 | }
|
| 16882 | }
|
| 16883 | ]
|
| 16884 | }
|
| 16885 | ],
|
| 16886 | "name": "LayerVersion",
|
| 16887 | "properties": [
|
| 16888 | {
|
| 16889 | "docs": {
|
| 16890 | "stability": "stable",
|
| 16891 | "summary": "The ARN of the Lambda Layer version that this Layer defines."
|
| 16892 | },
|
| 16893 | "immutable": true,
|
| 16894 | "locationInModule": {
|
| 16895 | "filename": "lib/layers.ts",
|
| 16896 | "line": 181
|
| 16897 | },
|
| 16898 | "name": "layerVersionArn",
|
| 16899 | "overrides": "@aws-cdk/aws-lambda.ILayerVersion",
|
| 16900 | "type": {
|
| 16901 | "primitive": "string"
|
| 16902 | }
|
| 16903 | },
|
| 16904 | {
|
| 16905 | "docs": {
|
| 16906 | "stability": "stable",
|
| 16907 | "summary": "The runtimes compatible with this Layer."
|
| 16908 | },
|
| 16909 | "immutable": true,
|
| 16910 | "locationInModule": {
|
| 16911 | "filename": "lib/layers.ts",
|
| 16912 | "line": 182
|
| 16913 | },
|
| 16914 | "name": "compatibleRuntimes",
|
| 16915 | "optional": true,
|
| 16916 | "overrides": "@aws-cdk/aws-lambda.ILayerVersion",
|
| 16917 | "type": {
|
| 16918 | "collection": {
|
| 16919 | "elementtype": {
|
| 16920 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 16921 | },
|
| 16922 | "kind": "array"
|
| 16923 | }
|
| 16924 | }
|
| 16925 | }
|
| 16926 | ],
|
| 16927 | "symbolId": "lib/layers:LayerVersion"
|
| 16928 | },
|
| 16929 | "@aws-cdk/aws-lambda.LayerVersionAttributes": {
|
| 16930 | "assembly": "@aws-cdk/aws-lambda",
|
| 16931 | "datatype": true,
|
| 16932 | "docs": {
|
| 16933 | "stability": "stable",
|
| 16934 | "summary": "Properties necessary to import a LayerVersion.",
|
| 16935 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\n\ndeclare const runtime: lambda.Runtime;\nconst layerVersionAttributes: lambda.LayerVersionAttributes = {\n layerVersionArn: 'layerVersionArn',\n\n // the properties below are optional\n compatibleRuntimes: [runtime],\n};",
|
| 16936 | "custom": {
|
| 16937 | "exampleMetadata": "fixture=_generated"
|
| 16938 | }
|
| 16939 | },
|
| 16940 | "fqn": "@aws-cdk/aws-lambda.LayerVersionAttributes",
|
| 16941 | "kind": "interface",
|
| 16942 | "locationInModule": {
|
| 16943 | "filename": "lib/layers.ts",
|
| 16944 | "line": 134
|
| 16945 | },
|
| 16946 | "name": "LayerVersionAttributes",
|
| 16947 | "properties": [
|
| 16948 | {
|
| 16949 | "abstract": true,
|
| 16950 | "docs": {
|
| 16951 | "stability": "stable",
|
| 16952 | "summary": "The ARN of the LayerVersion."
|
| 16953 | },
|
| 16954 | "immutable": true,
|
| 16955 | "locationInModule": {
|
| 16956 | "filename": "lib/layers.ts",
|
| 16957 | "line": 138
|
| 16958 | },
|
| 16959 | "name": "layerVersionArn",
|
| 16960 | "type": {
|
| 16961 | "primitive": "string"
|
| 16962 | }
|
| 16963 | },
|
| 16964 | {
|
| 16965 | "abstract": true,
|
| 16966 | "docs": {
|
| 16967 | "stability": "stable",
|
| 16968 | "summary": "The list of compatible runtimes with this Layer."
|
| 16969 | },
|
| 16970 | "immutable": true,
|
| 16971 | "locationInModule": {
|
| 16972 | "filename": "lib/layers.ts",
|
| 16973 | "line": 143
|
| 16974 | },
|
| 16975 | "name": "compatibleRuntimes",
|
| 16976 | "optional": true,
|
| 16977 | "type": {
|
| 16978 | "collection": {
|
| 16979 | "elementtype": {
|
| 16980 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 16981 | },
|
| 16982 | "kind": "array"
|
| 16983 | }
|
| 16984 | }
|
| 16985 | }
|
| 16986 | ],
|
| 16987 | "symbolId": "lib/layers:LayerVersionAttributes"
|
| 16988 | },
|
| 16989 | "@aws-cdk/aws-lambda.LayerVersionOptions": {
|
| 16990 | "assembly": "@aws-cdk/aws-lambda",
|
| 16991 | "datatype": true,
|
| 16992 | "docs": {
|
| 16993 | "stability": "stable",
|
| 16994 | "summary": "Non runtime options.",
|
| 16995 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\nconst layerVersionOptions: lambda.LayerVersionOptions = {\n description: 'description',\n layerVersionName: 'layerVersionName',\n license: 'license',\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n};",
|
| 16996 | "custom": {
|
| 16997 | "exampleMetadata": "fixture=_generated"
|
| 16998 | }
|
| 16999 | },
|
| 17000 | "fqn": "@aws-cdk/aws-lambda.LayerVersionOptions",
|
| 17001 | "kind": "interface",
|
| 17002 | "locationInModule": {
|
| 17003 | "filename": "lib/layers.ts",
|
| 17004 | "line": 11
|
| 17005 | },
|
| 17006 | "name": "LayerVersionOptions",
|
| 17007 | "properties": [
|
| 17008 | {
|
| 17009 | "abstract": true,
|
| 17010 | "docs": {
|
| 17011 | "default": "- No description.",
|
| 17012 | "stability": "stable",
|
| 17013 | "summary": "The description the this Lambda Layer."
|
| 17014 | },
|
| 17015 | "immutable": true,
|
| 17016 | "locationInModule": {
|
| 17017 | "filename": "lib/layers.ts",
|
| 17018 | "line": 17
|
| 17019 | },
|
| 17020 | "name": "description",
|
| 17021 | "optional": true,
|
| 17022 | "type": {
|
| 17023 | "primitive": "string"
|
| 17024 | }
|
| 17025 | },
|
| 17026 | {
|
| 17027 | "abstract": true,
|
| 17028 | "docs": {
|
| 17029 | "default": "- A name will be generated.",
|
| 17030 | "stability": "stable",
|
| 17031 | "summary": "The name of the layer."
|
| 17032 | },
|
| 17033 | "immutable": true,
|
| 17034 | "locationInModule": {
|
| 17035 | "filename": "lib/layers.ts",
|
| 17036 | "line": 31
|
| 17037 | },
|
| 17038 | "name": "layerVersionName",
|
| 17039 | "optional": true,
|
| 17040 | "type": {
|
| 17041 | "primitive": "string"
|
| 17042 | }
|
| 17043 | },
|
| 17044 | {
|
| 17045 | "abstract": true,
|
| 17046 | "docs": {
|
| 17047 | "default": "- No license information will be recorded.",
|
| 17048 | "stability": "stable",
|
| 17049 | "summary": "The SPDX licence identifier or URL to the license file for this layer."
|
| 17050 | },
|
| 17051 | "immutable": true,
|
| 17052 | "locationInModule": {
|
| 17053 | "filename": "lib/layers.ts",
|
| 17054 | "line": 24
|
| 17055 | },
|
| 17056 | "name": "license",
|
| 17057 | "optional": true,
|
| 17058 | "type": {
|
| 17059 | "primitive": "string"
|
| 17060 | }
|
| 17061 | },
|
| 17062 | {
|
| 17063 | "abstract": true,
|
| 17064 | "docs": {
|
| 17065 | "default": "RemovalPolicy.DESTROY",
|
| 17066 | "stability": "stable",
|
| 17067 | "summary": "Whether to retain this version of the layer when a new version is added or when the stack is deleted."
|
| 17068 | },
|
| 17069 | "immutable": true,
|
| 17070 | "locationInModule": {
|
| 17071 | "filename": "lib/layers.ts",
|
| 17072 | "line": 39
|
| 17073 | },
|
| 17074 | "name": "removalPolicy",
|
| 17075 | "optional": true,
|
| 17076 | "type": {
|
| 17077 | "fqn": "@aws-cdk/core.RemovalPolicy"
|
| 17078 | }
|
| 17079 | }
|
| 17080 | ],
|
| 17081 | "symbolId": "lib/layers:LayerVersionOptions"
|
| 17082 | },
|
| 17083 | "@aws-cdk/aws-lambda.LayerVersionPermission": {
|
| 17084 | "assembly": "@aws-cdk/aws-lambda",
|
| 17085 | "datatype": true,
|
| 17086 | "docs": {
|
| 17087 | "stability": "stable",
|
| 17088 | "summary": "Identification of an account (or organization) that is allowed to access a Lambda Layer Version.",
|
| 17089 | "example": "const layer = new lambda.LayerVersion(stack, 'MyLayer', {\n code: lambda.Code.fromAsset(path.join(__dirname, 'layer-code')),\n compatibleRuntimes: [lambda.Runtime.NODEJS_14_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_14_X,\n layers: [layer],\n});",
|
| 17090 | "custom": {
|
| 17091 | "exampleMetadata": "lit=test/integ.layer-version.lit.ts infused"
|
| 17092 | }
|
| 17093 | },
|
| 17094 | "fqn": "@aws-cdk/aws-lambda.LayerVersionPermission",
|
| 17095 | "kind": "interface",
|
| 17096 | "locationInModule": {
|
| 17097 | "filename": "lib/layers.ts",
|
| 17098 | "line": 116
|
| 17099 | },
|
| 17100 | "name": "LayerVersionPermission",
|
| 17101 | "properties": [
|
| 17102 | {
|
| 17103 | "abstract": true,
|
| 17104 | "docs": {
|
| 17105 | "remarks": "The wild-card ``'*'`` can be\nused to grant access to \"any\" account (or any account in an organization when ``organizationId`` is specified).",
|
| 17106 | "stability": "stable",
|
| 17107 | "summary": "The AWS Account id of the account that is authorized to use a Lambda Layer Version."
|
| 17108 | },
|
| 17109 | "immutable": true,
|
| 17110 | "locationInModule": {
|
| 17111 | "filename": "lib/layers.ts",
|
| 17112 | "line": 121
|
| 17113 | },
|
| 17114 | "name": "accountId",
|
| 17115 | "type": {
|
| 17116 | "primitive": "string"
|
| 17117 | }
|
| 17118 | },
|
| 17119 | {
|
| 17120 | "abstract": true,
|
| 17121 | "docs": {
|
| 17122 | "remarks": "Can only be specified if ``accountId`` is ``'*'``",
|
| 17123 | "stability": "stable",
|
| 17124 | "summary": "The ID of the AWS Organization to which the grant is restricted."
|
| 17125 | },
|
| 17126 | "immutable": true,
|
| 17127 | "locationInModule": {
|
| 17128 | "filename": "lib/layers.ts",
|
| 17129 | "line": 128
|
| 17130 | },
|
| 17131 | "name": "organizationId",
|
| 17132 | "optional": true,
|
| 17133 | "type": {
|
| 17134 | "primitive": "string"
|
| 17135 | }
|
| 17136 | }
|
| 17137 | ],
|
| 17138 | "symbolId": "lib/layers:LayerVersionPermission"
|
| 17139 | },
|
| 17140 | "@aws-cdk/aws-lambda.LayerVersionProps": {
|
| 17141 | "assembly": "@aws-cdk/aws-lambda",
|
| 17142 | "datatype": true,
|
| 17143 | "docs": {
|
| 17144 | "stability": "stable",
|
| 17145 | "example": "new lambda.LayerVersion(this, 'MyLayer', {\n removalPolicy: RemovalPolicy.RETAIN,\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n compatibleArchitectures: [lambda.Architecture.X86_64, lambda.Architecture.ARM_64],\n});",
|
| 17146 | "custom": {
|
| 17147 | "exampleMetadata": "infused"
|
| 17148 | }
|
| 17149 | },
|
| 17150 | "fqn": "@aws-cdk/aws-lambda.LayerVersionProps",
|
| 17151 | "interfaces": [
|
| 17152 | "@aws-cdk/aws-lambda.LayerVersionOptions"
|
| 17153 | ],
|
| 17154 | "kind": "interface",
|
| 17155 | "locationInModule": {
|
| 17156 | "filename": "lib/layers.ts",
|
| 17157 | "line": 42
|
| 17158 | },
|
| 17159 | "name": "LayerVersionProps",
|
| 17160 | "properties": [
|
| 17161 | {
|
| 17162 | "abstract": true,
|
| 17163 | "docs": {
|
| 17164 | "remarks": "Using `Code.fromInline` is not supported.",
|
| 17165 | "stability": "stable",
|
| 17166 | "summary": "The content of this Layer."
|
| 17167 | },
|
| 17168 | "immutable": true,
|
| 17169 | "locationInModule": {
|
| 17170 | "filename": "lib/layers.ts",
|
| 17171 | "line": 61
|
| 17172 | },
|
| 17173 | "name": "code",
|
| 17174 | "type": {
|
| 17175 | "fqn": "@aws-cdk/aws-lambda.Code"
|
| 17176 | }
|
| 17177 | },
|
| 17178 | {
|
| 17179 | "abstract": true,
|
| 17180 | "docs": {
|
| 17181 | "default": "[Architecture.X86_64]",
|
| 17182 | "stability": "stable",
|
| 17183 | "summary": "The system architectures compatible with this layer."
|
| 17184 | },
|
| 17185 | "immutable": true,
|
| 17186 | "locationInModule": {
|
| 17187 | "filename": "lib/layers.ts",
|
| 17188 | "line": 54
|
| 17189 | },
|
| 17190 | "name": "compatibleArchitectures",
|
| 17191 | "optional": true,
|
| 17192 | "type": {
|
| 17193 | "collection": {
|
| 17194 | "elementtype": {
|
| 17195 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 17196 | },
|
| 17197 | "kind": "array"
|
| 17198 | }
|
| 17199 | }
|
| 17200 | },
|
| 17201 | {
|
| 17202 | "abstract": true,
|
| 17203 | "docs": {
|
| 17204 | "default": "- All runtimes are supported.",
|
| 17205 | "stability": "stable",
|
| 17206 | "summary": "The runtimes compatible with this Layer."
|
| 17207 | },
|
| 17208 | "immutable": true,
|
| 17209 | "locationInModule": {
|
| 17210 | "filename": "lib/layers.ts",
|
| 17211 | "line": 48
|
| 17212 | },
|
| 17213 | "name": "compatibleRuntimes",
|
| 17214 | "optional": true,
|
| 17215 | "type": {
|
| 17216 | "collection": {
|
| 17217 | "elementtype": {
|
| 17218 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17219 | },
|
| 17220 | "kind": "array"
|
| 17221 | }
|
| 17222 | }
|
| 17223 | }
|
| 17224 | ],
|
| 17225 | "symbolId": "lib/layers:LayerVersionProps"
|
| 17226 | },
|
| 17227 | "@aws-cdk/aws-lambda.LogRetention": {
|
| 17228 | "assembly": "@aws-cdk/aws-lambda",
|
| 17229 | "base": "@aws-cdk/aws-logs.LogRetention",
|
| 17230 | "docs": {
|
| 17231 | "custom": {
|
| 17232 | "aws-cdk": "/aws-logs' instead",
|
| 17233 | "exampleMetadata": "fixture=_generated"
|
| 17234 | },
|
| 17235 | "deprecated": "use `LogRetention` from '",
|
| 17236 | "remarks": "The log group is created if it doesn't already exist. The policy\nis removed when `retentionDays` is `undefined` or equal to `Infinity`.",
|
| 17237 | "stability": "deprecated",
|
| 17238 | "summary": "Creates a custom resource to control the retention policy of a CloudWatch Logs log group.",
|
| 17239 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const role: iam.Role;\nconst logRetention = new lambda.LogRetention(this, 'MyLogRetention', {\n logGroupName: 'logGroupName',\n retention: logs.RetentionDays.ONE_DAY,\n\n // the properties below are optional\n logGroupRegion: 'logGroupRegion',\n logRetentionRetryOptions: {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n },\n role: role,\n});"
|
| 17240 | },
|
| 17241 | "fqn": "@aws-cdk/aws-lambda.LogRetention",
|
| 17242 | "initializer": {
|
| 17243 | "docs": {
|
| 17244 | "stability": "deprecated"
|
| 17245 | },
|
| 17246 | "locationInModule": {
|
| 17247 | "filename": "lib/log-retention.ts",
|
| 17248 | "line": 26
|
| 17249 | },
|
| 17250 | "parameters": [
|
| 17251 | {
|
| 17252 | "name": "scope",
|
| 17253 | "type": {
|
| 17254 | "fqn": "constructs.Construct"
|
| 17255 | }
|
| 17256 | },
|
| 17257 | {
|
| 17258 | "name": "id",
|
| 17259 | "type": {
|
| 17260 | "primitive": "string"
|
| 17261 | }
|
| 17262 | },
|
| 17263 | {
|
| 17264 | "name": "props",
|
| 17265 | "type": {
|
| 17266 | "fqn": "@aws-cdk/aws-lambda.LogRetentionProps"
|
| 17267 | }
|
| 17268 | }
|
| 17269 | ]
|
| 17270 | },
|
| 17271 | "kind": "class",
|
| 17272 | "locationInModule": {
|
| 17273 | "filename": "lib/log-retention.ts",
|
| 17274 | "line": 25
|
| 17275 | },
|
| 17276 | "name": "LogRetention",
|
| 17277 | "symbolId": "lib/log-retention:LogRetention"
|
| 17278 | },
|
| 17279 | "@aws-cdk/aws-lambda.LogRetentionProps": {
|
| 17280 | "assembly": "@aws-cdk/aws-lambda",
|
| 17281 | "datatype": true,
|
| 17282 | "docs": {
|
| 17283 | "custom": {
|
| 17284 | "aws-cdk": "/aws-logs' instead",
|
| 17285 | "exampleMetadata": "fixture=_generated"
|
| 17286 | },
|
| 17287 | "deprecated": "use `LogRetentionProps` from '",
|
| 17288 | "stability": "deprecated",
|
| 17289 | "summary": "Construction properties for a LogRetention.",
|
| 17290 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const role: iam.Role;\nconst logRetentionProps: lambda.LogRetentionProps = {\n logGroupName: 'logGroupName',\n retention: logs.RetentionDays.ONE_DAY,\n\n // the properties below are optional\n logGroupRegion: 'logGroupRegion',\n logRetentionRetryOptions: {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n },\n role: role,\n};"
|
| 17291 | },
|
| 17292 | "fqn": "@aws-cdk/aws-lambda.LogRetentionProps",
|
| 17293 | "interfaces": [
|
| 17294 | "@aws-cdk/aws-logs.LogRetentionProps"
|
| 17295 | ],
|
| 17296 | "kind": "interface",
|
| 17297 | "locationInModule": {
|
| 17298 | "filename": "lib/log-retention.ts",
|
| 17299 | "line": 15
|
| 17300 | },
|
| 17301 | "name": "LogRetentionProps",
|
| 17302 | "symbolId": "lib/log-retention:LogRetentionProps"
|
| 17303 | },
|
| 17304 | "@aws-cdk/aws-lambda.LogRetentionRetryOptions": {
|
| 17305 | "assembly": "@aws-cdk/aws-lambda",
|
| 17306 | "datatype": true,
|
| 17307 | "docs": {
|
| 17308 | "stability": "stable",
|
| 17309 | "summary": "Retry options for all AWS API calls.",
|
| 17310 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as cdk from '@aws-cdk/core';\nconst logRetentionRetryOptions: lambda.LogRetentionRetryOptions = {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n};",
|
| 17311 | "custom": {
|
| 17312 | "exampleMetadata": "fixture=_generated"
|
| 17313 | }
|
| 17314 | },
|
| 17315 | "fqn": "@aws-cdk/aws-lambda.LogRetentionRetryOptions",
|
| 17316 | "interfaces": [
|
| 17317 | "@aws-cdk/aws-logs.LogRetentionRetryOptions"
|
| 17318 | ],
|
| 17319 | "kind": "interface",
|
| 17320 | "locationInModule": {
|
| 17321 | "filename": "lib/log-retention.ts",
|
| 17322 | "line": 7
|
| 17323 | },
|
| 17324 | "name": "LogRetentionRetryOptions",
|
| 17325 | "symbolId": "lib/log-retention:LogRetentionRetryOptions"
|
| 17326 | },
|
| 17327 | "@aws-cdk/aws-lambda.Permission": {
|
| 17328 | "assembly": "@aws-cdk/aws-lambda",
|
| 17329 | "datatype": true,
|
| 17330 | "docs": {
|
| 17331 | "stability": "stable",
|
| 17332 | "summary": "Represents a permission statement that can be added to a Lambda function's resource policy via the `addPermission()` method.",
|
| 17333 | "example": "declare const fn: lambda.Function;\nconst principal = new iam.ServicePrincipal('my-service');\n\nfn.grantInvoke(principal);\n\n// Equivalent to:\nfn.addPermission('my-service Invocation', {\n principal: principal,\n});",
|
| 17334 | "custom": {
|
| 17335 | "exampleMetadata": "infused"
|
| 17336 | }
|
| 17337 | },
|
| 17338 | "fqn": "@aws-cdk/aws-lambda.Permission",
|
| 17339 | "kind": "interface",
|
| 17340 | "locationInModule": {
|
| 17341 | "filename": "lib/permission.ts",
|
| 17342 | "line": 13
|
| 17343 | },
|
| 17344 | "name": "Permission",
|
| 17345 | "properties": [
|
| 17346 | {
|
| 17347 | "abstract": true,
|
| 17348 | "docs": {
|
| 17349 | "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.",
|
| 17350 | "stability": "stable",
|
| 17351 | "summary": "The entity for which you are granting permission to invoke the Lambda function."
|
| 17352 | },
|
| 17353 | "immutable": true,
|
| 17354 | "locationInModule": {
|
| 17355 | "filename": "lib/permission.ts",
|
| 17356 | "line": 43
|
| 17357 | },
|
| 17358 | "name": "principal",
|
| 17359 | "type": {
|
| 17360 | "fqn": "@aws-cdk/aws-iam.IPrincipal"
|
| 17361 | }
|
| 17362 | },
|
| 17363 | {
|
| 17364 | "abstract": true,
|
| 17365 | "docs": {
|
| 17366 | "default": "'lambda:InvokeFunction'",
|
| 17367 | "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.",
|
| 17368 | "stability": "stable",
|
| 17369 | "summary": "The Lambda actions that you want to allow in this statement."
|
| 17370 | },
|
| 17371 | "immutable": true,
|
| 17372 | "locationInModule": {
|
| 17373 | "filename": "lib/permission.ts",
|
| 17374 | "line": 23
|
| 17375 | },
|
| 17376 | "name": "action",
|
| 17377 | "optional": true,
|
| 17378 | "type": {
|
| 17379 | "primitive": "string"
|
| 17380 | }
|
| 17381 | },
|
| 17382 | {
|
| 17383 | "abstract": true,
|
| 17384 | "docs": {
|
| 17385 | "default": "The caller would not need to present a token.",
|
| 17386 | "stability": "stable",
|
| 17387 | "summary": "A unique token that must be supplied by the principal invoking the function."
|
| 17388 | },
|
| 17389 | "immutable": true,
|
| 17390 | "locationInModule": {
|
| 17391 | "filename": "lib/permission.ts",
|
| 17392 | "line": 31
|
| 17393 | },
|
| 17394 | "name": "eventSourceToken",
|
| 17395 | "optional": true,
|
| 17396 | "type": {
|
| 17397 | "primitive": "string"
|
| 17398 | }
|
| 17399 | },
|
| 17400 | {
|
| 17401 | "abstract": true,
|
| 17402 | "docs": {
|
| 17403 | "default": "- No functionUrlAuthType",
|
| 17404 | "stability": "stable",
|
| 17405 | "summary": "The authType for the function URL that you are granting permissions for."
|
| 17406 | },
|
| 17407 | "immutable": true,
|
| 17408 | "locationInModule": {
|
| 17409 | "filename": "lib/permission.ts",
|
| 17410 | "line": 78
|
| 17411 | },
|
| 17412 | "name": "functionUrlAuthType",
|
| 17413 | "optional": true,
|
| 17414 | "type": {
|
| 17415 | "fqn": "@aws-cdk/aws-lambda.FunctionUrlAuthType"
|
| 17416 | }
|
| 17417 | },
|
| 17418 | {
|
| 17419 | "abstract": true,
|
| 17420 | "docs": {
|
| 17421 | "default": "- The instance of lambda.IFunction",
|
| 17422 | "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).",
|
| 17423 | "stability": "stable",
|
| 17424 | "summary": "The scope to which the permission constructs be attached."
|
| 17425 | },
|
| 17426 | "immutable": true,
|
| 17427 | "locationInModule": {
|
| 17428 | "filename": "lib/permission.ts",
|
| 17429 | "line": 53
|
| 17430 | },
|
| 17431 | "name": "scope",
|
| 17432 | "optional": true,
|
| 17433 | "type": {
|
| 17434 | "fqn": "@aws-cdk/core.Construct"
|
| 17435 | }
|
| 17436 | },
|
| 17437 | {
|
| 17438 | "abstract": true,
|
| 17439 | "docs": {
|
| 17440 | "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.",
|
| 17441 | "stability": "stable",
|
| 17442 | "summary": "The AWS account ID (without hyphens) of the source owner."
|
| 17443 | },
|
| 17444 | "immutable": true,
|
| 17445 | "locationInModule": {
|
| 17446 | "filename": "lib/permission.ts",
|
| 17447 | "line": 61
|
| 17448 | },
|
| 17449 | "name": "sourceAccount",
|
| 17450 | "optional": true,
|
| 17451 | "type": {
|
| 17452 | "primitive": "string"
|
| 17453 | }
|
| 17454 | },
|
| 17455 | {
|
| 17456 | "abstract": true,
|
| 17457 | "docs": {
|
| 17458 | "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.",
|
| 17459 | "stability": "stable",
|
| 17460 | "summary": "The ARN of a resource that is invoking your function."
|
| 17461 | },
|
| 17462 | "immutable": true,
|
| 17463 | "locationInModule": {
|
| 17464 | "filename": "lib/permission.ts",
|
| 17465 | "line": 71
|
| 17466 | },
|
| 17467 | "name": "sourceArn",
|
| 17468 | "optional": true,
|
| 17469 | "type": {
|
| 17470 | "primitive": "string"
|
| 17471 | }
|
| 17472 | }
|
| 17473 | ],
|
| 17474 | "symbolId": "lib/permission:Permission"
|
| 17475 | },
|
| 17476 | "@aws-cdk/aws-lambda.QualifiedFunctionBase": {
|
| 17477 | "abstract": true,
|
| 17478 | "assembly": "@aws-cdk/aws-lambda",
|
| 17479 | "base": "@aws-cdk/aws-lambda.FunctionBase",
|
| 17480 | "docs": {
|
| 17481 | "stability": "stable"
|
| 17482 | },
|
| 17483 | "fqn": "@aws-cdk/aws-lambda.QualifiedFunctionBase",
|
| 17484 | "initializer": {
|
| 17485 | "docs": {
|
| 17486 | "stability": "stable"
|
| 17487 | },
|
| 17488 | "locationInModule": {
|
| 17489 | "filename": "lib/resource.ts",
|
| 17490 | "line": 150
|
| 17491 | },
|
| 17492 | "parameters": [
|
| 17493 | {
|
| 17494 | "name": "scope",
|
| 17495 | "type": {
|
| 17496 | "fqn": "constructs.Construct"
|
| 17497 | }
|
| 17498 | },
|
| 17499 | {
|
| 17500 | "name": "id",
|
| 17501 | "type": {
|
| 17502 | "primitive": "string"
|
| 17503 | }
|
| 17504 | },
|
| 17505 | {
|
| 17506 | "name": "props",
|
| 17507 | "optional": true,
|
| 17508 | "type": {
|
| 17509 | "fqn": "@aws-cdk/core.ResourceProps"
|
| 17510 | }
|
| 17511 | }
|
| 17512 | ]
|
| 17513 | },
|
| 17514 | "kind": "class",
|
| 17515 | "locationInModule": {
|
| 17516 | "filename": "lib/function-base.ts",
|
| 17517 | "line": 627
|
| 17518 | },
|
| 17519 | "methods": [
|
| 17520 | {
|
| 17521 | "docs": {
|
| 17522 | "stability": "stable",
|
| 17523 | "summary": "Configures options for asynchronous invocation."
|
| 17524 | },
|
| 17525 | "locationInModule": {
|
| 17526 | "filename": "lib/function-base.ts",
|
| 17527 | "line": 647
|
| 17528 | },
|
| 17529 | "name": "configureAsyncInvoke",
|
| 17530 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 17531 | "parameters": [
|
| 17532 | {
|
| 17533 | "name": "options",
|
| 17534 | "type": {
|
| 17535 | "fqn": "@aws-cdk/aws-lambda.EventInvokeConfigOptions"
|
| 17536 | }
|
| 17537 | }
|
| 17538 | ]
|
| 17539 | },
|
| 17540 | {
|
| 17541 | "docs": {
|
| 17542 | "remarks": "- function.currentVersion is invoked before or after the permission is created.\n\nThis applies only to permissions on Lambda functions, not versions or aliases.\nThis function is overridden as a noOp for QualifiedFunctionBase.",
|
| 17543 | "stability": "stable",
|
| 17544 | "summary": "A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function."
|
| 17545 | },
|
| 17546 | "locationInModule": {
|
| 17547 | "filename": "lib/function-base.ts",
|
| 17548 | "line": 659
|
| 17549 | },
|
| 17550 | "name": "considerWarningOnInvokeFunctionPermissions",
|
| 17551 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 17552 | "parameters": [
|
| 17553 | {
|
| 17554 | "name": "_scope",
|
| 17555 | "type": {
|
| 17556 | "fqn": "@aws-cdk/core.Construct"
|
| 17557 | }
|
| 17558 | },
|
| 17559 | {
|
| 17560 | "name": "_action",
|
| 17561 | "type": {
|
| 17562 | "primitive": "string"
|
| 17563 | }
|
| 17564 | }
|
| 17565 | ]
|
| 17566 | }
|
| 17567 | ],
|
| 17568 | "name": "QualifiedFunctionBase",
|
| 17569 | "properties": [
|
| 17570 | {
|
| 17571 | "abstract": true,
|
| 17572 | "docs": {
|
| 17573 | "stability": "stable"
|
| 17574 | },
|
| 17575 | "immutable": true,
|
| 17576 | "locationInModule": {
|
| 17577 | "filename": "lib/function-base.ts",
|
| 17578 | "line": 628
|
| 17579 | },
|
| 17580 | "name": "lambda",
|
| 17581 | "type": {
|
| 17582 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 17583 | }
|
| 17584 | },
|
| 17585 | {
|
| 17586 | "docs": {
|
| 17587 | "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.",
|
| 17588 | "stability": "stable",
|
| 17589 | "summary": "The `$LATEST` version of this function."
|
| 17590 | },
|
| 17591 | "immutable": true,
|
| 17592 | "locationInModule": {
|
| 17593 | "filename": "lib/function-base.ts",
|
| 17594 | "line": 639
|
| 17595 | },
|
| 17596 | "name": "latestVersion",
|
| 17597 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 17598 | "type": {
|
| 17599 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 17600 | }
|
| 17601 | },
|
| 17602 | {
|
| 17603 | "docs": {
|
| 17604 | "stability": "stable",
|
| 17605 | "summary": "The construct node where permissions are attached."
|
| 17606 | },
|
| 17607 | "immutable": true,
|
| 17608 | "locationInModule": {
|
| 17609 | "filename": "lib/function-base.ts",
|
| 17610 | "line": 630
|
| 17611 | },
|
| 17612 | "name": "permissionsNode",
|
| 17613 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 17614 | "type": {
|
| 17615 | "fqn": "@aws-cdk/core.ConstructNode"
|
| 17616 | }
|
| 17617 | },
|
| 17618 | {
|
| 17619 | "abstract": true,
|
| 17620 | "docs": {
|
| 17621 | "remarks": "A qualifier is the identifier that's appended to a version or alias ARN.",
|
| 17622 | "see": "https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#API_GetFunctionConfiguration_RequestParameters",
|
| 17623 | "stability": "stable",
|
| 17624 | "summary": "The qualifier of the version or alias of this function."
|
| 17625 | },
|
| 17626 | "immutable": true,
|
| 17627 | "locationInModule": {
|
| 17628 | "filename": "lib/function-base.ts",
|
| 17629 | "line": 637
|
| 17630 | },
|
| 17631 | "name": "qualifier",
|
| 17632 | "protected": true,
|
| 17633 | "type": {
|
| 17634 | "primitive": "string"
|
| 17635 | }
|
| 17636 | },
|
| 17637 | {
|
| 17638 | "docs": {
|
| 17639 | "stability": "stable",
|
| 17640 | "summary": "The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()."
|
| 17641 | },
|
| 17642 | "immutable": true,
|
| 17643 | "locationInModule": {
|
| 17644 | "filename": "lib/function-base.ts",
|
| 17645 | "line": 643
|
| 17646 | },
|
| 17647 | "name": "resourceArnsForGrantInvoke",
|
| 17648 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 17649 | "type": {
|
| 17650 | "collection": {
|
| 17651 | "elementtype": {
|
| 17652 | "primitive": "string"
|
| 17653 | },
|
| 17654 | "kind": "array"
|
| 17655 | }
|
| 17656 | }
|
| 17657 | }
|
| 17658 | ],
|
| 17659 | "symbolId": "lib/function-base:QualifiedFunctionBase"
|
| 17660 | },
|
| 17661 | "@aws-cdk/aws-lambda.ResourceBindOptions": {
|
| 17662 | "assembly": "@aws-cdk/aws-lambda",
|
| 17663 | "datatype": true,
|
| 17664 | "docs": {
|
| 17665 | "stability": "stable",
|
| 17666 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst resourceBindOptions: lambda.ResourceBindOptions = {\n resourceProperty: 'resourceProperty',\n};",
|
| 17667 | "custom": {
|
| 17668 | "exampleMetadata": "fixture=_generated"
|
| 17669 | }
|
| 17670 | },
|
| 17671 | "fqn": "@aws-cdk/aws-lambda.ResourceBindOptions",
|
| 17672 | "kind": "interface",
|
| 17673 | "locationInModule": {
|
| 17674 | "filename": "lib/code.ts",
|
| 17675 | "line": 318
|
| 17676 | },
|
| 17677 | "name": "ResourceBindOptions",
|
| 17678 | "properties": [
|
| 17679 | {
|
| 17680 | "abstract": true,
|
| 17681 | "docs": {
|
| 17682 | "default": "Code",
|
| 17683 | "see": "https://github.com/aws/aws-cdk/issues/1432",
|
| 17684 | "stability": "stable",
|
| 17685 | "summary": "The name of the CloudFormation property to annotate with asset metadata."
|
| 17686 | },
|
| 17687 | "immutable": true,
|
| 17688 | "locationInModule": {
|
| 17689 | "filename": "lib/code.ts",
|
| 17690 | "line": 324
|
| 17691 | },
|
| 17692 | "name": "resourceProperty",
|
| 17693 | "optional": true,
|
| 17694 | "type": {
|
| 17695 | "primitive": "string"
|
| 17696 | }
|
| 17697 | }
|
| 17698 | ],
|
| 17699 | "symbolId": "lib/code:ResourceBindOptions"
|
| 17700 | },
|
| 17701 | "@aws-cdk/aws-lambda.Runtime": {
|
| 17702 | "assembly": "@aws-cdk/aws-lambda",
|
| 17703 | "docs": {
|
| 17704 | "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')`.",
|
| 17705 | "stability": "stable",
|
| 17706 | "summary": "Lambda function runtime environment.",
|
| 17707 | "example": "import * as signer from '@aws-cdk/aws-signer';\n\nconst signingProfile = new signer.SigningProfile(this, 'SigningProfile', {\n platform: signer.Platform.AWS_LAMBDA_SHA384_ECDSA,\n});\n\nconst codeSigningConfig = new lambda.CodeSigningConfig(this, 'CodeSigningConfig', {\n signingProfiles: [signingProfile],\n});\n\nnew lambda.Function(this, 'Function', {\n codeSigningConfig,\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});",
|
| 17708 | "custom": {
|
| 17709 | "exampleMetadata": "infused"
|
| 17710 | }
|
| 17711 | },
|
| 17712 | "fqn": "@aws-cdk/aws-lambda.Runtime",
|
| 17713 | "initializer": {
|
| 17714 | "docs": {
|
| 17715 | "stability": "stable"
|
| 17716 | },
|
| 17717 | "locationInModule": {
|
| 17718 | "filename": "lib/runtime.ts",
|
| 17719 | "line": 242
|
| 17720 | },
|
| 17721 | "parameters": [
|
| 17722 | {
|
| 17723 | "name": "name",
|
| 17724 | "type": {
|
| 17725 | "primitive": "string"
|
| 17726 | }
|
| 17727 | },
|
| 17728 | {
|
| 17729 | "name": "family",
|
| 17730 | "optional": true,
|
| 17731 | "type": {
|
| 17732 | "fqn": "@aws-cdk/aws-lambda.RuntimeFamily"
|
| 17733 | }
|
| 17734 | },
|
| 17735 | {
|
| 17736 | "name": "props",
|
| 17737 | "optional": true,
|
| 17738 | "type": {
|
| 17739 | "fqn": "@aws-cdk/aws-lambda.LambdaRuntimeProps"
|
| 17740 | }
|
| 17741 | }
|
| 17742 | ]
|
| 17743 | },
|
| 17744 | "kind": "class",
|
| 17745 | "locationInModule": {
|
| 17746 | "filename": "lib/runtime.ts",
|
| 17747 | "line": 39
|
| 17748 | },
|
| 17749 | "methods": [
|
| 17750 | {
|
| 17751 | "docs": {
|
| 17752 | "stability": "stable"
|
| 17753 | },
|
| 17754 | "locationInModule": {
|
| 17755 | "filename": "lib/runtime.ts",
|
| 17756 | "line": 259
|
| 17757 | },
|
| 17758 | "name": "runtimeEquals",
|
| 17759 | "parameters": [
|
| 17760 | {
|
| 17761 | "name": "other",
|
| 17762 | "type": {
|
| 17763 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17764 | }
|
| 17765 | }
|
| 17766 | ],
|
| 17767 | "returns": {
|
| 17768 | "type": {
|
| 17769 | "primitive": "boolean"
|
| 17770 | }
|
| 17771 | }
|
| 17772 | },
|
| 17773 | {
|
| 17774 | "docs": {
|
| 17775 | "stability": "stable"
|
| 17776 | },
|
| 17777 | "locationInModule": {
|
| 17778 | "filename": "lib/runtime.ts",
|
| 17779 | "line": 255
|
| 17780 | },
|
| 17781 | "name": "toString",
|
| 17782 | "returns": {
|
| 17783 | "type": {
|
| 17784 | "primitive": "string"
|
| 17785 | }
|
| 17786 | }
|
| 17787 | }
|
| 17788 | ],
|
| 17789 | "name": "Runtime",
|
| 17790 | "properties": [
|
| 17791 | {
|
| 17792 | "const": true,
|
| 17793 | "docs": {
|
| 17794 | "stability": "stable",
|
| 17795 | "summary": "A list of all known `Runtime`'s."
|
| 17796 | },
|
| 17797 | "immutable": true,
|
| 17798 | "locationInModule": {
|
| 17799 | "filename": "lib/runtime.ts",
|
| 17800 | "line": 41
|
| 17801 | },
|
| 17802 | "name": "ALL",
|
| 17803 | "static": true,
|
| 17804 | "type": {
|
| 17805 | "collection": {
|
| 17806 | "elementtype": {
|
| 17807 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17808 | },
|
| 17809 | "kind": "array"
|
| 17810 | }
|
| 17811 | }
|
| 17812 | },
|
| 17813 | {
|
| 17814 | "const": true,
|
| 17815 | "docs": {
|
| 17816 | "stability": "stable",
|
| 17817 | "summary": "The .NET 6 runtime (dotnet6)."
|
| 17818 | },
|
| 17819 | "immutable": true,
|
| 17820 | "locationInModule": {
|
| 17821 | "filename": "lib/runtime.ts",
|
| 17822 | "line": 154
|
| 17823 | },
|
| 17824 | "name": "DOTNET_6",
|
| 17825 | "static": true,
|
| 17826 | "type": {
|
| 17827 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17828 | }
|
| 17829 | },
|
| 17830 | {
|
| 17831 | "const": true,
|
| 17832 | "docs": {
|
| 17833 | "stability": "stable",
|
| 17834 | "summary": "The .NET Core 1.0 runtime (dotnetcore1.0) Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime."
|
| 17835 | },
|
| 17836 | "immutable": true,
|
| 17837 | "locationInModule": {
|
| 17838 | "filename": "lib/runtime.ts",
|
| 17839 | "line": 160
|
| 17840 | },
|
| 17841 | "name": "DOTNET_CORE_1",
|
| 17842 | "static": true,
|
| 17843 | "type": {
|
| 17844 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17845 | }
|
| 17846 | },
|
| 17847 | {
|
| 17848 | "const": true,
|
| 17849 | "docs": {
|
| 17850 | "stability": "stable",
|
| 17851 | "summary": "The .NET Core 2.0 runtime (dotnetcore2.0) Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime."
|
| 17852 | },
|
| 17853 | "immutable": true,
|
| 17854 | "locationInModule": {
|
| 17855 | "filename": "lib/runtime.ts",
|
| 17856 | "line": 166
|
| 17857 | },
|
| 17858 | "name": "DOTNET_CORE_2",
|
| 17859 | "static": true,
|
| 17860 | "type": {
|
| 17861 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17862 | }
|
| 17863 | },
|
| 17864 | {
|
| 17865 | "const": true,
|
| 17866 | "docs": {
|
| 17867 | "stability": "stable",
|
| 17868 | "summary": "The .NET Core 2.1 runtime (dotnetcore2.1) Legacy runtime no longer supported by AWS Lambda. Migrate to the latest .NET Core runtime."
|
| 17869 | },
|
| 17870 | "immutable": true,
|
| 17871 | "locationInModule": {
|
| 17872 | "filename": "lib/runtime.ts",
|
| 17873 | "line": 172
|
| 17874 | },
|
| 17875 | "name": "DOTNET_CORE_2_1",
|
| 17876 | "static": true,
|
| 17877 | "type": {
|
| 17878 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17879 | }
|
| 17880 | },
|
| 17881 | {
|
| 17882 | "const": true,
|
| 17883 | "docs": {
|
| 17884 | "stability": "stable",
|
| 17885 | "summary": "The .NET Core 3.1 runtime (dotnetcore3.1)."
|
| 17886 | },
|
| 17887 | "immutable": true,
|
| 17888 | "locationInModule": {
|
| 17889 | "filename": "lib/runtime.ts",
|
| 17890 | "line": 177
|
| 17891 | },
|
| 17892 | "name": "DOTNET_CORE_3_1",
|
| 17893 | "static": true,
|
| 17894 | "type": {
|
| 17895 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17896 | }
|
| 17897 | },
|
| 17898 | {
|
| 17899 | "const": true,
|
| 17900 | "docs": {
|
| 17901 | "stability": "stable",
|
| 17902 | "summary": "A special runtime entry to be used when function is using a docker image."
|
| 17903 | },
|
| 17904 | "immutable": true,
|
| 17905 | "locationInModule": {
|
| 17906 | "filename": "lib/runtime.ts",
|
| 17907 | "line": 208
|
| 17908 | },
|
| 17909 | "name": "FROM_IMAGE",
|
| 17910 | "static": true,
|
| 17911 | "type": {
|
| 17912 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17913 | }
|
| 17914 | },
|
| 17915 | {
|
| 17916 | "const": true,
|
| 17917 | "docs": {
|
| 17918 | "stability": "stable",
|
| 17919 | "summary": "The Go 1.x runtime (go1.x)."
|
| 17920 | },
|
| 17921 | "immutable": true,
|
| 17922 | "locationInModule": {
|
| 17923 | "filename": "lib/runtime.ts",
|
| 17924 | "line": 182
|
| 17925 | },
|
| 17926 | "name": "GO_1_X",
|
| 17927 | "static": true,
|
| 17928 | "type": {
|
| 17929 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17930 | }
|
| 17931 | },
|
| 17932 | {
|
| 17933 | "const": true,
|
| 17934 | "docs": {
|
| 17935 | "stability": "stable",
|
| 17936 | "summary": "The Java 11 runtime (java11)."
|
| 17937 | },
|
| 17938 | "immutable": true,
|
| 17939 | "locationInModule": {
|
| 17940 | "filename": "lib/runtime.ts",
|
| 17941 | "line": 147
|
| 17942 | },
|
| 17943 | "name": "JAVA_11",
|
| 17944 | "static": true,
|
| 17945 | "type": {
|
| 17946 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17947 | }
|
| 17948 | },
|
| 17949 | {
|
| 17950 | "const": true,
|
| 17951 | "docs": {
|
| 17952 | "stability": "stable",
|
| 17953 | "summary": "The Java 8 runtime (java8)."
|
| 17954 | },
|
| 17955 | "immutable": true,
|
| 17956 | "locationInModule": {
|
| 17957 | "filename": "lib/runtime.ts",
|
| 17958 | "line": 133
|
| 17959 | },
|
| 17960 | "name": "JAVA_8",
|
| 17961 | "static": true,
|
| 17962 | "type": {
|
| 17963 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17964 | }
|
| 17965 | },
|
| 17966 | {
|
| 17967 | "const": true,
|
| 17968 | "docs": {
|
| 17969 | "stability": "stable",
|
| 17970 | "summary": "The Java 8 Corretto runtime (java8.al2)."
|
| 17971 | },
|
| 17972 | "immutable": true,
|
| 17973 | "locationInModule": {
|
| 17974 | "filename": "lib/runtime.ts",
|
| 17975 | "line": 140
|
| 17976 | },
|
| 17977 | "name": "JAVA_8_CORRETTO",
|
| 17978 | "static": true,
|
| 17979 | "type": {
|
| 17980 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17981 | }
|
| 17982 | },
|
| 17983 | {
|
| 17984 | "const": true,
|
| 17985 | "docs": {
|
| 17986 | "deprecated": "Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.",
|
| 17987 | "stability": "deprecated",
|
| 17988 | "summary": "The NodeJS runtime (nodejs)."
|
| 17989 | },
|
| 17990 | "immutable": true,
|
| 17991 | "locationInModule": {
|
| 17992 | "filename": "lib/runtime.ts",
|
| 17993 | "line": 47
|
| 17994 | },
|
| 17995 | "name": "NODEJS",
|
| 17996 | "static": true,
|
| 17997 | "type": {
|
| 17998 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 17999 | }
|
| 18000 | },
|
| 18001 | {
|
| 18002 | "const": true,
|
| 18003 | "docs": {
|
| 18004 | "deprecated": "Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.",
|
| 18005 | "stability": "deprecated",
|
| 18006 | "summary": "The NodeJS 10.x runtime (nodejs10.x)."
|
| 18007 | },
|
| 18008 | "immutable": true,
|
| 18009 | "locationInModule": {
|
| 18010 | "filename": "lib/runtime.ts",
|
| 18011 | "line": 71
|
| 18012 | },
|
| 18013 | "name": "NODEJS_10_X",
|
| 18014 | "static": true,
|
| 18015 | "type": {
|
| 18016 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18017 | }
|
| 18018 | },
|
| 18019 | {
|
| 18020 | "const": true,
|
| 18021 | "docs": {
|
| 18022 | "stability": "stable",
|
| 18023 | "summary": "The NodeJS 12.x runtime (nodejs12.x)."
|
| 18024 | },
|
| 18025 | "immutable": true,
|
| 18026 | "locationInModule": {
|
| 18027 | "filename": "lib/runtime.ts",
|
| 18028 | "line": 76
|
| 18029 | },
|
| 18030 | "name": "NODEJS_12_X",
|
| 18031 | "static": true,
|
| 18032 | "type": {
|
| 18033 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18034 | }
|
| 18035 | },
|
| 18036 | {
|
| 18037 | "const": true,
|
| 18038 | "docs": {
|
| 18039 | "stability": "stable",
|
| 18040 | "summary": "The NodeJS 14.x runtime (nodejs14.x)."
|
| 18041 | },
|
| 18042 | "immutable": true,
|
| 18043 | "locationInModule": {
|
| 18044 | "filename": "lib/runtime.ts",
|
| 18045 | "line": 81
|
| 18046 | },
|
| 18047 | "name": "NODEJS_14_X",
|
| 18048 | "static": true,
|
| 18049 | "type": {
|
| 18050 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18051 | }
|
| 18052 | },
|
| 18053 | {
|
| 18054 | "const": true,
|
| 18055 | "docs": {
|
| 18056 | "stability": "stable",
|
| 18057 | "summary": "The NodeJS 16.x runtime (nodejs16.x)."
|
| 18058 | },
|
| 18059 | "immutable": true,
|
| 18060 | "locationInModule": {
|
| 18061 | "filename": "lib/runtime.ts",
|
| 18062 | "line": 86
|
| 18063 | },
|
| 18064 | "name": "NODEJS_16_X",
|
| 18065 | "static": true,
|
| 18066 | "type": {
|
| 18067 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18068 | }
|
| 18069 | },
|
| 18070 | {
|
| 18071 | "const": true,
|
| 18072 | "docs": {
|
| 18073 | "deprecated": "Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.",
|
| 18074 | "stability": "deprecated",
|
| 18075 | "summary": "The NodeJS 4.3 runtime (nodejs4.3)."
|
| 18076 | },
|
| 18077 | "immutable": true,
|
| 18078 | "locationInModule": {
|
| 18079 | "filename": "lib/runtime.ts",
|
| 18080 | "line": 53
|
| 18081 | },
|
| 18082 | "name": "NODEJS_4_3",
|
| 18083 | "static": true,
|
| 18084 | "type": {
|
| 18085 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18086 | }
|
| 18087 | },
|
| 18088 | {
|
| 18089 | "const": true,
|
| 18090 | "docs": {
|
| 18091 | "deprecated": "Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.",
|
| 18092 | "stability": "deprecated",
|
| 18093 | "summary": "The NodeJS 6.10 runtime (nodejs6.10)."
|
| 18094 | },
|
| 18095 | "immutable": true,
|
| 18096 | "locationInModule": {
|
| 18097 | "filename": "lib/runtime.ts",
|
| 18098 | "line": 59
|
| 18099 | },
|
| 18100 | "name": "NODEJS_6_10",
|
| 18101 | "static": true,
|
| 18102 | "type": {
|
| 18103 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18104 | }
|
| 18105 | },
|
| 18106 | {
|
| 18107 | "const": true,
|
| 18108 | "docs": {
|
| 18109 | "deprecated": "Legacy runtime no longer supported by AWS Lambda. Migrate to the latest NodeJS runtime.",
|
| 18110 | "stability": "deprecated",
|
| 18111 | "summary": "The NodeJS 8.10 runtime (nodejs8.10)."
|
| 18112 | },
|
| 18113 | "immutable": true,
|
| 18114 | "locationInModule": {
|
| 18115 | "filename": "lib/runtime.ts",
|
| 18116 | "line": 65
|
| 18117 | },
|
| 18118 | "name": "NODEJS_8_10",
|
| 18119 | "static": true,
|
| 18120 | "type": {
|
| 18121 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18122 | }
|
| 18123 | },
|
| 18124 | {
|
| 18125 | "const": true,
|
| 18126 | "docs": {
|
| 18127 | "stability": "stable",
|
| 18128 | "summary": "The custom provided runtime (provided)."
|
| 18129 | },
|
| 18130 | "immutable": true,
|
| 18131 | "locationInModule": {
|
| 18132 | "filename": "lib/runtime.ts",
|
| 18133 | "line": 198
|
| 18134 | },
|
| 18135 | "name": "PROVIDED",
|
| 18136 | "static": true,
|
| 18137 | "type": {
|
| 18138 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18139 | }
|
| 18140 | },
|
| 18141 | {
|
| 18142 | "const": true,
|
| 18143 | "docs": {
|
| 18144 | "stability": "stable",
|
| 18145 | "summary": "The custom provided runtime (provided)."
|
| 18146 | },
|
| 18147 | "immutable": true,
|
| 18148 | "locationInModule": {
|
| 18149 | "filename": "lib/runtime.ts",
|
| 18150 | "line": 203
|
| 18151 | },
|
| 18152 | "name": "PROVIDED_AL2",
|
| 18153 | "static": true,
|
| 18154 | "type": {
|
| 18155 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18156 | }
|
| 18157 | },
|
| 18158 | {
|
| 18159 | "const": true,
|
| 18160 | "docs": {
|
| 18161 | "deprecated": "Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.",
|
| 18162 | "stability": "deprecated",
|
| 18163 | "summary": "The Python 2.7 runtime (python2.7)."
|
| 18164 | },
|
| 18165 | "immutable": true,
|
| 18166 | "locationInModule": {
|
| 18167 | "filename": "lib/runtime.ts",
|
| 18168 | "line": 92
|
| 18169 | },
|
| 18170 | "name": "PYTHON_2_7",
|
| 18171 | "static": true,
|
| 18172 | "type": {
|
| 18173 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18174 | }
|
| 18175 | },
|
| 18176 | {
|
| 18177 | "const": true,
|
| 18178 | "docs": {
|
| 18179 | "deprecated": "Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Python runtime.",
|
| 18180 | "remarks": "The Python 3.6 runtime is deprecated as of July 2022.",
|
| 18181 | "stability": "deprecated",
|
| 18182 | "summary": "The Python 3.6 runtime (python3.6) (not recommended)."
|
| 18183 | },
|
| 18184 | "immutable": true,
|
| 18185 | "locationInModule": {
|
| 18186 | "filename": "lib/runtime.ts",
|
| 18187 | "line": 101
|
| 18188 | },
|
| 18189 | "name": "PYTHON_3_6",
|
| 18190 | "static": true,
|
| 18191 | "type": {
|
| 18192 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18193 | }
|
| 18194 | },
|
| 18195 | {
|
| 18196 | "const": true,
|
| 18197 | "docs": {
|
| 18198 | "stability": "stable",
|
| 18199 | "summary": "The Python 3.7 runtime (python3.7)."
|
| 18200 | },
|
| 18201 | "immutable": true,
|
| 18202 | "locationInModule": {
|
| 18203 | "filename": "lib/runtime.ts",
|
| 18204 | "line": 109
|
| 18205 | },
|
| 18206 | "name": "PYTHON_3_7",
|
| 18207 | "static": true,
|
| 18208 | "type": {
|
| 18209 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18210 | }
|
| 18211 | },
|
| 18212 | {
|
| 18213 | "const": true,
|
| 18214 | "docs": {
|
| 18215 | "stability": "stable",
|
| 18216 | "summary": "The Python 3.8 runtime (python3.8)."
|
| 18217 | },
|
| 18218 | "immutable": true,
|
| 18219 | "locationInModule": {
|
| 18220 | "filename": "lib/runtime.ts",
|
| 18221 | "line": 117
|
| 18222 | },
|
| 18223 | "name": "PYTHON_3_8",
|
| 18224 | "static": true,
|
| 18225 | "type": {
|
| 18226 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18227 | }
|
| 18228 | },
|
| 18229 | {
|
| 18230 | "const": true,
|
| 18231 | "docs": {
|
| 18232 | "stability": "stable",
|
| 18233 | "summary": "The Python 3.9 runtime (python3.9)."
|
| 18234 | },
|
| 18235 | "immutable": true,
|
| 18236 | "locationInModule": {
|
| 18237 | "filename": "lib/runtime.ts",
|
| 18238 | "line": 125
|
| 18239 | },
|
| 18240 | "name": "PYTHON_3_9",
|
| 18241 | "static": true,
|
| 18242 | "type": {
|
| 18243 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18244 | }
|
| 18245 | },
|
| 18246 | {
|
| 18247 | "const": true,
|
| 18248 | "docs": {
|
| 18249 | "stability": "stable",
|
| 18250 | "summary": "The Ruby 2.5 runtime (ruby2.5) Legacy runtime no longer supported by AWS Lambda. Migrate to the latest Ruby runtime."
|
| 18251 | },
|
| 18252 | "immutable": true,
|
| 18253 | "locationInModule": {
|
| 18254 | "filename": "lib/runtime.ts",
|
| 18255 | "line": 188
|
| 18256 | },
|
| 18257 | "name": "RUBY_2_5",
|
| 18258 | "static": true,
|
| 18259 | "type": {
|
| 18260 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18261 | }
|
| 18262 | },
|
| 18263 | {
|
| 18264 | "const": true,
|
| 18265 | "docs": {
|
| 18266 | "stability": "stable",
|
| 18267 | "summary": "The Ruby 2.7 runtime (ruby2.7)."
|
| 18268 | },
|
| 18269 | "immutable": true,
|
| 18270 | "locationInModule": {
|
| 18271 | "filename": "lib/runtime.ts",
|
| 18272 | "line": 193
|
| 18273 | },
|
| 18274 | "name": "RUBY_2_7",
|
| 18275 | "static": true,
|
| 18276 | "type": {
|
| 18277 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18278 | }
|
| 18279 | },
|
| 18280 | {
|
| 18281 | "docs": {
|
| 18282 | "deprecated": "use `bundlingImage`",
|
| 18283 | "stability": "deprecated",
|
| 18284 | "summary": "DEPRECATED."
|
| 18285 | },
|
| 18286 | "immutable": true,
|
| 18287 | "locationInModule": {
|
| 18288 | "filename": "lib/runtime.ts",
|
| 18289 | "line": 235
|
| 18290 | },
|
| 18291 | "name": "bundlingDockerImage",
|
| 18292 | "type": {
|
| 18293 | "fqn": "@aws-cdk/core.BundlingDockerImage"
|
| 18294 | }
|
| 18295 | },
|
| 18296 | {
|
| 18297 | "docs": {
|
| 18298 | "stability": "stable",
|
| 18299 | "summary": "The bundling Docker image for this runtime."
|
| 18300 | },
|
| 18301 | "immutable": true,
|
| 18302 | "locationInModule": {
|
| 18303 | "filename": "lib/runtime.ts",
|
| 18304 | "line": 240
|
| 18305 | },
|
| 18306 | "name": "bundlingImage",
|
| 18307 | "type": {
|
| 18308 | "fqn": "@aws-cdk/core.DockerImage"
|
| 18309 | }
|
| 18310 | },
|
| 18311 | {
|
| 18312 | "docs": {
|
| 18313 | "stability": "stable",
|
| 18314 | "summary": "The name of this runtime, as expected by the Lambda resource."
|
| 18315 | },
|
| 18316 | "immutable": true,
|
| 18317 | "locationInModule": {
|
| 18318 | "filename": "lib/runtime.ts",
|
| 18319 | "line": 213
|
| 18320 | },
|
| 18321 | "name": "name",
|
| 18322 | "type": {
|
| 18323 | "primitive": "string"
|
| 18324 | }
|
| 18325 | },
|
| 18326 | {
|
| 18327 | "docs": {
|
| 18328 | "stability": "stable",
|
| 18329 | "summary": "Whether this runtime is integrated with and supported for profiling using Amazon CodeGuru Profiler."
|
| 18330 | },
|
| 18331 | "immutable": true,
|
| 18332 | "locationInModule": {
|
| 18333 | "filename": "lib/runtime.ts",
|
| 18334 | "line": 224
|
| 18335 | },
|
| 18336 | "name": "supportsCodeGuruProfiling",
|
| 18337 | "type": {
|
| 18338 | "primitive": "boolean"
|
| 18339 | }
|
| 18340 | },
|
| 18341 | {
|
| 18342 | "docs": {
|
| 18343 | "stability": "stable",
|
| 18344 | "summary": "Whether the ``ZipFile`` (aka inline code) property can be used with this runtime."
|
| 18345 | },
|
| 18346 | "immutable": true,
|
| 18347 | "locationInModule": {
|
| 18348 | "filename": "lib/runtime.ts",
|
| 18349 | "line": 219
|
| 18350 | },
|
| 18351 | "name": "supportsInlineCode",
|
| 18352 | "type": {
|
| 18353 | "primitive": "boolean"
|
| 18354 | }
|
| 18355 | },
|
| 18356 | {
|
| 18357 | "docs": {
|
| 18358 | "stability": "stable",
|
| 18359 | "summary": "The runtime family."
|
| 18360 | },
|
| 18361 | "immutable": true,
|
| 18362 | "locationInModule": {
|
| 18363 | "filename": "lib/runtime.ts",
|
| 18364 | "line": 229
|
| 18365 | },
|
| 18366 | "name": "family",
|
| 18367 | "optional": true,
|
| 18368 | "type": {
|
| 18369 | "fqn": "@aws-cdk/aws-lambda.RuntimeFamily"
|
| 18370 | }
|
| 18371 | }
|
| 18372 | ],
|
| 18373 | "symbolId": "lib/runtime:Runtime"
|
| 18374 | },
|
| 18375 | "@aws-cdk/aws-lambda.RuntimeFamily": {
|
| 18376 | "assembly": "@aws-cdk/aws-lambda",
|
| 18377 | "docs": {
|
| 18378 | "stability": "stable"
|
| 18379 | },
|
| 18380 | "fqn": "@aws-cdk/aws-lambda.RuntimeFamily",
|
| 18381 | "kind": "enum",
|
| 18382 | "locationInModule": {
|
| 18383 | "filename": "lib/runtime.ts",
|
| 18384 | "line": 23
|
| 18385 | },
|
| 18386 | "members": [
|
| 18387 | {
|
| 18388 | "docs": {
|
| 18389 | "stability": "stable"
|
| 18390 | },
|
| 18391 | "name": "NODEJS"
|
| 18392 | },
|
| 18393 | {
|
| 18394 | "docs": {
|
| 18395 | "stability": "stable"
|
| 18396 | },
|
| 18397 | "name": "JAVA"
|
| 18398 | },
|
| 18399 | {
|
| 18400 | "docs": {
|
| 18401 | "stability": "stable"
|
| 18402 | },
|
| 18403 | "name": "PYTHON"
|
| 18404 | },
|
| 18405 | {
|
| 18406 | "docs": {
|
| 18407 | "stability": "stable"
|
| 18408 | },
|
| 18409 | "name": "DOTNET_CORE"
|
| 18410 | },
|
| 18411 | {
|
| 18412 | "docs": {
|
| 18413 | "stability": "stable"
|
| 18414 | },
|
| 18415 | "name": "GO"
|
| 18416 | },
|
| 18417 | {
|
| 18418 | "docs": {
|
| 18419 | "stability": "stable"
|
| 18420 | },
|
| 18421 | "name": "RUBY"
|
| 18422 | },
|
| 18423 | {
|
| 18424 | "docs": {
|
| 18425 | "stability": "stable"
|
| 18426 | },
|
| 18427 | "name": "OTHER"
|
| 18428 | }
|
| 18429 | ],
|
| 18430 | "name": "RuntimeFamily",
|
| 18431 | "symbolId": "lib/runtime:RuntimeFamily"
|
| 18432 | },
|
| 18433 | "@aws-cdk/aws-lambda.S3Code": {
|
| 18434 | "assembly": "@aws-cdk/aws-lambda",
|
| 18435 | "base": "@aws-cdk/aws-lambda.Code",
|
| 18436 | "docs": {
|
| 18437 | "stability": "stable",
|
| 18438 | "summary": "Lambda code from an S3 archive.",
|
| 18439 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as s3 from '@aws-cdk/aws-s3';\n\ndeclare const bucket: s3.Bucket;\nconst s3Code = new lambda.S3Code(bucket, 'key', /* all optional props */ 'objectVersion');",
|
| 18440 | "custom": {
|
| 18441 | "exampleMetadata": "fixture=_generated"
|
| 18442 | }
|
| 18443 | },
|
| 18444 | "fqn": "@aws-cdk/aws-lambda.S3Code",
|
| 18445 | "initializer": {
|
| 18446 | "docs": {
|
| 18447 | "stability": "stable"
|
| 18448 | },
|
| 18449 | "locationInModule": {
|
| 18450 | "filename": "lib/code.ts",
|
| 18451 | "line": 222
|
| 18452 | },
|
| 18453 | "parameters": [
|
| 18454 | {
|
| 18455 | "name": "bucket",
|
| 18456 | "type": {
|
| 18457 | "fqn": "@aws-cdk/aws-s3.IBucket"
|
| 18458 | }
|
| 18459 | },
|
| 18460 | {
|
| 18461 | "name": "key",
|
| 18462 | "type": {
|
| 18463 | "primitive": "string"
|
| 18464 | }
|
| 18465 | },
|
| 18466 | {
|
| 18467 | "name": "objectVersion",
|
| 18468 | "optional": true,
|
| 18469 | "type": {
|
| 18470 | "primitive": "string"
|
| 18471 | }
|
| 18472 | }
|
| 18473 | ]
|
| 18474 | },
|
| 18475 | "kind": "class",
|
| 18476 | "locationInModule": {
|
| 18477 | "filename": "lib/code.ts",
|
| 18478 | "line": 218
|
| 18479 | },
|
| 18480 | "methods": [
|
| 18481 | {
|
| 18482 | "docs": {
|
| 18483 | "stability": "stable",
|
| 18484 | "summary": "Called when the lambda or layer is initialized to allow this object to bind to the stack, add resources and have fun."
|
| 18485 | },
|
| 18486 | "locationInModule": {
|
| 18487 | "filename": "lib/code.ts",
|
| 18488 | "line": 232
|
| 18489 | },
|
| 18490 | "name": "bind",
|
| 18491 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 18492 | "parameters": [
|
| 18493 | {
|
| 18494 | "name": "_scope",
|
| 18495 | "type": {
|
| 18496 | "fqn": "@aws-cdk/core.Construct"
|
| 18497 | }
|
| 18498 | }
|
| 18499 | ],
|
| 18500 | "returns": {
|
| 18501 | "type": {
|
| 18502 | "fqn": "@aws-cdk/aws-lambda.CodeConfig"
|
| 18503 | }
|
| 18504 | }
|
| 18505 | }
|
| 18506 | ],
|
| 18507 | "name": "S3Code",
|
| 18508 | "properties": [
|
| 18509 | {
|
| 18510 | "docs": {
|
| 18511 | "stability": "stable",
|
| 18512 | "summary": "Determines whether this Code is inline code or not."
|
| 18513 | },
|
| 18514 | "immutable": true,
|
| 18515 | "locationInModule": {
|
| 18516 | "filename": "lib/code.ts",
|
| 18517 | "line": 219
|
| 18518 | },
|
| 18519 | "name": "isInline",
|
| 18520 | "overrides": "@aws-cdk/aws-lambda.Code",
|
| 18521 | "type": {
|
| 18522 | "primitive": "boolean"
|
| 18523 | }
|
| 18524 | }
|
| 18525 | ],
|
| 18526 | "symbolId": "lib/code:S3Code"
|
| 18527 | },
|
| 18528 | "@aws-cdk/aws-lambda.SingletonFunction": {
|
| 18529 | "assembly": "@aws-cdk/aws-lambda",
|
| 18530 | "base": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18531 | "docs": {
|
| 18532 | "custom": {
|
| 18533 | "resource": "AWS::Lambda::Function",
|
| 18534 | "exampleMetadata": "fixture=_generated"
|
| 18535 | },
|
| 18536 | "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.",
|
| 18537 | "stability": "stable",
|
| 18538 | "summary": "A Lambda that will only ever be added to a stack once.",
|
| 18539 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as codeguruprofiler from '@aws-cdk/aws-codeguruprofiler';\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as sns from '@aws-cdk/aws-sns';\nimport * as sqs from '@aws-cdk/aws-sqs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const architecture: lambda.Architecture;\ndeclare const code: lambda.Code;\ndeclare const codeSigningConfig: lambda.CodeSigningConfig;\ndeclare const destination: lambda.IDestination;\ndeclare const eventSource: lambda.IEventSource;\ndeclare const fileSystem: lambda.FileSystem;\ndeclare const key: kms.Key;\ndeclare const lambdaInsightsVersion: lambda.LambdaInsightsVersion;\ndeclare const layerVersion: lambda.LayerVersion;\ndeclare const policyStatement: iam.PolicyStatement;\ndeclare const profilingGroup: codeguruprofiler.ProfilingGroup;\ndeclare const queue: sqs.Queue;\ndeclare const role: iam.Role;\ndeclare const runtime: lambda.Runtime;\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const size: cdk.Size;\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const topic: sns.Topic;\ndeclare const vpc: ec2.Vpc;\nconst singletonFunction = new lambda.SingletonFunction(this, 'MySingletonFunction', {\n code: code,\n handler: 'handler',\n runtime: runtime,\n uuid: 'uuid',\n\n // the properties below are optional\n allowAllOutbound: false,\n allowPublicSubnet: false,\n architecture: architecture,\n architectures: [architecture],\n codeSigningConfig: codeSigningConfig,\n currentVersionOptions: {\n codeSha256: 'codeSha256',\n description: 'description',\n maxEventAge: cdk.Duration.minutes(30),\n onFailure: destination,\n onSuccess: destination,\n provisionedConcurrentExecutions: 123,\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n retryAttempts: 123,\n },\n deadLetterQueue: queue,\n deadLetterQueueEnabled: false,\n deadLetterTopic: topic,\n description: 'description',\n environment: {\n environmentKey: 'environment',\n },\n environmentEncryption: key,\n ephemeralStorageSize: size,\n events: [eventSource],\n filesystem: fileSystem,\n functionName: 'functionName',\n initialPolicy: [policyStatement],\n insightsVersion: lambdaInsightsVersion,\n lambdaPurpose: 'lambdaPurpose',\n layers: [layerVersion],\n logRetention: logs.RetentionDays.ONE_DAY,\n logRetentionRetryOptions: {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n },\n logRetentionRole: role,\n maxEventAge: cdk.Duration.minutes(30),\n memorySize: 123,\n onFailure: destination,\n onSuccess: destination,\n profiling: false,\n profilingGroup: profilingGroup,\n reservedConcurrentExecutions: 123,\n retryAttempts: 123,\n role: role,\n securityGroup: securityGroup,\n securityGroups: [securityGroup],\n timeout: cdk.Duration.minutes(30),\n tracing: lambda.Tracing.ACTIVE,\n vpc: vpc,\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n});"
|
| 18540 | },
|
| 18541 | "fqn": "@aws-cdk/aws-lambda.SingletonFunction",
|
| 18542 | "initializer": {
|
| 18543 | "docs": {
|
| 18544 | "stability": "stable"
|
| 18545 | },
|
| 18546 | "locationInModule": {
|
| 18547 | "filename": "lib/singleton-lambda.ts",
|
| 18548 | "line": 64
|
| 18549 | },
|
| 18550 | "parameters": [
|
| 18551 | {
|
| 18552 | "name": "scope",
|
| 18553 | "type": {
|
| 18554 | "fqn": "constructs.Construct"
|
| 18555 | }
|
| 18556 | },
|
| 18557 | {
|
| 18558 | "name": "id",
|
| 18559 | "type": {
|
| 18560 | "primitive": "string"
|
| 18561 | }
|
| 18562 | },
|
| 18563 | {
|
| 18564 | "name": "props",
|
| 18565 | "type": {
|
| 18566 | "fqn": "@aws-cdk/aws-lambda.SingletonFunctionProps"
|
| 18567 | }
|
| 18568 | }
|
| 18569 | ]
|
| 18570 | },
|
| 18571 | "kind": "class",
|
| 18572 | "locationInModule": {
|
| 18573 | "filename": "lib/singleton-lambda.ts",
|
| 18574 | "line": 48
|
| 18575 | },
|
| 18576 | "methods": [
|
| 18577 | {
|
| 18578 | "docs": {
|
| 18579 | "stability": "stable",
|
| 18580 | "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."
|
| 18581 | },
|
| 18582 | "locationInModule": {
|
| 18583 | "filename": "lib/singleton-lambda.ts",
|
| 18584 | "line": 154
|
| 18585 | },
|
| 18586 | "name": "addDependency",
|
| 18587 | "parameters": [
|
| 18588 | {
|
| 18589 | "name": "up",
|
| 18590 | "type": {
|
| 18591 | "fqn": "@aws-cdk/core.IDependable"
|
| 18592 | },
|
| 18593 | "variadic": true
|
| 18594 | }
|
| 18595 | ],
|
| 18596 | "variadic": true
|
| 18597 | },
|
| 18598 | {
|
| 18599 | "docs": {
|
| 18600 | "remarks": "If this is a ref to a Lambda function, this operation results in a no-op.",
|
| 18601 | "stability": "stable",
|
| 18602 | "summary": "Adds an environment variable to this Lambda function."
|
| 18603 | },
|
| 18604 | "locationInModule": {
|
| 18605 | "filename": "lib/singleton-lambda.ts",
|
| 18606 | "line": 131
|
| 18607 | },
|
| 18608 | "name": "addEnvironment",
|
| 18609 | "parameters": [
|
| 18610 | {
|
| 18611 | "docs": {
|
| 18612 | "summary": "The environment variable key."
|
| 18613 | },
|
| 18614 | "name": "key",
|
| 18615 | "type": {
|
| 18616 | "primitive": "string"
|
| 18617 | }
|
| 18618 | },
|
| 18619 | {
|
| 18620 | "docs": {
|
| 18621 | "summary": "The environment variable's value."
|
| 18622 | },
|
| 18623 | "name": "value",
|
| 18624 | "type": {
|
| 18625 | "primitive": "string"
|
| 18626 | }
|
| 18627 | },
|
| 18628 | {
|
| 18629 | "docs": {
|
| 18630 | "summary": "Environment variable options."
|
| 18631 | },
|
| 18632 | "name": "options",
|
| 18633 | "optional": true,
|
| 18634 | "type": {
|
| 18635 | "fqn": "@aws-cdk/aws-lambda.EnvironmentOptions"
|
| 18636 | }
|
| 18637 | }
|
| 18638 | ],
|
| 18639 | "returns": {
|
| 18640 | "type": {
|
| 18641 | "fqn": "@aws-cdk/aws-lambda.Function"
|
| 18642 | }
|
| 18643 | }
|
| 18644 | },
|
| 18645 | {
|
| 18646 | "docs": {
|
| 18647 | "custom": {
|
| 18648 | "throws": "if there are already 5 layers on this function, or the layer is incompatible with this function's runtime."
|
| 18649 | },
|
| 18650 | "stability": "stable",
|
| 18651 | "summary": "Adds one or more Lambda Layers to this Lambda function."
|
| 18652 | },
|
| 18653 | "locationInModule": {
|
| 18654 | "filename": "lib/singleton-lambda.ts",
|
| 18655 | "line": 142
|
| 18656 | },
|
| 18657 | "name": "addLayers",
|
| 18658 | "parameters": [
|
| 18659 | {
|
| 18660 | "docs": {
|
| 18661 | "summary": "the layers to be added."
|
| 18662 | },
|
| 18663 | "name": "layers",
|
| 18664 | "type": {
|
| 18665 | "fqn": "@aws-cdk/aws-lambda.ILayerVersion"
|
| 18666 | },
|
| 18667 | "variadic": true
|
| 18668 | }
|
| 18669 | ],
|
| 18670 | "variadic": true
|
| 18671 | },
|
| 18672 | {
|
| 18673 | "docs": {
|
| 18674 | "stability": "stable",
|
| 18675 | "summary": "Adds a permission to the Lambda resource policy."
|
| 18676 | },
|
| 18677 | "locationInModule": {
|
| 18678 | "filename": "lib/singleton-lambda.ts",
|
| 18679 | "line": 146
|
| 18680 | },
|
| 18681 | "name": "addPermission",
|
| 18682 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18683 | "parameters": [
|
| 18684 | {
|
| 18685 | "name": "name",
|
| 18686 | "type": {
|
| 18687 | "primitive": "string"
|
| 18688 | }
|
| 18689 | },
|
| 18690 | {
|
| 18691 | "name": "permission",
|
| 18692 | "type": {
|
| 18693 | "fqn": "@aws-cdk/aws-lambda.Permission"
|
| 18694 | }
|
| 18695 | }
|
| 18696 | ]
|
| 18697 | },
|
| 18698 | {
|
| 18699 | "docs": {
|
| 18700 | "stability": "stable",
|
| 18701 | "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."
|
| 18702 | },
|
| 18703 | "locationInModule": {
|
| 18704 | "filename": "lib/singleton-lambda.ts",
|
| 18705 | "line": 162
|
| 18706 | },
|
| 18707 | "name": "dependOn",
|
| 18708 | "parameters": [
|
| 18709 | {
|
| 18710 | "name": "down",
|
| 18711 | "type": {
|
| 18712 | "fqn": "@aws-cdk/core.IConstruct"
|
| 18713 | }
|
| 18714 | }
|
| 18715 | ]
|
| 18716 | }
|
| 18717 | ],
|
| 18718 | "name": "SingletonFunction",
|
| 18719 | "properties": [
|
| 18720 | {
|
| 18721 | "docs": {
|
| 18722 | "stability": "stable",
|
| 18723 | "summary": "The architecture of this Lambda Function."
|
| 18724 | },
|
| 18725 | "immutable": true,
|
| 18726 | "locationInModule": {
|
| 18727 | "filename": "lib/singleton-lambda.ts",
|
| 18728 | "line": 54
|
| 18729 | },
|
| 18730 | "name": "architecture",
|
| 18731 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18732 | "type": {
|
| 18733 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 18734 | }
|
| 18735 | },
|
| 18736 | {
|
| 18737 | "docs": {
|
| 18738 | "remarks": "True for new Lambdas, false for version $LATEST and imported Lambdas\nfrom different accounts.",
|
| 18739 | "stability": "stable",
|
| 18740 | "summary": "Whether the addPermission() call adds any permissions."
|
| 18741 | },
|
| 18742 | "immutable": true,
|
| 18743 | "locationInModule": {
|
| 18744 | "filename": "lib/singleton-lambda.ts",
|
| 18745 | "line": 61
|
| 18746 | },
|
| 18747 | "name": "canCreatePermissions",
|
| 18748 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18749 | "protected": true,
|
| 18750 | "type": {
|
| 18751 | "primitive": "boolean"
|
| 18752 | }
|
| 18753 | },
|
| 18754 | {
|
| 18755 | "docs": {
|
| 18756 | "custom": {
|
| 18757 | "inheritdoc": "true"
|
| 18758 | },
|
| 18759 | "remarks": "Will fail if not a VPC-enabled Lambda Function",
|
| 18760 | "stability": "stable",
|
| 18761 | "summary": "Access the Connections object."
|
| 18762 | },
|
| 18763 | "immutable": true,
|
| 18764 | "locationInModule": {
|
| 18765 | "filename": "lib/singleton-lambda.ts",
|
| 18766 | "line": 90
|
| 18767 | },
|
| 18768 | "name": "connections",
|
| 18769 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18770 | "type": {
|
| 18771 | "fqn": "@aws-cdk/aws-ec2.Connections"
|
| 18772 | }
|
| 18773 | },
|
| 18774 | {
|
| 18775 | "docs": {
|
| 18776 | "remarks": "You can specify options for this version using the `currentVersionOptions`\nprop when initializing the `lambda.SingletonFunction`.",
|
| 18777 | "stability": "stable",
|
| 18778 | "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."
|
| 18779 | },
|
| 18780 | "immutable": true,
|
| 18781 | "locationInModule": {
|
| 18782 | "filename": "lib/singleton-lambda.ts",
|
| 18783 | "line": 116
|
| 18784 | },
|
| 18785 | "name": "currentVersion",
|
| 18786 | "type": {
|
| 18787 | "fqn": "@aws-cdk/aws-lambda.Version"
|
| 18788 | }
|
| 18789 | },
|
| 18790 | {
|
| 18791 | "docs": {
|
| 18792 | "stability": "stable",
|
| 18793 | "summary": "The ARN fo the function."
|
| 18794 | },
|
| 18795 | "immutable": true,
|
| 18796 | "locationInModule": {
|
| 18797 | "filename": "lib/singleton-lambda.ts",
|
| 18798 | "line": 51
|
| 18799 | },
|
| 18800 | "name": "functionArn",
|
| 18801 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18802 | "type": {
|
| 18803 | "primitive": "string"
|
| 18804 | }
|
| 18805 | },
|
| 18806 | {
|
| 18807 | "docs": {
|
| 18808 | "stability": "stable",
|
| 18809 | "summary": "The name of the function."
|
| 18810 | },
|
| 18811 | "immutable": true,
|
| 18812 | "locationInModule": {
|
| 18813 | "filename": "lib/singleton-lambda.ts",
|
| 18814 | "line": 50
|
| 18815 | },
|
| 18816 | "name": "functionName",
|
| 18817 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18818 | "type": {
|
| 18819 | "primitive": "string"
|
| 18820 | }
|
| 18821 | },
|
| 18822 | {
|
| 18823 | "docs": {
|
| 18824 | "stability": "stable",
|
| 18825 | "summary": "The principal this Lambda Function is running as."
|
| 18826 | },
|
| 18827 | "immutable": true,
|
| 18828 | "locationInModule": {
|
| 18829 | "filename": "lib/singleton-lambda.ts",
|
| 18830 | "line": 49
|
| 18831 | },
|
| 18832 | "name": "grantPrincipal",
|
| 18833 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18834 | "type": {
|
| 18835 | "fqn": "@aws-cdk/aws-iam.IPrincipal"
|
| 18836 | }
|
| 18837 | },
|
| 18838 | {
|
| 18839 | "docs": {
|
| 18840 | "custom": {
|
| 18841 | "inheritdoc": "true"
|
| 18842 | },
|
| 18843 | "remarks": "If this is is `false`, trying to access the `connections` object will fail.",
|
| 18844 | "stability": "stable",
|
| 18845 | "summary": "Whether or not this Lambda function was bound to a VPC."
|
| 18846 | },
|
| 18847 | "immutable": true,
|
| 18848 | "locationInModule": {
|
| 18849 | "filename": "lib/singleton-lambda.ts",
|
| 18850 | "line": 83
|
| 18851 | },
|
| 18852 | "name": "isBoundToVpc",
|
| 18853 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18854 | "type": {
|
| 18855 | "primitive": "boolean"
|
| 18856 | }
|
| 18857 | },
|
| 18858 | {
|
| 18859 | "docs": {
|
| 18860 | "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.",
|
| 18861 | "stability": "stable",
|
| 18862 | "summary": "The LogGroup where the Lambda function's logs are made available."
|
| 18863 | },
|
| 18864 | "immutable": true,
|
| 18865 | "locationInModule": {
|
| 18866 | "filename": "lib/singleton-lambda.ts",
|
| 18867 | "line": 104
|
| 18868 | },
|
| 18869 | "name": "logGroup",
|
| 18870 | "type": {
|
| 18871 | "fqn": "@aws-cdk/aws-logs.ILogGroup"
|
| 18872 | }
|
| 18873 | },
|
| 18874 | {
|
| 18875 | "docs": {
|
| 18876 | "stability": "stable",
|
| 18877 | "summary": "The construct node where permissions are attached."
|
| 18878 | },
|
| 18879 | "immutable": true,
|
| 18880 | "locationInModule": {
|
| 18881 | "filename": "lib/singleton-lambda.ts",
|
| 18882 | "line": 53
|
| 18883 | },
|
| 18884 | "name": "permissionsNode",
|
| 18885 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18886 | "type": {
|
| 18887 | "fqn": "@aws-cdk/core.ConstructNode"
|
| 18888 | }
|
| 18889 | },
|
| 18890 | {
|
| 18891 | "docs": {
|
| 18892 | "stability": "stable",
|
| 18893 | "summary": "The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke()."
|
| 18894 | },
|
| 18895 | "immutable": true,
|
| 18896 | "locationInModule": {
|
| 18897 | "filename": "lib/singleton-lambda.ts",
|
| 18898 | "line": 120
|
| 18899 | },
|
| 18900 | "name": "resourceArnsForGrantInvoke",
|
| 18901 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18902 | "type": {
|
| 18903 | "collection": {
|
| 18904 | "elementtype": {
|
| 18905 | "primitive": "string"
|
| 18906 | },
|
| 18907 | "kind": "array"
|
| 18908 | }
|
| 18909 | }
|
| 18910 | },
|
| 18911 | {
|
| 18912 | "docs": {
|
| 18913 | "stability": "stable",
|
| 18914 | "summary": "The runtime environment for the Lambda function."
|
| 18915 | },
|
| 18916 | "immutable": true,
|
| 18917 | "locationInModule": {
|
| 18918 | "filename": "lib/singleton-lambda.ts",
|
| 18919 | "line": 59
|
| 18920 | },
|
| 18921 | "name": "runtime",
|
| 18922 | "type": {
|
| 18923 | "fqn": "@aws-cdk/aws-lambda.Runtime"
|
| 18924 | }
|
| 18925 | },
|
| 18926 | {
|
| 18927 | "docs": {
|
| 18928 | "remarks": "Undefined if the function was imported without a role.",
|
| 18929 | "stability": "stable",
|
| 18930 | "summary": "The IAM role associated with this function."
|
| 18931 | },
|
| 18932 | "immutable": true,
|
| 18933 | "locationInModule": {
|
| 18934 | "filename": "lib/singleton-lambda.ts",
|
| 18935 | "line": 52
|
| 18936 | },
|
| 18937 | "name": "role",
|
| 18938 | "optional": true,
|
| 18939 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 18940 | "type": {
|
| 18941 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 18942 | }
|
| 18943 | }
|
| 18944 | ],
|
| 18945 | "symbolId": "lib/singleton-lambda:SingletonFunction"
|
| 18946 | },
|
| 18947 | "@aws-cdk/aws-lambda.SingletonFunctionProps": {
|
| 18948 | "assembly": "@aws-cdk/aws-lambda",
|
| 18949 | "datatype": true,
|
| 18950 | "docs": {
|
| 18951 | "stability": "stable",
|
| 18952 | "summary": "Properties for a newly created singleton Lambda.",
|
| 18953 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as codeguruprofiler from '@aws-cdk/aws-codeguruprofiler';\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as lambda from '@aws-cdk/aws-lambda';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as sns from '@aws-cdk/aws-sns';\nimport * as sqs from '@aws-cdk/aws-sqs';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const architecture: lambda.Architecture;\ndeclare const code: lambda.Code;\ndeclare const codeSigningConfig: lambda.CodeSigningConfig;\ndeclare const destination: lambda.IDestination;\ndeclare const eventSource: lambda.IEventSource;\ndeclare const fileSystem: lambda.FileSystem;\ndeclare const key: kms.Key;\ndeclare const lambdaInsightsVersion: lambda.LambdaInsightsVersion;\ndeclare const layerVersion: lambda.LayerVersion;\ndeclare const policyStatement: iam.PolicyStatement;\ndeclare const profilingGroup: codeguruprofiler.ProfilingGroup;\ndeclare const queue: sqs.Queue;\ndeclare const role: iam.Role;\ndeclare const runtime: lambda.Runtime;\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const size: cdk.Size;\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const topic: sns.Topic;\ndeclare const vpc: ec2.Vpc;\nconst singletonFunctionProps: lambda.SingletonFunctionProps = {\n code: code,\n handler: 'handler',\n runtime: runtime,\n uuid: 'uuid',\n\n // the properties below are optional\n allowAllOutbound: false,\n allowPublicSubnet: false,\n architecture: architecture,\n architectures: [architecture],\n codeSigningConfig: codeSigningConfig,\n currentVersionOptions: {\n codeSha256: 'codeSha256',\n description: 'description',\n maxEventAge: cdk.Duration.minutes(30),\n onFailure: destination,\n onSuccess: destination,\n provisionedConcurrentExecutions: 123,\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n retryAttempts: 123,\n },\n deadLetterQueue: queue,\n deadLetterQueueEnabled: false,\n deadLetterTopic: topic,\n description: 'description',\n environment: {\n environmentKey: 'environment',\n },\n environmentEncryption: key,\n ephemeralStorageSize: size,\n events: [eventSource],\n filesystem: fileSystem,\n functionName: 'functionName',\n initialPolicy: [policyStatement],\n insightsVersion: lambdaInsightsVersion,\n lambdaPurpose: 'lambdaPurpose',\n layers: [layerVersion],\n logRetention: logs.RetentionDays.ONE_DAY,\n logRetentionRetryOptions: {\n base: cdk.Duration.minutes(30),\n maxRetries: 123,\n },\n logRetentionRole: role,\n maxEventAge: cdk.Duration.minutes(30),\n memorySize: 123,\n onFailure: destination,\n onSuccess: destination,\n profiling: false,\n profilingGroup: profilingGroup,\n reservedConcurrentExecutions: 123,\n retryAttempts: 123,\n role: role,\n securityGroup: securityGroup,\n securityGroups: [securityGroup],\n timeout: cdk.Duration.minutes(30),\n tracing: lambda.Tracing.ACTIVE,\n vpc: vpc,\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n};",
|
| 18954 | "custom": {
|
| 18955 | "exampleMetadata": "fixture=_generated"
|
| 18956 | }
|
| 18957 | },
|
| 18958 | "fqn": "@aws-cdk/aws-lambda.SingletonFunctionProps",
|
| 18959 | "interfaces": [
|
| 18960 | "@aws-cdk/aws-lambda.FunctionProps"
|
| 18961 | ],
|
| 18962 | "kind": "interface",
|
| 18963 | "locationInModule": {
|
| 18964 | "filename": "lib/singleton-lambda.ts",
|
| 18965 | "line": 17
|
| 18966 | },
|
| 18967 | "name": "SingletonFunctionProps",
|
| 18968 | "properties": [
|
| 18969 | {
|
| 18970 | "abstract": true,
|
| 18971 | "docs": {
|
| 18972 | "remarks": "The identifier should be unique across all custom resource providers.\nWe recommend generating a UUID per provider.",
|
| 18973 | "stability": "stable",
|
| 18974 | "summary": "A unique identifier to identify this lambda."
|
| 18975 | },
|
| 18976 | "immutable": true,
|
| 18977 | "locationInModule": {
|
| 18978 | "filename": "lib/singleton-lambda.ts",
|
| 18979 | "line": 24
|
| 18980 | },
|
| 18981 | "name": "uuid",
|
| 18982 | "type": {
|
| 18983 | "primitive": "string"
|
| 18984 | }
|
| 18985 | },
|
| 18986 | {
|
| 18987 | "abstract": true,
|
| 18988 | "docs": {
|
| 18989 | "default": "SingletonLambda",
|
| 18990 | "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.",
|
| 18991 | "stability": "stable",
|
| 18992 | "summary": "A descriptive name for the purpose of this Lambda."
|
| 18993 | },
|
| 18994 | "immutable": true,
|
| 18995 | "locationInModule": {
|
| 18996 | "filename": "lib/singleton-lambda.ts",
|
| 18997 | "line": 35
|
| 18998 | },
|
| 18999 | "name": "lambdaPurpose",
|
| 19000 | "optional": true,
|
| 19001 | "type": {
|
| 19002 | "primitive": "string"
|
| 19003 | }
|
| 19004 | }
|
| 19005 | ],
|
| 19006 | "symbolId": "lib/singleton-lambda:SingletonFunctionProps"
|
| 19007 | },
|
| 19008 | "@aws-cdk/aws-lambda.SourceAccessConfiguration": {
|
| 19009 | "assembly": "@aws-cdk/aws-lambda",
|
| 19010 | "datatype": true,
|
| 19011 | "docs": {
|
| 19012 | "stability": "stable",
|
| 19013 | "summary": "Specific settings like the authentication protocol or the VPC components to secure access to your event source.",
|
| 19014 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\n\ndeclare const sourceAccessConfigurationType: lambda.SourceAccessConfigurationType;\nconst sourceAccessConfiguration: lambda.SourceAccessConfiguration = {\n type: sourceAccessConfigurationType,\n uri: 'uri',\n};",
|
| 19015 | "custom": {
|
| 19016 | "exampleMetadata": "fixture=_generated"
|
| 19017 | }
|
| 19018 | },
|
| 19019 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfiguration",
|
| 19020 | "kind": "interface",
|
| 19021 | "locationInModule": {
|
| 19022 | "filename": "lib/event-source-mapping.ts",
|
| 19023 | "line": 63
|
| 19024 | },
|
| 19025 | "name": "SourceAccessConfiguration",
|
| 19026 | "properties": [
|
| 19027 | {
|
| 19028 | "abstract": true,
|
| 19029 | "docs": {
|
| 19030 | "remarks": "For example: \"SASL_SCRAM_512_AUTH\".",
|
| 19031 | "stability": "stable",
|
| 19032 | "summary": "The type of authentication protocol or the VPC components for your event source."
|
| 19033 | },
|
| 19034 | "immutable": true,
|
| 19035 | "locationInModule": {
|
| 19036 | "filename": "lib/event-source-mapping.ts",
|
| 19037 | "line": 67
|
| 19038 | },
|
| 19039 | "name": "type",
|
| 19040 | "type": {
|
| 19041 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType"
|
| 19042 | }
|
| 19043 | },
|
| 19044 | {
|
| 19045 | "abstract": true,
|
| 19046 | "docs": {
|
| 19047 | "remarks": "For example: \"URI\": \"arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName\".\nThe exact string depends on the type.",
|
| 19048 | "see": "SourceAccessConfigurationType",
|
| 19049 | "stability": "stable",
|
| 19050 | "summary": "The value for your chosen configuration in type."
|
| 19051 | },
|
| 19052 | "immutable": true,
|
| 19053 | "locationInModule": {
|
| 19054 | "filename": "lib/event-source-mapping.ts",
|
| 19055 | "line": 74
|
| 19056 | },
|
| 19057 | "name": "uri",
|
| 19058 | "type": {
|
| 19059 | "primitive": "string"
|
| 19060 | }
|
| 19061 | }
|
| 19062 | ],
|
| 19063 | "symbolId": "lib/event-source-mapping:SourceAccessConfiguration"
|
| 19064 | },
|
| 19065 | "@aws-cdk/aws-lambda.SourceAccessConfigurationType": {
|
| 19066 | "assembly": "@aws-cdk/aws-lambda",
|
| 19067 | "docs": {
|
| 19068 | "see": "https://docs.aws.amazon.com/lambda/latest/dg/API_SourceAccessConfiguration.html#SSS-Type-SourceAccessConfiguration-Type",
|
| 19069 | "stability": "stable",
|
| 19070 | "summary": "The type of authentication protocol or the VPC components for your event source's SourceAccessConfiguration.",
|
| 19071 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\nconst sourceAccessConfigurationType = lambda.SourceAccessConfigurationType.BASIC_AUTH;",
|
| 19072 | "custom": {
|
| 19073 | "exampleMetadata": "fixture=_generated"
|
| 19074 | }
|
| 19075 | },
|
| 19076 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType",
|
| 19077 | "kind": "class",
|
| 19078 | "locationInModule": {
|
| 19079 | "filename": "lib/event-source-mapping.ts",
|
| 19080 | "line": 11
|
| 19081 | },
|
| 19082 | "methods": [
|
| 19083 | {
|
| 19084 | "docs": {
|
| 19085 | "stability": "stable",
|
| 19086 | "summary": "A custom source access configuration property."
|
| 19087 | },
|
| 19088 | "locationInModule": {
|
| 19089 | "filename": "lib/event-source-mapping.ts",
|
| 19090 | "line": 45
|
| 19091 | },
|
| 19092 | "name": "of",
|
| 19093 | "parameters": [
|
| 19094 | {
|
| 19095 | "name": "name",
|
| 19096 | "type": {
|
| 19097 | "primitive": "string"
|
| 19098 | }
|
| 19099 | }
|
| 19100 | ],
|
| 19101 | "returns": {
|
| 19102 | "type": {
|
| 19103 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType"
|
| 19104 | }
|
| 19105 | },
|
| 19106 | "static": true
|
| 19107 | }
|
| 19108 | ],
|
| 19109 | "name": "SourceAccessConfigurationType",
|
| 19110 | "properties": [
|
| 19111 | {
|
| 19112 | "const": true,
|
| 19113 | "docs": {
|
| 19114 | "stability": "stable",
|
| 19115 | "summary": "(MQ) The Secrets Manager secret that stores your broker credentials."
|
| 19116 | },
|
| 19117 | "immutable": true,
|
| 19118 | "locationInModule": {
|
| 19119 | "filename": "lib/event-source-mapping.ts",
|
| 19120 | "line": 16
|
| 19121 | },
|
| 19122 | "name": "BASIC_AUTH",
|
| 19123 | "static": true,
|
| 19124 | "type": {
|
| 19125 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType"
|
| 19126 | }
|
| 19127 | },
|
| 19128 | {
|
| 19129 | "const": true,
|
| 19130 | "docs": {
|
| 19131 | "stability": "stable",
|
| 19132 | "summary": "The Secrets Manager ARN of your secret key containing the certificate chain (X.509 PEM), private key (PKCS#8 PEM), and private key password (optional) used for mutual TLS authentication of your MSK/Apache Kafka brokers."
|
| 19133 | },
|
| 19134 | "immutable": true,
|
| 19135 | "locationInModule": {
|
| 19136 | "filename": "lib/event-source-mapping.ts",
|
| 19137 | "line": 42
|
| 19138 | },
|
| 19139 | "name": "CLIENT_CERTIFICATE_TLS_AUTH",
|
| 19140 | "static": true,
|
| 19141 | "type": {
|
| 19142 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType"
|
| 19143 | }
|
| 19144 | },
|
| 19145 | {
|
| 19146 | "const": true,
|
| 19147 | "docs": {
|
| 19148 | "stability": "stable",
|
| 19149 | "summary": "The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your Self-Managed Apache Kafka brokers."
|
| 19150 | },
|
| 19151 | "immutable": true,
|
| 19152 | "locationInModule": {
|
| 19153 | "filename": "lib/event-source-mapping.ts",
|
| 19154 | "line": 31
|
| 19155 | },
|
| 19156 | "name": "SASL_SCRAM_256_AUTH",
|
| 19157 | "static": true,
|
| 19158 | "type": {
|
| 19159 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType"
|
| 19160 | }
|
| 19161 | },
|
| 19162 | {
|
| 19163 | "const": true,
|
| 19164 | "docs": {
|
| 19165 | "stability": "stable",
|
| 19166 | "summary": "The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers."
|
| 19167 | },
|
| 19168 | "immutable": true,
|
| 19169 | "locationInModule": {
|
| 19170 | "filename": "lib/event-source-mapping.ts",
|
| 19171 | "line": 36
|
| 19172 | },
|
| 19173 | "name": "SASL_SCRAM_512_AUTH",
|
| 19174 | "static": true,
|
| 19175 | "type": {
|
| 19176 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType"
|
| 19177 | }
|
| 19178 | },
|
| 19179 | {
|
| 19180 | "const": true,
|
| 19181 | "docs": {
|
| 19182 | "stability": "stable",
|
| 19183 | "summary": "The VPC security group used to manage access to your Self-Managed Apache Kafka brokers."
|
| 19184 | },
|
| 19185 | "immutable": true,
|
| 19186 | "locationInModule": {
|
| 19187 | "filename": "lib/event-source-mapping.ts",
|
| 19188 | "line": 26
|
| 19189 | },
|
| 19190 | "name": "VPC_SECURITY_GROUP",
|
| 19191 | "static": true,
|
| 19192 | "type": {
|
| 19193 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType"
|
| 19194 | }
|
| 19195 | },
|
| 19196 | {
|
| 19197 | "const": true,
|
| 19198 | "docs": {
|
| 19199 | "remarks": "Lambda connects to these subnets to fetch data from your Self-Managed Apache Kafka cluster.",
|
| 19200 | "stability": "stable",
|
| 19201 | "summary": "The subnets associated with your VPC."
|
| 19202 | },
|
| 19203 | "immutable": true,
|
| 19204 | "locationInModule": {
|
| 19205 | "filename": "lib/event-source-mapping.ts",
|
| 19206 | "line": 21
|
| 19207 | },
|
| 19208 | "name": "VPC_SUBNET",
|
| 19209 | "static": true,
|
| 19210 | "type": {
|
| 19211 | "fqn": "@aws-cdk/aws-lambda.SourceAccessConfigurationType"
|
| 19212 | }
|
| 19213 | },
|
| 19214 | {
|
| 19215 | "docs": {
|
| 19216 | "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-sourceaccessconfiguration.html#cfn-lambda-eventsourcemapping-sourceaccessconfiguration-type",
|
| 19217 | "stability": "stable",
|
| 19218 | "summary": "The key to use in `SourceAccessConfigurationProperty.Type` property in CloudFormation."
|
| 19219 | },
|
| 19220 | "immutable": true,
|
| 19221 | "locationInModule": {
|
| 19222 | "filename": "lib/event-source-mapping.ts",
|
| 19223 | "line": 53
|
| 19224 | },
|
| 19225 | "name": "type",
|
| 19226 | "type": {
|
| 19227 | "primitive": "string"
|
| 19228 | }
|
| 19229 | }
|
| 19230 | ],
|
| 19231 | "symbolId": "lib/event-source-mapping:SourceAccessConfigurationType"
|
| 19232 | },
|
| 19233 | "@aws-cdk/aws-lambda.StartingPosition": {
|
| 19234 | "assembly": "@aws-cdk/aws-lambda",
|
| 19235 | "docs": {
|
| 19236 | "stability": "stable",
|
| 19237 | "summary": "The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.",
|
| 19238 | "example": "import { Secret } from '@aws-cdk/aws-secretsmanager';\nimport { SelfManagedKafkaEventSource } from '@aws-cdk/aws-lambda-event-sources';\n\n// The list of Kafka brokers\nconst bootstrapServers = ['kafka-broker:9092'];\n\n// The Kafka topic you want to subscribe to\nconst topic = 'some-cool-topic';\n\n// The secret that allows access to your self hosted Kafka cluster\ndeclare const secret: Secret;\n\ndeclare const myFunction: lambda.Function;\nmyFunction.addEventSource(new SelfManagedKafkaEventSource({\n bootstrapServers: bootstrapServers,\n topic: topic,\n secret: secret,\n batchSize: 100, // default\n startingPosition: lambda.StartingPosition.TRIM_HORIZON,\n}));",
|
| 19239 | "custom": {
|
| 19240 | "exampleMetadata": "infused"
|
| 19241 | }
|
| 19242 | },
|
| 19243 | "fqn": "@aws-cdk/aws-lambda.StartingPosition",
|
| 19244 | "kind": "enum",
|
| 19245 | "locationInModule": {
|
| 19246 | "filename": "lib/event-source-mapping.ts",
|
| 19247 | "line": 342
|
| 19248 | },
|
| 19249 | "members": [
|
| 19250 | {
|
| 19251 | "docs": {
|
| 19252 | "stability": "stable",
|
| 19253 | "summary": "Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard."
|
| 19254 | },
|
| 19255 | "name": "TRIM_HORIZON"
|
| 19256 | },
|
| 19257 | {
|
| 19258 | "docs": {
|
| 19259 | "stability": "stable",
|
| 19260 | "summary": "Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard."
|
| 19261 | },
|
| 19262 | "name": "LATEST"
|
| 19263 | }
|
| 19264 | ],
|
| 19265 | "name": "StartingPosition",
|
| 19266 | "symbolId": "lib/event-source-mapping:StartingPosition"
|
| 19267 | },
|
| 19268 | "@aws-cdk/aws-lambda.Tracing": {
|
| 19269 | "assembly": "@aws-cdk/aws-lambda",
|
| 19270 | "docs": {
|
| 19271 | "stability": "stable",
|
| 19272 | "summary": "X-Ray Tracing Modes (https://docs.aws.amazon.com/lambda/latest/dg/API_TracingConfig.html).",
|
| 19273 | "example": "const fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_16_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});",
|
| 19274 | "custom": {
|
| 19275 | "exampleMetadata": "infused"
|
| 19276 | }
|
| 19277 | },
|
| 19278 | "fqn": "@aws-cdk/aws-lambda.Tracing",
|
| 19279 | "kind": "enum",
|
| 19280 | "locationInModule": {
|
| 19281 | "filename": "lib/function.ts",
|
| 19282 | "line": 36
|
| 19283 | },
|
| 19284 | "members": [
|
| 19285 | {
|
| 19286 | "docs": {
|
| 19287 | "remarks": "If no tracing header is received, Lambda will call X-Ray for a tracing decision.",
|
| 19288 | "stability": "stable",
|
| 19289 | "summary": "Lambda will respect any tracing header it receives from an upstream service."
|
| 19290 | },
|
| 19291 | "name": "ACTIVE"
|
| 19292 | },
|
| 19293 | {
|
| 19294 | "docs": {
|
| 19295 | "stability": "stable",
|
| 19296 | "summary": "Lambda will only trace the request from an upstream service if it contains a tracing header with \"sampled=1\"."
|
| 19297 | },
|
| 19298 | "name": "PASS_THROUGH"
|
| 19299 | },
|
| 19300 | {
|
| 19301 | "docs": {
|
| 19302 | "stability": "stable",
|
| 19303 | "summary": "Lambda will not trace any request."
|
| 19304 | },
|
| 19305 | "name": "DISABLED"
|
| 19306 | }
|
| 19307 | ],
|
| 19308 | "name": "Tracing",
|
| 19309 | "symbolId": "lib/function:Tracing"
|
| 19310 | },
|
| 19311 | "@aws-cdk/aws-lambda.UntrustedArtifactOnDeployment": {
|
| 19312 | "assembly": "@aws-cdk/aws-lambda",
|
| 19313 | "docs": {
|
| 19314 | "stability": "stable",
|
| 19315 | "summary": "Code signing configuration policy for deployment validation failure."
|
| 19316 | },
|
| 19317 | "fqn": "@aws-cdk/aws-lambda.UntrustedArtifactOnDeployment",
|
| 19318 | "kind": "enum",
|
| 19319 | "locationInModule": {
|
| 19320 | "filename": "lib/code-signing-config.ts",
|
| 19321 | "line": 9
|
| 19322 | },
|
| 19323 | "members": [
|
| 19324 | {
|
| 19325 | "docs": {
|
| 19326 | "stability": "stable",
|
| 19327 | "summary": "Lambda blocks the deployment request if signature validation checks fail."
|
| 19328 | },
|
| 19329 | "name": "ENFORCE"
|
| 19330 | },
|
| 19331 | {
|
| 19332 | "docs": {
|
| 19333 | "remarks": "Lambda issues a new Amazon CloudWatch metric, called a signature validation error and also stores the warning in CloudTrail.",
|
| 19334 | "stability": "stable",
|
| 19335 | "summary": "Lambda allows the deployment of the code package, but issues a warning."
|
| 19336 | },
|
| 19337 | "name": "WARN"
|
| 19338 | }
|
| 19339 | ],
|
| 19340 | "name": "UntrustedArtifactOnDeployment",
|
| 19341 | "symbolId": "lib/code-signing-config:UntrustedArtifactOnDeployment"
|
| 19342 | },
|
| 19343 | "@aws-cdk/aws-lambda.UtilizationScalingOptions": {
|
| 19344 | "assembly": "@aws-cdk/aws-lambda",
|
| 19345 | "datatype": true,
|
| 19346 | "docs": {
|
| 19347 | "stability": "stable",
|
| 19348 | "summary": "Options for enabling Lambda utilization tracking.",
|
| 19349 | "example": "import * as autoscaling from '@aws-cdk/aws-autoscaling';\n\ndeclare const fn: lambda.Function;\nconst alias = fn.addAlias('prod');\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: autoscaling.Schedule.cron({ hour: '8', minute: '0'}),\n minCapacity: 20,\n});",
|
| 19350 | "custom": {
|
| 19351 | "exampleMetadata": "infused"
|
| 19352 | }
|
| 19353 | },
|
| 19354 | "fqn": "@aws-cdk/aws-lambda.UtilizationScalingOptions",
|
| 19355 | "interfaces": [
|
| 19356 | "@aws-cdk/aws-applicationautoscaling.BaseTargetTrackingProps"
|
| 19357 | ],
|
| 19358 | "kind": "interface",
|
| 19359 | "locationInModule": {
|
| 19360 | "filename": "lib/scalable-attribute-api.ts",
|
| 19361 | "line": 24
|
| 19362 | },
|
| 19363 | "name": "UtilizationScalingOptions",
|
| 19364 | "properties": [
|
| 19365 | {
|
| 19366 | "abstract": true,
|
| 19367 | "docs": {
|
| 19368 | "remarks": "For example, .5 indicates that 50 percent of allocated provisioned concurrency is in use.",
|
| 19369 | "stability": "stable",
|
| 19370 | "summary": "Utilization target for the attribute."
|
| 19371 | },
|
| 19372 | "immutable": true,
|
| 19373 | "locationInModule": {
|
| 19374 | "filename": "lib/scalable-attribute-api.ts",
|
| 19375 | "line": 28
|
| 19376 | },
|
| 19377 | "name": "utilizationTarget",
|
| 19378 | "type": {
|
| 19379 | "primitive": "number"
|
| 19380 | }
|
| 19381 | }
|
| 19382 | ],
|
| 19383 | "symbolId": "lib/scalable-attribute-api:UtilizationScalingOptions"
|
| 19384 | },
|
| 19385 | "@aws-cdk/aws-lambda.Version": {
|
| 19386 | "assembly": "@aws-cdk/aws-lambda",
|
| 19387 | "base": "@aws-cdk/aws-lambda.QualifiedFunctionBase",
|
| 19388 | "docs": {
|
| 19389 | "remarks": "Avoid using this resource directly. If you need a Version object, use\n`function.currentVersion` instead. That will add a Version object to your\ntemplate, and make sure the Version is invalidated whenever the Function\nobject changes. If you use the `Version` resource directly, you are\nresponsible for making sure it is invalidated (by changing its\nlogical ID) whenever necessary.\n\nVersion resources can then be used in `Alias` resources to refer to a\nparticular deployment of a Lambda.\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.",
|
| 19390 | "stability": "stable",
|
| 19391 | "summary": "Tag the current state of a Function with a Version number.",
|
| 19392 | "example": "const lambdaCode = lambda.Code.fromCfnParameters();\nconst func = new lambda.Function(this, 'Lambda', {\n code: lambdaCode,\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_14_X,\n});\n// used to make sure each CDK synthesis produces a different Version\nconst version = func.currentVersion;\nconst alias = new lambda.Alias(this, 'LambdaAlias', {\n aliasName: 'Prod',\n version,\n});\n\nnew codedeploy.LambdaDeploymentGroup(this, 'DeploymentGroup', {\n alias,\n deploymentConfig: codedeploy.LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,\n});",
|
| 19393 | "custom": {
|
| 19394 | "exampleMetadata": "infused"
|
| 19395 | }
|
| 19396 | },
|
| 19397 | "fqn": "@aws-cdk/aws-lambda.Version",
|
| 19398 | "initializer": {
|
| 19399 | "docs": {
|
| 19400 | "stability": "stable"
|
| 19401 | },
|
| 19402 | "locationInModule": {
|
| 19403 | "filename": "lib/lambda-version.ts",
|
| 19404 | "line": 189
|
| 19405 | },
|
| 19406 | "parameters": [
|
| 19407 | {
|
| 19408 | "name": "scope",
|
| 19409 | "type": {
|
| 19410 | "fqn": "constructs.Construct"
|
| 19411 | }
|
| 19412 | },
|
| 19413 | {
|
| 19414 | "name": "id",
|
| 19415 | "type": {
|
| 19416 | "primitive": "string"
|
| 19417 | }
|
| 19418 | },
|
| 19419 | {
|
| 19420 | "name": "props",
|
| 19421 | "type": {
|
| 19422 | "fqn": "@aws-cdk/aws-lambda.VersionProps"
|
| 19423 | }
|
| 19424 | }
|
| 19425 | ]
|
| 19426 | },
|
| 19427 | "interfaces": [
|
| 19428 | "@aws-cdk/aws-lambda.IVersion"
|
| 19429 | ],
|
| 19430 | "kind": "class",
|
| 19431 | "locationInModule": {
|
| 19432 | "filename": "lib/lambda-version.ts",
|
| 19433 | "line": 114
|
| 19434 | },
|
| 19435 | "methods": [
|
| 19436 | {
|
| 19437 | "docs": {
|
| 19438 | "stability": "stable",
|
| 19439 | "summary": "Construct a Version object from a Version ARN."
|
| 19440 | },
|
| 19441 | "locationInModule": {
|
| 19442 | "filename": "lib/lambda-version.ts",
|
| 19443 | "line": 123
|
| 19444 | },
|
| 19445 | "name": "fromVersionArn",
|
| 19446 | "parameters": [
|
| 19447 | {
|
| 19448 | "docs": {
|
| 19449 | "summary": "The cdk scope creating this resource."
|
| 19450 | },
|
| 19451 | "name": "scope",
|
| 19452 | "type": {
|
| 19453 | "fqn": "constructs.Construct"
|
| 19454 | }
|
| 19455 | },
|
| 19456 | {
|
| 19457 | "docs": {
|
| 19458 | "summary": "The cdk id of this resource."
|
| 19459 | },
|
| 19460 | "name": "id",
|
| 19461 | "type": {
|
| 19462 | "primitive": "string"
|
| 19463 | }
|
| 19464 | },
|
| 19465 | {
|
| 19466 | "docs": {
|
| 19467 | "summary": "The version ARN to create this version from."
|
| 19468 | },
|
| 19469 | "name": "versionArn",
|
| 19470 | "type": {
|
| 19471 | "primitive": "string"
|
| 19472 | }
|
| 19473 | }
|
| 19474 | ],
|
| 19475 | "returns": {
|
| 19476 | "type": {
|
| 19477 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 19478 | }
|
| 19479 | },
|
| 19480 | "static": true
|
| 19481 | },
|
| 19482 | {
|
| 19483 | "docs": {
|
| 19484 | "stability": "stable"
|
| 19485 | },
|
| 19486 | "locationInModule": {
|
| 19487 | "filename": "lib/lambda-version.ts",
|
| 19488 | "line": 153
|
| 19489 | },
|
| 19490 | "name": "fromVersionAttributes",
|
| 19491 | "parameters": [
|
| 19492 | {
|
| 19493 | "name": "scope",
|
| 19494 | "type": {
|
| 19495 | "fqn": "constructs.Construct"
|
| 19496 | }
|
| 19497 | },
|
| 19498 | {
|
| 19499 | "name": "id",
|
| 19500 | "type": {
|
| 19501 | "primitive": "string"
|
| 19502 | }
|
| 19503 | },
|
| 19504 | {
|
| 19505 | "name": "attrs",
|
| 19506 | "type": {
|
| 19507 | "fqn": "@aws-cdk/aws-lambda.VersionAttributes"
|
| 19508 | }
|
| 19509 | }
|
| 19510 | ],
|
| 19511 | "returns": {
|
| 19512 | "type": {
|
| 19513 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 19514 | }
|
| 19515 | },
|
| 19516 | "static": true
|
| 19517 | },
|
| 19518 | {
|
| 19519 | "docs": {
|
| 19520 | "deprecated": "Calling `addAlias` on a `Version` object will cause the Alias to be replaced on every function update. Call `function.addAlias()` or `new Alias()` instead.",
|
| 19521 | "stability": "deprecated",
|
| 19522 | "summary": "Defines an alias for this version."
|
| 19523 | },
|
| 19524 | "locationInModule": {
|
| 19525 | "filename": "lib/lambda-version.ts",
|
| 19526 | "line": 251
|
| 19527 | },
|
| 19528 | "name": "addAlias",
|
| 19529 | "overrides": "@aws-cdk/aws-lambda.IVersion",
|
| 19530 | "parameters": [
|
| 19531 | {
|
| 19532 | "docs": {
|
| 19533 | "summary": "The name of the alias (e.g. \"live\")."
|
| 19534 | },
|
| 19535 | "name": "aliasName",
|
| 19536 | "type": {
|
| 19537 | "primitive": "string"
|
| 19538 | }
|
| 19539 | },
|
| 19540 | {
|
| 19541 | "docs": {
|
| 19542 | "summary": "Alias options."
|
| 19543 | },
|
| 19544 | "name": "options",
|
| 19545 | "optional": true,
|
| 19546 | "type": {
|
| 19547 | "fqn": "@aws-cdk/aws-lambda.AliasOptions"
|
| 19548 | }
|
| 19549 | }
|
| 19550 | ],
|
| 19551 | "returns": {
|
| 19552 | "type": {
|
| 19553 | "fqn": "@aws-cdk/aws-lambda.Alias"
|
| 19554 | }
|
| 19555 | }
|
| 19556 | },
|
| 19557 | {
|
| 19558 | "docs": {
|
| 19559 | "stability": "stable",
|
| 19560 | "summary": "Return the given named metric for this Function."
|
| 19561 | },
|
| 19562 | "locationInModule": {
|
| 19563 | "filename": "lib/lambda-version.ts",
|
| 19564 | "line": 231
|
| 19565 | },
|
| 19566 | "name": "metric",
|
| 19567 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 19568 | "parameters": [
|
| 19569 | {
|
| 19570 | "name": "metricName",
|
| 19571 | "type": {
|
| 19572 | "primitive": "string"
|
| 19573 | }
|
| 19574 | },
|
| 19575 | {
|
| 19576 | "name": "props",
|
| 19577 | "optional": true,
|
| 19578 | "type": {
|
| 19579 | "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions"
|
| 19580 | }
|
| 19581 | }
|
| 19582 | ],
|
| 19583 | "returns": {
|
| 19584 | "type": {
|
| 19585 | "fqn": "@aws-cdk/aws-cloudwatch.Metric"
|
| 19586 | }
|
| 19587 | }
|
| 19588 | }
|
| 19589 | ],
|
| 19590 | "name": "Version",
|
| 19591 | "properties": [
|
| 19592 | {
|
| 19593 | "docs": {
|
| 19594 | "stability": "stable",
|
| 19595 | "summary": "The architecture of this Lambda Function."
|
| 19596 | },
|
| 19597 | "immutable": true,
|
| 19598 | "locationInModule": {
|
| 19599 | "filename": "lib/lambda-version.ts",
|
| 19600 | "line": 184
|
| 19601 | },
|
| 19602 | "name": "architecture",
|
| 19603 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 19604 | "type": {
|
| 19605 | "fqn": "@aws-cdk/aws-lambda.Architecture"
|
| 19606 | }
|
| 19607 | },
|
| 19608 | {
|
| 19609 | "docs": {
|
| 19610 | "remarks": "True for new Lambdas, false for version $LATEST and imported Lambdas\nfrom different accounts.",
|
| 19611 | "stability": "stable",
|
| 19612 | "summary": "Whether the addPermission() call adds any permissions."
|
| 19613 | },
|
| 19614 | "immutable": true,
|
| 19615 | "locationInModule": {
|
| 19616 | "filename": "lib/lambda-version.ts",
|
| 19617 | "line": 187
|
| 19618 | },
|
| 19619 | "name": "canCreatePermissions",
|
| 19620 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 19621 | "protected": true,
|
| 19622 | "type": {
|
| 19623 | "primitive": "boolean"
|
| 19624 | }
|
| 19625 | },
|
| 19626 | {
|
| 19627 | "docs": {
|
| 19628 | "stability": "stable",
|
| 19629 | "summary": "The ARN of the version for Lambda@Edge."
|
| 19630 | },
|
| 19631 | "immutable": true,
|
| 19632 | "locationInModule": {
|
| 19633 | "filename": "lib/lambda-version.ts",
|
| 19634 | "line": 255
|
| 19635 | },
|
| 19636 | "name": "edgeArn",
|
| 19637 | "overrides": "@aws-cdk/aws-lambda.IVersion",
|
| 19638 | "type": {
|
| 19639 | "primitive": "string"
|
| 19640 | }
|
| 19641 | },
|
| 19642 | {
|
| 19643 | "docs": {
|
| 19644 | "stability": "stable",
|
| 19645 | "summary": "The ARN fo the function."
|
| 19646 | },
|
| 19647 | "immutable": true,
|
| 19648 | "locationInModule": {
|
| 19649 | "filename": "lib/lambda-version.ts",
|
| 19650 | "line": 182
|
| 19651 | },
|
| 19652 | "name": "functionArn",
|
| 19653 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 19654 | "type": {
|
| 19655 | "primitive": "string"
|
| 19656 | }
|
| 19657 | },
|
| 19658 | {
|
| 19659 | "docs": {
|
| 19660 | "stability": "stable",
|
| 19661 | "summary": "The name of the function."
|
| 19662 | },
|
| 19663 | "immutable": true,
|
| 19664 | "locationInModule": {
|
| 19665 | "filename": "lib/lambda-version.ts",
|
| 19666 | "line": 183
|
| 19667 | },
|
| 19668 | "name": "functionName",
|
| 19669 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 19670 | "type": {
|
| 19671 | "primitive": "string"
|
| 19672 | }
|
| 19673 | },
|
| 19674 | {
|
| 19675 | "docs": {
|
| 19676 | "stability": "stable",
|
| 19677 | "summary": "The principal this Lambda Function is running as."
|
| 19678 | },
|
| 19679 | "immutable": true,
|
| 19680 | "locationInModule": {
|
| 19681 | "filename": "lib/lambda-version.ts",
|
| 19682 | "line": 223
|
| 19683 | },
|
| 19684 | "name": "grantPrincipal",
|
| 19685 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 19686 | "type": {
|
| 19687 | "fqn": "@aws-cdk/aws-iam.IPrincipal"
|
| 19688 | }
|
| 19689 | },
|
| 19690 | {
|
| 19691 | "docs": {
|
| 19692 | "stability": "stable",
|
| 19693 | "summary": "The underlying AWS Lambda function."
|
| 19694 | },
|
| 19695 | "immutable": true,
|
| 19696 | "locationInModule": {
|
| 19697 | "filename": "lib/lambda-version.ts",
|
| 19698 | "line": 181
|
| 19699 | },
|
| 19700 | "name": "lambda",
|
| 19701 | "overrides": "@aws-cdk/aws-lambda.QualifiedFunctionBase",
|
| 19702 | "type": {
|
| 19703 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 19704 | }
|
| 19705 | },
|
| 19706 | {
|
| 19707 | "docs": {
|
| 19708 | "remarks": "A qualifier is the identifier that's appended to a version or alias ARN.",
|
| 19709 | "stability": "stable",
|
| 19710 | "summary": "The qualifier of the version or alias of this function."
|
| 19711 | },
|
| 19712 | "immutable": true,
|
| 19713 | "locationInModule": {
|
| 19714 | "filename": "lib/lambda-version.ts",
|
| 19715 | "line": 186
|
| 19716 | },
|
| 19717 | "name": "qualifier",
|
| 19718 | "overrides": "@aws-cdk/aws-lambda.QualifiedFunctionBase",
|
| 19719 | "protected": true,
|
| 19720 | "type": {
|
| 19721 | "primitive": "string"
|
| 19722 | }
|
| 19723 | },
|
| 19724 | {
|
| 19725 | "docs": {
|
| 19726 | "stability": "stable",
|
| 19727 | "summary": "The most recently deployed version of this function."
|
| 19728 | },
|
| 19729 | "immutable": true,
|
| 19730 | "locationInModule": {
|
| 19731 | "filename": "lib/lambda-version.ts",
|
| 19732 | "line": 180
|
| 19733 | },
|
| 19734 | "name": "version",
|
| 19735 | "overrides": "@aws-cdk/aws-lambda.IVersion",
|
| 19736 | "type": {
|
| 19737 | "primitive": "string"
|
| 19738 | }
|
| 19739 | },
|
| 19740 | {
|
| 19741 | "docs": {
|
| 19742 | "remarks": "Undefined if the function was imported without a role.",
|
| 19743 | "stability": "stable",
|
| 19744 | "summary": "The IAM role associated with this function."
|
| 19745 | },
|
| 19746 | "immutable": true,
|
| 19747 | "locationInModule": {
|
| 19748 | "filename": "lib/lambda-version.ts",
|
| 19749 | "line": 227
|
| 19750 | },
|
| 19751 | "name": "role",
|
| 19752 | "optional": true,
|
| 19753 | "overrides": "@aws-cdk/aws-lambda.FunctionBase",
|
| 19754 | "type": {
|
| 19755 | "fqn": "@aws-cdk/aws-iam.IRole"
|
| 19756 | }
|
| 19757 | }
|
| 19758 | ],
|
| 19759 | "symbolId": "lib/lambda-version:Version"
|
| 19760 | },
|
| 19761 | "@aws-cdk/aws-lambda.VersionAttributes": {
|
| 19762 | "assembly": "@aws-cdk/aws-lambda",
|
| 19763 | "datatype": true,
|
| 19764 | "docs": {
|
| 19765 | "stability": "stable",
|
| 19766 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\n\ndeclare const function_: lambda.Function;\nconst versionAttributes: lambda.VersionAttributes = {\n lambda: function_,\n version: 'version',\n};",
|
| 19767 | "custom": {
|
| 19768 | "exampleMetadata": "fixture=_generated"
|
| 19769 | }
|
| 19770 | },
|
| 19771 | "fqn": "@aws-cdk/aws-lambda.VersionAttributes",
|
| 19772 | "kind": "interface",
|
| 19773 | "locationInModule": {
|
| 19774 | "filename": "lib/lambda-version.ts",
|
| 19775 | "line": 85
|
| 19776 | },
|
| 19777 | "name": "VersionAttributes",
|
| 19778 | "properties": [
|
| 19779 | {
|
| 19780 | "abstract": true,
|
| 19781 | "docs": {
|
| 19782 | "stability": "stable",
|
| 19783 | "summary": "The lambda function."
|
| 19784 | },
|
| 19785 | "immutable": true,
|
| 19786 | "locationInModule": {
|
| 19787 | "filename": "lib/lambda-version.ts",
|
| 19788 | "line": 94
|
| 19789 | },
|
| 19790 | "name": "lambda",
|
| 19791 | "type": {
|
| 19792 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 19793 | }
|
| 19794 | },
|
| 19795 | {
|
| 19796 | "abstract": true,
|
| 19797 | "docs": {
|
| 19798 | "stability": "stable",
|
| 19799 | "summary": "The version."
|
| 19800 | },
|
| 19801 | "immutable": true,
|
| 19802 | "locationInModule": {
|
| 19803 | "filename": "lib/lambda-version.ts",
|
| 19804 | "line": 89
|
| 19805 | },
|
| 19806 | "name": "version",
|
| 19807 | "type": {
|
| 19808 | "primitive": "string"
|
| 19809 | }
|
| 19810 | }
|
| 19811 | ],
|
| 19812 | "symbolId": "lib/lambda-version:VersionAttributes"
|
| 19813 | },
|
| 19814 | "@aws-cdk/aws-lambda.VersionOptions": {
|
| 19815 | "assembly": "@aws-cdk/aws-lambda",
|
| 19816 | "datatype": true,
|
| 19817 | "docs": {
|
| 19818 | "stability": "stable",
|
| 19819 | "summary": "Options for `lambda.Version`.",
|
| 19820 | "example": "const fn = new lambda.Function(this, 'MyFunction', {\n currentVersionOptions: {\n removalPolicy: RemovalPolicy.RETAIN, // retain old versions\n retryAttempts: 1, // async retry attempts\n },\n runtime: lambda.Runtime.NODEJS_16_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),\n});\n\nfn.addAlias('live');",
|
| 19821 | "custom": {
|
| 19822 | "exampleMetadata": "infused"
|
| 19823 | }
|
| 19824 | },
|
| 19825 | "fqn": "@aws-cdk/aws-lambda.VersionOptions",
|
| 19826 | "interfaces": [
|
| 19827 | "@aws-cdk/aws-lambda.EventInvokeConfigOptions"
|
| 19828 | ],
|
| 19829 | "kind": "interface",
|
| 19830 | "locationInModule": {
|
| 19831 | "filename": "lib/lambda-version.ts",
|
| 19832 | "line": 42
|
| 19833 | },
|
| 19834 | "name": "VersionOptions",
|
| 19835 | "properties": [
|
| 19836 | {
|
| 19837 | "abstract": true,
|
| 19838 | "docs": {
|
| 19839 | "default": "No validation is performed",
|
| 19840 | "remarks": "Specify to validate that you're deploying the right version.",
|
| 19841 | "stability": "stable",
|
| 19842 | "summary": "SHA256 of the version of the Lambda source code."
|
| 19843 | },
|
| 19844 | "immutable": true,
|
| 19845 | "locationInModule": {
|
| 19846 | "filename": "lib/lambda-version.ts",
|
| 19847 | "line": 50
|
| 19848 | },
|
| 19849 | "name": "codeSha256",
|
| 19850 | "optional": true,
|
| 19851 | "type": {
|
| 19852 | "primitive": "string"
|
| 19853 | }
|
| 19854 | },
|
| 19855 | {
|
| 19856 | "abstract": true,
|
| 19857 | "docs": {
|
| 19858 | "default": "Description of the Lambda",
|
| 19859 | "stability": "stable",
|
| 19860 | "summary": "Description of the version."
|
| 19861 | },
|
| 19862 | "immutable": true,
|
| 19863 | "locationInModule": {
|
| 19864 | "filename": "lib/lambda-version.ts",
|
| 19865 | "line": 57
|
| 19866 | },
|
| 19867 | "name": "description",
|
| 19868 | "optional": true,
|
| 19869 | "type": {
|
| 19870 | "primitive": "string"
|
| 19871 | }
|
| 19872 | },
|
| 19873 | {
|
| 19874 | "abstract": true,
|
| 19875 | "docs": {
|
| 19876 | "default": "No provisioned concurrency",
|
| 19877 | "stability": "stable",
|
| 19878 | "summary": "Specifies a provisioned concurrency configuration for a function's version."
|
| 19879 | },
|
| 19880 | "immutable": true,
|
| 19881 | "locationInModule": {
|
| 19882 | "filename": "lib/lambda-version.ts",
|
| 19883 | "line": 64
|
| 19884 | },
|
| 19885 | "name": "provisionedConcurrentExecutions",
|
| 19886 | "optional": true,
|
| 19887 | "type": {
|
| 19888 | "primitive": "number"
|
| 19889 | }
|
| 19890 | },
|
| 19891 | {
|
| 19892 | "abstract": true,
|
| 19893 | "docs": {
|
| 19894 | "default": "RemovalPolicy.DESTROY",
|
| 19895 | "stability": "stable",
|
| 19896 | "summary": "Whether to retain old versions of this function when a new version is created."
|
| 19897 | },
|
| 19898 | "immutable": true,
|
| 19899 | "locationInModule": {
|
| 19900 | "filename": "lib/lambda-version.ts",
|
| 19901 | "line": 72
|
| 19902 | },
|
| 19903 | "name": "removalPolicy",
|
| 19904 | "optional": true,
|
| 19905 | "type": {
|
| 19906 | "fqn": "@aws-cdk/core.RemovalPolicy"
|
| 19907 | }
|
| 19908 | }
|
| 19909 | ],
|
| 19910 | "symbolId": "lib/lambda-version:VersionOptions"
|
| 19911 | },
|
| 19912 | "@aws-cdk/aws-lambda.VersionProps": {
|
| 19913 | "assembly": "@aws-cdk/aws-lambda",
|
| 19914 | "datatype": true,
|
| 19915 | "docs": {
|
| 19916 | "stability": "stable",
|
| 19917 | "summary": "Properties for a new Lambda version.",
|
| 19918 | "example": "declare const fn: lambda.Function;\nconst version = new lambda.Version(this, 'MyVersion', {\n lambda: fn,\n});",
|
| 19919 | "custom": {
|
| 19920 | "exampleMetadata": "infused"
|
| 19921 | }
|
| 19922 | },
|
| 19923 | "fqn": "@aws-cdk/aws-lambda.VersionProps",
|
| 19924 | "interfaces": [
|
| 19925 | "@aws-cdk/aws-lambda.VersionOptions"
|
| 19926 | ],
|
| 19927 | "kind": "interface",
|
| 19928 | "locationInModule": {
|
| 19929 | "filename": "lib/lambda-version.ts",
|
| 19930 | "line": 78
|
| 19931 | },
|
| 19932 | "name": "VersionProps",
|
| 19933 | "properties": [
|
| 19934 | {
|
| 19935 | "abstract": true,
|
| 19936 | "docs": {
|
| 19937 | "stability": "stable",
|
| 19938 | "summary": "Function to get the value of."
|
| 19939 | },
|
| 19940 | "immutable": true,
|
| 19941 | "locationInModule": {
|
| 19942 | "filename": "lib/lambda-version.ts",
|
| 19943 | "line": 82
|
| 19944 | },
|
| 19945 | "name": "lambda",
|
| 19946 | "type": {
|
| 19947 | "fqn": "@aws-cdk/aws-lambda.IFunction"
|
| 19948 | }
|
| 19949 | }
|
| 19950 | ],
|
| 19951 | "symbolId": "lib/lambda-version:VersionProps"
|
| 19952 | },
|
| 19953 | "@aws-cdk/aws-lambda.VersionWeight": {
|
| 19954 | "assembly": "@aws-cdk/aws-lambda",
|
| 19955 | "datatype": true,
|
| 19956 | "docs": {
|
| 19957 | "stability": "stable",
|
| 19958 | "summary": "A version/weight pair for routing traffic to Lambda functions.",
|
| 19959 | "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as lambda from '@aws-cdk/aws-lambda';\n\ndeclare const version: lambda.Version;\nconst versionWeight: lambda.VersionWeight = {\n version: version,\n weight: 123,\n};",
|
| 19960 | "custom": {
|
| 19961 | "exampleMetadata": "fixture=_generated"
|
| 19962 | }
|
| 19963 | },
|
| 19964 | "fqn": "@aws-cdk/aws-lambda.VersionWeight",
|
| 19965 | "kind": "interface",
|
| 19966 | "locationInModule": {
|
| 19967 | "filename": "lib/alias.ts",
|
| 19968 | "line": 295
|
| 19969 | },
|
| 19970 | "name": "VersionWeight",
|
| 19971 | "properties": [
|
| 19972 | {
|
| 19973 | "abstract": true,
|
| 19974 | "docs": {
|
| 19975 | "stability": "stable",
|
| 19976 | "summary": "The version to route traffic to."
|
| 19977 | },
|
| 19978 | "immutable": true,
|
| 19979 | "locationInModule": {
|
| 19980 | "filename": "lib/alias.ts",
|
| 19981 | "line": 299
|
| 19982 | },
|
| 19983 | "name": "version",
|
| 19984 | "type": {
|
| 19985 | "fqn": "@aws-cdk/aws-lambda.IVersion"
|
| 19986 | }
|
| 19987 | },
|
| 19988 | {
|
| 19989 | "abstract": true,
|
| 19990 | "docs": {
|
| 19991 | "stability": "stable",
|
| 19992 | "summary": "How much weight to assign to this version (0..1)."
|
| 19993 | },
|
| 19994 | "immutable": true,
|
| 19995 | "locationInModule": {
|
| 19996 | "filename": "lib/alias.ts",
|
| 19997 | "line": 304
|
| 19998 | },
|
| 19999 | "name": "weight",
|
| 20000 | "type": {
|
| 20001 | "primitive": "number"
|
| 20002 | }
|
| 20003 | }
|
| 20004 | ],
|
| 20005 | "symbolId": "lib/alias:VersionWeight"
|
| 20006 | }
|
| 20007 | },
|
| 20008 | "version": "1.190.0",
|
| 20009 | "fingerprint": "**********"
|
| 20010 | } |
| \ | No newline at end of file |