@aws-cdk/cloud-assembly-schema 53.27.0 → 54.0.0
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 +459 -107
- package/.jsii.tabl.json +1 -1
- package/cli-version.json +1 -1
- package/lib/cloud-assembly/validation-report-schema.d.ts +85 -1
- package/lib/cloud-assembly/validation-report-schema.js +2 -2
- package/lib/integ-tests/test-case.d.ts +9 -0
- package/lib/integ-tests/test-case.js +1 -1
- package/lib/manifest.js +1 -1
- package/node_modules/semver/classes/range.js +7 -0
- package/node_modules/semver/package.json +1 -1
- package/node_modules/semver/ranges/subset.js +2 -2
- package/package.json +16 -10
- package/rosetta/_generated.ts-fixture +6 -0
- package/schema/integ.schema.json +5 -0
- package/schema/validation-report.schema.json +64 -0
- package/schema/version.json +2 -2
package/.jsii
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
},
|
|
10
10
|
"bundled": {
|
|
11
11
|
"jsonschema": "^1.5.0",
|
|
12
|
-
"semver": "^7.8.
|
|
12
|
+
"semver": "^7.8.1"
|
|
13
13
|
},
|
|
14
14
|
"description": "Schema for the protocol between CDK framework and CDK CLI",
|
|
15
15
|
"docs": {
|
|
@@ -74,7 +74,11 @@
|
|
|
74
74
|
"datatype": true,
|
|
75
75
|
"docs": {
|
|
76
76
|
"stability": "stable",
|
|
77
|
-
"summary": "Query to AMI context provider."
|
|
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';\n\ndeclare const assumeRoleAdditionalOptions: any;\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n owners: ['owners'],\n};",
|
|
79
|
+
"custom": {
|
|
80
|
+
"exampleMetadata": "fixture=_generated"
|
|
81
|
+
}
|
|
78
82
|
},
|
|
79
83
|
"fqn": "@aws-cdk/cloud-assembly-schema.AmiContextQuery",
|
|
80
84
|
"interfaces": [
|
|
@@ -144,7 +148,11 @@
|
|
|
144
148
|
"datatype": true,
|
|
145
149
|
"docs": {
|
|
146
150
|
"stability": "stable",
|
|
147
|
-
"summary": "A manifest for a single artifact within the cloud assembly."
|
|
151
|
+
"summary": "A manifest for a single artifact within the cloud assembly.",
|
|
152
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst artifactManifest: cloud_assembly_schema.ArtifactManifest = {\n type: cloud_assembly_schema.ArtifactType.NONE,\n\n // the properties below are optional\n additionalMetadataFile: 'additionalMetadataFile',\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n notificationArns: ['notificationArns'],\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};",
|
|
153
|
+
"custom": {
|
|
154
|
+
"exampleMetadata": "fixture=_generated"
|
|
155
|
+
}
|
|
148
156
|
},
|
|
149
157
|
"fqn": "@aws-cdk/cloud-assembly-schema.ArtifactManifest",
|
|
150
158
|
"kind": "interface",
|
|
@@ -461,7 +469,11 @@
|
|
|
461
469
|
"datatype": true,
|
|
462
470
|
"docs": {
|
|
463
471
|
"stability": "stable",
|
|
464
|
-
"summary": "A manifest which describes the cloud assembly."
|
|
472
|
+
"summary": "A manifest which describes the cloud assembly.",
|
|
473
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\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 additionalMetadataFile: 'additionalMetadataFile',\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n notificationArns: ['notificationArns'],\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 minimumCliVersion: 'minimumCliVersion',\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n }],\n runtime: {\n libraries: {\n librariesKey: 'libraries',\n },\n },\n};",
|
|
474
|
+
"custom": {
|
|
475
|
+
"exampleMetadata": "fixture=_generated"
|
|
476
|
+
}
|
|
465
477
|
},
|
|
466
478
|
"fqn": "@aws-cdk/cloud-assembly-schema.AssemblyManifest",
|
|
467
479
|
"kind": "interface",
|
|
@@ -579,7 +591,11 @@
|
|
|
579
591
|
"datatype": true,
|
|
580
592
|
"docs": {
|
|
581
593
|
"stability": "stable",
|
|
582
|
-
"summary": "Definitions for the asset manifest."
|
|
594
|
+
"summary": "Definitions for the asset manifest.",
|
|
595
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\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 dockerBuildContexts: {\n dockerBuildContextsKey: 'dockerBuildContexts',\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 // the properties below are optional\n displayName: 'displayName',\n },\n },\n files: {\n filesKey: {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\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 // the properties below are optional\n displayName: 'displayName',\n },\n },\n};",
|
|
596
|
+
"custom": {
|
|
597
|
+
"exampleMetadata": "fixture=_generated"
|
|
598
|
+
}
|
|
583
599
|
},
|
|
584
600
|
"fqn": "@aws-cdk/cloud-assembly-schema.AssetManifest",
|
|
585
601
|
"kind": "interface",
|
|
@@ -659,7 +675,11 @@
|
|
|
659
675
|
"datatype": true,
|
|
660
676
|
"docs": {
|
|
661
677
|
"stability": "stable",
|
|
662
|
-
"summary": "Configuration options for the Asset Manifest."
|
|
678
|
+
"summary": "Configuration options for the Asset Manifest.",
|
|
679
|
+
"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};",
|
|
680
|
+
"custom": {
|
|
681
|
+
"exampleMetadata": "fixture=_generated"
|
|
682
|
+
}
|
|
663
683
|
},
|
|
664
684
|
"fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestOptions",
|
|
665
685
|
"kind": "interface",
|
|
@@ -714,7 +734,11 @@
|
|
|
714
734
|
"datatype": true,
|
|
715
735
|
"docs": {
|
|
716
736
|
"stability": "stable",
|
|
717
|
-
"summary": "Artifact properties for the Asset Manifest."
|
|
737
|
+
"summary": "Artifact properties for the Asset Manifest.",
|
|
738
|
+
"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};",
|
|
739
|
+
"custom": {
|
|
740
|
+
"exampleMetadata": "fixture=_generated"
|
|
741
|
+
}
|
|
718
742
|
},
|
|
719
743
|
"fqn": "@aws-cdk/cloud-assembly-schema.AssetManifestProperties",
|
|
720
744
|
"interfaces": [
|
|
@@ -751,7 +775,11 @@
|
|
|
751
775
|
"datatype": true,
|
|
752
776
|
"docs": {
|
|
753
777
|
"stability": "stable",
|
|
754
|
-
"summary": "Query to availability zone context provider."
|
|
778
|
+
"summary": "Query to availability zone context provider.",
|
|
779
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst availabilityZonesContextQuery: cloud_assembly_schema.AvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n};",
|
|
780
|
+
"custom": {
|
|
781
|
+
"exampleMetadata": "fixture=_generated"
|
|
782
|
+
}
|
|
755
783
|
},
|
|
756
784
|
"fqn": "@aws-cdk/cloud-assembly-schema.AvailabilityZonesContextQuery",
|
|
757
785
|
"interfaces": [
|
|
@@ -770,7 +798,11 @@
|
|
|
770
798
|
"datatype": true,
|
|
771
799
|
"docs": {
|
|
772
800
|
"stability": "stable",
|
|
773
|
-
"summary": "Artifact properties for CloudFormation stacks."
|
|
801
|
+
"summary": "Artifact properties for CloudFormation stacks.",
|
|
802
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst awsCloudFormationStackProperties: cloud_assembly_schema.AwsCloudFormationStackProperties = {\n templateFile: 'templateFile',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n },\n notificationArns: ['notificationArns'],\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};",
|
|
803
|
+
"custom": {
|
|
804
|
+
"exampleMetadata": "fixture=_generated"
|
|
805
|
+
}
|
|
774
806
|
},
|
|
775
807
|
"fqn": "@aws-cdk/cloud-assembly-schema.AwsCloudFormationStackProperties",
|
|
776
808
|
"kind": "interface",
|
|
@@ -1080,7 +1112,11 @@
|
|
|
1080
1112
|
"datatype": true,
|
|
1081
1113
|
"docs": {
|
|
1082
1114
|
"stability": "stable",
|
|
1083
|
-
"summary": "Destination for assets that need to be uploaded to AWS."
|
|
1115
|
+
"summary": "Destination for assets that need to be uploaded to AWS.",
|
|
1116
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst awsDestination: cloud_assembly_schema.AwsDestination = {\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
|
|
1117
|
+
"custom": {
|
|
1118
|
+
"exampleMetadata": "fixture=_generated"
|
|
1119
|
+
}
|
|
1084
1120
|
},
|
|
1085
1121
|
"fqn": "@aws-cdk/cloud-assembly-schema.AwsDestination",
|
|
1086
1122
|
"kind": "interface",
|
|
@@ -1177,7 +1213,11 @@
|
|
|
1177
1213
|
"datatype": true,
|
|
1178
1214
|
"docs": {
|
|
1179
1215
|
"stability": "stable",
|
|
1180
|
-
"summary": "Information needed to access an IAM role created as part of the bootstrap process."
|
|
1216
|
+
"summary": "Information needed to access an IAM role created as part of the bootstrap process.",
|
|
1217
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst bootstrapRole: cloud_assembly_schema.BootstrapRole = {\n arn: 'arn',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleExternalId: 'assumeRoleExternalId',\n bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n requiresBootstrapStackVersion: 123,\n};",
|
|
1218
|
+
"custom": {
|
|
1219
|
+
"exampleMetadata": "fixture=_generated"
|
|
1220
|
+
}
|
|
1181
1221
|
},
|
|
1182
1222
|
"fqn": "@aws-cdk/cloud-assembly-schema.BootstrapRole",
|
|
1183
1223
|
"kind": "interface",
|
|
@@ -1476,13 +1516,17 @@
|
|
|
1476
1516
|
"datatype": true,
|
|
1477
1517
|
"docs": {
|
|
1478
1518
|
"stability": "stable",
|
|
1479
|
-
"summary": "Represents a cdk command i.e. `synth`, `deploy`, & `destroy`."
|
|
1519
|
+
"summary": "Represents a cdk command i.e. `synth`, `deploy`, & `destroy`.",
|
|
1520
|
+
"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};",
|
|
1521
|
+
"custom": {
|
|
1522
|
+
"exampleMetadata": "fixture=_generated"
|
|
1523
|
+
}
|
|
1480
1524
|
},
|
|
1481
1525
|
"fqn": "@aws-cdk/cloud-assembly-schema.CdkCommand",
|
|
1482
1526
|
"kind": "interface",
|
|
1483
1527
|
"locationInModule": {
|
|
1484
1528
|
"filename": "lib/integ-tests/test-case.ts",
|
|
1485
|
-
"line":
|
|
1529
|
+
"line": 145
|
|
1486
1530
|
},
|
|
1487
1531
|
"name": "CdkCommand",
|
|
1488
1532
|
"properties": [
|
|
@@ -1496,7 +1540,7 @@
|
|
|
1496
1540
|
"immutable": true,
|
|
1497
1541
|
"locationInModule": {
|
|
1498
1542
|
"filename": "lib/integ-tests/test-case.ts",
|
|
1499
|
-
"line":
|
|
1543
|
+
"line": 154
|
|
1500
1544
|
},
|
|
1501
1545
|
"name": "enabled",
|
|
1502
1546
|
"optional": true,
|
|
@@ -1514,7 +1558,7 @@
|
|
|
1514
1558
|
"immutable": true,
|
|
1515
1559
|
"locationInModule": {
|
|
1516
1560
|
"filename": "lib/integ-tests/test-case.ts",
|
|
1517
|
-
"line":
|
|
1561
|
+
"line": 169
|
|
1518
1562
|
},
|
|
1519
1563
|
"name": "expectedMessage",
|
|
1520
1564
|
"optional": true,
|
|
@@ -1532,7 +1576,7 @@
|
|
|
1532
1576
|
"immutable": true,
|
|
1533
1577
|
"locationInModule": {
|
|
1534
1578
|
"filename": "lib/integ-tests/test-case.ts",
|
|
1535
|
-
"line":
|
|
1579
|
+
"line": 161
|
|
1536
1580
|
},
|
|
1537
1581
|
"name": "expectError",
|
|
1538
1582
|
"optional": true,
|
|
@@ -1548,13 +1592,17 @@
|
|
|
1548
1592
|
"datatype": true,
|
|
1549
1593
|
"docs": {
|
|
1550
1594
|
"stability": "stable",
|
|
1551
|
-
"summary": "Options for specific cdk commands that are run as part of the integration test workflow."
|
|
1595
|
+
"summary": "Options for specific cdk commands that are run as part of the integration test workflow.",
|
|
1596
|
+
"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};",
|
|
1597
|
+
"custom": {
|
|
1598
|
+
"exampleMetadata": "fixture=_generated"
|
|
1599
|
+
}
|
|
1552
1600
|
},
|
|
1553
1601
|
"fqn": "@aws-cdk/cloud-assembly-schema.CdkCommands",
|
|
1554
1602
|
"kind": "interface",
|
|
1555
1603
|
"locationInModule": {
|
|
1556
1604
|
"filename": "lib/integ-tests/test-case.ts",
|
|
1557
|
-
"line":
|
|
1605
|
+
"line": 202
|
|
1558
1606
|
},
|
|
1559
1607
|
"name": "CdkCommands",
|
|
1560
1608
|
"properties": [
|
|
@@ -1568,7 +1616,7 @@
|
|
|
1568
1616
|
"immutable": true,
|
|
1569
1617
|
"locationInModule": {
|
|
1570
1618
|
"filename": "lib/integ-tests/test-case.ts",
|
|
1571
|
-
"line":
|
|
1619
|
+
"line": 208
|
|
1572
1620
|
},
|
|
1573
1621
|
"name": "deploy",
|
|
1574
1622
|
"optional": true,
|
|
@@ -1586,7 +1634,7 @@
|
|
|
1586
1634
|
"immutable": true,
|
|
1587
1635
|
"locationInModule": {
|
|
1588
1636
|
"filename": "lib/integ-tests/test-case.ts",
|
|
1589
|
-
"line":
|
|
1637
|
+
"line": 215
|
|
1590
1638
|
},
|
|
1591
1639
|
"name": "destroy",
|
|
1592
1640
|
"optional": true,
|
|
@@ -1602,13 +1650,17 @@
|
|
|
1602
1650
|
"datatype": true,
|
|
1603
1651
|
"docs": {
|
|
1604
1652
|
"stability": "stable",
|
|
1605
|
-
"summary": "A node in the construct creation stack trace."
|
|
1653
|
+
"summary": "A node in the construct creation stack trace.",
|
|
1654
|
+
"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 cloudFormationResourceJson: cloud_assembly_schema.CloudFormationResourceJson = {\n logicalId: 'logicalId',\n templatePath: 'templatePath',\n\n // the properties below are optional\n propertyPaths: ['propertyPaths'],\n};",
|
|
1655
|
+
"custom": {
|
|
1656
|
+
"exampleMetadata": "fixture=_generated"
|
|
1657
|
+
}
|
|
1606
1658
|
},
|
|
1607
1659
|
"fqn": "@aws-cdk/cloud-assembly-schema.CloudFormationResourceJson",
|
|
1608
1660
|
"kind": "interface",
|
|
1609
1661
|
"locationInModule": {
|
|
1610
1662
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
1611
|
-
"line":
|
|
1663
|
+
"line": 256
|
|
1612
1664
|
},
|
|
1613
1665
|
"name": "CloudFormationResourceJson",
|
|
1614
1666
|
"properties": [
|
|
@@ -1621,7 +1673,7 @@
|
|
|
1621
1673
|
"immutable": true,
|
|
1622
1674
|
"locationInModule": {
|
|
1623
1675
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
1624
|
-
"line":
|
|
1676
|
+
"line": 265
|
|
1625
1677
|
},
|
|
1626
1678
|
"name": "logicalId",
|
|
1627
1679
|
"type": {
|
|
@@ -1637,7 +1689,7 @@
|
|
|
1637
1689
|
"immutable": true,
|
|
1638
1690
|
"locationInModule": {
|
|
1639
1691
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
1640
|
-
"line":
|
|
1692
|
+
"line": 260
|
|
1641
1693
|
},
|
|
1642
1694
|
"name": "templatePath",
|
|
1643
1695
|
"type": {
|
|
@@ -1655,7 +1707,7 @@
|
|
|
1655
1707
|
"immutable": true,
|
|
1656
1708
|
"locationInModule": {
|
|
1657
1709
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
1658
|
-
"line":
|
|
1710
|
+
"line": 275
|
|
1659
1711
|
},
|
|
1660
1712
|
"name": "propertyPaths",
|
|
1661
1713
|
"optional": true,
|
|
@@ -1676,7 +1728,11 @@
|
|
|
1676
1728
|
"datatype": true,
|
|
1677
1729
|
"docs": {
|
|
1678
1730
|
"stability": "stable",
|
|
1679
|
-
"summary": "Options for configuring the Docker cache backend."
|
|
1731
|
+
"summary": "Options for configuring the Docker cache backend.",
|
|
1732
|
+
"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};",
|
|
1733
|
+
"custom": {
|
|
1734
|
+
"exampleMetadata": "fixture=_generated"
|
|
1735
|
+
}
|
|
1680
1736
|
},
|
|
1681
1737
|
"fqn": "@aws-cdk/cloud-assembly-schema.ContainerImageAssetCacheOption",
|
|
1682
1738
|
"kind": "interface",
|
|
@@ -2123,7 +2179,11 @@
|
|
|
2123
2179
|
"datatype": true,
|
|
2124
2180
|
"docs": {
|
|
2125
2181
|
"stability": "stable",
|
|
2126
|
-
"summary": "Options for context lookup roles."
|
|
2182
|
+
"summary": "Options for context lookup roles.",
|
|
2183
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst contextLookupRoleOptions: cloud_assembly_schema.ContextLookupRoleOptions = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n};",
|
|
2184
|
+
"custom": {
|
|
2185
|
+
"exampleMetadata": "fixture=_generated"
|
|
2186
|
+
}
|
|
2127
2187
|
},
|
|
2128
2188
|
"fqn": "@aws-cdk/cloud-assembly-schema.ContextLookupRoleOptions",
|
|
2129
2189
|
"kind": "interface",
|
|
@@ -2335,7 +2395,11 @@
|
|
|
2335
2395
|
"datatype": true,
|
|
2336
2396
|
"docs": {
|
|
2337
2397
|
"stability": "stable",
|
|
2338
|
-
"summary": "Default CDK CLI options that apply to all commands."
|
|
2398
|
+
"summary": "Default CDK CLI options that apply to all commands.",
|
|
2399
|
+
"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};",
|
|
2400
|
+
"custom": {
|
|
2401
|
+
"exampleMetadata": "fixture=_generated"
|
|
2402
|
+
}
|
|
2339
2403
|
},
|
|
2340
2404
|
"fqn": "@aws-cdk/cloud-assembly-schema.DefaultCdkOptions",
|
|
2341
2405
|
"kind": "interface",
|
|
@@ -2782,7 +2846,11 @@
|
|
|
2782
2846
|
"datatype": true,
|
|
2783
2847
|
"docs": {
|
|
2784
2848
|
"stability": "stable",
|
|
2785
|
-
"summary": "Represents a cdk deploy command."
|
|
2849
|
+
"summary": "Represents a cdk deploy command.",
|
|
2850
|
+
"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};",
|
|
2851
|
+
"custom": {
|
|
2852
|
+
"exampleMetadata": "fixture=_generated"
|
|
2853
|
+
}
|
|
2786
2854
|
},
|
|
2787
2855
|
"fqn": "@aws-cdk/cloud-assembly-schema.DeployCommand",
|
|
2788
2856
|
"interfaces": [
|
|
@@ -2791,7 +2859,7 @@
|
|
|
2791
2859
|
"kind": "interface",
|
|
2792
2860
|
"locationInModule": {
|
|
2793
2861
|
"filename": "lib/integ-tests/test-case.ts",
|
|
2794
|
-
"line":
|
|
2862
|
+
"line": 175
|
|
2795
2863
|
},
|
|
2796
2864
|
"name": "DeployCommand",
|
|
2797
2865
|
"properties": [
|
|
@@ -2805,7 +2873,7 @@
|
|
|
2805
2873
|
"immutable": true,
|
|
2806
2874
|
"locationInModule": {
|
|
2807
2875
|
"filename": "lib/integ-tests/test-case.ts",
|
|
2808
|
-
"line":
|
|
2876
|
+
"line": 182
|
|
2809
2877
|
},
|
|
2810
2878
|
"name": "args",
|
|
2811
2879
|
"optional": true,
|
|
@@ -2821,7 +2889,11 @@
|
|
|
2821
2889
|
"datatype": true,
|
|
2822
2890
|
"docs": {
|
|
2823
2891
|
"stability": "stable",
|
|
2824
|
-
"summary": "Options to use with cdk deploy."
|
|
2892
|
+
"summary": "Options to use with cdk deploy.",
|
|
2893
|
+
"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};",
|
|
2894
|
+
"custom": {
|
|
2895
|
+
"exampleMetadata": "fixture=_generated"
|
|
2896
|
+
}
|
|
2825
2897
|
},
|
|
2826
2898
|
"fqn": "@aws-cdk/cloud-assembly-schema.DeployOptions",
|
|
2827
2899
|
"interfaces": [
|
|
@@ -3111,7 +3183,11 @@
|
|
|
3111
3183
|
"datatype": true,
|
|
3112
3184
|
"docs": {
|
|
3113
3185
|
"stability": "stable",
|
|
3114
|
-
"summary": "Represents a cdk destroy command."
|
|
3186
|
+
"summary": "Represents a cdk destroy command.",
|
|
3187
|
+
"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};",
|
|
3188
|
+
"custom": {
|
|
3189
|
+
"exampleMetadata": "fixture=_generated"
|
|
3190
|
+
}
|
|
3115
3191
|
},
|
|
3116
3192
|
"fqn": "@aws-cdk/cloud-assembly-schema.DestroyCommand",
|
|
3117
3193
|
"interfaces": [
|
|
@@ -3120,7 +3196,7 @@
|
|
|
3120
3196
|
"kind": "interface",
|
|
3121
3197
|
"locationInModule": {
|
|
3122
3198
|
"filename": "lib/integ-tests/test-case.ts",
|
|
3123
|
-
"line":
|
|
3199
|
+
"line": 188
|
|
3124
3200
|
},
|
|
3125
3201
|
"name": "DestroyCommand",
|
|
3126
3202
|
"properties": [
|
|
@@ -3134,7 +3210,7 @@
|
|
|
3134
3210
|
"immutable": true,
|
|
3135
3211
|
"locationInModule": {
|
|
3136
3212
|
"filename": "lib/integ-tests/test-case.ts",
|
|
3137
|
-
"line":
|
|
3213
|
+
"line": 195
|
|
3138
3214
|
},
|
|
3139
3215
|
"name": "args",
|
|
3140
3216
|
"optional": true,
|
|
@@ -3150,7 +3226,11 @@
|
|
|
3150
3226
|
"datatype": true,
|
|
3151
3227
|
"docs": {
|
|
3152
3228
|
"stability": "stable",
|
|
3153
|
-
"summary": "Options to use with cdk destroy."
|
|
3229
|
+
"summary": "Options to use with cdk destroy.",
|
|
3230
|
+
"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};",
|
|
3231
|
+
"custom": {
|
|
3232
|
+
"exampleMetadata": "fixture=_generated"
|
|
3233
|
+
}
|
|
3154
3234
|
},
|
|
3155
3235
|
"fqn": "@aws-cdk/cloud-assembly-schema.DestroyOptions",
|
|
3156
3236
|
"interfaces": [
|
|
@@ -3207,7 +3287,11 @@
|
|
|
3207
3287
|
"datatype": true,
|
|
3208
3288
|
"docs": {
|
|
3209
3289
|
"stability": "stable",
|
|
3210
|
-
"summary": "Options for configuring the Docker cache backend."
|
|
3290
|
+
"summary": "Options for configuring the Docker cache backend.",
|
|
3291
|
+
"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};",
|
|
3292
|
+
"custom": {
|
|
3293
|
+
"exampleMetadata": "fixture=_generated"
|
|
3294
|
+
}
|
|
3211
3295
|
},
|
|
3212
3296
|
"fqn": "@aws-cdk/cloud-assembly-schema.DockerCacheOption",
|
|
3213
3297
|
"kind": "interface",
|
|
@@ -3269,7 +3353,11 @@
|
|
|
3269
3353
|
"datatype": true,
|
|
3270
3354
|
"docs": {
|
|
3271
3355
|
"stability": "stable",
|
|
3272
|
-
"summary": "A file asset."
|
|
3356
|
+
"summary": "A file asset.",
|
|
3357
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst dockerImageAsset: cloud_assembly_schema.DockerImageAsset = {\n destinations: {\n destinationsKey: {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\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 dockerBuildContexts: {\n dockerBuildContextsKey: 'dockerBuildContexts',\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 // the properties below are optional\n displayName: 'displayName',\n};",
|
|
3358
|
+
"custom": {
|
|
3359
|
+
"exampleMetadata": "fixture=_generated"
|
|
3360
|
+
}
|
|
3273
3361
|
},
|
|
3274
3362
|
"fqn": "@aws-cdk/cloud-assembly-schema.DockerImageAsset",
|
|
3275
3363
|
"kind": "interface",
|
|
@@ -3342,7 +3430,11 @@
|
|
|
3342
3430
|
"datatype": true,
|
|
3343
3431
|
"docs": {
|
|
3344
3432
|
"stability": "stable",
|
|
3345
|
-
"summary": "Where to publish docker images."
|
|
3433
|
+
"summary": "Where to publish docker images.",
|
|
3434
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst dockerImageDestination: cloud_assembly_schema.DockerImageDestination = {\n imageTag: 'imageTag',\n repositoryName: 'repositoryName',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
|
|
3435
|
+
"custom": {
|
|
3436
|
+
"exampleMetadata": "fixture=_generated"
|
|
3437
|
+
}
|
|
3346
3438
|
},
|
|
3347
3439
|
"fqn": "@aws-cdk/cloud-assembly-schema.DockerImageDestination",
|
|
3348
3440
|
"interfaces": [
|
|
@@ -3395,7 +3487,11 @@
|
|
|
3395
3487
|
"datatype": true,
|
|
3396
3488
|
"docs": {
|
|
3397
3489
|
"stability": "stable",
|
|
3398
|
-
"summary": "Properties for how to produce a Docker image from a source."
|
|
3490
|
+
"summary": "Properties for how to produce a Docker image from a source.",
|
|
3491
|
+
"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 dockerBuildContexts: {\n dockerBuildContextsKey: 'dockerBuildContexts',\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};",
|
|
3492
|
+
"custom": {
|
|
3493
|
+
"exampleMetadata": "fixture=_generated"
|
|
3494
|
+
}
|
|
3399
3495
|
},
|
|
3400
3496
|
"fqn": "@aws-cdk/cloud-assembly-schema.DockerImageSource",
|
|
3401
3497
|
"kind": "interface",
|
|
@@ -3707,7 +3803,11 @@
|
|
|
3707
3803
|
"datatype": true,
|
|
3708
3804
|
"docs": {
|
|
3709
3805
|
"stability": "stable",
|
|
3710
|
-
"summary": "Query to endpoint service context provider."
|
|
3806
|
+
"summary": "Query to endpoint service context provider.",
|
|
3807
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst endpointServiceAvailabilityZonesContextQuery: cloud_assembly_schema.EndpointServiceAvailabilityZonesContextQuery = {\n account: 'account',\n region: 'region',\n serviceName: 'serviceName',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n};",
|
|
3808
|
+
"custom": {
|
|
3809
|
+
"exampleMetadata": "fixture=_generated"
|
|
3810
|
+
}
|
|
3711
3811
|
},
|
|
3712
3812
|
"fqn": "@aws-cdk/cloud-assembly-schema.EndpointServiceAvailabilityZonesContextQuery",
|
|
3713
3813
|
"interfaces": [
|
|
@@ -3744,7 +3844,11 @@
|
|
|
3744
3844
|
"datatype": true,
|
|
3745
3845
|
"docs": {
|
|
3746
3846
|
"stability": "stable",
|
|
3747
|
-
"summary": "A single feature flag."
|
|
3847
|
+
"summary": "A single feature flag.",
|
|
3848
|
+
"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';\n\ndeclare const recommendedValue: any;\ndeclare const userValue: any;\ndeclare const v1: any;\ndeclare const v2: any;\nconst featureFlag: cloud_assembly_schema.FeatureFlag = {\n explanation: 'explanation',\n recommendedValue: recommendedValue,\n unconfiguredBehavesLike: {\n v1: v1,\n v2: v2,\n },\n userValue: userValue,\n};",
|
|
3849
|
+
"custom": {
|
|
3850
|
+
"exampleMetadata": "fixture=_generated"
|
|
3851
|
+
}
|
|
3748
3852
|
},
|
|
3749
3853
|
"fqn": "@aws-cdk/cloud-assembly-schema.FeatureFlag",
|
|
3750
3854
|
"kind": "interface",
|
|
@@ -3838,7 +3942,11 @@
|
|
|
3838
3942
|
"docs": {
|
|
3839
3943
|
"remarks": "A feature flag report is small enough that all the properties can be inlined\nhere, and doesn't need an additional file.",
|
|
3840
3944
|
"stability": "stable",
|
|
3841
|
-
"summary": "Artifact properties for a feature flag report."
|
|
3945
|
+
"summary": "Artifact properties for a feature flag report.",
|
|
3946
|
+
"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';\n\ndeclare const recommendedValue: any;\ndeclare const userValue: any;\ndeclare const v1: any;\ndeclare const v2: any;\nconst featureFlagReportProperties: cloud_assembly_schema.FeatureFlagReportProperties = {\n flags: {\n flagsKey: {\n explanation: 'explanation',\n recommendedValue: recommendedValue,\n unconfiguredBehavesLike: {\n v1: v1,\n v2: v2,\n },\n userValue: userValue,\n },\n },\n module: 'module',\n};",
|
|
3947
|
+
"custom": {
|
|
3948
|
+
"exampleMetadata": "fixture=_generated"
|
|
3949
|
+
}
|
|
3842
3950
|
},
|
|
3843
3951
|
"fqn": "@aws-cdk/cloud-assembly-schema.FeatureFlagReportProperties",
|
|
3844
3952
|
"kind": "interface",
|
|
@@ -3893,7 +4001,11 @@
|
|
|
3893
4001
|
"datatype": true,
|
|
3894
4002
|
"docs": {
|
|
3895
4003
|
"stability": "stable",
|
|
3896
|
-
"summary": "A file asset."
|
|
4004
|
+
"summary": "A file asset.",
|
|
4005
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst fileAsset: cloud_assembly_schema.FileAsset = {\n destinations: {\n destinationsKey: {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\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 // the properties below are optional\n displayName: 'displayName',\n};",
|
|
4006
|
+
"custom": {
|
|
4007
|
+
"exampleMetadata": "fixture=_generated"
|
|
4008
|
+
}
|
|
3897
4009
|
},
|
|
3898
4010
|
"fqn": "@aws-cdk/cloud-assembly-schema.FileAsset",
|
|
3899
4011
|
"kind": "interface",
|
|
@@ -4128,7 +4240,11 @@
|
|
|
4128
4240
|
"datatype": true,
|
|
4129
4241
|
"docs": {
|
|
4130
4242
|
"stability": "stable",
|
|
4131
|
-
"summary": "Where in S3 a file asset needs to be published."
|
|
4243
|
+
"summary": "Where in S3 a file asset needs to be published.",
|
|
4244
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst fileDestination: cloud_assembly_schema.FileDestination = {\n bucketName: 'bucketName',\n objectKey: 'objectKey',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n assumeRoleArn: 'assumeRoleArn',\n assumeRoleExternalId: 'assumeRoleExternalId',\n region: 'region',\n};",
|
|
4245
|
+
"custom": {
|
|
4246
|
+
"exampleMetadata": "fixture=_generated"
|
|
4247
|
+
}
|
|
4132
4248
|
},
|
|
4133
4249
|
"fqn": "@aws-cdk/cloud-assembly-schema.FileDestination",
|
|
4134
4250
|
"interfaces": [
|
|
@@ -4181,7 +4297,11 @@
|
|
|
4181
4297
|
"datatype": true,
|
|
4182
4298
|
"docs": {
|
|
4183
4299
|
"stability": "stable",
|
|
4184
|
-
"summary": "Describe the source of a file asset."
|
|
4300
|
+
"summary": "Describe the source of a file asset.",
|
|
4301
|
+
"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};",
|
|
4302
|
+
"custom": {
|
|
4303
|
+
"exampleMetadata": "fixture=_generated"
|
|
4304
|
+
}
|
|
4185
4305
|
},
|
|
4186
4306
|
"fqn": "@aws-cdk/cloud-assembly-schema.FileSource",
|
|
4187
4307
|
"kind": "interface",
|
|
@@ -4260,13 +4380,17 @@
|
|
|
4260
4380
|
"datatype": true,
|
|
4261
4381
|
"docs": {
|
|
4262
4382
|
"stability": "stable",
|
|
4263
|
-
"summary": "Commands to run at predefined points during the integration test workflow."
|
|
4383
|
+
"summary": "Commands to run at predefined points during the integration test workflow.",
|
|
4384
|
+
"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};",
|
|
4385
|
+
"custom": {
|
|
4386
|
+
"exampleMetadata": "fixture=_generated"
|
|
4387
|
+
}
|
|
4264
4388
|
},
|
|
4265
4389
|
"fqn": "@aws-cdk/cloud-assembly-schema.Hooks",
|
|
4266
4390
|
"kind": "interface",
|
|
4267
4391
|
"locationInModule": {
|
|
4268
4392
|
"filename": "lib/integ-tests/test-case.ts",
|
|
4269
|
-
"line":
|
|
4393
|
+
"line": 107
|
|
4270
4394
|
},
|
|
4271
4395
|
"name": "Hooks",
|
|
4272
4396
|
"properties": [
|
|
@@ -4280,7 +4404,7 @@
|
|
|
4280
4404
|
"immutable": true,
|
|
4281
4405
|
"locationInModule": {
|
|
4282
4406
|
"filename": "lib/integ-tests/test-case.ts",
|
|
4283
|
-
"line":
|
|
4407
|
+
"line": 122
|
|
4284
4408
|
},
|
|
4285
4409
|
"name": "postDeploy",
|
|
4286
4410
|
"optional": true,
|
|
@@ -4303,7 +4427,7 @@
|
|
|
4303
4427
|
"immutable": true,
|
|
4304
4428
|
"locationInModule": {
|
|
4305
4429
|
"filename": "lib/integ-tests/test-case.ts",
|
|
4306
|
-
"line":
|
|
4430
|
+
"line": 138
|
|
4307
4431
|
},
|
|
4308
4432
|
"name": "postDestroy",
|
|
4309
4433
|
"optional": true,
|
|
@@ -4326,7 +4450,7 @@
|
|
|
4326
4450
|
"immutable": true,
|
|
4327
4451
|
"locationInModule": {
|
|
4328
4452
|
"filename": "lib/integ-tests/test-case.ts",
|
|
4329
|
-
"line":
|
|
4453
|
+
"line": 114
|
|
4330
4454
|
},
|
|
4331
4455
|
"name": "preDeploy",
|
|
4332
4456
|
"optional": true,
|
|
@@ -4349,7 +4473,7 @@
|
|
|
4349
4473
|
"immutable": true,
|
|
4350
4474
|
"locationInModule": {
|
|
4351
4475
|
"filename": "lib/integ-tests/test-case.ts",
|
|
4352
|
-
"line":
|
|
4476
|
+
"line": 130
|
|
4353
4477
|
},
|
|
4354
4478
|
"name": "preDestroy",
|
|
4355
4479
|
"optional": true,
|
|
@@ -4370,7 +4494,11 @@
|
|
|
4370
4494
|
"datatype": true,
|
|
4371
4495
|
"docs": {
|
|
4372
4496
|
"stability": "stable",
|
|
4373
|
-
"summary": "Query to hosted zone context provider."
|
|
4497
|
+
"summary": "Query to hosted zone context provider.",
|
|
4498
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst hostedZoneContextQuery: cloud_assembly_schema.HostedZoneContextQuery = {\n account: 'account',\n domainName: 'domainName',\n region: 'region',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n privateZone: false,\n vpcId: 'vpcId',\n};",
|
|
4499
|
+
"custom": {
|
|
4500
|
+
"exampleMetadata": "fixture=_generated"
|
|
4501
|
+
}
|
|
4374
4502
|
},
|
|
4375
4503
|
"fqn": "@aws-cdk/cloud-assembly-schema.HostedZoneContextQuery",
|
|
4376
4504
|
"interfaces": [
|
|
@@ -4479,7 +4607,11 @@
|
|
|
4479
4607
|
"datatype": true,
|
|
4480
4608
|
"docs": {
|
|
4481
4609
|
"stability": "stable",
|
|
4482
|
-
"summary": "Definitions for the integration testing manifest."
|
|
4610
|
+
"summary": "Definitions for the integration testing manifest.",
|
|
4611
|
+
"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 allowDeleteFailures: false,\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};",
|
|
4612
|
+
"custom": {
|
|
4613
|
+
"exampleMetadata": "fixture=_generated"
|
|
4614
|
+
}
|
|
4483
4615
|
},
|
|
4484
4616
|
"fqn": "@aws-cdk/cloud-assembly-schema.IntegManifest",
|
|
4485
4617
|
"kind": "interface",
|
|
@@ -4577,7 +4709,11 @@
|
|
|
4577
4709
|
"datatype": true,
|
|
4578
4710
|
"docs": {
|
|
4579
4711
|
"stability": "stable",
|
|
4580
|
-
"summary": "Query input for looking up a KMS Key."
|
|
4712
|
+
"summary": "Query input for looking up a KMS Key.",
|
|
4713
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst keyContextQuery: cloud_assembly_schema.KeyContextQuery = {\n account: 'account',\n aliasName: 'aliasName',\n region: 'region',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n};",
|
|
4714
|
+
"custom": {
|
|
4715
|
+
"exampleMetadata": "fixture=_generated"
|
|
4716
|
+
}
|
|
4581
4717
|
},
|
|
4582
4718
|
"fqn": "@aws-cdk/cloud-assembly-schema.KeyContextQuery",
|
|
4583
4719
|
"interfaces": [
|
|
@@ -4614,7 +4750,11 @@
|
|
|
4614
4750
|
"datatype": true,
|
|
4615
4751
|
"docs": {
|
|
4616
4752
|
"stability": "stable",
|
|
4617
|
-
"summary": "Query input for looking up a load balancer."
|
|
4753
|
+
"summary": "Query input for looking up a load balancer.",
|
|
4754
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n};",
|
|
4755
|
+
"custom": {
|
|
4756
|
+
"exampleMetadata": "fixture=_generated"
|
|
4757
|
+
}
|
|
4618
4758
|
},
|
|
4619
4759
|
"fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerContextQuery",
|
|
4620
4760
|
"interfaces": [
|
|
@@ -4633,7 +4773,11 @@
|
|
|
4633
4773
|
"datatype": true,
|
|
4634
4774
|
"docs": {
|
|
4635
4775
|
"stability": "stable",
|
|
4636
|
-
"summary": "Filters for selecting load balancers."
|
|
4776
|
+
"summary": "Filters for selecting load balancers.",
|
|
4777
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst loadBalancerFilter: cloud_assembly_schema.LoadBalancerFilter = {\n account: 'account',\n loadBalancerType: cloud_assembly_schema.LoadBalancerType.NETWORK,\n region: 'region',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n loadBalancerArn: 'loadBalancerArn',\n loadBalancerTags: [{\n key: 'key',\n value: 'value',\n }],\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n};",
|
|
4778
|
+
"custom": {
|
|
4779
|
+
"exampleMetadata": "fixture=_generated"
|
|
4780
|
+
}
|
|
4637
4781
|
},
|
|
4638
4782
|
"fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerFilter",
|
|
4639
4783
|
"interfaces": [
|
|
@@ -4711,7 +4855,11 @@
|
|
|
4711
4855
|
"datatype": true,
|
|
4712
4856
|
"docs": {
|
|
4713
4857
|
"stability": "stable",
|
|
4714
|
-
"summary": "Query input for looking up a load balancer listener."
|
|
4858
|
+
"summary": "Query input for looking up a load balancer listener.",
|
|
4859
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\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 lookupRoleExternalId: 'lookupRoleExternalId',\n};",
|
|
4860
|
+
"custom": {
|
|
4861
|
+
"exampleMetadata": "fixture=_generated"
|
|
4862
|
+
}
|
|
4715
4863
|
},
|
|
4716
4864
|
"fqn": "@aws-cdk/cloud-assembly-schema.LoadBalancerListenerContextQuery",
|
|
4717
4865
|
"interfaces": [
|
|
@@ -4876,7 +5024,11 @@
|
|
|
4876
5024
|
"datatype": true,
|
|
4877
5025
|
"docs": {
|
|
4878
5026
|
"stability": "stable",
|
|
4879
|
-
"summary": "Options for the loadManifest operation."
|
|
5027
|
+
"summary": "Options for the loadManifest operation.",
|
|
5028
|
+
"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 validateSchema: false,\n};",
|
|
5029
|
+
"custom": {
|
|
5030
|
+
"exampleMetadata": "fixture=_generated"
|
|
5031
|
+
}
|
|
4880
5032
|
},
|
|
4881
5033
|
"fqn": "@aws-cdk/cloud-assembly-schema.LoadManifestOptions",
|
|
4882
5034
|
"kind": "interface",
|
|
@@ -5296,7 +5448,11 @@
|
|
|
5296
5448
|
"datatype": true,
|
|
5297
5449
|
"docs": {
|
|
5298
5450
|
"stability": "stable",
|
|
5299
|
-
"summary": "A metadata entry in a cloud assembly artifact."
|
|
5451
|
+
"summary": "A metadata entry in a cloud assembly artifact.",
|
|
5452
|
+
"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};",
|
|
5453
|
+
"custom": {
|
|
5454
|
+
"exampleMetadata": "fixture=_generated"
|
|
5455
|
+
}
|
|
5300
5456
|
},
|
|
5301
5457
|
"fqn": "@aws-cdk/cloud-assembly-schema.MetadataEntry",
|
|
5302
5458
|
"kind": "interface",
|
|
@@ -5409,7 +5565,11 @@
|
|
|
5409
5565
|
"datatype": true,
|
|
5410
5566
|
"docs": {
|
|
5411
5567
|
"stability": "stable",
|
|
5412
|
-
"summary": "Represents a missing piece of context."
|
|
5568
|
+
"summary": "Represents a missing piece of context.",
|
|
5569
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n owners: ['owners'],\n },\n provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n};",
|
|
5570
|
+
"custom": {
|
|
5571
|
+
"exampleMetadata": "fixture=_generated"
|
|
5572
|
+
}
|
|
5413
5573
|
},
|
|
5414
5574
|
"fqn": "@aws-cdk/cloud-assembly-schema.MissingContext",
|
|
5415
5575
|
"kind": "interface",
|
|
@@ -5514,7 +5674,11 @@
|
|
|
5514
5674
|
"datatype": true,
|
|
5515
5675
|
"docs": {
|
|
5516
5676
|
"stability": "stable",
|
|
5517
|
-
"summary": "Artifact properties for nested cloud assemblies."
|
|
5677
|
+
"summary": "Artifact properties for nested cloud assemblies.",
|
|
5678
|
+
"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};",
|
|
5679
|
+
"custom": {
|
|
5680
|
+
"exampleMetadata": "fixture=_generated"
|
|
5681
|
+
}
|
|
5518
5682
|
},
|
|
5519
5683
|
"fqn": "@aws-cdk/cloud-assembly-schema.NestedCloudAssemblyProperties",
|
|
5520
5684
|
"kind": "interface",
|
|
@@ -5567,7 +5731,11 @@
|
|
|
5567
5731
|
"docs": {
|
|
5568
5732
|
"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.",
|
|
5569
5733
|
"stability": "stable",
|
|
5570
|
-
"summary": "Query input for plugins."
|
|
5734
|
+
"summary": "Query input for plugins.",
|
|
5735
|
+
"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};",
|
|
5736
|
+
"custom": {
|
|
5737
|
+
"exampleMetadata": "fixture=_generated"
|
|
5738
|
+
}
|
|
5571
5739
|
},
|
|
5572
5740
|
"fqn": "@aws-cdk/cloud-assembly-schema.PluginContextQuery",
|
|
5573
5741
|
"kind": "interface",
|
|
@@ -5600,6 +5768,7 @@
|
|
|
5600
5768
|
"assembly": "@aws-cdk/cloud-assembly-schema",
|
|
5601
5769
|
"datatype": true,
|
|
5602
5770
|
"docs": {
|
|
5771
|
+
"example": "import { PluginReportJson } from '@aws-cdk/cloud-assembly-schema';\n\nconst report: PluginReportJson = {\n pluginName: 'my-plugin',\n conclusion: 'success',\n violations: [],\n};",
|
|
5603
5772
|
"stability": "stable",
|
|
5604
5773
|
"summary": "A report from a single validation plugin."
|
|
5605
5774
|
},
|
|
@@ -5607,7 +5776,7 @@
|
|
|
5607
5776
|
"kind": "interface",
|
|
5608
5777
|
"locationInModule": {
|
|
5609
5778
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5610
|
-
"line":
|
|
5779
|
+
"line": 52
|
|
5611
5780
|
},
|
|
5612
5781
|
"name": "PluginReportJson",
|
|
5613
5782
|
"properties": [
|
|
@@ -5620,7 +5789,7 @@
|
|
|
5620
5789
|
"immutable": true,
|
|
5621
5790
|
"locationInModule": {
|
|
5622
5791
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5623
|
-
"line":
|
|
5792
|
+
"line": 68
|
|
5624
5793
|
},
|
|
5625
5794
|
"name": "conclusion",
|
|
5626
5795
|
"type": {
|
|
@@ -5636,7 +5805,7 @@
|
|
|
5636
5805
|
"immutable": true,
|
|
5637
5806
|
"locationInModule": {
|
|
5638
5807
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5639
|
-
"line":
|
|
5808
|
+
"line": 56
|
|
5640
5809
|
},
|
|
5641
5810
|
"name": "pluginName",
|
|
5642
5811
|
"type": {
|
|
@@ -5652,7 +5821,7 @@
|
|
|
5652
5821
|
"immutable": true,
|
|
5653
5822
|
"locationInModule": {
|
|
5654
5823
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5655
|
-
"line":
|
|
5824
|
+
"line": 80
|
|
5656
5825
|
},
|
|
5657
5826
|
"name": "violations",
|
|
5658
5827
|
"type": {
|
|
@@ -5674,7 +5843,7 @@
|
|
|
5674
5843
|
"immutable": true,
|
|
5675
5844
|
"locationInModule": {
|
|
5676
5845
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5677
|
-
"line":
|
|
5846
|
+
"line": 75
|
|
5678
5847
|
},
|
|
5679
5848
|
"name": "metadata",
|
|
5680
5849
|
"optional": true,
|
|
@@ -5697,13 +5866,37 @@
|
|
|
5697
5866
|
"immutable": true,
|
|
5698
5867
|
"locationInModule": {
|
|
5699
5868
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5700
|
-
"line":
|
|
5869
|
+
"line": 63
|
|
5701
5870
|
},
|
|
5702
5871
|
"name": "pluginVersion",
|
|
5703
5872
|
"optional": true,
|
|
5704
5873
|
"type": {
|
|
5705
5874
|
"primitive": "string"
|
|
5706
5875
|
}
|
|
5876
|
+
},
|
|
5877
|
+
{
|
|
5878
|
+
"abstract": true,
|
|
5879
|
+
"docs": {
|
|
5880
|
+
"default": "- no suppressed violations",
|
|
5881
|
+
"remarks": "These violations matched an acknowledged rule ID and were excluded\nfrom the active violations list. They are retained for audit\ntrail and reporting purposes.",
|
|
5882
|
+
"stability": "stable",
|
|
5883
|
+
"summary": "Violations that were suppressed via acknowledgement."
|
|
5884
|
+
},
|
|
5885
|
+
"immutable": true,
|
|
5886
|
+
"locationInModule": {
|
|
5887
|
+
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5888
|
+
"line": 91
|
|
5889
|
+
},
|
|
5890
|
+
"name": "suppressedViolations",
|
|
5891
|
+
"optional": true,
|
|
5892
|
+
"type": {
|
|
5893
|
+
"collection": {
|
|
5894
|
+
"elementtype": {
|
|
5895
|
+
"fqn": "@aws-cdk/cloud-assembly-schema.SuppressedViolationJson"
|
|
5896
|
+
},
|
|
5897
|
+
"kind": "array"
|
|
5898
|
+
}
|
|
5899
|
+
}
|
|
5707
5900
|
}
|
|
5708
5901
|
],
|
|
5709
5902
|
"symbolId": "lib/cloud-assembly/validation-report-schema:PluginReportJson"
|
|
@@ -5712,6 +5905,7 @@
|
|
|
5712
5905
|
"assembly": "@aws-cdk/cloud-assembly-schema",
|
|
5713
5906
|
"datatype": true,
|
|
5714
5907
|
"docs": {
|
|
5908
|
+
"example": "import { PolicyValidationReportJson } from '@aws-cdk/cloud-assembly-schema';\n\nconst report: PolicyValidationReportJson = {\n version: '1.0',\n pluginReports: [{\n pluginName: 'my-plugin',\n conclusion: 'success',\n violations: [],\n }],\n};",
|
|
5715
5909
|
"stability": "stable",
|
|
5716
5910
|
"summary": "The top-level structure of the policy validation report file."
|
|
5717
5911
|
},
|
|
@@ -5719,7 +5913,7 @@
|
|
|
5719
5913
|
"kind": "interface",
|
|
5720
5914
|
"locationInModule": {
|
|
5721
5915
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5722
|
-
"line":
|
|
5916
|
+
"line": 23
|
|
5723
5917
|
},
|
|
5724
5918
|
"name": "PolicyValidationReportJson",
|
|
5725
5919
|
"properties": [
|
|
@@ -5732,7 +5926,7 @@
|
|
|
5732
5926
|
"immutable": true,
|
|
5733
5927
|
"locationInModule": {
|
|
5734
5928
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5735
|
-
"line":
|
|
5929
|
+
"line": 37
|
|
5736
5930
|
},
|
|
5737
5931
|
"name": "pluginReports",
|
|
5738
5932
|
"type": {
|
|
@@ -5753,7 +5947,7 @@
|
|
|
5753
5947
|
"immutable": true,
|
|
5754
5948
|
"locationInModule": {
|
|
5755
5949
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5756
|
-
"line":
|
|
5950
|
+
"line": 27
|
|
5757
5951
|
},
|
|
5758
5952
|
"name": "version",
|
|
5759
5953
|
"type": {
|
|
@@ -5769,7 +5963,7 @@
|
|
|
5769
5963
|
"immutable": true,
|
|
5770
5964
|
"locationInModule": {
|
|
5771
5965
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5772
|
-
"line":
|
|
5966
|
+
"line": 32
|
|
5773
5967
|
},
|
|
5774
5968
|
"name": "title",
|
|
5775
5969
|
"optional": true,
|
|
@@ -5784,6 +5978,7 @@
|
|
|
5784
5978
|
"assembly": "@aws-cdk/cloud-assembly-schema",
|
|
5785
5979
|
"datatype": true,
|
|
5786
5980
|
"docs": {
|
|
5981
|
+
"example": "import { PolicyViolationJson } from '@aws-cdk/cloud-assembly-schema';\n\nconst violation: PolicyViolationJson = {\n ruleName: 'no-public-access',\n description: 'S3 bucket should not allow public access',\n severity: 'error',\n violatingConstructs: [{ constructPath: 'MyStack/MyBucket' }],\n};",
|
|
5787
5982
|
"stability": "stable",
|
|
5788
5983
|
"summary": "A single policy violation found by a validation plugin."
|
|
5789
5984
|
},
|
|
@@ -5791,7 +5986,7 @@
|
|
|
5791
5986
|
"kind": "interface",
|
|
5792
5987
|
"locationInModule": {
|
|
5793
5988
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5794
|
-
"line":
|
|
5989
|
+
"line": 112
|
|
5795
5990
|
},
|
|
5796
5991
|
"name": "PolicyViolationJson",
|
|
5797
5992
|
"properties": [
|
|
@@ -5804,7 +5999,7 @@
|
|
|
5804
5999
|
"immutable": true,
|
|
5805
6000
|
"locationInModule": {
|
|
5806
6001
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5807
|
-
"line":
|
|
6002
|
+
"line": 121
|
|
5808
6003
|
},
|
|
5809
6004
|
"name": "description",
|
|
5810
6005
|
"type": {
|
|
@@ -5820,7 +6015,7 @@
|
|
|
5820
6015
|
"immutable": true,
|
|
5821
6016
|
"locationInModule": {
|
|
5822
6017
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5823
|
-
"line":
|
|
6018
|
+
"line": 116
|
|
5824
6019
|
},
|
|
5825
6020
|
"name": "ruleName",
|
|
5826
6021
|
"type": {
|
|
@@ -5836,7 +6031,7 @@
|
|
|
5836
6031
|
"immutable": true,
|
|
5837
6032
|
"locationInModule": {
|
|
5838
6033
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5839
|
-
"line":
|
|
6034
|
+
"line": 133
|
|
5840
6035
|
},
|
|
5841
6036
|
"name": "severity",
|
|
5842
6037
|
"type": {
|
|
@@ -5852,7 +6047,7 @@
|
|
|
5852
6047
|
"immutable": true,
|
|
5853
6048
|
"locationInModule": {
|
|
5854
6049
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5855
|
-
"line":
|
|
6050
|
+
"line": 150
|
|
5856
6051
|
},
|
|
5857
6052
|
"name": "violatingConstructs",
|
|
5858
6053
|
"type": {
|
|
@@ -5873,7 +6068,7 @@
|
|
|
5873
6068
|
"immutable": true,
|
|
5874
6069
|
"locationInModule": {
|
|
5875
6070
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5876
|
-
"line":
|
|
6071
|
+
"line": 138
|
|
5877
6072
|
},
|
|
5878
6073
|
"name": "customSeverity",
|
|
5879
6074
|
"optional": true,
|
|
@@ -5891,7 +6086,7 @@
|
|
|
5891
6086
|
"immutable": true,
|
|
5892
6087
|
"locationInModule": {
|
|
5893
6088
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5894
|
-
"line":
|
|
6089
|
+
"line": 145
|
|
5895
6090
|
},
|
|
5896
6091
|
"name": "ruleMetadata",
|
|
5897
6092
|
"optional": true,
|
|
@@ -5914,7 +6109,7 @@
|
|
|
5914
6109
|
"immutable": true,
|
|
5915
6110
|
"locationInModule": {
|
|
5916
6111
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
5917
|
-
"line":
|
|
6112
|
+
"line": 128
|
|
5918
6113
|
},
|
|
5919
6114
|
"name": "suggestedFix",
|
|
5920
6115
|
"optional": true,
|
|
@@ -5930,7 +6125,11 @@
|
|
|
5930
6125
|
"datatype": true,
|
|
5931
6126
|
"docs": {
|
|
5932
6127
|
"stability": "stable",
|
|
5933
|
-
"summary": "Metadata type of a PropertyMutation."
|
|
6128
|
+
"summary": "Metadata type of a PropertyMutation.",
|
|
6129
|
+
"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 propertyMutationMetadataEntry: cloud_assembly_schema.PropertyMutationMetadataEntry = {\n propertyName: 'propertyName',\n stackTrace: ['stackTrace'],\n};",
|
|
6130
|
+
"custom": {
|
|
6131
|
+
"exampleMetadata": "fixture=_generated"
|
|
6132
|
+
}
|
|
5934
6133
|
},
|
|
5935
6134
|
"fqn": "@aws-cdk/cloud-assembly-schema.PropertyMutationMetadataEntry",
|
|
5936
6135
|
"kind": "interface",
|
|
@@ -6023,7 +6222,11 @@
|
|
|
6023
6222
|
"datatype": true,
|
|
6024
6223
|
"docs": {
|
|
6025
6224
|
"stability": "stable",
|
|
6026
|
-
"summary": "Information about the application's runtime components."
|
|
6225
|
+
"summary": "Information about the application's runtime components.",
|
|
6226
|
+
"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};",
|
|
6227
|
+
"custom": {
|
|
6228
|
+
"exampleMetadata": "fixture=_generated"
|
|
6229
|
+
}
|
|
6027
6230
|
},
|
|
6028
6231
|
"fqn": "@aws-cdk/cloud-assembly-schema.RuntimeInfo",
|
|
6029
6232
|
"kind": "interface",
|
|
@@ -6062,7 +6265,11 @@
|
|
|
6062
6265
|
"datatype": true,
|
|
6063
6266
|
"docs": {
|
|
6064
6267
|
"stability": "stable",
|
|
6065
|
-
"summary": "Query to SSM Parameter Context Provider."
|
|
6268
|
+
"summary": "Query to SSM Parameter Context Provider.",
|
|
6269
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst sSMParameterContextQuery: cloud_assembly_schema.SSMParameterContextQuery = {\n account: 'account',\n parameterName: 'parameterName',\n region: 'region',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n};",
|
|
6270
|
+
"custom": {
|
|
6271
|
+
"exampleMetadata": "fixture=_generated"
|
|
6272
|
+
}
|
|
6066
6273
|
},
|
|
6067
6274
|
"fqn": "@aws-cdk/cloud-assembly-schema.SSMParameterContextQuery",
|
|
6068
6275
|
"interfaces": [
|
|
@@ -6099,7 +6306,11 @@
|
|
|
6099
6306
|
"datatype": true,
|
|
6100
6307
|
"docs": {
|
|
6101
6308
|
"stability": "stable",
|
|
6102
|
-
"summary": "Query input for looking up a security group."
|
|
6309
|
+
"summary": "Query input for looking up a security group.",
|
|
6310
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\nconst securityGroupContextQuery: cloud_assembly_schema.SecurityGroupContextQuery = {\n account: 'account',\n region: 'region',\n\n // the properties below are optional\n assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n securityGroupId: 'securityGroupId',\n securityGroupName: 'securityGroupName',\n vpcId: 'vpcId',\n};",
|
|
6311
|
+
"custom": {
|
|
6312
|
+
"exampleMetadata": "fixture=_generated"
|
|
6313
|
+
}
|
|
6103
6314
|
},
|
|
6104
6315
|
"fqn": "@aws-cdk/cloud-assembly-schema.SecurityGroupContextQuery",
|
|
6105
6316
|
"interfaces": [
|
|
@@ -6169,12 +6380,110 @@
|
|
|
6169
6380
|
],
|
|
6170
6381
|
"symbolId": "lib/cloud-assembly/context-queries:SecurityGroupContextQuery"
|
|
6171
6382
|
},
|
|
6383
|
+
"@aws-cdk/cloud-assembly-schema.SuppressedViolationJson": {
|
|
6384
|
+
"assembly": "@aws-cdk/cloud-assembly-schema",
|
|
6385
|
+
"datatype": true,
|
|
6386
|
+
"docs": {
|
|
6387
|
+
"example": "import { SuppressedViolationJson } from '@aws-cdk/cloud-assembly-schema';\n\nconst suppressed: SuppressedViolationJson = {\n ruleName: 'no-public-access',\n description: 'S3 bucket should not allow public access',\n severity: 'warning',\n violatingConstructs: [{ constructPath: 'MyStack/MyBucket' }],\n acknowledgedId: 'my-plugin::no-public-access',\n};",
|
|
6388
|
+
"stability": "stable",
|
|
6389
|
+
"summary": "A violation that was acknowledged/suppressed and excluded from the active violation set."
|
|
6390
|
+
},
|
|
6391
|
+
"fqn": "@aws-cdk/cloud-assembly-schema.SuppressedViolationJson",
|
|
6392
|
+
"interfaces": [
|
|
6393
|
+
"@aws-cdk/cloud-assembly-schema.PolicyViolationJson"
|
|
6394
|
+
],
|
|
6395
|
+
"kind": "interface",
|
|
6396
|
+
"locationInModule": {
|
|
6397
|
+
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6398
|
+
"line": 221
|
|
6399
|
+
},
|
|
6400
|
+
"name": "SuppressedViolationJson",
|
|
6401
|
+
"properties": [
|
|
6402
|
+
{
|
|
6403
|
+
"abstract": true,
|
|
6404
|
+
"docs": {
|
|
6405
|
+
"remarks": "Format: `<plugin-name>::<rule-name>` (spaces replaced with hyphens).",
|
|
6406
|
+
"stability": "stable",
|
|
6407
|
+
"summary": "The acknowledgement ID that caused this violation to be suppressed."
|
|
6408
|
+
},
|
|
6409
|
+
"immutable": true,
|
|
6410
|
+
"locationInModule": {
|
|
6411
|
+
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6412
|
+
"line": 227
|
|
6413
|
+
},
|
|
6414
|
+
"name": "acknowledgedId",
|
|
6415
|
+
"type": {
|
|
6416
|
+
"primitive": "string"
|
|
6417
|
+
}
|
|
6418
|
+
},
|
|
6419
|
+
{
|
|
6420
|
+
"abstract": true,
|
|
6421
|
+
"docs": {
|
|
6422
|
+
"default": "- unknown",
|
|
6423
|
+
"stability": "stable",
|
|
6424
|
+
"summary": "The construct path where the acknowledgement was declared."
|
|
6425
|
+
},
|
|
6426
|
+
"immutable": true,
|
|
6427
|
+
"locationInModule": {
|
|
6428
|
+
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6429
|
+
"line": 241
|
|
6430
|
+
},
|
|
6431
|
+
"name": "acknowledgedAt",
|
|
6432
|
+
"optional": true,
|
|
6433
|
+
"type": {
|
|
6434
|
+
"primitive": "string"
|
|
6435
|
+
}
|
|
6436
|
+
},
|
|
6437
|
+
{
|
|
6438
|
+
"abstract": true,
|
|
6439
|
+
"docs": {
|
|
6440
|
+
"default": "- no stack trace",
|
|
6441
|
+
"remarks": "A `\\n`-delimited string of stack frames.",
|
|
6442
|
+
"stability": "stable",
|
|
6443
|
+
"summary": "Stack trace showing where the acknowledgement was declared."
|
|
6444
|
+
},
|
|
6445
|
+
"immutable": true,
|
|
6446
|
+
"locationInModule": {
|
|
6447
|
+
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6448
|
+
"line": 250
|
|
6449
|
+
},
|
|
6450
|
+
"name": "acknowledgedStackTrace",
|
|
6451
|
+
"optional": true,
|
|
6452
|
+
"type": {
|
|
6453
|
+
"primitive": "string"
|
|
6454
|
+
}
|
|
6455
|
+
},
|
|
6456
|
+
{
|
|
6457
|
+
"abstract": true,
|
|
6458
|
+
"docs": {
|
|
6459
|
+
"default": "- no reason given",
|
|
6460
|
+
"stability": "stable",
|
|
6461
|
+
"summary": "The reason given for the acknowledgement, if provided."
|
|
6462
|
+
},
|
|
6463
|
+
"immutable": true,
|
|
6464
|
+
"locationInModule": {
|
|
6465
|
+
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6466
|
+
"line": 234
|
|
6467
|
+
},
|
|
6468
|
+
"name": "reason",
|
|
6469
|
+
"optional": true,
|
|
6470
|
+
"type": {
|
|
6471
|
+
"primitive": "string"
|
|
6472
|
+
}
|
|
6473
|
+
}
|
|
6474
|
+
],
|
|
6475
|
+
"symbolId": "lib/cloud-assembly/validation-report-schema:SuppressedViolationJson"
|
|
6476
|
+
},
|
|
6172
6477
|
"@aws-cdk/cloud-assembly-schema.Tag": {
|
|
6173
6478
|
"assembly": "@aws-cdk/cloud-assembly-schema",
|
|
6174
6479
|
"datatype": true,
|
|
6175
6480
|
"docs": {
|
|
6176
6481
|
"stability": "stable",
|
|
6177
|
-
"summary": "Metadata Entry spec for stack tag."
|
|
6482
|
+
"summary": "Metadata Entry spec for stack tag.",
|
|
6483
|
+
"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};",
|
|
6484
|
+
"custom": {
|
|
6485
|
+
"exampleMetadata": "fixture=_generated"
|
|
6486
|
+
}
|
|
6178
6487
|
},
|
|
6179
6488
|
"fqn": "@aws-cdk/cloud-assembly-schema.Tag",
|
|
6180
6489
|
"kind": "interface",
|
|
@@ -6226,7 +6535,11 @@
|
|
|
6226
6535
|
"datatype": true,
|
|
6227
6536
|
"docs": {
|
|
6228
6537
|
"stability": "stable",
|
|
6229
|
-
"summary": "Represents an integration test case."
|
|
6538
|
+
"summary": "Represents an integration test case.",
|
|
6539
|
+
"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 allowDeleteFailures: false,\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};",
|
|
6540
|
+
"custom": {
|
|
6541
|
+
"exampleMetadata": "fixture=_generated"
|
|
6542
|
+
}
|
|
6230
6543
|
},
|
|
6231
6544
|
"fqn": "@aws-cdk/cloud-assembly-schema.TestCase",
|
|
6232
6545
|
"interfaces": [
|
|
@@ -6235,7 +6548,7 @@
|
|
|
6235
6548
|
"kind": "interface",
|
|
6236
6549
|
"locationInModule": {
|
|
6237
6550
|
"filename": "lib/integ-tests/test-case.ts",
|
|
6238
|
-
"line":
|
|
6551
|
+
"line": 78
|
|
6239
6552
|
},
|
|
6240
6553
|
"name": "TestCase",
|
|
6241
6554
|
"properties": [
|
|
@@ -6248,7 +6561,7 @@
|
|
|
6248
6561
|
"immutable": true,
|
|
6249
6562
|
"locationInModule": {
|
|
6250
6563
|
"filename": "lib/integ-tests/test-case.ts",
|
|
6251
|
-
"line":
|
|
6564
|
+
"line": 85
|
|
6252
6565
|
},
|
|
6253
6566
|
"name": "stacks",
|
|
6254
6567
|
"type": {
|
|
@@ -6271,7 +6584,7 @@
|
|
|
6271
6584
|
"immutable": true,
|
|
6272
6585
|
"locationInModule": {
|
|
6273
6586
|
"filename": "lib/integ-tests/test-case.ts",
|
|
6274
|
-
"line":
|
|
6587
|
+
"line": 93
|
|
6275
6588
|
},
|
|
6276
6589
|
"name": "assertionStack",
|
|
6277
6590
|
"optional": true,
|
|
@@ -6289,7 +6602,7 @@
|
|
|
6289
6602
|
"immutable": true,
|
|
6290
6603
|
"locationInModule": {
|
|
6291
6604
|
"filename": "lib/integ-tests/test-case.ts",
|
|
6292
|
-
"line":
|
|
6605
|
+
"line": 100
|
|
6293
6606
|
},
|
|
6294
6607
|
"name": "assertionStackName",
|
|
6295
6608
|
"optional": true,
|
|
@@ -6305,7 +6618,11 @@
|
|
|
6305
6618
|
"datatype": true,
|
|
6306
6619
|
"docs": {
|
|
6307
6620
|
"stability": "stable",
|
|
6308
|
-
"summary": "The set of options to control the workflow of the test runner."
|
|
6621
|
+
"summary": "The set of options to control the workflow of the test runner.",
|
|
6622
|
+
"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 allowDeleteFailures: false,\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};",
|
|
6623
|
+
"custom": {
|
|
6624
|
+
"exampleMetadata": "fixture=_generated"
|
|
6625
|
+
}
|
|
6309
6626
|
},
|
|
6310
6627
|
"fqn": "@aws-cdk/cloud-assembly-schema.TestOptions",
|
|
6311
6628
|
"kind": "interface",
|
|
@@ -6315,6 +6632,25 @@
|
|
|
6315
6632
|
},
|
|
6316
6633
|
"name": "TestOptions",
|
|
6317
6634
|
"properties": [
|
|
6635
|
+
{
|
|
6636
|
+
"abstract": true,
|
|
6637
|
+
"docs": {
|
|
6638
|
+
"default": "false",
|
|
6639
|
+
"remarks": "When false, the test will fail if CloudFormation skips deleting a resource\nduring a stack update. When true, only a warning is printed.",
|
|
6640
|
+
"stability": "stable",
|
|
6641
|
+
"summary": "Whether to allow resources that fail to delete during a stack update."
|
|
6642
|
+
},
|
|
6643
|
+
"immutable": true,
|
|
6644
|
+
"locationInModule": {
|
|
6645
|
+
"filename": "lib/integ-tests/test-case.ts",
|
|
6646
|
+
"line": 40
|
|
6647
|
+
},
|
|
6648
|
+
"name": "allowDeleteFailures",
|
|
6649
|
+
"optional": true,
|
|
6650
|
+
"type": {
|
|
6651
|
+
"primitive": "boolean"
|
|
6652
|
+
}
|
|
6653
|
+
},
|
|
6318
6654
|
{
|
|
6319
6655
|
"abstract": true,
|
|
6320
6656
|
"docs": {
|
|
@@ -6326,7 +6662,7 @@
|
|
|
6326
6662
|
"immutable": true,
|
|
6327
6663
|
"locationInModule": {
|
|
6328
6664
|
"filename": "lib/integ-tests/test-case.ts",
|
|
6329
|
-
"line":
|
|
6665
|
+
"line": 65
|
|
6330
6666
|
},
|
|
6331
6667
|
"name": "allowDestroy",
|
|
6332
6668
|
"optional": true,
|
|
@@ -6368,7 +6704,7 @@
|
|
|
6368
6704
|
"immutable": true,
|
|
6369
6705
|
"locationInModule": {
|
|
6370
6706
|
"filename": "lib/integ-tests/test-case.ts",
|
|
6371
|
-
"line":
|
|
6707
|
+
"line": 50
|
|
6372
6708
|
},
|
|
6373
6709
|
"name": "diffAssets",
|
|
6374
6710
|
"optional": true,
|
|
@@ -6405,7 +6741,7 @@
|
|
|
6405
6741
|
"immutable": true,
|
|
6406
6742
|
"locationInModule": {
|
|
6407
6743
|
"filename": "lib/integ-tests/test-case.ts",
|
|
6408
|
-
"line":
|
|
6744
|
+
"line": 72
|
|
6409
6745
|
},
|
|
6410
6746
|
"name": "regions",
|
|
6411
6747
|
"optional": true,
|
|
@@ -6444,7 +6780,11 @@
|
|
|
6444
6780
|
"datatype": true,
|
|
6445
6781
|
"docs": {
|
|
6446
6782
|
"stability": "stable",
|
|
6447
|
-
"summary": "Artifact properties for the Construct Tree Artifact."
|
|
6783
|
+
"summary": "Artifact properties for the Construct Tree Artifact.",
|
|
6784
|
+
"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};",
|
|
6785
|
+
"custom": {
|
|
6786
|
+
"exampleMetadata": "fixture=_generated"
|
|
6787
|
+
}
|
|
6448
6788
|
},
|
|
6449
6789
|
"fqn": "@aws-cdk/cloud-assembly-schema.TreeArtifactProperties",
|
|
6450
6790
|
"kind": "interface",
|
|
@@ -6477,7 +6817,11 @@
|
|
|
6477
6817
|
"assembly": "@aws-cdk/cloud-assembly-schema",
|
|
6478
6818
|
"datatype": true,
|
|
6479
6819
|
"docs": {
|
|
6480
|
-
"stability": "stable"
|
|
6820
|
+
"stability": "stable",
|
|
6821
|
+
"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';\n\ndeclare const v1: any;\ndeclare const v2: any;\nconst unconfiguredBehavesLike: cloud_assembly_schema.UnconfiguredBehavesLike = {\n v1: v1,\n v2: v2,\n};",
|
|
6822
|
+
"custom": {
|
|
6823
|
+
"exampleMetadata": "fixture=_generated"
|
|
6824
|
+
}
|
|
6481
6825
|
},
|
|
6482
6826
|
"fqn": "@aws-cdk/cloud-assembly-schema.UnconfiguredBehavesLike",
|
|
6483
6827
|
"kind": "interface",
|
|
@@ -6533,13 +6877,17 @@
|
|
|
6533
6877
|
"datatype": true,
|
|
6534
6878
|
"docs": {
|
|
6535
6879
|
"stability": "stable",
|
|
6536
|
-
"summary": "A construct that violated a policy rule."
|
|
6880
|
+
"summary": "A construct that violated a policy rule.",
|
|
6881
|
+
"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 violatingConstructJson: cloud_assembly_schema.ViolatingConstructJson = {\n constructPath: 'constructPath',\n\n // the properties below are optional\n cloudFormationResource: {\n logicalId: 'logicalId',\n templatePath: 'templatePath',\n\n // the properties below are optional\n propertyPaths: ['propertyPaths'],\n },\n constructFqn: 'constructFqn',\n libraryVersion: 'libraryVersion',\n stackTraces: ['stackTraces'],\n};",
|
|
6882
|
+
"custom": {
|
|
6883
|
+
"exampleMetadata": "fixture=_generated"
|
|
6884
|
+
}
|
|
6537
6885
|
},
|
|
6538
6886
|
"fqn": "@aws-cdk/cloud-assembly-schema.ViolatingConstructJson",
|
|
6539
6887
|
"kind": "interface",
|
|
6540
6888
|
"locationInModule": {
|
|
6541
6889
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6542
|
-
"line":
|
|
6890
|
+
"line": 164
|
|
6543
6891
|
},
|
|
6544
6892
|
"name": "ViolatingConstructJson",
|
|
6545
6893
|
"properties": [
|
|
@@ -6553,7 +6901,7 @@
|
|
|
6553
6901
|
"immutable": true,
|
|
6554
6902
|
"locationInModule": {
|
|
6555
6903
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6556
|
-
"line":
|
|
6904
|
+
"line": 170
|
|
6557
6905
|
},
|
|
6558
6906
|
"name": "constructPath",
|
|
6559
6907
|
"type": {
|
|
@@ -6569,7 +6917,7 @@
|
|
|
6569
6917
|
"immutable": true,
|
|
6570
6918
|
"locationInModule": {
|
|
6571
6919
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6572
|
-
"line":
|
|
6920
|
+
"line": 191
|
|
6573
6921
|
},
|
|
6574
6922
|
"name": "cloudFormationResource",
|
|
6575
6923
|
"optional": true,
|
|
@@ -6587,7 +6935,7 @@
|
|
|
6587
6935
|
"immutable": true,
|
|
6588
6936
|
"locationInModule": {
|
|
6589
6937
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6590
|
-
"line":
|
|
6938
|
+
"line": 177
|
|
6591
6939
|
},
|
|
6592
6940
|
"name": "constructFqn",
|
|
6593
6941
|
"optional": true,
|
|
@@ -6606,7 +6954,7 @@
|
|
|
6606
6954
|
"immutable": true,
|
|
6607
6955
|
"locationInModule": {
|
|
6608
6956
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6609
|
-
"line":
|
|
6957
|
+
"line": 186
|
|
6610
6958
|
},
|
|
6611
6959
|
"name": "libraryVersion",
|
|
6612
6960
|
"optional": true,
|
|
@@ -6625,7 +6973,7 @@
|
|
|
6625
6973
|
"immutable": true,
|
|
6626
6974
|
"locationInModule": {
|
|
6627
6975
|
"filename": "lib/cloud-assembly/validation-report-schema.ts",
|
|
6628
|
-
"line":
|
|
6976
|
+
"line": 203
|
|
6629
6977
|
},
|
|
6630
6978
|
"name": "stackTraces",
|
|
6631
6979
|
"optional": true,
|
|
@@ -6646,7 +6994,11 @@
|
|
|
6646
6994
|
"datatype": true,
|
|
6647
6995
|
"docs": {
|
|
6648
6996
|
"stability": "stable",
|
|
6649
|
-
"summary": "Query input for looking up a VPC."
|
|
6997
|
+
"summary": "Query input for looking up a VPC.",
|
|
6998
|
+
"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';\n\ndeclare const assumeRoleAdditionalOptions: any;\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 assumeRoleAdditionalOptions: {\n assumeRoleAdditionalOptionsKey: assumeRoleAdditionalOptions,\n },\n lookupRoleArn: 'lookupRoleArn',\n lookupRoleExternalId: 'lookupRoleExternalId',\n returnAsymmetricSubnets: false,\n returnVpnGateways: false,\n subnetGroupNameTag: 'subnetGroupNameTag',\n};",
|
|
6999
|
+
"custom": {
|
|
7000
|
+
"exampleMetadata": "fixture=_generated"
|
|
7001
|
+
}
|
|
6650
7002
|
},
|
|
6651
7003
|
"fqn": "@aws-cdk/cloud-assembly-schema.VpcContextQuery",
|
|
6652
7004
|
"interfaces": [
|
|
@@ -6742,6 +7094,6 @@
|
|
|
6742
7094
|
"symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
|
|
6743
7095
|
}
|
|
6744
7096
|
},
|
|
6745
|
-
"version": "
|
|
6746
|
-
"fingerprint": "
|
|
7097
|
+
"version": "54.0.0",
|
|
7098
|
+
"fingerprint": "**********"
|
|
6747
7099
|
}
|