| 1 | {
|
| 2 | "author": {
|
| 3 | "email": "aws-cdk-dev@amazon.com",
|
| 4 | "name": "Amazon Web Services",
|
| 5 | "organization": true,
|
| 6 | "roles": [
|
| 7 | "author"
|
| 8 | ]
|
| 9 | },
|
| 10 | "description": "A programming model for software-defined state",
|
| 11 | "docs": {
|
| 12 | "stability": "stable"
|
| 13 | },
|
| 14 | "homepage": "https://github.com/aws/constructs",
|
| 15 | "jsiiVersion": "5.4.36 (build 0893030)",
|
| 16 | "keywords": [
|
| 17 | "aws",
|
| 18 | "cdk",
|
| 19 | "constructs",
|
| 20 | "jsii"
|
| 21 | ],
|
| 22 | "license": "Apache-2.0",
|
| 23 | "metadata": {
|
| 24 | "jsii": {
|
| 25 | "pacmak": {
|
| 26 | "hasDefaultInterfaces": true
|
| 27 | }
|
| 28 | },
|
| 29 | "tscRootDir": "src"
|
| 30 | },
|
| 31 | "name": "constructs",
|
| 32 | "readme": {
|
| 33 | "markdown": "# Constructs\n\n> Software-defined persistent state\n\n[](https://github.com/aws/constructs/actions/workflows/release.yml)\n[](https://badge.fury.io/js/constructs)\n[](https://badge.fury.io/py/constructs)\n[](https://badge.fury.io/nu/Constructs)\n[](https://maven-badges.herokuapp.com/maven-central/software.constructs/constructs)\n\n## What are constructs?\n\nConstructs are classes which define a \"piece of system state\". Constructs can be composed together to form higher-level building blocks which represent more complex state.\n\nConstructs are often used to represent the _desired state_ of cloud applications. For example, in the AWS CDK, which is used to define the desired state for AWS infrastructure using CloudFormation, the lowest-level construct represents a _resource definition_ in a CloudFormation template. These resources are composed to represent higher-level logical units of a cloud application, etc.\n\n## Support policy\n\nAll [maintained Node.js versions](https://nodejs.org/en/about/previous-releases#release-schedule) are supported by this package.\n\n## Contributing\n\nThis project has adopted the [Amazon Open Source Code of\nConduct](https://aws.github.io/code-of-conduct).\n\nWe welcome community contributions and pull requests. See our [contribution\nguide](./CONTRIBUTING.md) for more information on how to report issues, set up a\ndevelopment environment and submit code.\n\n## License\n\nThis project is distributed under the [Apache License, Version 2.0](./LICENSE).\n"
|
| 34 | },
|
| 35 | "repository": {
|
| 36 | "type": "git",
|
| 37 | "url": "https://github.com/aws/constructs.git"
|
| 38 | },
|
| 39 | "schema": "jsii/0.10.0",
|
| 40 | "targets": {
|
| 41 | "dotnet": {
|
| 42 | "namespace": "Constructs",
|
| 43 | "packageId": "Constructs"
|
| 44 | },
|
| 45 | "go": {
|
| 46 | "moduleName": "github.com/aws/constructs-go"
|
| 47 | },
|
| 48 | "java": {
|
| 49 | "maven": {
|
| 50 | "artifactId": "constructs",
|
| 51 | "groupId": "software.constructs"
|
| 52 | },
|
| 53 | "package": "software.constructs"
|
| 54 | },
|
| 55 | "js": {
|
| 56 | "npm": "constructs"
|
| 57 | },
|
| 58 | "python": {
|
| 59 | "distName": "constructs",
|
| 60 | "module": "constructs"
|
| 61 | }
|
| 62 | },
|
| 63 | "types": {
|
| 64 | "constructs.Construct": {
|
| 65 | "assembly": "constructs",
|
| 66 | "docs": {
|
| 67 | "remarks": "All constructs besides the root construct must be created within the scope of\nanother construct.",
|
| 68 | "stability": "stable",
|
| 69 | "summary": "Represents the building block of the construct graph."
|
| 70 | },
|
| 71 | "fqn": "constructs.Construct",
|
| 72 | "initializer": {
|
| 73 | "docs": {
|
| 74 | "stability": "stable",
|
| 75 | "summary": "Creates a new construct node."
|
| 76 | },
|
| 77 | "locationInModule": {
|
| 78 | "filename": "src/construct.ts",
|
| 79 | "line": 481
|
| 80 | },
|
| 81 | "parameters": [
|
| 82 | {
|
| 83 | "docs": {
|
| 84 | "summary": "The scope in which to define this construct."
|
| 85 | },
|
| 86 | "name": "scope",
|
| 87 | "type": {
|
| 88 | "fqn": "constructs.Construct"
|
| 89 | }
|
| 90 | },
|
| 91 | {
|
| 92 | "docs": {
|
| 93 | "remarks": "Must be unique amongst siblings. If\nthe ID includes a path separator (`/`), then it will be replaced by double\ndash `--`.",
|
| 94 | "summary": "The scoped construct ID."
|
| 95 | },
|
| 96 | "name": "id",
|
| 97 | "type": {
|
| 98 | "primitive": "string"
|
| 99 | }
|
| 100 | }
|
| 101 | ]
|
| 102 | },
|
| 103 | "interfaces": [
|
| 104 | "constructs.IConstruct"
|
| 105 | ],
|
| 106 | "kind": "class",
|
| 107 | "locationInModule": {
|
| 108 | "filename": "src/construct.ts",
|
| 109 | "line": 443
|
| 110 | },
|
| 111 | "methods": [
|
| 112 | {
|
| 113 | "docs": {
|
| 114 | "remarks": "Use this method instead of `instanceof` to properly detect `Construct`\ninstances, even when the construct library is symlinked.\n\nExplanation: in JavaScript, multiple copies of the `constructs` library on\ndisk are seen as independent, completely different libraries. As a\nconsequence, the class `Construct` in each copy of the `constructs` library\nis seen as a different class, and an instance of one class will not test as\n`instanceof` the other class. `npm install` will not create installations\nlike this, but users may manually symlink construct libraries together or\nuse a monorepo tool: in those cases, multiple copies of the `constructs`\nlibrary can be accidentally installed, and `instanceof` will behave\nunpredictably. It is safest to avoid using `instanceof`, and using\nthis type-testing method instead.",
|
| 115 | "returns": "true if `x` is an object created from a class which extends `Construct`.",
|
| 116 | "stability": "stable",
|
| 117 | "summary": "Checks if `x` is a construct."
|
| 118 | },
|
| 119 | "locationInModule": {
|
| 120 | "filename": "src/construct.ts",
|
| 121 | "line": 464
|
| 122 | },
|
| 123 | "name": "isConstruct",
|
| 124 | "parameters": [
|
| 125 | {
|
| 126 | "docs": {
|
| 127 | "summary": "Any object."
|
| 128 | },
|
| 129 | "name": "x",
|
| 130 | "type": {
|
| 131 | "primitive": "any"
|
| 132 | }
|
| 133 | }
|
| 134 | ],
|
| 135 | "returns": {
|
| 136 | "type": {
|
| 137 | "primitive": "boolean"
|
| 138 | }
|
| 139 | },
|
| 140 | "static": true
|
| 141 | },
|
| 142 | {
|
| 143 | "docs": {
|
| 144 | "stability": "stable",
|
| 145 | "summary": "Returns a string representation of this construct."
|
| 146 | },
|
| 147 | "locationInModule": {
|
| 148 | "filename": "src/construct.ts",
|
| 149 | "line": 493
|
| 150 | },
|
| 151 | "name": "toString",
|
| 152 | "returns": {
|
| 153 | "type": {
|
| 154 | "primitive": "string"
|
| 155 | }
|
| 156 | }
|
| 157 | }
|
| 158 | ],
|
| 159 | "name": "Construct",
|
| 160 | "properties": [
|
| 161 | {
|
| 162 | "docs": {
|
| 163 | "stability": "stable",
|
| 164 | "summary": "The tree node."
|
| 165 | },
|
| 166 | "immutable": true,
|
| 167 | "locationInModule": {
|
| 168 | "filename": "src/construct.ts",
|
| 169 | "line": 471
|
| 170 | },
|
| 171 | "name": "node",
|
| 172 | "overrides": "constructs.IConstruct",
|
| 173 | "type": {
|
| 174 | "fqn": "constructs.Node"
|
| 175 | }
|
| 176 | }
|
| 177 | ],
|
| 178 | "symbolId": "src/construct:Construct"
|
| 179 | },
|
| 180 | "constructs.ConstructOrder": {
|
| 181 | "assembly": "constructs",
|
| 182 | "docs": {
|
| 183 | "stability": "stable",
|
| 184 | "summary": "In what order to return constructs."
|
| 185 | },
|
| 186 | "fqn": "constructs.ConstructOrder",
|
| 187 | "kind": "enum",
|
| 188 | "locationInModule": {
|
| 189 | "filename": "src/construct.ts",
|
| 190 | "line": 516
|
| 191 | },
|
| 192 | "members": [
|
| 193 | {
|
| 194 | "docs": {
|
| 195 | "stability": "stable",
|
| 196 | "summary": "Depth-first, pre-order."
|
| 197 | },
|
| 198 | "name": "PREORDER"
|
| 199 | },
|
| 200 | {
|
| 201 | "docs": {
|
| 202 | "stability": "stable",
|
| 203 | "summary": "Depth-first, post-order (leaf nodes first)."
|
| 204 | },
|
| 205 | "name": "POSTORDER"
|
| 206 | }
|
| 207 | ],
|
| 208 | "name": "ConstructOrder",
|
| 209 | "symbolId": "src/construct:ConstructOrder"
|
| 210 | },
|
| 211 | "constructs.Dependable": {
|
| 212 | "abstract": true,
|
| 213 | "assembly": "constructs",
|
| 214 | "docs": {
|
| 215 | "example": "// Usage\nconst roots = Dependable.of(construct).dependencyRoots;\n\n// Definition\nDependable.implement(construct, {\n dependencyRoots: [construct],\n});",
|
| 216 | "remarks": "Traits are interfaces that are privately implemented by objects. Instead of\nshowing up in the public interface of a class, they need to be queried\nexplicitly. This is used to implement certain framework features that are\nnot intended to be used by Construct consumers, and so should be hidden\nfrom accidental use.",
|
| 217 | "stability": "stable",
|
| 218 | "summary": "Trait for IDependable."
|
| 219 | },
|
| 220 | "fqn": "constructs.Dependable",
|
| 221 | "initializer": {
|
| 222 | "docs": {
|
| 223 | "stability": "stable"
|
| 224 | }
|
| 225 | },
|
| 226 | "kind": "class",
|
| 227 | "locationInModule": {
|
| 228 | "filename": "src/dependency.ts",
|
| 229 | "line": 72
|
| 230 | },
|
| 231 | "methods": [
|
| 232 | {
|
| 233 | "docs": {
|
| 234 | "deprecated": "use `of`",
|
| 235 | "stability": "deprecated",
|
| 236 | "summary": "Return the matching Dependable for the given class instance."
|
| 237 | },
|
| 238 | "locationInModule": {
|
| 239 | "filename": "src/dependency.ts",
|
| 240 | "line": 98
|
| 241 | },
|
| 242 | "name": "get",
|
| 243 | "parameters": [
|
| 244 | {
|
| 245 | "name": "instance",
|
| 246 | "type": {
|
| 247 | "fqn": "constructs.IDependable"
|
| 248 | }
|
| 249 | }
|
| 250 | ],
|
| 251 | "returns": {
|
| 252 | "type": {
|
| 253 | "fqn": "constructs.Dependable"
|
| 254 | }
|
| 255 | },
|
| 256 | "static": true
|
| 257 | },
|
| 258 | {
|
| 259 | "docs": {
|
| 260 | "stability": "stable",
|
| 261 | "summary": "Turn any object into an IDependable."
|
| 262 | },
|
| 263 | "locationInModule": {
|
| 264 | "filename": "src/dependency.ts",
|
| 265 | "line": 76
|
| 266 | },
|
| 267 | "name": "implement",
|
| 268 | "parameters": [
|
| 269 | {
|
| 270 | "name": "instance",
|
| 271 | "type": {
|
| 272 | "fqn": "constructs.IDependable"
|
| 273 | }
|
| 274 | },
|
| 275 | {
|
| 276 | "name": "trait",
|
| 277 | "type": {
|
| 278 | "fqn": "constructs.Dependable"
|
| 279 | }
|
| 280 | }
|
| 281 | ],
|
| 282 | "static": true
|
| 283 | },
|
| 284 | {
|
| 285 | "docs": {
|
| 286 | "stability": "stable",
|
| 287 | "summary": "Return the matching Dependable for the given class instance."
|
| 288 | },
|
| 289 | "locationInModule": {
|
| 290 | "filename": "src/dependency.ts",
|
| 291 | "line": 86
|
| 292 | },
|
| 293 | "name": "of",
|
| 294 | "parameters": [
|
| 295 | {
|
| 296 | "name": "instance",
|
| 297 | "type": {
|
| 298 | "fqn": "constructs.IDependable"
|
| 299 | }
|
| 300 | }
|
| 301 | ],
|
| 302 | "returns": {
|
| 303 | "type": {
|
| 304 | "fqn": "constructs.Dependable"
|
| 305 | }
|
| 306 | },
|
| 307 | "static": true
|
| 308 | }
|
| 309 | ],
|
| 310 | "name": "Dependable",
|
| 311 | "properties": [
|
| 312 | {
|
| 313 | "abstract": true,
|
| 314 | "docs": {
|
| 315 | "remarks": "All resources under all returned constructs are included in the ordering\ndependency.",
|
| 316 | "stability": "stable",
|
| 317 | "summary": "The set of constructs that form the root of this dependable."
|
| 318 | },
|
| 319 | "immutable": true,
|
| 320 | "locationInModule": {
|
| 321 | "filename": "src/dependency.ts",
|
| 322 | "line": 108
|
| 323 | },
|
| 324 | "name": "dependencyRoots",
|
| 325 | "type": {
|
| 326 | "collection": {
|
| 327 | "elementtype": {
|
| 328 | "fqn": "constructs.IConstruct"
|
| 329 | },
|
| 330 | "kind": "array"
|
| 331 | }
|
| 332 | }
|
| 333 | }
|
| 334 | ],
|
| 335 | "symbolId": "src/dependency:Dependable"
|
| 336 | },
|
| 337 | "constructs.DependencyGroup": {
|
| 338 | "assembly": "constructs",
|
| 339 | "docs": {
|
| 340 | "remarks": "This class can be used when a set of constructs which are disjoint in the\nconstruct tree needs to be combined to be used as a single dependable.",
|
| 341 | "stability": "stable",
|
| 342 | "summary": "A set of constructs to be used as a dependable."
|
| 343 | },
|
| 344 | "fqn": "constructs.DependencyGroup",
|
| 345 | "initializer": {
|
| 346 | "docs": {
|
| 347 | "stability": "stable"
|
| 348 | },
|
| 349 | "locationInModule": {
|
| 350 | "filename": "src/dependency.ts",
|
| 351 | "line": 27
|
| 352 | },
|
| 353 | "parameters": [
|
| 354 | {
|
| 355 | "name": "deps",
|
| 356 | "type": {
|
| 357 | "fqn": "constructs.IDependable"
|
| 358 | },
|
| 359 | "variadic": true
|
| 360 | }
|
| 361 | ],
|
| 362 | "variadic": true
|
| 363 | },
|
| 364 | "interfaces": [
|
| 365 | "constructs.IDependable"
|
| 366 | ],
|
| 367 | "kind": "class",
|
| 368 | "locationInModule": {
|
| 369 | "filename": "src/dependency.ts",
|
| 370 | "line": 24
|
| 371 | },
|
| 372 | "methods": [
|
| 373 | {
|
| 374 | "docs": {
|
| 375 | "stability": "stable",
|
| 376 | "summary": "Add a construct to the dependency roots."
|
| 377 | },
|
| 378 | "locationInModule": {
|
| 379 | "filename": "src/dependency.ts",
|
| 380 | "line": 46
|
| 381 | },
|
| 382 | "name": "add",
|
| 383 | "parameters": [
|
| 384 | {
|
| 385 | "name": "scopes",
|
| 386 | "type": {
|
| 387 | "fqn": "constructs.IDependable"
|
| 388 | },
|
| 389 | "variadic": true
|
| 390 | }
|
| 391 | ],
|
| 392 | "variadic": true
|
| 393 | }
|
| 394 | ],
|
| 395 | "name": "DependencyGroup",
|
| 396 | "symbolId": "src/dependency:DependencyGroup"
|
| 397 | },
|
| 398 | "constructs.IConstruct": {
|
| 399 | "assembly": "constructs",
|
| 400 | "docs": {
|
| 401 | "stability": "stable",
|
| 402 | "summary": "Represents a construct."
|
| 403 | },
|
| 404 | "fqn": "constructs.IConstruct",
|
| 405 | "interfaces": [
|
| 406 | "constructs.IDependable"
|
| 407 | ],
|
| 408 | "kind": "interface",
|
| 409 | "locationInModule": {
|
| 410 | "filename": "src/construct.ts",
|
| 411 | "line": 11
|
| 412 | },
|
| 413 | "name": "IConstruct",
|
| 414 | "properties": [
|
| 415 | {
|
| 416 | "abstract": true,
|
| 417 | "docs": {
|
| 418 | "stability": "stable",
|
| 419 | "summary": "The tree node."
|
| 420 | },
|
| 421 | "immutable": true,
|
| 422 | "locationInModule": {
|
| 423 | "filename": "src/construct.ts",
|
| 424 | "line": 15
|
| 425 | },
|
| 426 | "name": "node",
|
| 427 | "type": {
|
| 428 | "fqn": "constructs.Node"
|
| 429 | }
|
| 430 | }
|
| 431 | ],
|
| 432 | "symbolId": "src/construct:IConstruct"
|
| 433 | },
|
| 434 | "constructs.IDependable": {
|
| 435 | "assembly": "constructs",
|
| 436 | "docs": {
|
| 437 | "remarks": "The presence of this interface indicates that an object has\nan `IDependable` implementation.\n\nThis interface can be used to take an (ordering) dependency on a set of\nconstructs. An ordering dependency implies that the resources represented by\nthose constructs are deployed before the resources depending ON them are\ndeployed.",
|
| 438 | "stability": "stable",
|
| 439 | "summary": "Trait marker for classes that can be depended upon."
|
| 440 | },
|
| 441 | "fqn": "constructs.IDependable",
|
| 442 | "kind": "interface",
|
| 443 | "locationInModule": {
|
| 444 | "filename": "src/dependency.ts",
|
| 445 | "line": 14
|
| 446 | },
|
| 447 | "name": "IDependable",
|
| 448 | "symbolId": "src/dependency:IDependable"
|
| 449 | },
|
| 450 | "constructs.IValidation": {
|
| 451 | "assembly": "constructs",
|
| 452 | "docs": {
|
| 453 | "stability": "stable",
|
| 454 | "summary": "Implement this interface in order for the construct to be able to validate itself."
|
| 455 | },
|
| 456 | "fqn": "constructs.IValidation",
|
| 457 | "kind": "interface",
|
| 458 | "locationInModule": {
|
| 459 | "filename": "src/construct.ts",
|
| 460 | "line": 501
|
| 461 | },
|
| 462 | "methods": [
|
| 463 | {
|
| 464 | "abstract": true,
|
| 465 | "docs": {
|
| 466 | "remarks": "This method can be implemented by derived constructs in order to perform\nvalidation logic. It is called on all constructs before synthesis.",
|
| 467 | "returns": "An array of validation error messages, or an empty array if there the construct is valid.",
|
| 468 | "stability": "stable",
|
| 469 | "summary": "Validate the current construct."
|
| 470 | },
|
| 471 | "locationInModule": {
|
| 472 | "filename": "src/construct.ts",
|
| 473 | "line": 510
|
| 474 | },
|
| 475 | "name": "validate",
|
| 476 | "returns": {
|
| 477 | "type": {
|
| 478 | "collection": {
|
| 479 | "elementtype": {
|
| 480 | "primitive": "string"
|
| 481 | },
|
| 482 | "kind": "array"
|
| 483 | }
|
| 484 | }
|
| 485 | }
|
| 486 | }
|
| 487 | ],
|
| 488 | "name": "IValidation",
|
| 489 | "symbolId": "src/construct:IValidation"
|
| 490 | },
|
| 491 | "constructs.MetadataEntry": {
|
| 492 | "assembly": "constructs",
|
| 493 | "datatype": true,
|
| 494 | "docs": {
|
| 495 | "stability": "stable",
|
| 496 | "summary": "An entry in the construct metadata table."
|
| 497 | },
|
| 498 | "fqn": "constructs.MetadataEntry",
|
| 499 | "kind": "interface",
|
| 500 | "locationInModule": {
|
| 501 | "filename": "src/metadata.ts",
|
| 502 | "line": 4
|
| 503 | },
|
| 504 | "name": "MetadataEntry",
|
| 505 | "properties": [
|
| 506 | {
|
| 507 | "abstract": true,
|
| 508 | "docs": {
|
| 509 | "stability": "stable",
|
| 510 | "summary": "The data."
|
| 511 | },
|
| 512 | "immutable": true,
|
| 513 | "locationInModule": {
|
| 514 | "filename": "src/metadata.ts",
|
| 515 | "line": 13
|
| 516 | },
|
| 517 | "name": "data",
|
| 518 | "type": {
|
| 519 | "primitive": "any"
|
| 520 | }
|
| 521 | },
|
| 522 | {
|
| 523 | "abstract": true,
|
| 524 | "docs": {
|
| 525 | "stability": "stable",
|
| 526 | "summary": "The metadata entry type."
|
| 527 | },
|
| 528 | "immutable": true,
|
| 529 | "locationInModule": {
|
| 530 | "filename": "src/metadata.ts",
|
| 531 | "line": 8
|
| 532 | },
|
| 533 | "name": "type",
|
| 534 | "type": {
|
| 535 | "primitive": "string"
|
| 536 | }
|
| 537 | },
|
| 538 | {
|
| 539 | "abstract": true,
|
| 540 | "docs": {
|
| 541 | "default": "- no trace information",
|
| 542 | "remarks": "Only available if `addMetadata()` is called with `stackTrace: true`.",
|
| 543 | "stability": "stable",
|
| 544 | "summary": "Stack trace at the point of adding the metadata."
|
| 545 | },
|
| 546 | "immutable": true,
|
| 547 | "locationInModule": {
|
| 548 | "filename": "src/metadata.ts",
|
| 549 | "line": 22
|
| 550 | },
|
| 551 | "name": "trace",
|
| 552 | "optional": true,
|
| 553 | "type": {
|
| 554 | "collection": {
|
| 555 | "elementtype": {
|
| 556 | "primitive": "string"
|
| 557 | },
|
| 558 | "kind": "array"
|
| 559 | }
|
| 560 | }
|
| 561 | }
|
| 562 | ],
|
| 563 | "symbolId": "src/metadata:MetadataEntry"
|
| 564 | },
|
| 565 | "constructs.MetadataOptions": {
|
| 566 | "assembly": "constructs",
|
| 567 | "datatype": true,
|
| 568 | "docs": {
|
| 569 | "stability": "stable",
|
| 570 | "summary": "Options for `construct.addMetadata()`."
|
| 571 | },
|
| 572 | "fqn": "constructs.MetadataOptions",
|
| 573 | "kind": "interface",
|
| 574 | "locationInModule": {
|
| 575 | "filename": "src/construct.ts",
|
| 576 | "line": 541
|
| 577 | },
|
| 578 | "name": "MetadataOptions",
|
| 579 | "properties": [
|
| 580 | {
|
| 581 | "abstract": true,
|
| 582 | "docs": {
|
| 583 | "default": "false",
|
| 584 | "stability": "stable",
|
| 585 | "summary": "Include stack trace with metadata entry."
|
| 586 | },
|
| 587 | "immutable": true,
|
| 588 | "locationInModule": {
|
| 589 | "filename": "src/construct.ts",
|
| 590 | "line": 546
|
| 591 | },
|
| 592 | "name": "stackTrace",
|
| 593 | "optional": true,
|
| 594 | "type": {
|
| 595 | "primitive": "boolean"
|
| 596 | }
|
| 597 | },
|
| 598 | {
|
| 599 | "abstract": true,
|
| 600 | "docs": {
|
| 601 | "default": "addMetadata()",
|
| 602 | "remarks": "This option is ignored unless `stackTrace` is `true`.",
|
| 603 | "stability": "stable",
|
| 604 | "summary": "A JavaScript function to begin tracing from."
|
| 605 | },
|
| 606 | "immutable": true,
|
| 607 | "locationInModule": {
|
| 608 | "filename": "src/construct.ts",
|
| 609 | "line": 555
|
| 610 | },
|
| 611 | "name": "traceFromFunction",
|
| 612 | "optional": true,
|
| 613 | "type": {
|
| 614 | "primitive": "any"
|
| 615 | }
|
| 616 | }
|
| 617 | ],
|
| 618 | "symbolId": "src/construct:MetadataOptions"
|
| 619 | },
|
| 620 | "constructs.Node": {
|
| 621 | "assembly": "constructs",
|
| 622 | "docs": {
|
| 623 | "stability": "stable",
|
| 624 | "summary": "Represents the construct node in the scope tree."
|
| 625 | },
|
| 626 | "fqn": "constructs.Node",
|
| 627 | "initializer": {
|
| 628 | "docs": {
|
| 629 | "stability": "stable"
|
| 630 | },
|
| 631 | "locationInModule": {
|
| 632 | "filename": "src/construct.ts",
|
| 633 | "line": 60
|
| 634 | },
|
| 635 | "parameters": [
|
| 636 | {
|
| 637 | "name": "host",
|
| 638 | "type": {
|
| 639 | "fqn": "constructs.Construct"
|
| 640 | }
|
| 641 | },
|
| 642 | {
|
| 643 | "name": "scope",
|
| 644 | "type": {
|
| 645 | "fqn": "constructs.IConstruct"
|
| 646 | }
|
| 647 | },
|
| 648 | {
|
| 649 | "name": "id",
|
| 650 | "type": {
|
| 651 | "primitive": "string"
|
| 652 | }
|
| 653 | }
|
| 654 | ]
|
| 655 | },
|
| 656 | "kind": "class",
|
| 657 | "locationInModule": {
|
| 658 | "filename": "src/construct.ts",
|
| 659 | "line": 21
|
| 660 | },
|
| 661 | "methods": [
|
| 662 | {
|
| 663 | "docs": {
|
| 664 | "deprecated": "use `construct.node` instead",
|
| 665 | "stability": "deprecated",
|
| 666 | "summary": "Returns the node associated with a construct."
|
| 667 | },
|
| 668 | "locationInModule": {
|
| 669 | "filename": "src/construct.ts",
|
| 670 | "line": 33
|
| 671 | },
|
| 672 | "name": "of",
|
| 673 | "parameters": [
|
| 674 | {
|
| 675 | "docs": {
|
| 676 | "summary": "the construct."
|
| 677 | },
|
| 678 | "name": "construct",
|
| 679 | "type": {
|
| 680 | "fqn": "constructs.IConstruct"
|
| 681 | }
|
| 682 | }
|
| 683 | ],
|
| 684 | "returns": {
|
| 685 | "type": {
|
| 686 | "fqn": "constructs.Node"
|
| 687 | }
|
| 688 | },
|
| 689 | "static": true
|
| 690 | },
|
| 691 | {
|
| 692 | "docs": {
|
| 693 | "remarks": "An `IDependable`",
|
| 694 | "stability": "stable",
|
| 695 | "summary": "Add an ordering dependency on another construct."
|
| 696 | },
|
| 697 | "locationInModule": {
|
| 698 | "filename": "src/construct.ts",
|
| 699 | "line": 345
|
| 700 | },
|
| 701 | "name": "addDependency",
|
| 702 | "parameters": [
|
| 703 | {
|
| 704 | "name": "deps",
|
| 705 | "type": {
|
| 706 | "fqn": "constructs.IDependable"
|
| 707 | },
|
| 708 | "variadic": true
|
| 709 | }
|
| 710 | ],
|
| 711 | "variadic": true
|
| 712 | },
|
| 713 | {
|
| 714 | "docs": {
|
| 715 | "remarks": "Entries are arbitrary values and will also include a stack trace to allow tracing back to\nthe code location for when the entry was added. It can be used, for example, to include source\nmapping in CloudFormation templates to improve diagnostics.\nNote that construct metadata is not the same as CloudFormation resource metadata and is never written to the CloudFormation template.\nThe metadata entries are written to the Cloud Assembly Manifest if the `treeMetadata` property is specified in the props of the App that contains this Construct.",
|
| 716 | "stability": "stable",
|
| 717 | "summary": "Adds a metadata entry to this construct."
|
| 718 | },
|
| 719 | "locationInModule": {
|
| 720 | "filename": "src/construct.ts",
|
| 721 | "line": 287
|
| 722 | },
|
| 723 | "name": "addMetadata",
|
| 724 | "parameters": [
|
| 725 | {
|
| 726 | "docs": {
|
| 727 | "summary": "a string denoting the type of metadata."
|
| 728 | },
|
| 729 | "name": "type",
|
| 730 | "type": {
|
| 731 | "primitive": "string"
|
| 732 | }
|
| 733 | },
|
| 734 | {
|
| 735 | "docs": {
|
| 736 | "remarks": "If null/undefined, metadata will not be added.",
|
| 737 | "summary": "the value of the metadata (can be a Token)."
|
| 738 | },
|
| 739 | "name": "data",
|
| 740 | "type": {
|
| 741 | "primitive": "any"
|
| 742 | }
|
| 743 | },
|
| 744 | {
|
| 745 | "docs": {
|
| 746 | "summary": "options."
|
| 747 | },
|
| 748 | "name": "options",
|
| 749 | "optional": true,
|
| 750 | "type": {
|
| 751 | "fqn": "constructs.MetadataOptions"
|
| 752 | }
|
| 753 | }
|
| 754 | ]
|
| 755 | },
|
| 756 | {
|
| 757 | "docs": {
|
| 758 | "remarks": "When `node.validate()` is called, the `validate()` method will be called on\nall validations and all errors will be returned.",
|
| 759 | "stability": "stable",
|
| 760 | "summary": "Adds a validation to this construct."
|
| 761 | },
|
| 762 | "locationInModule": {
|
| 763 | "filename": "src/construct.ts",
|
| 764 | "line": 384
|
| 765 | },
|
| 766 | "name": "addValidation",
|
| 767 | "parameters": [
|
| 768 | {
|
| 769 | "docs": {
|
| 770 | "summary": "The validation object."
|
| 771 | },
|
| 772 | "name": "validation",
|
| 773 | "type": {
|
| 774 | "fqn": "constructs.IValidation"
|
| 775 | }
|
| 776 | }
|
| 777 | ]
|
| 778 | },
|
| 779 | {
|
| 780 | "docs": {
|
| 781 | "stability": "stable",
|
| 782 | "summary": "Return this construct and all of its children in the given order."
|
| 783 | },
|
| 784 | "locationInModule": {
|
| 785 | "filename": "src/construct.ts",
|
| 786 | "line": 184
|
| 787 | },
|
| 788 | "name": "findAll",
|
| 789 | "parameters": [
|
| 790 | {
|
| 791 | "name": "order",
|
| 792 | "optional": true,
|
| 793 | "type": {
|
| 794 | "fqn": "constructs.ConstructOrder"
|
| 795 | }
|
| 796 | }
|
| 797 | ],
|
| 798 | "returns": {
|
| 799 | "type": {
|
| 800 | "collection": {
|
| 801 | "elementtype": {
|
| 802 | "fqn": "constructs.IConstruct"
|
| 803 | },
|
| 804 | "kind": "array"
|
| 805 | }
|
| 806 | }
|
| 807 | }
|
| 808 | },
|
| 809 | {
|
| 810 | "docs": {
|
| 811 | "remarks": "Throws an error if the child is not found.",
|
| 812 | "returns": "Child with the given id.",
|
| 813 | "stability": "stable",
|
| 814 | "summary": "Return a direct child by id."
|
| 815 | },
|
| 816 | "locationInModule": {
|
| 817 | "filename": "src/construct.ts",
|
| 818 | "line": 130
|
| 819 | },
|
| 820 | "name": "findChild",
|
| 821 | "parameters": [
|
| 822 | {
|
| 823 | "docs": {
|
| 824 | "summary": "Identifier of direct child."
|
| 825 | },
|
| 826 | "name": "id",
|
| 827 | "type": {
|
| 828 | "primitive": "string"
|
| 829 | }
|
| 830 | }
|
| 831 | ],
|
| 832 | "returns": {
|
| 833 | "type": {
|
| 834 | "fqn": "constructs.IConstruct"
|
| 835 | }
|
| 836 | }
|
| 837 | },
|
| 838 | {
|
| 839 | "docs": {
|
| 840 | "remarks": "Context is usually initialized at the root, but can be overridden at any point in the tree.",
|
| 841 | "returns": "The context object or an empty object if there is discovered context",
|
| 842 | "stability": "stable",
|
| 843 | "summary": "Retrieves the all context of a node from tree context."
|
| 844 | },
|
| 845 | "locationInModule": {
|
| 846 | "filename": "src/construct.ts",
|
| 847 | "line": 247
|
| 848 | },
|
| 849 | "name": "getAllContext",
|
| 850 | "parameters": [
|
| 851 | {
|
| 852 | "docs": {
|
| 853 | "summary": "Any keys to override the retrieved context."
|
| 854 | },
|
| 855 | "name": "defaults",
|
| 856 | "optional": true,
|
| 857 | "type": {
|
| 858 | "primitive": "json"
|
| 859 | }
|
| 860 | }
|
| 861 | ],
|
| 862 | "returns": {
|
| 863 | "type": {
|
| 864 | "primitive": "any"
|
| 865 | }
|
| 866 | }
|
| 867 | },
|
| 868 | {
|
| 869 | "docs": {
|
| 870 | "remarks": "Context is usually initialized at the root, but can be overridden at any point in the tree.",
|
| 871 | "returns": "The context value or throws error if there is no context value for this key",
|
| 872 | "stability": "stable",
|
| 873 | "summary": "Retrieves a value from tree context if present. Otherwise, would throw an error."
|
| 874 | },
|
| 875 | "locationInModule": {
|
| 876 | "filename": "src/construct.ts",
|
| 877 | "line": 227
|
| 878 | },
|
| 879 | "name": "getContext",
|
| 880 | "parameters": [
|
| 881 | {
|
| 882 | "docs": {
|
| 883 | "summary": "The context key."
|
| 884 | },
|
| 885 | "name": "key",
|
| 886 | "type": {
|
| 887 | "primitive": "string"
|
| 888 | }
|
| 889 | }
|
| 890 | ],
|
| 891 | "returns": {
|
| 892 | "type": {
|
| 893 | "primitive": "any"
|
| 894 | }
|
| 895 | }
|
| 896 | },
|
| 897 | {
|
| 898 | "docs": {
|
| 899 | "remarks": "After this\ncall, no more children can be added to this construct or to any children.",
|
| 900 | "stability": "stable",
|
| 901 | "summary": "Locks this construct from allowing more children to be added."
|
| 902 | },
|
| 903 | "locationInModule": {
|
| 904 | "filename": "src/construct.ts",
|
| 905 | "line": 405
|
| 906 | },
|
| 907 | "name": "lock"
|
| 908 | },
|
| 909 | {
|
| 910 | "docs": {
|
| 911 | "remarks": "Context must be set before any children are added, since children may consult context info during construction.\nIf the key already exists, it will be overridden.",
|
| 912 | "stability": "stable",
|
| 913 | "summary": "This can be used to set contextual values."
|
| 914 | },
|
| 915 | "locationInModule": {
|
| 916 | "filename": "src/construct.ts",
|
| 917 | "line": 211
|
| 918 | },
|
| 919 | "name": "setContext",
|
| 920 | "parameters": [
|
| 921 | {
|
| 922 | "docs": {
|
| 923 | "summary": "The context key."
|
| 924 | },
|
| 925 | "name": "key",
|
| 926 | "type": {
|
| 927 | "primitive": "string"
|
| 928 | }
|
| 929 | },
|
| 930 | {
|
| 931 | "docs": {
|
| 932 | "summary": "The context value."
|
| 933 | },
|
| 934 | "name": "value",
|
| 935 | "type": {
|
| 936 | "primitive": "any"
|
| 937 | }
|
| 938 | }
|
| 939 | ]
|
| 940 | },
|
| 941 | {
|
| 942 | "docs": {
|
| 943 | "returns": "the child if found, or undefined",
|
| 944 | "stability": "stable",
|
| 945 | "summary": "Return a direct child by id, or undefined."
|
| 946 | },
|
| 947 | "locationInModule": {
|
| 948 | "filename": "src/construct.ts",
|
| 949 | "line": 118
|
| 950 | },
|
| 951 | "name": "tryFindChild",
|
| 952 | "parameters": [
|
| 953 | {
|
| 954 | "docs": {
|
| 955 | "summary": "Identifier of direct child."
|
| 956 | },
|
| 957 | "name": "id",
|
| 958 | "type": {
|
| 959 | "primitive": "string"
|
| 960 | }
|
| 961 | }
|
| 962 | ],
|
| 963 | "returns": {
|
| 964 | "optional": true,
|
| 965 | "type": {
|
| 966 | "fqn": "constructs.IConstruct"
|
| 967 | }
|
| 968 | }
|
| 969 | },
|
| 970 | {
|
| 971 | "docs": {
|
| 972 | "remarks": "Context is usually initialized at the root, but can be overridden at any point in the tree.",
|
| 973 | "returns": "The context value or `undefined` if there is no context value for this key.",
|
| 974 | "stability": "stable",
|
| 975 | "summary": "Retrieves a value from tree context."
|
| 976 | },
|
| 977 | "locationInModule": {
|
| 978 | "filename": "src/construct.ts",
|
| 979 | "line": 260
|
| 980 | },
|
| 981 | "name": "tryGetContext",
|
| 982 | "parameters": [
|
| 983 | {
|
| 984 | "docs": {
|
| 985 | "summary": "The context key."
|
| 986 | },
|
| 987 | "name": "key",
|
| 988 | "type": {
|
| 989 | "primitive": "string"
|
| 990 | }
|
| 991 | }
|
| 992 | ],
|
| 993 | "returns": {
|
| 994 | "type": {
|
| 995 | "primitive": "any"
|
| 996 | }
|
| 997 | }
|
| 998 | },
|
| 999 | {
|
| 1000 | "docs": {
|
| 1001 | "returns": "Whether a child with the given name was deleted.",
|
| 1002 | "stability": "stable",
|
| 1003 | "summary": "Remove the child with the given name, if present."
|
| 1004 | },
|
| 1005 | "locationInModule": {
|
| 1006 | "filename": "src/construct.ts",
|
| 1007 | "line": 370
|
| 1008 | },
|
| 1009 | "name": "tryRemoveChild",
|
| 1010 | "parameters": [
|
| 1011 | {
|
| 1012 | "name": "childName",
|
| 1013 | "type": {
|
| 1014 | "primitive": "string"
|
| 1015 | }
|
| 1016 | }
|
| 1017 | ],
|
| 1018 | "returns": {
|
| 1019 | "type": {
|
| 1020 | "primitive": "boolean"
|
| 1021 | }
|
| 1022 | }
|
| 1023 | },
|
| 1024 | {
|
| 1025 | "docs": {
|
| 1026 | "remarks": "Invokes the `validate()` method on all validations added through\n`addValidation()`.",
|
| 1027 | "returns": "an array of validation error messages associated with this\nconstruct.",
|
| 1028 | "stability": "stable",
|
| 1029 | "summary": "Validates this construct."
|
| 1030 | },
|
| 1031 | "locationInModule": {
|
| 1032 | "filename": "src/construct.ts",
|
| 1033 | "line": 397
|
| 1034 | },
|
| 1035 | "name": "validate",
|
| 1036 | "returns": {
|
| 1037 | "type": {
|
| 1038 | "collection": {
|
| 1039 | "elementtype": {
|
| 1040 | "primitive": "string"
|
| 1041 | },
|
| 1042 | "kind": "array"
|
| 1043 | }
|
| 1044 | }
|
| 1045 | }
|
| 1046 | }
|
| 1047 | ],
|
| 1048 | "name": "Node",
|
| 1049 | "properties": [
|
| 1050 | {
|
| 1051 | "const": true,
|
| 1052 | "docs": {
|
| 1053 | "stability": "stable",
|
| 1054 | "summary": "Separator used to delimit construct path components."
|
| 1055 | },
|
| 1056 | "immutable": true,
|
| 1057 | "locationInModule": {
|
| 1058 | "filename": "src/construct.ts",
|
| 1059 | "line": 25
|
| 1060 | },
|
| 1061 | "name": "PATH_SEP",
|
| 1062 | "static": true,
|
| 1063 | "type": {
|
| 1064 | "primitive": "string"
|
| 1065 | }
|
| 1066 | },
|
| 1067 | {
|
| 1068 | "docs": {
|
| 1069 | "example": "c83a2846e506bcc5f10682b564084bca2d275709ee",
|
| 1070 | "remarks": "Addresses are 42 characters hexadecimal strings. They begin with \"c8\"\nfollowed by 40 lowercase hexadecimal characters (0-9a-f).\n\nAddresses are calculated using a SHA-1 of the components of the construct\npath.\n\nTo enable refactoring of construct trees, constructs with the ID `Default`\nwill be excluded from the calculation. In those cases constructs in the\nsame tree may have the same address.",
|
| 1071 | "stability": "stable",
|
| 1072 | "summary": "Returns an opaque tree-unique address for this construct."
|
| 1073 | },
|
| 1074 | "immutable": true,
|
| 1075 | "locationInModule": {
|
| 1076 | "filename": "src/construct.ts",
|
| 1077 | "line": 104
|
| 1078 | },
|
| 1079 | "name": "addr",
|
| 1080 | "type": {
|
| 1081 | "primitive": "string"
|
| 1082 | }
|
| 1083 | },
|
| 1084 | {
|
| 1085 | "docs": {
|
| 1086 | "stability": "stable",
|
| 1087 | "summary": "All direct children of this construct."
|
| 1088 | },
|
| 1089 | "immutable": true,
|
| 1090 | "locationInModule": {
|
| 1091 | "filename": "src/construct.ts",
|
| 1092 | "line": 177
|
| 1093 | },
|
| 1094 | "name": "children",
|
| 1095 | "type": {
|
| 1096 | "collection": {
|
| 1097 | "elementtype": {
|
| 1098 | "fqn": "constructs.IConstruct"
|
| 1099 | },
|
| 1100 | "kind": "array"
|
| 1101 | }
|
| 1102 | }
|
| 1103 | },
|
| 1104 | {
|
| 1105 | "docs": {
|
| 1106 | "stability": "stable",
|
| 1107 | "summary": "Return all dependencies registered on this node (non-recursive)."
|
| 1108 | },
|
| 1109 | "immutable": true,
|
| 1110 | "locationInModule": {
|
| 1111 | "filename": "src/construct.ts",
|
| 1112 | "line": 354
|
| 1113 | },
|
| 1114 | "name": "dependencies",
|
| 1115 | "type": {
|
| 1116 | "collection": {
|
| 1117 | "elementtype": {
|
| 1118 | "fqn": "constructs.IConstruct"
|
| 1119 | },
|
| 1120 | "kind": "array"
|
| 1121 | }
|
| 1122 | }
|
| 1123 | },
|
| 1124 | {
|
| 1125 | "docs": {
|
| 1126 | "remarks": "This is a scope-unique id. To obtain an app-unique id for this construct, use `addr`.",
|
| 1127 | "stability": "stable",
|
| 1128 | "summary": "The id of this construct within the current scope."
|
| 1129 | },
|
| 1130 | "immutable": true,
|
| 1131 | "locationInModule": {
|
| 1132 | "filename": "src/construct.ts",
|
| 1133 | "line": 49
|
| 1134 | },
|
| 1135 | "name": "id",
|
| 1136 | "type": {
|
| 1137 | "primitive": "string"
|
| 1138 | }
|
| 1139 | },
|
| 1140 | {
|
| 1141 | "docs": {
|
| 1142 | "stability": "stable",
|
| 1143 | "summary": "Returns true if this construct or the scopes in which it is defined are locked."
|
| 1144 | },
|
| 1145 | "immutable": true,
|
| 1146 | "locationInModule": {
|
| 1147 | "filename": "src/construct.ts",
|
| 1148 | "line": 328
|
| 1149 | },
|
| 1150 | "name": "locked",
|
| 1151 | "type": {
|
| 1152 | "primitive": "boolean"
|
| 1153 | }
|
| 1154 | },
|
| 1155 | {
|
| 1156 | "docs": {
|
| 1157 | "remarks": "This can be used, for example, to implement support for deprecation notices, source mapping, etc.",
|
| 1158 | "stability": "stable",
|
| 1159 | "summary": "An immutable array of metadata objects associated with this construct."
|
| 1160 | },
|
| 1161 | "immutable": true,
|
| 1162 | "locationInModule": {
|
| 1163 | "filename": "src/construct.ts",
|
| 1164 | "line": 271
|
| 1165 | },
|
| 1166 | "name": "metadata",
|
| 1167 | "type": {
|
| 1168 | "collection": {
|
| 1169 | "elementtype": {
|
| 1170 | "fqn": "constructs.MetadataEntry"
|
| 1171 | },
|
| 1172 | "kind": "array"
|
| 1173 | }
|
| 1174 | }
|
| 1175 | },
|
| 1176 | {
|
| 1177 | "docs": {
|
| 1178 | "remarks": "Components are separated by '/'.",
|
| 1179 | "stability": "stable",
|
| 1180 | "summary": "The full, absolute path of this construct in the tree."
|
| 1181 | },
|
| 1182 | "immutable": true,
|
| 1183 | "locationInModule": {
|
| 1184 | "filename": "src/construct.ts",
|
| 1185 | "line": 79
|
| 1186 | },
|
| 1187 | "name": "path",
|
| 1188 | "type": {
|
| 1189 | "primitive": "string"
|
| 1190 | }
|
| 1191 | },
|
| 1192 | {
|
| 1193 | "docs": {
|
| 1194 | "returns": "The root of the construct tree.",
|
| 1195 | "stability": "stable",
|
| 1196 | "summary": "Returns the root of the construct tree."
|
| 1197 | },
|
| 1198 | "immutable": true,
|
| 1199 | "locationInModule": {
|
| 1200 | "filename": "src/construct.ts",
|
| 1201 | "line": 320
|
| 1202 | },
|
| 1203 | "name": "root",
|
| 1204 | "type": {
|
| 1205 | "fqn": "constructs.IConstruct"
|
| 1206 | }
|
| 1207 | },
|
| 1208 | {
|
| 1209 | "docs": {
|
| 1210 | "returns": "a list of parent scopes. The last element in the list will always\nbe the current construct and the first element will be the root of the\ntree.",
|
| 1211 | "stability": "stable",
|
| 1212 | "summary": "All parent scopes of this construct."
|
| 1213 | },
|
| 1214 | "immutable": true,
|
| 1215 | "locationInModule": {
|
| 1216 | "filename": "src/construct.ts",
|
| 1217 | "line": 304
|
| 1218 | },
|
| 1219 | "name": "scopes",
|
| 1220 | "type": {
|
| 1221 | "collection": {
|
| 1222 | "elementtype": {
|
| 1223 | "fqn": "constructs.IConstruct"
|
| 1224 | },
|
| 1225 | "kind": "array"
|
| 1226 | }
|
| 1227 | }
|
| 1228 | },
|
| 1229 | {
|
| 1230 | "docs": {
|
| 1231 | "remarks": "The value is `undefined` at the root of the construct scope tree.",
|
| 1232 | "stability": "stable",
|
| 1233 | "summary": "Returns the scope in which this construct is defined."
|
| 1234 | },
|
| 1235 | "immutable": true,
|
| 1236 | "locationInModule": {
|
| 1237 | "filename": "src/construct.ts",
|
| 1238 | "line": 42
|
| 1239 | },
|
| 1240 | "name": "scope",
|
| 1241 | "optional": true,
|
| 1242 | "type": {
|
| 1243 | "fqn": "constructs.IConstruct"
|
| 1244 | }
|
| 1245 | },
|
| 1246 | {
|
| 1247 | "docs": {
|
| 1248 | "custom": {
|
| 1249 | "throws": "if there is more than one child"
|
| 1250 | },
|
| 1251 | "remarks": "This is usually the construct that provides the bulk of the underlying functionality.\nUseful for modifications of the underlying construct that are not available at the higher levels.\nOverride the defaultChild property.\n\nThis should only be used in the cases where the correct\ndefault child is not named 'Resource' or 'Default' as it\nshould be.\n\nIf you set this to undefined, the default behavior of finding\nthe child named 'Resource' or 'Default' will be used.",
|
| 1252 | "returns": "a construct or undefined if there is no default child",
|
| 1253 | "stability": "stable",
|
| 1254 | "summary": "Returns the child construct that has the id `Default` or `Resource\"`."
|
| 1255 | },
|
| 1256 | "locationInModule": {
|
| 1257 | "filename": "src/construct.ts",
|
| 1258 | "line": 146
|
| 1259 | },
|
| 1260 | "name": "defaultChild",
|
| 1261 | "optional": true,
|
| 1262 | "type": {
|
| 1263 | "fqn": "constructs.IConstruct"
|
| 1264 | }
|
| 1265 | }
|
| 1266 | ],
|
| 1267 | "symbolId": "src/construct:Node"
|
| 1268 | },
|
| 1269 | "constructs.RootConstruct": {
|
| 1270 | "assembly": "constructs",
|
| 1271 | "base": "constructs.Construct",
|
| 1272 | "docs": {
|
| 1273 | "remarks": "The root construct represents the top of the construct tree and is not contained within a parent scope itself.\nFor root constructs, the id is optional.",
|
| 1274 | "stability": "stable",
|
| 1275 | "summary": "Creates a new root construct node."
|
| 1276 | },
|
| 1277 | "fqn": "constructs.RootConstruct",
|
| 1278 | "initializer": {
|
| 1279 | "docs": {
|
| 1280 | "stability": "stable",
|
| 1281 | "summary": "Creates a new root construct node."
|
| 1282 | },
|
| 1283 | "locationInModule": {
|
| 1284 | "filename": "src/construct.ts",
|
| 1285 | "line": 579
|
| 1286 | },
|
| 1287 | "parameters": [
|
| 1288 | {
|
| 1289 | "docs": {
|
| 1290 | "remarks": "Must be unique amongst siblings. If\nthe ID includes a path separator (`/`), then it will be replaced by double\ndash `--`.",
|
| 1291 | "summary": "The scoped construct ID."
|
| 1292 | },
|
| 1293 | "name": "id",
|
| 1294 | "optional": true,
|
| 1295 | "type": {
|
| 1296 | "primitive": "string"
|
| 1297 | }
|
| 1298 | }
|
| 1299 | ]
|
| 1300 | },
|
| 1301 | "kind": "class",
|
| 1302 | "locationInModule": {
|
| 1303 | "filename": "src/construct.ts",
|
| 1304 | "line": 571
|
| 1305 | },
|
| 1306 | "name": "RootConstruct",
|
| 1307 | "symbolId": "src/construct:RootConstruct"
|
| 1308 | }
|
| 1309 | },
|
| 1310 | "version": "10.4.2",
|
| 1311 | "fingerprint": "+0GkpuNfNI/pq9SPETomSpMo9D67QcVbiDoOit855Ec="
|
| 1312 | } |
| \ | No newline at end of file |