@aws-cdk/cloud-assembly-schema 2.4.0 → 2.8.0

package/.jsii

@@ -16,7 +16,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/aws/aws-cdk",
-  "jsiiVersion": "1.50.0 (build d1830a4)",
+  "jsiiVersion": "1.52.1 (build 5ccc8f6)",
   "keywords": [
     "aws",
     "cdk"
@@ -196,7 +196,7 @@
       "docs": {
         "stability": "stable",
         "summary": "A manifest for a single artifact within the cloud assembly.",
-        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst artifactManifest: cloud_assembly_schema.ArtifactManifest = {\n  type: cloud_assembly_schema.ArtifactType.NONE,\n\n  // the properties below are optional\n  dependencies: ['dependencies'],\n  displayName: 'displayName',\n  environment: 'environment',\n  metadata: {\n    metadataKey: [{\n      type: 'type',\n\n      // the properties below are optional\n      data: 'data',\n      trace: ['trace'],\n    }],\n  },\n  properties: {\n    templateFile: 'templateFile',\n\n    // the properties below are optional\n    assumeRoleArn: 'assumeRoleArn',\n    assumeRoleExternalId: 'assumeRoleExternalId',\n    bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n    cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n    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};",
+        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst artifactManifest: cloud_assembly_schema.ArtifactManifest = {\n  type: cloud_assembly_schema.ArtifactType.NONE,\n\n  // the properties below are optional\n  dependencies: ['dependencies'],\n  displayName: 'displayName',\n  environment: 'environment',\n  metadata: {\n    metadataKey: [{\n      type: 'type',\n\n      // the properties below are optional\n      data: 'data',\n      trace: ['trace'],\n    }],\n  },\n  properties: {\n    templateFile: 'templateFile',\n\n    // the properties below are optional\n    assumeRoleArn: 'assumeRoleArn',\n    assumeRoleExternalId: 'assumeRoleExternalId',\n    bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n    cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n    lookupRole: {\n      arn: 'arn',\n\n      // the properties below are optional\n      assumeRoleExternalId: 'assumeRoleExternalId',\n      bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n      requiresBootstrapStackVersion: 123,\n    },\n    parameters: {\n      parametersKey: 'parameters',\n    },\n    requiresBootstrapStackVersion: 123,\n    stackName: 'stackName',\n    stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n    tags: {\n      tagsKey: 'tags',\n    },\n    terminationProtection: false,\n    validateOnSynth: false,\n  },\n};",
         "custom": {
           "exampleMetadata": "fixture=_generated"
         }
@@ -466,7 +466,7 @@
       "docs": {
         "stability": "stable",
         "summary": "A manifest which describes the cloud assembly.",
-        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assemblyManifest: cloud_assembly_schema.AssemblyManifest = {\n  version: 'version',\n\n  // the properties below are optional\n  artifacts: {\n    artifactsKey: {\n      type: cloud_assembly_schema.ArtifactType.NONE,\n\n      // the properties below are optional\n      dependencies: ['dependencies'],\n      displayName: 'displayName',\n      environment: 'environment',\n      metadata: {\n        metadataKey: [{\n          type: 'type',\n\n          // the properties below are optional\n          data: 'data',\n          trace: ['trace'],\n        }],\n      },\n      properties: {\n        templateFile: 'templateFile',\n\n        // the properties below are optional\n        assumeRoleArn: 'assumeRoleArn',\n        assumeRoleExternalId: 'assumeRoleExternalId',\n        bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n        cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n        parameters: {\n          parametersKey: 'parameters',\n        },\n        requiresBootstrapStackVersion: 123,\n        stackName: 'stackName',\n        stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n        tags: {\n          tagsKey: 'tags',\n        },\n        terminationProtection: false,\n        validateOnSynth: false,\n      },\n    },\n  },\n  missing: [{\n    key: 'key',\n    props: {\n      account: 'account',\n      filters: {\n        filtersKey: ['filters'],\n      },\n      region: 'region',\n\n      // the properties below are optional\n      lookupRoleArn: 'lookupRoleArn',\n      owners: ['owners'],\n    },\n    provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n  }],\n  runtime: {\n    libraries: {\n      librariesKey: 'libraries',\n    },\n  },\n};",
+        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst assemblyManifest: cloud_assembly_schema.AssemblyManifest = {\n  version: 'version',\n\n  // the properties below are optional\n  artifacts: {\n    artifactsKey: {\n      type: cloud_assembly_schema.ArtifactType.NONE,\n\n      // the properties below are optional\n      dependencies: ['dependencies'],\n      displayName: 'displayName',\n      environment: 'environment',\n      metadata: {\n        metadataKey: [{\n          type: 'type',\n\n          // the properties below are optional\n          data: 'data',\n          trace: ['trace'],\n        }],\n      },\n      properties: {\n        templateFile: 'templateFile',\n\n        // the properties below are optional\n        assumeRoleArn: 'assumeRoleArn',\n        assumeRoleExternalId: 'assumeRoleExternalId',\n        bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n        cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n        lookupRole: {\n          arn: 'arn',\n\n          // the properties below are optional\n          assumeRoleExternalId: 'assumeRoleExternalId',\n          bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n          requiresBootstrapStackVersion: 123,\n        },\n        parameters: {\n          parametersKey: 'parameters',\n        },\n        requiresBootstrapStackVersion: 123,\n        stackName: 'stackName',\n        stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n        tags: {\n          tagsKey: 'tags',\n        },\n        terminationProtection: false,\n        validateOnSynth: false,\n      },\n    },\n  },\n  missing: [{\n    key: 'key',\n    props: {\n      account: 'account',\n      filters: {\n        filtersKey: ['filters'],\n      },\n      region: 'region',\n\n      // the properties below are optional\n      lookupRoleArn: 'lookupRoleArn',\n      owners: ['owners'],\n    },\n    provider: cloud_assembly_schema.ContextProvider.AMI_PROVIDER,\n  }],\n  runtime: {\n    libraries: {\n      librariesKey: 'libraries',\n    },\n  },\n};",
         "custom": {
           "exampleMetadata": "fixture=_generated"
         }
@@ -662,7 +662,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lib/cloud-assembly/artifact-schema.ts",
-        "line": 99
+        "line": 139
       },
       "name": "AssetManifestProperties",
       "properties": [
@@ -675,7 +675,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 103
+            "line": 143
           },
           "name": "file",
           "type": {
@@ -693,7 +693,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 123
+            "line": 163
           },
           "name": "bootstrapStackVersionSsmParameter",
           "optional": true,
@@ -711,7 +711,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 110
+            "line": 150
           },
           "name": "requiresBootstrapStackVersion",
           "optional": true,
@@ -800,7 +800,7 @@
       "docs": {
         "stability": "stable",
         "summary": "Artifact properties for CloudFormation stacks.",
-        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst awsCloudFormationStackProperties: cloud_assembly_schema.AwsCloudFormationStackProperties = {\n  templateFile: 'templateFile',\n\n  // the properties below are optional\n  assumeRoleArn: 'assumeRoleArn',\n  assumeRoleExternalId: 'assumeRoleExternalId',\n  bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n  cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n  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};",
+        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst awsCloudFormationStackProperties: cloud_assembly_schema.AwsCloudFormationStackProperties = {\n  templateFile: 'templateFile',\n\n  // the properties below are optional\n  assumeRoleArn: 'assumeRoleArn',\n  assumeRoleExternalId: 'assumeRoleExternalId',\n  bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n  cloudFormationExecutionRoleArn: 'cloudFormationExecutionRoleArn',\n  lookupRole: {\n    arn: 'arn',\n\n    // the properties below are optional\n    assumeRoleExternalId: 'assumeRoleExternalId',\n    bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n    requiresBootstrapStackVersion: 123,\n  },\n  parameters: {\n    parametersKey: 'parameters',\n  },\n  requiresBootstrapStackVersion: 123,\n  stackName: 'stackName',\n  stackTemplateAssetObjectUrl: 'stackTemplateAssetObjectUrl',\n  tags: {\n    tagsKey: 'tags',\n  },\n  terminationProtection: false,\n  validateOnSynth: false,\n};",
         "custom": {
           "exampleMetadata": "fixture=_generated"
         }
@@ -809,7 +809,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lib/cloud-assembly/artifact-schema.ts",
-        "line": 5
+        "line": 38
       },
       "name": "AwsCloudFormationStackProperties",
       "properties": [
@@ -822,7 +822,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 9
+            "line": 42
           },
           "name": "templateFile",
           "type": {
@@ -839,7 +839,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 43
+            "line": 76
           },
           "name": "assumeRoleArn",
           "optional": true,
@@ -857,7 +857,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 50
+            "line": 83
           },
           "name": "assumeRoleExternalId",
           "optional": true,
@@ -876,7 +876,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 86
+            "line": 126
           },
           "name": "bootstrapStackVersionSsmParameter",
           "optional": true,
@@ -894,7 +894,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 57
+            "line": 90
           },
           "name": "cloudFormationExecutionRoleArn",
           "optional": true,
@@ -902,6 +902,24 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- No role is assumed (current credentials are used)",
+            "stability": "stable",
+            "summary": "The role to use to look up values from the target AWS account."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/cloud-assembly/artifact-schema.ts",
+            "line": 97
+          },
+          "name": "lookupRole",
+          "optional": true,
+          "type": {
+            "fqn": "@aws-cdk/cloud-assembly-schema.BootstrapRole"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -912,7 +930,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 16
+            "line": 49
           },
           "name": "parameters",
           "optional": true,
@@ -935,7 +953,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 71
+            "line": 111
           },
           "name": "requiresBootstrapStackVersion",
           "optional": true,
@@ -953,7 +971,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 29
+            "line": 62
           },
           "name": "stackName",
           "optional": true,
@@ -971,7 +989,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 64
+            "line": 104
           },
           "name": "stackTemplateAssetObjectUrl",
           "optional": true,
