@aws-cdk/cloud-assembly-schema 2.151.0 → 36.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -9,14 +9,14 @@
9
9
  },
10
10
  "bundled": {
11
11
  "jsonschema": "^1.4.1",
12
- "semver": "^7.6.2"
12
+ "semver": "^7.6.3"
13
13
  },
14
14
  "description": "Cloud Assembly Schema",
15
15
  "docs": {
16
16
  "stability": "stable"
17
17
  },
18
- "homepage": "https://github.com/aws/aws-cdk",
19
- "jsiiVersion": "5.4.25 (build 09cecf6)",
18
+ "homepage": "https://github.com/cdklabs/cloud-assembly-schema",
19
+ "jsiiVersion": "5.4.31 (build 9643ee9)",
20
20
  "keywords": [
21
21
  "aws",
22
22
  "cdk"
@@ -24,23 +24,19 @@
24
24
  "license": "Apache-2.0",
25
25
  "metadata": {
26
26
  "jsii": {
27
- "compiledWithDeprecationWarnings": true,
28
27
  "pacmak": {
29
28
  "hasDefaultInterfaces": true
30
- },
31
- "rosetta": {
32
- "strict": false
33
29
  }
34
- }
30
+ },
31
+ "tscRootDir": "lib"
35
32
  },
36
33
  "name": "@aws-cdk/cloud-assembly-schema",
37
34
  "readme": {
38
- "markdown": "# Cloud Assembly Schema\n\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Cloud Assembly\n\nThe *Cloud Assembly* is the output of the synthesis operation. It is produced as part of the\n[`cdk synth`](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk#cdk-synthesize)\ncommand, or the [`app.synth()`](https://github.com/aws/aws-cdk/blob/main/packages/@aws-cdk/core/lib/app.ts#L135) method invocation.\n\nIts essentially a set of files and directories, one of which is the `manifest.json` file. It defines the set of instructions that are\nneeded in order to deploy the assembly directory.\n\n> For example, when `cdk deploy` is executed, the CLI reads this file and performs its instructions:\n>\n> - Build container images.\n> - Upload assets.\n> - Deploy CloudFormation templates.\n\nTherefore, the assembly is how the CDK class library and CDK CLI (or any other consumer) communicate. To ensure compatibility\nbetween the assembly and its consumers, we treat the manifest file as a well defined, versioned schema.\n\n## Schema\n\nThis module contains the typescript structs that comprise the `manifest.json` file, as well as the\ngenerated [*json-schema*](./schema/cloud-assembly.schema.json).\n\n## Versioning\n\nThe schema version is specified in the [`cloud-assembly.version.json`](./schema/cloud-assembly.schema.json) file, under the `version` property.\nIt follows semantic versioning, but with a small twist.\n\nWhen we add instructions to the assembly, they are reflected in the manifest file and the *json-schema* accordingly.\nEvery such instruction, is crucial for ensuring the correct deployment behavior. This means that to properly deploy a cloud assembly,\nconsumers must be aware of every such instruction modification.\n\nFor this reason, every change to the schema, even though it might not strictly break validation of the *json-schema* format,\nis considered `major` version bump.\n\n## How to consume\n\nIf you'd like to consume the [schema file](./schema/cloud-assembly.schema.json) in order to do validations on `manifest.json` files,\nsimply download it from this repo and run it against standard *json-schema* validators, such as [jsonschema](https://www.npmjs.com/package/jsonschema).\n\nConsumers must take into account the `major` version of the schema they are consuming. They should reject cloud assemblies\nwith a `major` version that is higher than what they expect. While schema validation might pass on such assemblies, the deployment integrity\ncannot be guaranteed because some instructions will be ignored.\n\n> For example, if your consumer was built when the schema version was 2.0.0, you should reject deploying cloud assemblies with a\n> manifest version of 3.0.0.\n\n## Contributing\n\nSee [Contribution Guide](./CONTRIBUTING.md)\n"
35
+ "markdown": "# Cloud Assembly Schema\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Cloud Assembly\n\nThe _Cloud Assembly_ is the output of the synthesis operation. It is produced as part of the\n[`cdk synth`](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk#cdk-synthesize)\ncommand, or the [`app.synth()`](https://github.com/aws/aws-cdk/blob/main/packages/@aws-cdk/core/lib/app.ts#L135) method invocation.\n\nIts essentially a set of files and directories, one of which is the `manifest.json` file. It defines the set of instructions that are\nneeded in order to deploy the assembly directory.\n\n> For example, when `cdk deploy` is executed, the CLI reads this file and performs its instructions:\n>\n> - Build container images.\n> - Upload assets.\n> - Deploy CloudFormation templates.\n\nTherefore, the assembly is how the CDK class library and CDK CLI (or any other consumer) communicate. To ensure compatibility\nbetween the assembly and its consumers, we treat the manifest file as a well defined, versioned schema.\n\n## Schema\n\nThis module contains the typescript structs that comprise the `manifest.json` file, as well as the\ngenerated [_json-schema_](./schema/cloud-assembly.schema.json).\n\n## Versioning\n\nThe schema version is specified my the major version of the package release. It follows semantic versioning, but with a small twist.\n\nWhen we add instructions to the assembly, they are reflected in the manifest file and the _json-schema_ accordingly.\nEvery such instruction, is crucial for ensuring the correct deployment behavior. This means that to properly deploy a cloud assembly,\nconsumers must be aware of every such instruction modification.\n\nFor this reason, every change to the schema, even though it might not strictly break validation of the _json-schema_ format,\nis considered `major` version bump. All changes that do not impact the schema are considered a `minor` version bump.\n\n## How to consume\n\nIf you'd like to consume the [schema file](./schema/cloud-assembly.schema.json) in order to do validations on `manifest.json` files,\nsimply download it from this repo and run it against standard _json-schema_ validators, such as [jsonschema](https://www.npmjs.com/package/jsonschema).\n\nConsumers must take into account the `major` version of the schema they are consuming. They should reject cloud assemblies\nwith a `major` version that is higher than what they expect. While schema validation might pass on such assemblies, the deployment integrity\ncannot be guaranteed because some instructions will be ignored.\n\n> For example, if your consumer was built when the schema version was 2.0.0, you should reject deploying cloud assemblies with a\n> manifest version of 3.0.0.\n\n## Contributing\n\nSee [Contribution Guide](./CONTRIBUTING.md)\n"
39
36
  },
40
37
  "repository": {
41
- "directory": "packages/@aws-cdk/cloud-assembly-schema",
42
38
  "type": "git",
43
- "url": "https://github.com/aws/aws-cdk.git"
39
+ "url": "https://github.com/cdklabs/cloud-assembly-schema.git"
44
40
  },
45
41
  "schema": "jsii/0.10.0",
46
42
  "targets": {
@@ -49,6 +45,9 @@
49
45
  "namespace": "Amazon.CDK.CloudAssembly.Schema",
50
46
  "packageId": "Amazon.CDK.CloudAssembly.Schema"
51
47
  },
48
+ "go": {
49
+ "moduleName": "github.com/aws/aws-cdk-go/awscdk/cloudassemblyschema"
50
+ },
52
51
  "java": {
53
52
  "maven": {
54
53
  "artifactId": "cdk-cloud-assembly-schema",
@@ -74,11 +73,7 @@
74
73
  "datatype": true,
75
74
  "docs": {
76
75
  "stability": "stable",
77
- "summary": "Query to AMI context provider.",
78
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst amiContextQuery: cloud_assembly_schema.AmiContextQuery = {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n};",
79
- "custom": {
80
- "exampleMetadata": "fixture=_generated"
81
- }
76
+ "summary": "Query to AMI context provider."
82
77
  },
83
78
  "fqn": "@aws-cdk/cloud-assembly-schema.AmiContextQuery",
84
79
  "kind": "interface",
@@ -195,11 +190,7 @@
195
190
  "datatype": true,
196
191
  "docs": {
197
192
  "stability": "stable",
198
- "summary": "A manifest for a single artifact within the cloud assembly.",
199
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst artifactManifest: cloud_assembly_schema.ArtifactManifest = {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n};",
200
- "custom": {
201
- "exampleMetadata": "fixture=_generated"
202
- }
193
+ "summary": "A manifest for a single artifact within the cloud assembly."
203
194
  },
204
195
  "fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest",
205
196
  "kind": "interface",
@@ -359,7 +350,7 @@
359
350
  "kind": "enum",
360
351
  "locationInModule": {
361
352
  "filename": "lib/cloud-assembly/metadata-schema.ts",
362
- "line": 271
353
+ "line": 275
363
354
  },
364
355
  "members": [
365
356
  {
@@ -465,11 +456,7 @@
465
456
  "datatype": true,
466
457
  "docs": {
467
458
  "stability": "stable",
468
- "summary": "A manifest which describes the cloud assembly.",
469
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assemblyManifest: cloud_assembly_schema.AssemblyManifest = {\n version: 'version',\n\n // the properties below are optional\n artifacts: {\n artifactsKey: {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n dependencies: ['dependencies'],\n displayName: 'displayName',\n environment: 'environment',\n metadata: {\n metadataKey: [{\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n }],\n },\n properties: {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n },\n },\n },\n missing: [{\n key: 'key',\n props: {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n }],\n runtime: {\n libraries: {\n librariesKey: 'libraries',\n },\n },\n};",
470
- "custom": {
471
- "exampleMetadata": "fixture=_generated"
472
- }
459
+ "summary": "A manifest which describes the cloud assembly."
473
460
  },
474
461
  "fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest",
475
462
  "kind": "interface",
@@ -568,11 +555,7 @@
568
555
  "datatype": true,
569
556
  "docs": {
570
557
  "stability": "stable",
571
- "summary": "Definitions for the asset manifest.",
572
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assetManifest: cloud_assembly_schema.AssetManifest = {\n version: 'version',\n\n // the properties below are optional\n dockerImages: {\n dockerImagesKey: {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n cacheDisabled: false,\n cacheFrom: [{\n type: 'type',\n\n // the properties below are optional\n params: {\n paramsKey: 'params',\n },\n }],\n cacheTo: {\n type: 'type',\n\n // the properties below are optional\n params: {\n paramsKey: 'params',\n },\n },\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildSecrets: {\n dockerBuildSecretsKey: 'dockerBuildSecrets',\n },\n dockerBuildSsh: 'dockerBuildSsh',\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n dockerOutputs: ['dockerOutputs'],\n executable: ['executable'],\n networkMode: 'networkMode',\n platform: 'platform',\n },\n },\n },\n files: {\n filesKey: {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n },\n },\n },\n};",
573
- "custom": {
574
- "exampleMetadata": "fixture=_generated"
575
- }
558
+ "summary": "Definitions for the asset manifest."
576
559
  },
577
560
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest",
578
561
  "kind": "interface",
@@ -652,17 +635,13 @@
652
635
  "datatype": true,
653
636
  "docs": {
654
637
  "stability": "stable",
655
- "summary": "Configuration options for the Asset Manifest.",
656
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assetManifestOptions: cloud_assembly_schema.AssetManifestOptions = {\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n};",
657
- "custom": {
658
- "exampleMetadata": "fixture=_generated"
659
- }
638
+ "summary": "Configuration options for the Asset Manifest."
660
639
  },
661
640
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestOptions",
662
641
  "kind": "interface",
663
642
  "locationInModule": {
664
643
  "filename": "lib/cloud-assembly/artifact-schema.ts",
665
- "line": 139
644
+ "line": 138
666
645
  },
667
646
  "name": "AssetManifestOptions",
668
647
  "properties": [
@@ -677,7 +656,7 @@
677
656
  "immutable": true,
678
657
  "locationInModule": {
679
658
  "filename": "lib/cloud-assembly/artifact-schema.ts",
680
- "line": 158
659
+ "line": 157
681
660
  },
682
661
  "name": "bootstrapStackVersionSsmParameter",
683
662
  "optional": true,
@@ -695,7 +674,7 @@
695
674
  "immutable": true,
696
675
  "locationInModule": {
697
676
  "filename": "lib/cloud-assembly/artifact-schema.ts",
698
- "line": 145
677
+ "line": 144
699
678
  },
700
679
  "name": "requiresBootstrapStackVersion",
701
680
  "optional": true,
@@ -711,11 +690,7 @@
711
690
  "datatype": true,
712
691
  "docs": {
713
692
  "stability": "stable",
714
- "summary": "Artifact properties for the Asset Manifest.",
715
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assetManifestProperties: cloud_assembly_schema.AssetManifestProperties = {\n file: 'file',\n\n // the properties below are optional\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n};",
716
- "custom": {
717
- "exampleMetadata": "fixture=_generated"
718
- }
693
+ "summary": "Artifact properties for the Asset Manifest."
719
694
  },
720
695
  "fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestProperties",
721
696
  "interfaces": [
@@ -724,7 +699,7 @@
724
699
  "kind": "interface",
725
700
  "locationInModule": {
726
701
  "filename": "lib/cloud-assembly/artifact-schema.ts",
727
- "line": 164
702
+ "line": 163
728
703
  },
729
704
  "name": "AssetManifestProperties",
730
705
  "properties": [
@@ -737,7 +712,7 @@
737
712
  "immutable": true,
738
713
  "locationInModule": {
739
714
  "filename": "lib/cloud-assembly/artifact-schema.ts",
740
- "line": 168
715
+ "line": 167
741
716
  },
742
717
  "name": "file",
743
718
  "type": {
@@ -752,11 +727,7 @@
752
727
  "datatype": true,
753
728
  "docs": {
754
729
  "stability": "stable",
755
- "summary": "Query to availability zone context provider.",
756
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst availabilityZonesContextQuery: cloud_assembly_schema.AvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};",
757
- "custom": {
758
- "exampleMetadata": "fixture=_generated"
759
- }
730
+ "summary": "Query to availability zone context provider."
760
731
  },
761
732
  "fqn": "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery",
762
733
  "kind": "interface",
@@ -824,17 +795,13 @@
824
795
  "datatype": true,
825
796
  "docs": {
826
797
  "stability": "stable",
827
- "summary": "Artifact properties for CloudFormation stacks.",
828
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst awsCloudFormationStackProperties: cloud_assembly_schema.AwsCloudFormationStackProperties = {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n lookupRole: {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n parameters: {\n parametersKey: 'parameters',\n },\n requiresBootstrapStackVersion: 123,\n stackName: 'stackName',\n stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n tags: {\n tagsKey: 'tags',\n },\n terminationProtection: false,\n validateOnSynth: false,\n};",
829
- "custom": {
830
- "exampleMetadata": "fixture=_generated"
831
- }
798
+ "summary": "Artifact properties for CloudFormation stacks."
832
799
  },
833
800
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties",
834
801
  "kind": "interface",
835
802
  "locationInModule": {
836
803
  "filename": "lib/cloud-assembly/artifact-schema.ts",
837
- "line": 38
804
+ "line": 37
838
805
  },
839
806
  "name": "AwsCloudFormationStackProperties",
840
807
  "properties": [
@@ -847,7 +814,7 @@
847
814
  "immutable": true,
848
815
  "locationInModule": {
849
816
  "filename": "lib/cloud-assembly/artifact-schema.ts",
850
- "line": 42
817
+ "line": 41
851
818
  },
852
819
  "name": "templateFile",
853
820
  "type": {
@@ -864,7 +831,7 @@
864
831
  "immutable": true,
865
832
  "locationInModule": {
866
833
  "filename": "lib/cloud-assembly/artifact-schema.ts",
867
- "line": 76
834
+ "line": 75
868
835
  },
869
836
  "name": "assumeRoleArn",
870
837
  "optional": true,
@@ -882,7 +849,7 @@
882
849
  "immutable": true,
883
850
  "locationInModule": {
884
851
  "filename": "lib/cloud-assembly/artifact-schema.ts",
885
- "line": 83
852
+ "line": 82
886
853
  },
887
854
  "name": "assumeRoleExternalId",
888
855
  "optional": true,
@@ -901,7 +868,7 @@
901
868
  "immutable": true,
902
869
  "locationInModule": {
903
870
  "filename": "lib/cloud-assembly/artifact-schema.ts",
904
- "line": 126
871
+ "line": 125
905
872
  },
906
873
  "name": "bootstrapStackVersionSsmParameter",
907
874
  "optional": true,
@@ -919,7 +886,7 @@
919
886
  "immutable": true,
920
887
  "locationInModule": {
921
888
  "filename": "lib/cloud-assembly/artifact-schema.ts",
922
- "line": 90
889
+ "line": 89
923
890
  },
924
891
  "name": "cloudFormationExecutionRoleArn",
925
892
  "optional": true,
@@ -937,7 +904,7 @@
937
904
  "immutable": true,
938
905
  "locationInModule": {
939
906
  "filename": "lib/cloud-assembly/artifact-schema.ts",
940
- "line": 97
907
+ "line": 96
941
908
  },
942
909
  "name": "lookupRole",
943
910
  "optional": true,
@@ -955,7 +922,7 @@
955
922
  "immutable": true,
956
923
  "locationInModule": {
957
924
  "filename": "lib/cloud-assembly/artifact-schema.ts",
958
- "line": 49
925
+ "line": 48
959
926
  },
960
927
  "name": "parameters",
961
928
  "optional": true,
@@ -978,7 +945,7 @@
978
945
  "immutable": true,
979
946
  "locationInModule": {
980
947
  "filename": "lib/cloud-assembly/artifact-schema.ts",
981
- "line": 111
948
+ "line": 110
982
949
  },
983
950
  "name": "requiresBootstrapStackVersion",
984
951
  "optional": true,
@@ -996,7 +963,7 @@
996
963
  "immutable": true,
997
964
  "locationInModule": {
998
965
  "filename": "lib/cloud-assembly/artifact-schema.ts",
999
- "line": 62
966
+ "line": 61
1000
967
  },
1001
968
  "name": "stackName",
1002
969
  "optional": true,
@@ -1014,7 +981,7 @@
1014
981
  "immutable": true,
1015
982
  "locationInModule": {
1016
983
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1017
- "line": 104
984
+ "line": 103
1018
985
  },
1019
986
  "name": "stackTemplateAssetObjectUrl",
1020
987
  "optional": true,
@@ -1032,7 +999,7 @@
1032
999
  "immutable": true,
1033
1000
  "locationInModule": {
1034
1001
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1035
- "line": 56
1002
+ "line": 55
1036
1003
  },
1037
1004
  "name": "tags",
1038
1005
  "optional": true,
@@ -1055,7 +1022,7 @@
1055
1022
  "immutable": true,
1056
1023
  "locationInModule": {
1057
1024
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1058
- "line": 69
1025
+ "line": 68
1059
1026
  },
1060
1027
  "name": "terminationProtection",
1061
1028
  "optional": true,
@@ -1073,7 +1040,7 @@
1073
1040
  "immutable": true,
1074
1041
  "locationInModule": {
1075
1042
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1076
- "line": 133
1043
+ "line": 132
1077
1044
  },
1078
1045
  "name": "validateOnSynth",
1079
1046
  "optional": true,
@@ -1089,11 +1056,7 @@
1089
1056
  "datatype": true,
1090
1057
  "docs": {
1091
1058
  "stability": "stable",
1092
- "summary": "Destination for assets that need to be uploaded to AWS.",
1093
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst awsDestination: cloud_assembly_schema.AwsDestination = {\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
1094
- "custom": {
1095
- "exampleMetadata": "fixture=_generated"
1096
- }
1059
+ "summary": "Destination for assets that need to be uploaded to AWS."
1097
1060
  },
1098
1061
  "fqn": "@aws-cdk/cloud-assembly-schema.AwsDestination",
1099
1062
  "kind": "interface",
@@ -1165,17 +1128,13 @@
1165
1128
  "datatype": true,
1166
1129
  "docs": {
1167
1130
  "stability": "stable",
1168
- "summary": "Information needed to access an IAM role created as part of the bootstrap process.",
1169
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst bootstrapRole: cloud_assembly_schema.BootstrapRole = {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n};",
1170
- "custom": {
1171
- "exampleMetadata": "fixture=_generated"
1172
- }
1131
+ "summary": "Information needed to access an IAM role created as part of the bootstrap process."
1173
1132
  },
1174
1133
  "fqn": "@aws-cdk/cloud-assembly-schema.BootstrapRole",
1175
1134
  "kind": "interface",
1176
1135
  "locationInModule": {
1177
1136
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1178
- "line": 6
1137
+ "line": 5
1179
1138
  },
1180
1139
  "name": "BootstrapRole",
1181
1140
  "properties": [
@@ -1188,7 +1147,7 @@
1188
1147
  "immutable": true,
1189
1148
  "locationInModule": {
1190
1149
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1191
- "line": 11
1150
+ "line": 10
1192
1151
  },
1193
1152
  "name": "arn",
1194
1153
  "type": {
@@ -1205,7 +1164,7 @@
1205
1164
  "immutable": true,
1206
1165
  "locationInModule": {
1207
1166
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1208
- "line": 18
1167
+ "line": 17
1209
1168
  },
1210
1169
  "name": "assumeRoleExternalId",
1211
1170
  "optional": true,
@@ -1223,7 +1182,7 @@
1223
1182
  "immutable": true,
1224
1183
  "locationInModule": {
1225
1184
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1226
- "line": 32
1185
+ "line": 31
1227
1186
  },
1228
1187
  "name": "bootstrapStackVersionSsmParameter",
1229
1188
  "optional": true,
@@ -1241,7 +1200,7 @@
1241
1200
  "immutable": true,
1242
1201
  "locationInModule": {
1243
1202
  "filename": "lib/cloud-assembly/artifact-schema.ts",
1244
- "line": 25
1203
+ "line": 24
1245
1204
  },
1246
1205
  "name": "requiresBootstrapStackVersion",
1247
1206
  "optional": true,
@@ -1257,11 +1216,7 @@
1257
1216
  "datatype": true,
1258
1217
  "docs": {
1259
1218
  "stability": "stable",
1260
- "summary": "Represents a cdk command i.e. `synth`, `deploy`, & `destroy`.",
1261
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst cdkCommand: cloud_assembly_schema.CdkCommand = {\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n};",
1262
- "custom": {
1263
- "exampleMetadata": "fixture=_generated"
1264
- }
1219
+ "summary": "Represents a cdk command i.e. `synth`, `deploy`, & `destroy`."
1265
1220
  },
1266
1221
  "fqn": "@aws-cdk/cloud-assembly-schema.CdkCommand",
1267
1222
  "kind": "interface",
@@ -1333,11 +1288,7 @@
1333
1288
  "datatype": true,
1334
1289
  "docs": {
1335
1290
  "stability": "stable",
1336
- "summary": "Options for specific cdk commands that are run as part of the integration test workflow.",
1337
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst cdkCommands: cloud_assembly_schema.CdkCommands = {\n deploy: {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n changeSetName: 'changeSetName',\n ci: false,\n color: false,\n concurrency: 123,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n execute: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n notificationArns: ['notificationArns'],\n output: 'output',\n outputsFile: 'outputsFile',\n parameters: {\n parametersKey: 'parameters',\n },\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n requireApproval: cloud_assembly_schema.RequireApproval.NEVER,\n reuseAssets: ['reuseAssets'],\n roleArn: 'roleArn',\n rollback: false,\n stacks: ['stacks'],\n staging: false,\n strict: false,\n toolkitStackName: 'toolkitStackName',\n trace: false,\n usePreviousParameters: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n },\n destroy: {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n color: false,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n output: 'output',\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n roleArn: 'roleArn',\n stacks: ['stacks'],\n staging: false,\n strict: false,\n trace: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n },\n};",
1338
- "custom": {
1339
- "exampleMetadata": "fixture=_generated"
1340
- }
1291
+ "summary": "Options for specific cdk commands that are run as part of the integration test workflow."
1341
1292
  },
1342
1293
  "fqn": "@aws-cdk/cloud-assembly-schema.CdkCommands",
1343
1294
  "kind": "interface",
@@ -1391,11 +1342,7 @@
1391
1342
  "datatype": true,
1392
1343
  "docs": {
1393
1344
  "stability": "stable",
1394
- "summary": "Options for configuring the Docker cache backend.",
1395
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst containerImageAssetCacheOption: cloud_assembly_schema.ContainerImageAssetCacheOption = {\n type: 'type',\n\n // the properties below are optional\n params: {\n paramsKey: 'params',\n },\n};",
1396
- "custom": {
1397
- "exampleMetadata": "fixture=_generated"
1398
- }
1345
+ "summary": "Options for configuring the Docker cache backend."
1399
1346
  },
1400
1347
  "fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetCacheOption",
1401
1348
  "kind": "interface",
@@ -1913,11 +1860,7 @@
1913
1860
  "datatype": true,
1914
1861
  "docs": {
1915
1862
  "stability": "stable",
1916
- "summary": "Default CDK CLI options that apply to all commands.",
1917
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst defaultCdkOptions: cloud_assembly_schema.DefaultCdkOptions = {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n color: false,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n output: 'output',\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n roleArn: 'roleArn',\n stacks: ['stacks'],\n staging: false,\n strict: false,\n trace: false,\n verbose: false,\n versionReporting: false,\n};",
1918
- "custom": {
1919
- "exampleMetadata": "fixture=_generated"
1920
- }
1863
+ "summary": "Default CDK CLI options that apply to all commands."
1921
1864
  },
1922
1865
  "fqn": "@aws-cdk/cloud-assembly-schema.DefaultCdkOptions",
1923
1866
  "kind": "interface",
@@ -2364,11 +2307,7 @@
2364
2307
  "datatype": true,
2365
2308
  "docs": {
2366
2309
  "stability": "stable",
2367
- "summary": "Represents a cdk deploy command.",
2368
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst deployCommand: cloud_assembly_schema.DeployCommand = {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n changeSetName: 'changeSetName',\n ci: false,\n color: false,\n concurrency: 123,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n execute: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n notificationArns: ['notificationArns'],\n output: 'output',\n outputsFile: 'outputsFile',\n parameters: {\n parametersKey: 'parameters',\n },\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n requireApproval: cloud_assembly_schema.RequireApproval.NEVER,\n reuseAssets: ['reuseAssets'],\n roleArn: 'roleArn',\n rollback: false,\n stacks: ['stacks'],\n staging: false,\n strict: false,\n toolkitStackName: 'toolkitStackName',\n trace: false,\n usePreviousParameters: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n};",
2369
- "custom": {
2370
- "exampleMetadata": "fixture=_generated"
2371
- }
2310
+ "summary": "Represents a cdk deploy command."
2372
2311
  },
2373
2312
  "fqn": "@aws-cdk/cloud-assembly-schema.DeployCommand",
2374
2313
  "interfaces": [
@@ -2407,11 +2346,7 @@
2407
2346
  "datatype": true,
2408
2347
  "docs": {
2409
2348
  "stability": "stable",
2410
- "summary": "Options to use with cdk deploy.",
2411
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst deployOptions: cloud_assembly_schema.DeployOptions = {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n changeSetName: 'changeSetName',\n ci: false,\n color: false,\n concurrency: 123,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n execute: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n notificationArns: ['notificationArns'],\n output: 'output',\n outputsFile: 'outputsFile',\n parameters: {\n parametersKey: 'parameters',\n },\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n requireApproval: cloud_assembly_schema.RequireApproval.NEVER,\n reuseAssets: ['reuseAssets'],\n roleArn: 'roleArn',\n rollback: false,\n stacks: ['stacks'],\n staging: false,\n strict: false,\n toolkitStackName: 'toolkitStackName',\n trace: false,\n usePreviousParameters: false,\n verbose: false,\n versionReporting: false,\n};",
2412
- "custom": {
2413
- "exampleMetadata": "fixture=_generated"
2414
- }
2349
+ "summary": "Options to use with cdk deploy."
2415
2350
  },
2416
2351
  "fqn": "@aws-cdk/cloud-assembly-schema.DeployOptions",
2417
2352
  "interfaces": [
@@ -2701,11 +2636,7 @@
2701
2636
  "datatype": true,
2702
2637
  "docs": {
2703
2638
  "stability": "stable",
2704
- "summary": "Represents a cdk destroy command.",
2705
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst destroyCommand: cloud_assembly_schema.DestroyCommand = {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n color: false,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n output: 'output',\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n roleArn: 'roleArn',\n stacks: ['stacks'],\n staging: false,\n strict: false,\n trace: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n};",
2706
- "custom": {
2707
- "exampleMetadata": "fixture=_generated"
2708
- }
2639
+ "summary": "Represents a cdk destroy command."
2709
2640
  },
2710
2641
  "fqn": "@aws-cdk/cloud-assembly-schema.DestroyCommand",
2711
2642
  "interfaces": [
@@ -2744,11 +2675,7 @@
2744
2675
  "datatype": true,
2745
2676
  "docs": {
2746
2677
  "stability": "stable",
2747
- "summary": "Options to use with cdk destroy.",
2748
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst destroyOptions: cloud_assembly_schema.DestroyOptions = {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n color: false,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n output: 'output',\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n roleArn: 'roleArn',\n stacks: ['stacks'],\n staging: false,\n strict: false,\n trace: false,\n verbose: false,\n versionReporting: false,\n};",
2749
- "custom": {
2750
- "exampleMetadata": "fixture=_generated"
2751
- }
2678
+ "summary": "Options to use with cdk destroy."
2752
2679
  },
2753
2680
  "fqn": "@aws-cdk/cloud-assembly-schema.DestroyOptions",
2754
2681
  "interfaces": [
@@ -2805,11 +2732,7 @@
2805
2732
  "datatype": true,
2806
2733
  "docs": {
2807
2734
  "stability": "stable",
2808
- "summary": "Options for configuring the Docker cache backend.",
2809
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst dockerCacheOption: cloud_assembly_schema.DockerCacheOption = {\n type: 'type',\n\n // the properties below are optional\n params: {\n paramsKey: 'params',\n },\n};",
2810
- "custom": {
2811
- "exampleMetadata": "fixture=_generated"
2812
- }
2735
+ "summary": "Options for configuring the Docker cache backend."
2813
2736
  },
2814
2737
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerCacheOption",
2815
2738
  "kind": "interface",
@@ -2871,11 +2794,7 @@
2871
2794
  "datatype": true,
2872
2795
  "docs": {
2873
2796
  "stability": "stable",
2874
- "summary": "A file asset.",
2875
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst dockerImageAsset: cloud_assembly_schema.DockerImageAsset = {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n cacheDisabled: false,\n cacheFrom: [{\n type: 'type',\n\n // the properties below are optional\n params: {\n paramsKey: 'params',\n },\n }],\n cacheTo: {\n type: 'type',\n\n // the properties below are optional\n params: {\n paramsKey: 'params',\n },\n },\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildSecrets: {\n dockerBuildSecretsKey: 'dockerBuildSecrets',\n },\n dockerBuildSsh: 'dockerBuildSsh',\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n dockerOutputs: ['dockerOutputs'],\n executable: ['executable'],\n networkMode: 'networkMode',\n platform: 'platform',\n },\n};",
2876
- "custom": {
2877
- "exampleMetadata": "fixture=_generated"
2878
- }
2797
+ "summary": "A file asset."
2879
2798
  },
2880
2799
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageAsset",
2881
2800
  "kind": "interface",
@@ -2930,11 +2849,7 @@
2930
2849
  "datatype": true,
2931
2850
  "docs": {
2932
2851
  "stability": "stable",
2933
- "summary": "Where to publish docker images.",
2934
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst dockerImageDestination: cloud_assembly_schema.DockerImageDestination = {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
2935
- "custom": {
2936
- "exampleMetadata": "fixture=_generated"
2937
- }
2852
+ "summary": "Where to publish docker images."
2938
2853
  },
2939
2854
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageDestination",
2940
2855
  "interfaces": [
@@ -2987,11 +2902,7 @@
2987
2902
  "datatype": true,
2988
2903
  "docs": {
2989
2904
  "stability": "stable",
2990
- "summary": "Properties for how to produce a Docker image from a source.",
2991
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst dockerImageSource: cloud_assembly_schema.DockerImageSource = {\n cacheDisabled: false,\n cacheFrom: [{\n type: 'type',\n\n // the properties below are optional\n params: {\n paramsKey: 'params',\n },\n }],\n cacheTo: {\n type: 'type',\n\n // the properties below are optional\n params: {\n paramsKey: 'params',\n },\n },\n directory: 'directory',\n dockerBuildArgs: {\n dockerBuildArgsKey: 'dockerBuildArgs',\n },\n dockerBuildSecrets: {\n dockerBuildSecretsKey: 'dockerBuildSecrets',\n },\n dockerBuildSsh: 'dockerBuildSsh',\n dockerBuildTarget: 'dockerBuildTarget',\n dockerFile: 'dockerFile',\n dockerOutputs: ['dockerOutputs'],\n executable: ['executable'],\n networkMode: 'networkMode',\n platform: 'platform',\n};",
2992
- "custom": {
2993
- "exampleMetadata": "fixture=_generated"
2994
- }
2905
+ "summary": "Properties for how to produce a Docker image from a source."
2995
2906
  },
2996
2907
  "fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource",
2997
2908
  "kind": "interface",
@@ -3279,17 +3190,13 @@
3279
3190
  "datatype": true,
3280
3191
  "docs": {
3281
3192
  "stability": "stable",
3282
- "summary": "Query to endpoint service context provider.",
3283
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst endpointServiceAvailabilityZonesContextQuery: cloud_assembly_schema.EndpointServiceAvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n serviceName: 'serviceName',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};",
3284
- "custom": {
3285
- "exampleMetadata": "fixture=_generated"
3286
- }
3193
+ "summary": "Query to endpoint service context provider."
3287
3194
  },
3288
3195
  "fqn": "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery",
3289
3196
  "kind": "interface",
3290
3197
  "locationInModule": {
3291
3198
  "filename": "lib/cloud-assembly/context-queries.ts",
3292
- "line": 253
3199
+ "line": 252
3293
3200
  },
3294
3201
  "name": "EndpointServiceAvailabilityZonesContextQuery",
3295
3202
  "properties": [
@@ -3302,7 +3209,7 @@
3302
3209
  "immutable": true,
3303
3210
  "locationInModule": {
3304
3211
  "filename": "lib/cloud-assembly/context-queries.ts",
3305
- "line": 257
3212
+ "line": 256
3306
3213
  },
3307
3214
  "name": "account",
3308
3215
  "type": {
@@ -3318,7 +3225,7 @@
3318
3225
  "immutable": true,
3319
3226
  "locationInModule": {
3320
3227
  "filename": "lib/cloud-assembly/context-queries.ts",
3321
- "line": 262
3228
+ "line": 261
3322
3229
  },
3323
3230
  "name": "region",
3324
3231
  "type": {
@@ -3334,7 +3241,7 @@
3334
3241
  "immutable": true,
3335
3242
  "locationInModule": {
3336
3243
  "filename": "lib/cloud-assembly/context-queries.ts",
3337
- "line": 274
3244
+ "line": 273
3338
3245
  },
3339
3246
  "name": "serviceName",
3340
3247
  "type": {
@@ -3351,7 +3258,7 @@
3351
3258
  "immutable": true,
3352
3259
  "locationInModule": {
3353
3260
  "filename": "lib/cloud-assembly/context-queries.ts",
3354
- "line": 269
3261
+ "line": 268
3355
3262
  },
3356
3263
  "name": "lookupRoleArn",
3357
3264
  "optional": true,
@@ -3367,11 +3274,7 @@
3367
3274
  "datatype": true,
3368
3275
  "docs": {
3369
3276
  "stability": "stable",
3370
- "summary": "A file asset.",
3371
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst fileAsset: cloud_assembly_schema.FileAsset = {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n },\n },\n source: {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n },\n};",
3372
- "custom": {
3373
- "exampleMetadata": "fixture=_generated"
3374
- }
3277
+ "summary": "A file asset."
3375
3278
  },
3376
3279
  "fqn": "@aws-cdk/cloud-assembly-schema.FileAsset",
3377
3280
  "kind": "interface",
@@ -3588,11 +3491,7 @@
3588
3491
  "datatype": true,
3589
3492
  "docs": {
3590
3493
  "stability": "stable",
3591
- "summary": "Where in S3 a file asset needs to be published.",
3592
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst fileDestination: cloud_assembly_schema.FileDestination = {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
3593
- "custom": {
3594
- "exampleMetadata": "fixture=_generated"
3595
- }
3494
+ "summary": "Where in S3 a file asset needs to be published."
3596
3495
  },
3597
3496
  "fqn": "@aws-cdk/cloud-assembly-schema.FileDestination",
3598
3497
  "interfaces": [
@@ -3645,11 +3544,7 @@
3645
3544
  "datatype": true,
3646
3545
  "docs": {
3647
3546
  "stability": "stable",
3648
- "summary": "Describe the source of a file asset.",
3649
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst fileSource: cloud_assembly_schema.FileSource = {\n executable: ['executable'],\n packaging: cloud_assembly_schema.FileAssetPackaging.FILE,\n path: 'path',\n};",
3650
- "custom": {
3651
- "exampleMetadata": "fixture=_generated"
3652
- }
3547
+ "summary": "Describe the source of a file asset."
3653
3548
  },
3654
3549
  "fqn": "@aws-cdk/cloud-assembly-schema.FileSource",
3655
3550
  "kind": "interface",
@@ -3728,11 +3623,7 @@
3728
3623
  "datatype": true,
3729
3624
  "docs": {
3730
3625
  "stability": "stable",
3731
- "summary": "Commands to run at predefined points during the integration test workflow.",
3732
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst hooks: cloud_assembly_schema.Hooks = {\n postDeploy: ['postDeploy'],\n postDestroy: ['postDestroy'],\n preDeploy: ['preDeploy'],\n preDestroy: ['preDestroy'],\n};",
3733
- "custom": {
3734
- "exampleMetadata": "fixture=_generated"
3735
- }
3626
+ "summary": "Commands to run at predefined points during the integration test workflow."
3736
3627
  },
3737
3628
  "fqn": "@aws-cdk/cloud-assembly-schema.Hooks",
3738
3629
  "kind": "interface",
@@ -3842,17 +3733,13 @@
3842
3733
  "datatype": true,
3843
3734
  "docs": {
3844
3735
  "stability": "stable",
3845
- "summary": "Query to hosted zone context provider.",
3846
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst hostedZoneContextQuery: cloud_assembly_schema.HostedZoneContextQuery = {\n account: 'account',\n domainName: 'domainName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n privateZone: false,\n vpcId: 'vpcId',\n};",
3847
- "custom": {
3848
- "exampleMetadata": "fixture=_generated"
3849
- }
3736
+ "summary": "Query to hosted zone context provider."
3850
3737
  },
3851
3738
  "fqn": "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery",
3852
3739
  "kind": "interface",
3853
3740
  "locationInModule": {
3854
3741
  "filename": "lib/cloud-assembly/context-queries.ts",
3855
- "line": 123
3742
+ "line": 122
3856
3743
  },
3857
3744
  "name": "HostedZoneContextQuery",
3858
3745
  "properties": [
@@ -3865,7 +3752,7 @@
3865
3752
  "immutable": true,
3866
3753
  "locationInModule": {
3867
3754
  "filename": "lib/cloud-assembly/context-queries.ts",
3868
- "line": 127
3755
+ "line": 126
3869
3756
  },
3870
3757
  "name": "account",
3871
3758
  "type": {
@@ -3881,7 +3768,7 @@
3881
3768
  "immutable": true,
3882
3769
  "locationInModule": {
3883
3770
  "filename": "lib/cloud-assembly/context-queries.ts",
3884
- "line": 144
3771
+ "line": 143
3885
3772
  },
3886
3773
  "name": "domainName",
3887
3774
  "type": {
@@ -3897,7 +3784,7 @@
3897
3784
  "immutable": true,
3898
3785
  "locationInModule": {
3899
3786
  "filename": "lib/cloud-assembly/context-queries.ts",
3900
- "line": 132
3787
+ "line": 131
3901
3788
  },
3902
3789
  "name": "region",
3903
3790
  "type": {
@@ -3914,7 +3801,7 @@
3914
3801
  "immutable": true,
3915
3802
  "locationInModule": {
3916
3803
  "filename": "lib/cloud-assembly/context-queries.ts",
3917
- "line": 139
3804
+ "line": 138
3918
3805
  },
3919
3806
  "name": "lookupRoleArn",
3920
3807
  "optional": true,
@@ -3932,7 +3819,7 @@
3932
3819
  "immutable": true,
3933
3820
  "locationInModule": {
3934
3821
  "filename": "lib/cloud-assembly/context-queries.ts",
3935
- "line": 151
3822
+ "line": 150
3936
3823
  },
3937
3824
  "name": "privateZone",
3938
3825
  "optional": true,
@@ -3951,7 +3838,7 @@
3951
3838
  "immutable": true,
3952
3839
  "locationInModule": {
3953
3840
  "filename": "lib/cloud-assembly/context-queries.ts",
3954
- "line": 161
3841
+ "line": 160
3955
3842
  },
3956
3843
  "name": "vpcId",
3957
3844
  "optional": true,
@@ -3967,11 +3854,7 @@
3967
3854
  "datatype": true,
3968
3855
  "docs": {
3969
3856
  "stability": "stable",
3970
- "summary": "Definitions for the integration testing manifest.",
3971
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst integManifest: cloud_assembly_schema.IntegManifest = {\n testCases: {\n testCasesKey: {\n stacks: ['stacks'],\n\n // the properties below are optional\n allowDestroy: ['allowDestroy'],\n assertionStack: 'assertionStack',\n assertionStackName: 'assertionStackName',\n cdkCommandOptions: {\n deploy: {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n changeSetName: 'changeSetName',\n ci: false,\n color: false,\n concurrency: 123,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n execute: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n notificationArns: ['notificationArns'],\n output: 'output',\n outputsFile: 'outputsFile',\n parameters: {\n parametersKey: 'parameters',\n },\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n requireApproval: cloud_assembly_schema.RequireApproval.NEVER,\n reuseAssets: ['reuseAssets'],\n roleArn: 'roleArn',\n rollback: false,\n stacks: ['stacks'],\n staging: false,\n strict: false,\n toolkitStackName: 'toolkitStackName',\n trace: false,\n usePreviousParameters: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n },\n destroy: {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n color: false,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n output: 'output',\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n roleArn: 'roleArn',\n stacks: ['stacks'],\n staging: false,\n strict: false,\n trace: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n },\n },\n diffAssets: false,\n hooks: {\n postDeploy: ['postDeploy'],\n postDestroy: ['postDestroy'],\n preDeploy: ['preDeploy'],\n preDestroy: ['preDestroy'],\n },\n regions: ['regions'],\n stackUpdateWorkflow: false,\n },\n },\n version: 'version',\n\n // the properties below are optional\n enableLookups: false,\n synthContext: {\n synthContextKey: 'synthContext',\n },\n};",
3972
- "custom": {
3973
- "exampleMetadata": "fixture=_generated"
3974
- }
3857
+ "summary": "Definitions for the integration testing manifest."
3975
3858
  },
3976
3859
  "fqn": "@aws-cdk/cloud-assembly-schema.IntegManifest",
3977
3860
  "kind": "interface",
@@ -4069,17 +3952,13 @@
4069
3952
  "datatype": true,
4070
3953
  "docs": {
4071
3954
  "stability": "stable",
4072
- "summary": "Query input for looking up a KMS Key.",
4073
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst keyContextQuery: cloud_assembly_schema.KeyContextQuery = {\n account: 'account',\n aliasName: 'aliasName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};",
4074
- "custom": {
4075
- "exampleMetadata": "fixture=_generated"
4076
- }
3955
+ "summary": "Query input for looking up a KMS Key."
4077
3956
  },
4078
3957
  "fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery",
4079
3958
  "kind": "interface",
4080
3959
  "locationInModule": {
4081
3960
  "filename": "lib/cloud-assembly/context-queries.ts",
4082
- "line": 457
3961
+ "line": 456
4083
3962
  },
4084
3963
  "name": "KeyContextQuery",
4085
3964
  "properties": [
@@ -4092,7 +3971,7 @@
4092
3971
  "immutable": true,
4093
3972
  "locationInModule": {
4094
3973
  "filename": "lib/cloud-assembly/context-queries.ts",
4095
- "line": 461
3974
+ "line": 460
4096
3975
  },
4097
3976
  "name": "account",
4098
3977
  "type": {
@@ -4108,7 +3987,7 @@
4108
3987
  "immutable": true,
4109
3988
  "locationInModule": {
4110
3989
  "filename": "lib/cloud-assembly/context-queries.ts",
4111
- "line": 478
3990
+ "line": 477
4112
3991
  },
4113
3992
  "name": "aliasName",
4114
3993
  "type": {
@@ -4124,7 +4003,7 @@
4124
4003
  "immutable": true,
4125
4004
  "locationInModule": {
4126
4005
  "filename": "lib/cloud-assembly/context-queries.ts",
4127
- "line": 466
4006
+ "line": 465
4128
4007
  },
4129
4008
  "name": "region",
4130
4009
  "type": {
@@ -4141,7 +4020,7 @@
4141
4020
  "immutable": true,
4142
4021
  "locationInModule": {
4143
4022
  "filename": "lib/cloud-assembly/context-queries.ts",
4144
- "line": 473
4023
+ "line": 472
4145
4024
  },
4146
4025
  "name": "lookupRoleArn",
4147
4026
  "optional": true,
@@ -4157,11 +4036,7 @@
4157
4036
  "datatype": true,
4158
4037
  "docs": {
4159
4038
  "stability": "stable",
4160
- "summary": "Query input for looking up a load balancer.",
4161
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst loadBalancerContextQuery: cloud_assembly_schema.LoadBalancerContextQuery = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n};",
4162
- "custom": {
4163
- "exampleMetadata": "fixture=_generated"
4164
- }
4039
+ "summary": "Query input for looking up a load balancer."
4165
4040
  },
4166
4041
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery",
4167
4042
  "interfaces": [
@@ -4170,7 +4045,7 @@
4170
4045
  "kind": "interface",
4171
4046
  "locationInModule": {
4172
4047
  "filename": "lib/cloud-assembly/context-queries.ts",
4173
- "line": 317
4048
+ "line": 316
4174
4049
  },
4175
4050
  "name": "LoadBalancerContextQuery",
4176
4051
  "properties": [
@@ -4183,7 +4058,7 @@
4183
4058
  "immutable": true,
4184
4059
  "locationInModule": {
4185
4060
  "filename": "lib/cloud-assembly/context-queries.ts",
4186
- "line": 321
4061
+ "line": 320
4187
4062
  },
4188
4063
  "name": "account",
4189
4064
  "type": {
@@ -4199,7 +4074,7 @@
4199
4074
  "immutable": true,
4200
4075
  "locationInModule": {
4201
4076
  "filename": "lib/cloud-assembly/context-queries.ts",
4202
- "line": 326
4077
+ "line": 325
4203
4078
  },
4204
4079
  "name": "region",
4205
4080
  "type": {
@@ -4216,7 +4091,7 @@
4216
4091
  "immutable": true,
4217
4092
  "locationInModule": {
4218
4093
  "filename": "lib/cloud-assembly/context-queries.ts",
4219
- "line": 333
4094
+ "line": 332
4220
4095
  },
4221
4096
  "name": "lookupRoleArn",
4222
4097
  "optional": true,
@@ -4232,17 +4107,13 @@
4232
4107
  "datatype": true,
4233
4108
  "docs": {
4234
4109
  "stability": "stable",
4235
- "summary": "Filters for selecting load balancers.",
4236
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst loadBalancerFilter: cloud_assembly_schema.LoadBalancerFilter = {\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n\n // the properties below are optional\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n};",
4237
- "custom": {
4238
- "exampleMetadata": "fixture=_generated"
4239
- }
4110
+ "summary": "Filters for selecting load balancers."
4240
4111
  },
4241
4112
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter",
4242
4113
  "kind": "interface",
4243
4114
  "locationInModule": {
4244
4115
  "filename": "lib/cloud-assembly/context-queries.ts",
4245
- "line": 295
4116
+ "line": 294
4246
4117
  },
4247
4118
  "name": "LoadBalancerFilter",
4248
4119
  "properties": [
@@ -4255,7 +4126,7 @@
4255
4126
  "immutable": true,
4256
4127
  "locationInModule": {
4257
4128
  "filename": "lib/cloud-assembly/context-queries.ts",
4258
- "line": 299
4129
+ "line": 298
4259
4130
  },
4260
4131
  "name": "loadBalancerType",
4261
4132
  "type": {
@@ -4272,7 +4143,7 @@
4272
4143
  "immutable": true,
4273
4144
  "locationInModule": {
4274
4145
  "filename": "lib/cloud-assembly/context-queries.ts",
4275
- "line": 305
4146
+ "line": 304
4276
4147
  },
4277
4148
  "name": "loadBalancerArn",
4278
4149
  "optional": true,
@@ -4290,7 +4161,7 @@
4290
4161
  "immutable": true,
4291
4162
  "locationInModule": {
4292
4163
  "filename": "lib/cloud-assembly/context-queries.ts",
4293
- "line": 311
4164
+ "line": 310
4294
4165
  },
4295
4166
  "name": "loadBalancerTags",
4296
4167
  "optional": true,
@@ -4311,11 +4182,7 @@
4311
4182
  "datatype": true,
4312
4183
  "docs": {
4313
4184
  "stability": "stable",
4314
- "summary": "Query input for looking up a load balancer listener.",
4315
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst loadBalancerListenerContextQuery: cloud_assembly_schema.LoadBalancerListenerContextQuery = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n listenerArn: 'listenerArn',\n listenerPort: 123,\n listenerProtocol: cloud_assembly_schema.LoadBalancerListenerProtocol.HTTP,\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n};",
4316
- "custom": {
4317
- "exampleMetadata": "fixture=_generated"
4318
- }
4185
+ "summary": "Query input for looking up a load balancer listener."
4319
4186
  },
4320
4187
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery",
4321
4188
  "interfaces": [
@@ -4324,7 +4191,7 @@
4324
4191
  "kind": "interface",
4325
4192
  "locationInModule": {
4326
4193
  "filename": "lib/cloud-assembly/context-queries.ts",
4327
- "line": 374
4194
+ "line": 373
4328
4195
  },
4329
4196
  "name": "LoadBalancerListenerContextQuery",
4330
4197
  "properties": [
@@ -4337,7 +4204,7 @@
4337
4204
  "immutable": true,
4338
4205
  "locationInModule": {
4339
4206
  "filename": "lib/cloud-assembly/context-queries.ts",
4340
- "line": 378
4207
+ "line": 377
4341
4208
  },
4342
4209
  "name": "account",
4343
4210
  "type": {
@@ -4353,7 +4220,7 @@
4353
4220
  "immutable": true,
4354
4221
  "locationInModule": {
4355
4222
  "filename": "lib/cloud-assembly/context-queries.ts",
4356
- "line": 383
4223
+ "line": 382
4357
4224
  },
4358
4225
  "name": "region",
4359
4226
  "type": {
@@ -4370,7 +4237,7 @@
4370
4237
  "immutable": true,
4371
4238
  "locationInModule": {
4372
4239
  "filename": "lib/cloud-assembly/context-queries.ts",
4373
- "line": 396
4240
+ "line": 395
4374
4241
  },
4375
4242
  "name": "listenerArn",
4376
4243
  "optional": true,
@@ -4388,7 +4255,7 @@
4388
4255
  "immutable": true,
4389
4256
  "locationInModule": {
4390
4257
  "filename": "lib/cloud-assembly/context-queries.ts",
4391
- "line": 408
4258
+ "line": 407
4392
4259
  },
4393
4260
  "name": "listenerPort",
4394
4261
  "optional": true,
@@ -4406,7 +4273,7 @@
4406
4273
  "immutable": true,
4407
4274
  "locationInModule": {
4408
4275
  "filename": "lib/cloud-assembly/context-queries.ts",
4409
- "line": 402
4276
+ "line": 401
4410
4277
  },
4411
4278
  "name": "listenerProtocol",
4412
4279
  "optional": true,
@@ -4424,7 +4291,7 @@
4424
4291
  "immutable": true,
4425
4292
  "locationInModule": {
4426
4293
  "filename": "lib/cloud-assembly/context-queries.ts",
4427
- "line": 390
4294
+ "line": 389
4428
4295
  },
4429
4296
  "name": "lookupRoleArn",
4430
4297
  "optional": true,
@@ -4445,7 +4312,7 @@
4445
4312
  "kind": "enum",
4446
4313
  "locationInModule": {
4447
4314
  "filename": "lib/cloud-assembly/context-queries.ts",
4448
- "line": 339
4315
+ "line": 338
4449
4316
  },
4450
4317
  "members": [
4451
4318
  {
@@ -4504,7 +4371,7 @@
4504
4371
  "kind": "enum",
4505
4372
  "locationInModule": {
4506
4373
  "filename": "lib/cloud-assembly/context-queries.ts",
4507
- "line": 280
4374
+ "line": 279
4508
4375
  },
4509
4376
  "members": [
4510
4377
  {
@@ -4530,11 +4397,7 @@
4530
4397
  "datatype": true,
4531
4398
  "docs": {
4532
4399
  "stability": "stable",
4533
- "summary": "Options for the loadManifest operation.",
4534
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst loadManifestOptions: cloud_assembly_schema.LoadManifestOptions = {\n skipEnumCheck: false,\n skipVersionCheck: false,\n topoSort: false,\n};",
4535
- "custom": {
4536
- "exampleMetadata": "fixture=_generated"
4537
- }
4400
+ "summary": "Options for the loadManifest operation."
4538
4401
  },
4539
4402
  "fqn": "@aws-cdk/cloud-assembly-schema.LoadManifestOptions",
4540
4403
  "kind": "interface",
@@ -4625,7 +4488,7 @@
4625
4488
  },
4626
4489
  "locationInModule": {
4627
4490
  "filename": "lib/manifest.ts",
4628
- "line": 141
4491
+ "line": 146
4629
4492
  },
4630
4493
  "name": "load",
4631
4494
  "parameters": [
@@ -4685,7 +4548,7 @@
4685
4548
  },
4686
4549
  "locationInModule": {
4687
4550
  "filename": "lib/manifest.ts",
4688
- "line": 101
4551
+ "line": 104
4689
4552
  },
4690
4553
  "name": "loadAssetManifest",
4691
4554
  "parameters": [
@@ -4713,7 +4576,7 @@
4713
4576
  },
4714
4577
  "locationInModule": {
4715
4578
  "filename": "lib/manifest.ts",
4716
- "line": 120
4579
+ "line": 123
4717
4580
  },
4718
4581
  "name": "loadIntegManifest",
4719
4582
  "parameters": [
@@ -4742,7 +4605,7 @@
4742
4605
  },
4743
4606
  "locationInModule": {
4744
4607
  "filename": "lib/manifest.ts",
4745
- "line": 135
4608
+ "line": 138
4746
4609
  },
4747
4610
  "name": "save",
4748
4611
  "parameters": [
@@ -4800,7 +4663,7 @@
4800
4663
  },
4801
4664
  "locationInModule": {
4802
4665
  "filename": "lib/manifest.ts",
4803
- "line": 92
4666
+ "line": 95
4804
4667
  },
4805
4668
  "name": "saveAssetManifest",
4806
4669
  "parameters": [
@@ -4832,7 +4695,7 @@
4832
4695
  },
4833
4696
  "locationInModule": {
4834
4697
  "filename": "lib/manifest.ts",
4835
- "line": 111
4698
+ "line": 114
4836
4699
  },
4837
4700
  "name": "saveIntegManifest",
4838
4701
  "parameters": [
@@ -4864,7 +4727,7 @@
4864
4727
  },
4865
4728
  "locationInModule": {
4866
4729
  "filename": "lib/manifest.ts",
4867
- "line": 127
4730
+ "line": 130
4868
4731
  },
4869
4732
  "name": "version",
4870
4733
  "returns": {
@@ -4883,17 +4746,13 @@
4883
4746
  "datatype": true,
4884
4747
  "docs": {
4885
4748
  "stability": "stable",
4886
- "summary": "A metadata entry in a cloud assembly artifact.",
4887
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst metadataEntry: cloud_assembly_schema.MetadataEntry = {\n type: 'type',\n\n // the properties below are optional\n data: 'data',\n trace: ['trace'],\n};",
4888
- "custom": {
4889
- "exampleMetadata": "fixture=_generated"
4890
- }
4749
+ "summary": "A metadata entry in a cloud assembly artifact."
4891
4750
  },
4892
4751
  "fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry",
4893
4752
  "kind": "interface",
4894
4753
  "locationInModule": {
4895
4754
  "filename": "lib/cloud-assembly/metadata-schema.ts",
4896
- "line": 306
4755
+ "line": 310
4897
4756
  },
4898
4757
  "name": "MetadataEntry",
4899
4758
  "properties": [
@@ -4906,7 +4765,7 @@
4906
4765
  "immutable": true,
4907
4766
  "locationInModule": {
4908
4767
  "filename": "lib/cloud-assembly/metadata-schema.ts",
4909
- "line": 310
4768
+ "line": 314
4910
4769
  },
4911
4770
  "name": "type",
4912
4771
  "type": {
@@ -4923,7 +4782,7 @@
4923
4782
  "immutable": true,
4924
4783
  "locationInModule": {
4925
4784
  "filename": "lib/cloud-assembly/metadata-schema.ts",
4926
- "line": 317
4785
+ "line": 321
4927
4786
  },
4928
4787
  "name": "data",
4929
4788
  "optional": true,
@@ -4961,7 +4820,7 @@
4961
4820
  "immutable": true,
4962
4821
  "locationInModule": {
4963
4822
  "filename": "lib/cloud-assembly/metadata-schema.ts",
4964
- "line": 324
4823
+ "line": 328
4965
4824
  },
4966
4825
  "name": "trace",
4967
4826
  "optional": true,
@@ -4982,11 +4841,7 @@
4982
4841
  "datatype": true,
4983
4842
  "docs": {
4984
4843
  "stability": "stable",
4985
- "summary": "Represents a missing piece of context.",
4986
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst missingContext: cloud_assembly_schema.MissingContext = {\n key: 'key',\n props: {\n account: 'account',\n filters: {\n filtersKey: ['filters'],\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n};",
4987
- "custom": {
4988
- "exampleMetadata": "fixture=_generated"
4989
- }
4844
+ "summary": "Represents a missing piece of context."
4990
4845
  },
4991
4846
  "fqn": "@aws-cdk/cloud-assembly-schema.MissingContext",
4992
4847
  "kind": "interface",
@@ -5088,17 +4943,13 @@
5088
4943
  "datatype": true,
5089
4944
  "docs": {
5090
4945
  "stability": "stable",
5091
- "summary": "Artifact properties for nested cloud assemblies.",
5092
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst nestedCloudAssemblyProperties: cloud_assembly_schema.NestedCloudAssemblyProperties = {\n directoryName: 'directoryName',\n\n // the properties below are optional\n displayName: 'displayName',\n};",
5093
- "custom": {
5094
- "exampleMetadata": "fixture=_generated"
5095
- }
4946
+ "summary": "Artifact properties for nested cloud assemblies."
5096
4947
  },
5097
4948
  "fqn": "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties",
5098
4949
  "kind": "interface",
5099
4950
  "locationInModule": {
5100
4951
  "filename": "lib/cloud-assembly/artifact-schema.ts",
5101
- "line": 184
4952
+ "line": 183
5102
4953
  },
5103
4954
  "name": "NestedCloudAssemblyProperties",
5104
4955
  "properties": [
@@ -5111,7 +4962,7 @@
5111
4962
  "immutable": true,
5112
4963
  "locationInModule": {
5113
4964
  "filename": "lib/cloud-assembly/artifact-schema.ts",
5114
- "line": 188
4965
+ "line": 187
5115
4966
  },
5116
4967
  "name": "directoryName",
5117
4968
  "type": {
@@ -5128,7 +4979,7 @@
5128
4979
  "immutable": true,
5129
4980
  "locationInModule": {
5130
4981
  "filename": "lib/cloud-assembly/artifact-schema.ts",
5131
- "line": 195
4982
+ "line": 194
5132
4983
  },
5133
4984
  "name": "displayName",
5134
4985
  "optional": true,
@@ -5145,17 +4996,13 @@
5145
4996
  "docs": {
5146
4997
  "remarks": "This alternate branch is necessary because it needs to be able to escape all type checking\nwe do on on the cloud assembly -- we cannot know the properties that will be used a priori.",
5147
4998
  "stability": "stable",
5148
- "summary": "Query input for plugins.",
5149
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst pluginContextQuery: cloud_assembly_schema.PluginContextQuery = {\n pluginName: 'pluginName',\n};",
5150
- "custom": {
5151
- "exampleMetadata": "fixture=_generated"
5152
- }
4999
+ "summary": "Query input for plugins."
5153
5000
  },
5154
5001
  "fqn": "@aws-cdk/cloud-assembly-schema.PluginContextQuery",
5155
5002
  "kind": "interface",
5156
5003
  "locationInModule": {
5157
5004
  "filename": "lib/cloud-assembly/context-queries.ts",
5158
- "line": 487
5005
+ "line": 486
5159
5006
  },
5160
5007
  "name": "PluginContextQuery",
5161
5008
  "properties": [
@@ -5168,7 +5015,7 @@
5168
5015
  "immutable": true,
5169
5016
  "locationInModule": {
5170
5017
  "filename": "lib/cloud-assembly/context-queries.ts",
5171
- "line": 491
5018
+ "line": 490
5172
5019
  },
5173
5020
  "name": "pluginName",
5174
5021
  "type": {
@@ -5221,11 +5068,7 @@
5221
5068
  "datatype": true,
5222
5069
  "docs": {
5223
5070
  "stability": "stable",
5224
- "summary": "Information about the application's runtime components.",
5225
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst runtimeInfo: cloud_assembly_schema.RuntimeInfo = {\n libraries: {\n librariesKey: 'libraries',\n },\n};",
5226
- "custom": {
5227
- "exampleMetadata": "fixture=_generated"
5228
- }
5071
+ "summary": "Information about the application's runtime components."
5229
5072
  },
5230
5073
  "fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo",
5231
5074
  "kind": "interface",
@@ -5264,17 +5107,13 @@
5264
5107
  "datatype": true,
5265
5108
  "docs": {
5266
5109
  "stability": "stable",
5267
- "summary": "Query to SSM Parameter Context Provider.",
5268
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst sSMParameterContextQuery: cloud_assembly_schema.SSMParameterContextQuery = {\n account: 'account',\n parameterName: 'parameterName',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n};",
5269
- "custom": {
5270
- "exampleMetadata": "fixture=_generated"
5271
- }
5110
+ "summary": "Query to SSM Parameter Context Provider."
5272
5111
  },
5273
5112
  "fqn": "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery",
5274
5113
  "kind": "interface",
5275
5114
  "locationInModule": {
5276
5115
  "filename": "lib/cloud-assembly/context-queries.ts",
5277
- "line": 167
5116
+ "line": 166
5278
5117
  },
5279
5118
  "name": "SSMParameterContextQuery",
5280
5119
  "properties": [
@@ -5287,7 +5126,7 @@
5287
5126
  "immutable": true,
5288
5127
  "locationInModule": {
5289
5128
  "filename": "lib/cloud-assembly/context-queries.ts",
5290
- "line": 171
5129
+ "line": 170
5291
5130
  },
5292
5131
  "name": "account",
5293
5132
  "type": {
@@ -5303,7 +5142,7 @@
5303
5142
  "immutable": true,
5304
5143
  "locationInModule": {
5305
5144
  "filename": "lib/cloud-assembly/context-queries.ts",
5306
- "line": 188
5145
+ "line": 187
5307
5146
  },
5308
5147
  "name": "parameterName",
5309
5148
  "type": {
@@ -5319,7 +5158,7 @@
5319
5158
  "immutable": true,
5320
5159
  "locationInModule": {
5321
5160
  "filename": "lib/cloud-assembly/context-queries.ts",
5322
- "line": 176
5161
+ "line": 175
5323
5162
  },
5324
5163
  "name": "region",
5325
5164
  "type": {
@@ -5336,7 +5175,7 @@
5336
5175
  "immutable": true,
5337
5176
  "locationInModule": {
5338
5177
  "filename": "lib/cloud-assembly/context-queries.ts",
5339
- "line": 183
5178
+ "line": 182
5340
5179
  },
5341
5180
  "name": "lookupRoleArn",
5342
5181
  "optional": true,
@@ -5352,17 +5191,13 @@
5352
5191
  "datatype": true,
5353
5192
  "docs": {
5354
5193
  "stability": "stable",
5355
- "summary": "Query input for looking up a security group.",
5356
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst securityGroupContextQuery: cloud_assembly_schema.SecurityGroupContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n securityGroupId: 'securityGroupId',\n securityGroupName: 'securityGroupName',\n vpcId: 'vpcId',\n};",
5357
- "custom": {
5358
- "exampleMetadata": "fixture=_generated"
5359
- }
5194
+ "summary": "Query input for looking up a security group."
5360
5195
  },
5361
5196
  "fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery",
5362
5197
  "kind": "interface",
5363
5198
  "locationInModule": {
5364
5199
  "filename": "lib/cloud-assembly/context-queries.ts",
5365
- "line": 414
5200
+ "line": 413
5366
5201
  },
5367
5202
  "name": "SecurityGroupContextQuery",
5368
5203
  "properties": [
@@ -5375,7 +5210,7 @@
5375
5210
  "immutable": true,
5376
5211
  "locationInModule": {
5377
5212
  "filename": "lib/cloud-assembly/context-queries.ts",
5378
- "line": 418
5213
+ "line": 417
5379
5214
  },
5380
5215
  "name": "account",
5381
5216
  "type": {
@@ -5391,7 +5226,7 @@
5391
5226
  "immutable": true,
5392
5227
  "locationInModule": {
5393
5228
  "filename": "lib/cloud-assembly/context-queries.ts",
5394
- "line": 423
5229
+ "line": 422
5395
5230
  },
5396
5231
  "name": "region",
5397
5232
  "type": {
@@ -5408,7 +5243,7 @@
5408
5243
  "immutable": true,
5409
5244
  "locationInModule": {
5410
5245
  "filename": "lib/cloud-assembly/context-queries.ts",
5411
- "line": 430
5246
+ "line": 429
5412
5247
  },
5413
5248
  "name": "lookupRoleArn",
5414
5249
  "optional": true,
@@ -5426,7 +5261,7 @@
5426
5261
  "immutable": true,
5427
5262
  "locationInModule": {
5428
5263
  "filename": "lib/cloud-assembly/context-queries.ts",
5429
- "line": 437
5264
+ "line": 436
5430
5265
  },
5431
5266
  "name": "securityGroupId",
5432
5267
  "optional": true,
@@ -5444,7 +5279,7 @@
5444
5279
  "immutable": true,
5445
5280
  "locationInModule": {
5446
5281
  "filename": "lib/cloud-assembly/context-queries.ts",
5447
- "line": 444
5282
+ "line": 443
5448
5283
  },
5449
5284
  "name": "securityGroupName",
5450
5285
  "optional": true,
@@ -5462,7 +5297,7 @@
5462
5297
  "immutable": true,
5463
5298
  "locationInModule": {
5464
5299
  "filename": "lib/cloud-assembly/context-queries.ts",
5465
- "line": 451
5300
+ "line": 450
5466
5301
  },
5467
5302
  "name": "vpcId",
5468
5303
  "optional": true,
@@ -5478,11 +5313,7 @@
5478
5313
  "datatype": true,
5479
5314
  "docs": {
5480
5315
  "stability": "stable",
5481
- "summary": "Metadata Entry spec for stack tag.",
5482
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst tag: cloud_assembly_schema.Tag = {\n key: 'key',\n value: 'value',\n};",
5483
- "custom": {
5484
- "exampleMetadata": "fixture=_generated"
5485
- }
5316
+ "summary": "Metadata Entry spec for stack tag."
5486
5317
  },
5487
5318
  "fqn": "@aws-cdk/cloud-assembly-schema.Tag",
5488
5319
  "kind": "interface",
@@ -5534,11 +5365,7 @@
5534
5365
  "datatype": true,
5535
5366
  "docs": {
5536
5367
  "stability": "stable",
5537
- "summary": "Represents an integration test case.",
5538
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst testCase: cloud_assembly_schema.TestCase = {\n stacks: ['stacks'],\n\n // the properties below are optional\n allowDestroy: ['allowDestroy'],\n assertionStack: 'assertionStack',\n assertionStackName: 'assertionStackName',\n cdkCommandOptions: {\n deploy: {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n changeSetName: 'changeSetName',\n ci: false,\n color: false,\n concurrency: 123,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n execute: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n notificationArns: ['notificationArns'],\n output: 'output',\n outputsFile: 'outputsFile',\n parameters: {\n parametersKey: 'parameters',\n },\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n requireApproval: cloud_assembly_schema.RequireApproval.NEVER,\n reuseAssets: ['reuseAssets'],\n roleArn: 'roleArn',\n rollback: false,\n stacks: ['stacks'],\n staging: false,\n strict: false,\n toolkitStackName: 'toolkitStackName',\n trace: false,\n usePreviousParameters: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n },\n destroy: {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n color: false,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n output: 'output',\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n roleArn: 'roleArn',\n stacks: ['stacks'],\n staging: false,\n strict: false,\n trace: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n },\n },\n diffAssets: false,\n hooks: {\n postDeploy: ['postDeploy'],\n postDestroy: ['postDestroy'],\n preDeploy: ['preDeploy'],\n preDestroy: ['preDestroy'],\n },\n regions: ['regions'],\n stackUpdateWorkflow: false,\n};",
5539
- "custom": {
5540
- "exampleMetadata": "fixture=_generated"
5541
- }
5368
+ "summary": "Represents an integration test case."
5542
5369
  },
5543
5370
  "fqn": "@aws-cdk/cloud-assembly-schema.TestCase",
5544
5371
  "interfaces": [
@@ -5617,11 +5444,7 @@
5617
5444
  "datatype": true,
5618
5445
  "docs": {
5619
5446
  "stability": "stable",
5620
- "summary": "The set of options to control the workflow of the test runner.",
5621
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst testOptions: cloud_assembly_schema.TestOptions = {\n allowDestroy: ['allowDestroy'],\n cdkCommandOptions: {\n deploy: {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n changeSetName: 'changeSetName',\n ci: false,\n color: false,\n concurrency: 123,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n execute: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n notificationArns: ['notificationArns'],\n output: 'output',\n outputsFile: 'outputsFile',\n parameters: {\n parametersKey: 'parameters',\n },\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n requireApproval: cloud_assembly_schema.RequireApproval.NEVER,\n reuseAssets: ['reuseAssets'],\n roleArn: 'roleArn',\n rollback: false,\n stacks: ['stacks'],\n staging: false,\n strict: false,\n toolkitStackName: 'toolkitStackName',\n trace: false,\n usePreviousParameters: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n },\n destroy: {\n args: {\n all: false,\n app: 'app',\n assetMetadata: false,\n caBundlePath: 'caBundlePath',\n color: false,\n context: {\n contextKey: 'context',\n },\n debug: false,\n ec2Creds: false,\n exclusively: false,\n force: false,\n ignoreErrors: false,\n json: false,\n lookups: false,\n notices: false,\n output: 'output',\n pathMetadata: false,\n profile: 'profile',\n proxy: 'proxy',\n roleArn: 'roleArn',\n stacks: ['stacks'],\n staging: false,\n strict: false,\n trace: false,\n verbose: false,\n versionReporting: false,\n },\n enabled: false,\n expectedMessage: 'expectedMessage',\n expectError: false,\n },\n },\n diffAssets: false,\n hooks: {\n postDeploy: ['postDeploy'],\n postDestroy: ['postDestroy'],\n preDeploy: ['preDeploy'],\n preDestroy: ['preDestroy'],\n },\n regions: ['regions'],\n stackUpdateWorkflow: false,\n};",
5622
- "custom": {
5623
- "exampleMetadata": "fixture=_generated"
5624
- }
5447
+ "summary": "The set of options to control the workflow of the test runner."
5625
5448
  },
5626
5449
  "fqn": "@aws-cdk/cloud-assembly-schema.TestOptions",
5627
5450
  "kind": "interface",
@@ -5760,17 +5583,13 @@
5760
5583
  "datatype": true,
5761
5584
  "docs": {
5762
5585
  "stability": "stable",
5763
- "summary": "Artifact properties for the Construct Tree Artifact.",
5764
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst treeArtifactProperties: cloud_assembly_schema.TreeArtifactProperties = {\n file: 'file',\n};",
5765
- "custom": {
5766
- "exampleMetadata": "fixture=_generated"
5767
- }
5586
+ "summary": "Artifact properties for the Construct Tree Artifact."
5768
5587
  },
5769
5588
  "fqn": "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties",
5770
5589
  "kind": "interface",
5771
5590
  "locationInModule": {
5772
5591
  "filename": "lib/cloud-assembly/artifact-schema.ts",
5773
- "line": 174
5592
+ "line": 173
5774
5593
  },
5775
5594
  "name": "TreeArtifactProperties",
5776
5595
  "properties": [
@@ -5783,7 +5602,7 @@
5783
5602
  "immutable": true,
5784
5603
  "locationInModule": {
5785
5604
  "filename": "lib/cloud-assembly/artifact-schema.ts",
5786
- "line": 178
5605
+ "line": 177
5787
5606
  },
5788
5607
  "name": "file",
5789
5608
  "type": {
@@ -5798,17 +5617,13 @@
5798
5617
  "datatype": true,
5799
5618
  "docs": {
5800
5619
  "stability": "stable",
5801
- "summary": "Query input for looking up a VPC.",
5802
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst vpcContextQuery: cloud_assembly_schema.VpcContextQuery = {\n account: 'account',\n filter: {\n filterKey: 'filter',\n },\n region: 'region',\n\n // the properties below are optional\n lookupRoleArn: 'lookupRoleArn',\n returnAsymmetricSubnets: false,\n returnVpnGateways: false,\n subnetGroupNameTag: 'subnetGroupNameTag',\n};",
5803
- "custom": {
5804
- "exampleMetadata": "fixture=_generated"
5805
- }
5620
+ "summary": "Query input for looking up a VPC."
5806
5621
  },
5807
5622
  "fqn": "@aws-cdk/cloud-assembly-schema.VpcContextQuery",
5808
5623
  "kind": "interface",
5809
5624
  "locationInModule": {
5810
5625
  "filename": "lib/cloud-assembly/context-queries.ts",
5811
- "line": 194
5626
+ "line": 193
5812
5627
  },
5813
5628
  "name": "VpcContextQuery",
5814
5629
  "properties": [
@@ -5821,7 +5636,7 @@
5821
5636
  "immutable": true,
5822
5637
  "locationInModule": {
5823
5638
  "filename": "lib/cloud-assembly/context-queries.ts",
5824
- "line": 198
5639
+ "line": 197
5825
5640
  },
5826
5641
  "name": "account",
5827
5642
  "type": {
@@ -5839,7 +5654,7 @@
5839
5654
  "immutable": true,
5840
5655
  "locationInModule": {
5841
5656
  "filename": "lib/cloud-assembly/context-queries.ts",
5842
- "line": 219
5657
+ "line": 218
5843
5658
  },
5844
5659
  "name": "filter",
5845
5660
  "type": {
@@ -5860,7 +5675,7 @@
5860
5675
  "immutable": true,
5861
5676
  "locationInModule": {
5862
5677
  "filename": "lib/cloud-assembly/context-queries.ts",
5863
- "line": 203
5678
+ "line": 202
5864
5679
  },
5865
5680
  "name": "region",
5866
5681
  "type": {
@@ -5877,7 +5692,7 @@
5877
5692
  "immutable": true,
5878
5693
  "locationInModule": {
5879
5694
  "filename": "lib/cloud-assembly/context-queries.ts",
5880
- "line": 210
5695
+ "line": 209
5881
5696
  },
5882
5697
  "name": "lookupRoleArn",
5883
5698
  "optional": true,
@@ -5895,7 +5710,7 @@
5895
5710
  "immutable": true,
5896
5711
  "locationInModule": {
5897
5712
  "filename": "lib/cloud-assembly/context-queries.ts",
5898
- "line": 227
5713
+ "line": 226
5899
5714
  },
5900
5715
  "name": "returnAsymmetricSubnets",
5901
5716
  "optional": true,
@@ -5914,7 +5729,7 @@
5914
5729
  "immutable": true,
5915
5730
  "locationInModule": {
5916
5731
  "filename": "lib/cloud-assembly/context-queries.ts",
5917
- "line": 247
5732
+ "line": 246
5918
5733
  },
5919
5734
  "name": "returnVpnGateways",
5920
5735
  "optional": true,
@@ -5933,7 +5748,7 @@
5933
5748
  "immutable": true,
5934
5749
  "locationInModule": {
5935
5750
  "filename": "lib/cloud-assembly/context-queries.ts",
5936
- "line": 237
5751
+ "line": 236
5937
5752
  },
5938
5753
  "name": "subnetGroupNameTag",
5939
5754
  "optional": true,
@@ -5945,6 +5760,6 @@
5945
5760
  "symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
5946
5761
  }
5947
5762
  },
5948
- "version": "2.151.0",
5949
- "fingerprint": "**********"
5763
+ "version": "36.0.1",
5764
+ "fingerprint": "N+2zh/iQfnHjKcjBaYsH5btVXAvRBa+q72QZNaif8qo="
5950
5765
  }