@@ -989,7 +1007,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 23
+            "line": 56
           },
           "name": "tags",
           "optional": true,
@@ -1012,7 +1030,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 36
+            "line": 69
           },
           "name": "terminationProtection",
           "optional": true,
@@ -1030,7 +1048,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 93
+            "line": 133
           },
           "name": "validateOnSynth",
           "optional": true,
@@ -1117,6 +1135,98 @@
       ],
       "symbolId": "lib/assets/aws-destination:AwsDestination"
     },
+    "@aws-cdk/cloud-assembly-schema.BootstrapRole": {
+      "assembly": "@aws-cdk/cloud-assembly-schema",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Information needed to access an IAM role created as part of the bootstrap process.",
+        "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as cloud_assembly_schema from '@aws-cdk/cloud-assembly-schema';\nconst bootstrapRole: cloud_assembly_schema.BootstrapRole = {\n  arn: 'arn',\n\n  // the properties below are optional\n  assumeRoleExternalId: 'assumeRoleExternalId',\n  bootstrapStackVersionSsmParameter: 'bootstrapStackVersionSsmParameter',\n  requiresBootstrapStackVersion: 123,\n};",
+        "custom": {
+          "exampleMetadata": "fixture=_generated"
+        }
+      },
+      "fqn": "@aws-cdk/cloud-assembly-schema.BootstrapRole",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "lib/cloud-assembly/artifact-schema.ts",
+        "line": 6
+      },
+      "name": "BootstrapRole",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The ARN of the IAM role created as part of bootrapping e.g. lookupRoleArn."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/cloud-assembly/artifact-schema.ts",
+            "line": 11
+          },
+          "name": "arn",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- No external ID",
+            "stability": "stable",
+            "summary": "External ID to use when assuming the bootstrap role."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/cloud-assembly/artifact-schema.ts",
+            "line": 18
+          },
+          "name": "assumeRoleExternalId",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Discover SSM parameter by reading stack",
+            "stability": "stable",
+            "summary": "Name of SSM parameter with bootstrap stack version."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/cloud-assembly/artifact-schema.ts",
+            "line": 32
+          },
+          "name": "bootstrapStackVersionSsmParameter",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- No bootstrap stack required",
+            "stability": "stable",
+            "summary": "Version of bootstrap stack required to use this role."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "lib/cloud-assembly/artifact-schema.ts",
+            "line": 25
+          },
+          "name": "requiresBootstrapStackVersion",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        }
+      ],
+      "symbolId": "lib/cloud-assembly/artifact-schema:BootstrapRole"
+    },
     "@aws-cdk/cloud-assembly-schema.ContainerImageAssetMetadataEntry": {
       "assembly": "@aws-cdk/cloud-assembly-schema",
       "datatype": true,
@@ -3110,7 +3220,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lib/cloud-assembly/artifact-schema.ts",
-        "line": 139
+        "line": 179
       },
       "name": "NestedCloudAssemblyProperties",
       "properties": [
@@ -3123,7 +3233,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 143
+            "line": 183
           },
           "name": "directoryName",
           "type": {
@@ -3140,7 +3250,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 150
+            "line": 190
           },
           "name": "displayName",
           "optional": true,
@@ -3479,7 +3589,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "lib/cloud-assembly/artifact-schema.ts",
-        "line": 129
+        "line": 169
       },
       "name": "TreeArtifactProperties",
       "properties": [
@@ -3492,7 +3602,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "lib/cloud-assembly/artifact-schema.ts",
-            "line": 133
+            "line": 173
           },
           "name": "file",
           "type": {
@@ -3635,6 +3745,6 @@
       "symbolId": "lib/cloud-assembly/context-queries:VpcContextQuery"
     }
   },
-  "version": "2.4.0",
+  "version": "2.8.0",
   "fingerprint": "**********"
 }