fix(core): account for { Ref } incompatibility between schema and CFN

packages/@aws-cdk/mixins-preview/lib/services/aws-cases/index.ts

@@ -0,0 +1 @@
+export * as mixins from './mixins';

packages/@aws-cdk/mixins-preview/lib/services/aws-cases/mixins.ts

@@ -0,0 +1 @@
+export * from './cfn-props-mixins.generated';

packages/@aws-cdk/mixins-preview/lib/services/aws-codebuild/events.ts

@@ -0,0 +1 @@
+export * from './events.generated';

packages/@aws-cdk/mixins-preview/lib/services/aws-codebuild/index.ts

@@ -1 +1,2 @@
+export * as events from './events';
 export * as mixins from './mixins';

packages/@aws-cdk/mixins-preview/lib/services/aws-elasticache/mixins.ts

@@ -1 +1,2 @@
 export * from './cfn-props-mixins.generated';
+export * from './logs-delivery-mixins.generated';

packages/@aws-cdk/mixins-preview/lib/services/index.ts

@@ -34,6 +34,7 @@ export * as aws_bedrock from './aws-bedrock';
 export * as aws_bedrockagentcore from './aws-bedrockagentcore';
 export * as aws_billingconductor from './aws-billingconductor';
 export * as aws_budgets from './aws-budgets';
+export * as aws_cases from './aws-cases';
 export * as aws_cassandra from './aws-cassandra';
 export * as aws_ce from './aws-ce';
 export * as aws_certificatemanager from './aws-certificatemanager';

packages/@aws-cdk/mixins-preview/package.json

@@ -84,6 +84,8 @@
     "./aws-billingconductor/mixins": "./lib/services/aws-billingconductor/mixins.js",
     "./aws-budgets": "./lib/services/aws-budgets/index.js",
     "./aws-budgets/mixins": "./lib/services/aws-budgets/mixins.js",
+    "./aws-cases": "./lib/services/aws-cases/index.js",
+    "./aws-cases/mixins": "./lib/services/aws-cases/mixins.js",
     "./aws-cassandra": "./lib/services/aws-cassandra/index.js",
     "./aws-cassandra/mixins": "./lib/services/aws-cassandra/mixins.js",
     "./aws-ce": "./lib/services/aws-ce/index.js",
@@ -110,6 +112,7 @@
     "./aws-codeartifact": "./lib/services/aws-codeartifact/index.js",
     "./aws-codeartifact/mixins": "./lib/services/aws-codeartifact/mixins.js",
     "./aws-codebuild": "./lib/services/aws-codebuild/index.js",
+    "./aws-codebuild/events": "./lib/services/aws-codebuild/events.js",
     "./aws-codebuild/mixins": "./lib/services/aws-codebuild/mixins.js",
     "./aws-codecommit": "./lib/services/aws-codecommit/index.js",
     "./aws-codecommit/events": "./lib/services/aws-codecommit/events.js",
@@ -658,7 +661,7 @@
     "@aws-cdk/integ-runner": "^2.192.2",
     "@aws-cdk/integ-tests-alpha": "0.0.0",
     "@aws-cdk/pkglint": "0.0.0",
-    "@aws-cdk/service-spec-types": "^0.0.199",
+    "@aws-cdk/service-spec-types": "^0.0.201",
     "@aws-cdk/spec2cdk": "0.0.0",
     "@cdklabs/tskb": "^0.0.4",
     "@cdklabs/typewriter": "^0.0.14",

packages/aws-cdk-lib/aws-appmesh/lib/virtual-gateway.ts

@@ -112,7 +112,6 @@ abstract class VirtualGatewayBase extends cdk.Resource implements IVirtualGatewa
   public get virtualGatewayRef(): VirtualGatewayReference {
     return {
       virtualGatewayArn: this.virtualGatewayArn,
-      virtualGatewayId: this.virtualGatewayName,
     };
   }
 

packages/aws-cdk-lib/aws-appmesh/lib/virtual-node.ts

@@ -125,7 +125,6 @@ abstract class VirtualNodeBase extends cdk.Resource implements IVirtualNode {
   public get virtualNodeRef(): VirtualNodeReference {
     return {
       virtualNodeArn: this.virtualNodeArn,
-      virtualNodeId: this.virtualNodeName,
     };
   }
 

packages/aws-cdk-lib/aws-appmesh/test/virtual-gateway.test.ts

@@ -977,12 +977,7 @@ describe('virtual gateway', () => {
           {
             Action: 'appmesh:StreamAggregatedResources',
             Effect: 'Allow',
-            Resource: {
-              'Fn::GetAtt': [
-                'testGateway',
-                'Arn',
-              ],
-            },
+            Resource: { Ref: 'testGateway' },
           },
         ],
       },

packages/aws-cdk-lib/aws-cases/.jsiirc.json

@@ -0,0 +1,13 @@
+{
+  "targets": {
+    "java": {
+      "package": "software.amazon.awscdk.services.cases"
+    },
+    "dotnet": {
+      "namespace": "Amazon.CDK.AWS.Cases"
+    },
+    "python": {
+      "module": "aws_cdk.aws_cases"
+    }
+  }
+}

packages/aws-cdk-lib/aws-cases/README.md

@@ -0,0 +1,39 @@
+# AWS::Cases Construct Library
+<!--BEGIN STABILITY BANNER-->
+
+---
+
+![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
+
+> All classes with the `Cfn` prefix in this module ([CFN Resources]) are always stable and safe to use.
+>
+> [CFN Resources]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib
+
+---
+
+<!--END STABILITY BANNER-->
+
+This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.
+
+```ts nofixture
+import * as cases from 'aws-cdk-lib/aws-cases';
+```
+
+<!--BEGIN CFNONLY DISCLAIMER-->
+
+There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:
+
+- Search [Construct Hub for Cases construct libraries](https://constructs.dev/search?q=cases)
+- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::Cases resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Cases.html) directly.
+
+
+<!--BEGIN CFNONLY DISCLAIMER-->
+
+There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. 
+However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.
+
+For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::Cases](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Cases.html).
+
+(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)
+
+<!--END CFNONLY DISCLAIMER-->

packages/aws-cdk-lib/aws-cases/index.ts

@@ -0,0 +1 @@
+export * from './lib';

packages/aws-cdk-lib/aws-cases/lib/index.ts

@@ -0,0 +1,2 @@
+// AWS::Cases Cloudformation Resources
+export * from './cases.generated';

packages/aws-cdk-lib/aws-elasticsearch/lib/domain.ts

@@ -961,7 +961,7 @@ abstract class DomainBase extends cdk.Resource implements IDomain {
 
   public get domainRef(): DomainReference {
     return {
-      domainId: this.domainName,
+      domainName: this.domainName,
       domainArn: this.domainArn,
     };
   }

packages/aws-cdk-lib/index.ts

@@ -40,6 +40,7 @@ export * as aws_bedrock from './aws-bedrock';
 export * as aws_bedrockagentcore from './aws-bedrockagentcore';
 export * as aws_billingconductor from './aws-billingconductor';
 export * as aws_budgets from './aws-budgets';
+export * as aws_cases from './aws-cases';
 export * as aws_cassandra from './aws-cassandra';
 export * as aws_ce from './aws-ce';
 export * as aws_certificatemanager from './aws-certificatemanager';

packages/aws-cdk-lib/package.json

@@ -131,7 +131,7 @@
   },
   "devDependencies": {
     "@aws-cdk/lambda-layer-kubectl-v31": "^2.1.0",
-    "@aws-cdk/aws-service-spec": "^0.1.133",
+    "@aws-cdk/aws-service-spec": "^0.1.135",
     "@aws-cdk/cdk-build-tools": "0.0.0",
     "@aws-cdk/custom-resource-handlers": "0.0.0",
     "@aws-cdk/pkglint": "0.0.0",
@@ -250,6 +250,7 @@
     "./aws-billing": "./aws-billing/index.js",
     "./aws-billingconductor": "./aws-billingconductor/index.js",
     "./aws-budgets": "./aws-budgets/index.js",
+    "./aws-cases": "./aws-cases/index.js",
     "./aws-cassandra": "./aws-cassandra/index.js",
     "./aws-ce": "./aws-ce/index.js",
     "./aws-certificatemanager": "./aws-certificatemanager/index.js",

packages/aws-cdk-lib/scripts/scope-map.json

@@ -276,6 +276,13 @@
       }
     ]
   },
+  "aws-cases": {
+    "scopes": [
+      {
+        "namespace": "AWS::Cases"
+      }
+    ]
+  },
   "aws-cassandra": {
     "scopes": [
       {

tools/@aws-cdk/spec2cdk/lib/cdk/arn.ts

@@ -7,19 +7,22 @@ import { Resource } from '@aws-cdk/service-spec-types';
  * included in the primary identifier.
  */
 export function findNonIdentifierArnProperty(resource: Resource) {
-  return findArnProperty(resource, (name) => !resource.primaryIdentifier?.includes(name));
+  const refIdentifier = resource.cfnRefIdentifier ?? resource.primaryIdentifier;
+  return findArnProperty(resource, (name) => !refIdentifier?.includes(name));
 }
 
 export function findArnProperty(resource: Resource, filter: (name: string) => boolean = () => true): string | undefined {
   const prefixes = ['', resource.name];
   const suffixes = ['Arn', 'ARN'];
   const primaryIdentifierSuffixes = ['Id', 'ID'];
 
+  const refIdentifier = resource.cfnRefIdentifier ?? resource.primaryIdentifier;
+
   // if the primary identifier uses a prefix that is different than the resource name, we add that to the list
-  if (resource.primaryIdentifier?.length === 1) {
+  if (refIdentifier?.length === 1) {
     for (const suffix of primaryIdentifierSuffixes) {
-      if (resource.primaryIdentifier[0].endsWith(suffix)) {
-        const prefix = resource.primaryIdentifier[0].slice(0, -suffix.length);
+      if (refIdentifier[0].endsWith(suffix)) {
+        const prefix = refIdentifier[0].slice(0, -suffix.length);
         if (prefix && !prefixes.includes(prefix)) {
           prefixes.push(prefix);
         }

tools/@aws-cdk/spec2cdk/lib/cdk/reference-props.ts

@@ -1,6 +1,6 @@
 import { Resource } from '@aws-cdk/service-spec-types';
 import { $this, expr, Expression, PropertySpec, Type } from '@cdklabs/typewriter';
-import { attributePropertyName, referencePropertyName } from '../naming';
+import { attributePropertyName, propertyNameFromCloudFormation, referencePropertyName } from '../naming';
 import { extractResourceVariablesFromArnFormat, findArnProperty, findNonIdentifierArnProperty } from './arn';
 import { CDK_CORE } from './cdk';
 
@@ -9,6 +9,37 @@ export interface ReferenceProp {
   readonly cfnValue: Expression;
 }
 
+/**
+ * Calculations for to the resource reference interface.
+ *
+ * This  class is slightly complicated because it needs to account for the differences between CloudFormation
+ * and CC-API identifiers.
+ *
+ * - In principle, the CC-API identifier is leading: it uniquely identifies a resource inside an environment.
+ * - For backwards compatibility reasons, the CFN identifier (the value returned by `{ Ref }`) isn't necessarily
+ *   always the same. If it isn't the same, there can be two reasons for them to diverge:
+ *
+ *    - SPECIFICITY: the CC-API identifier is more specific than the CFN
+ *      identifier. For example, for `ApiGateway::Stage`, the unique identifier is
+ *      `[ApiId, StageName]` but the value that `{ Ref }` returns is just
+ *      `StageName`.
+ *
+ *      This distinction happens for subresources, and in those cases the
+ *      primary resource will be a required input property. For maximum
+ *      flexibility we generate the interface according to the CC-API
+ *      identifier, and get values from the CFN identifier, attributes and input
+ *      properties as necessary.
+ *
+ *    - ALIASING: the CC-API uses a different form of identifying the resource than the
+ *      CFN identifier. For example, for `Batch::JobDefinition` the spec says the primary
+ *      identifier is the `Name` but the actual value that `{ Ref }` returns is the
+ *      the `Arn`. We will just use the CFN value as leading.
+ *
+ * We will identify the difference between these 2 cases by the length of the primary
+ * identifier: equal length = aliasing, different length = specificity.
+ *
+ * If available, we also add an ARN field into the reference interface.
+ */
 export class ResourceReference {
   public readonly resource: Resource;
   public readonly arnPropertyName?: string;
@@ -44,36 +75,20 @@ export class ResourceReference {
   }
 
   private collectReferencesProps() {
-    // Primary identifier. We assume all parts are strings.
-    const primaryIdentifier = this.resource.primaryIdentifier ?? [];
-    if (primaryIdentifier.length === 1) {
-      const name = referencePropertyName(primaryIdentifier[0], this.resource.name);
+    // Reference fields
+    for (const cfnName of this.referenceFields) {
+      const name = referencePropertyName(cfnName, this.resource.name);
       this._referenceProps.setIfAbsent(name, {
         declaration: {
           name,
           type: Type.STRING,
           immutable: true,
           docs: {
-            summary: `The ${primaryIdentifier[0]} of the ${this.resource.name} resource.`,
+            summary: `The ${cfnName} of the ${this.resource.name} resource.`,
           },
         },
-        cfnValue: $this.ref,
+        cfnValue: this.getStringValue(cfnName),
       });
-    } else if (primaryIdentifier.length > 1) {
-      for (const [i, cfnName] of primaryIdentifier.entries()) {
-        const name = referencePropertyName(cfnName, this.resource.name);
-        this._referenceProps.setIfAbsent(name, {
-          declaration: {
-            name,
-            type: Type.STRING,
-            immutable: true,
-            docs: {
-              summary: `The ${cfnName} of the ${this.resource.name} resource.`,
-            },
-          },
-          cfnValue: splitSelect('|', i, $this.ref),
-        });
-      }
     }
 
     // Arn identifier
@@ -137,6 +152,71 @@ export class ResourceReference {
     // we don't have a matching value
     return undefined;
   }
+
+  /**
+   * The actual reference fields
+   *
+   * The CFN values if present and the same length as the CC-API values, otherwise the CC-API values.
+   *
+   * For a CC-API identifier we filter out optional properties, such as for `ECS::Cluster`: the real
+   * unique identifier includes `Cluster` but that is an optional property because the Service will fall
+   * back to some implicit default Cluster that we can never replicate.
+   */
+  public get referenceFields(): string[] {
+    if (this.resource.cfnRefIdentifier && this.resource.cfnRefIdentifier.length === this.resource.primaryIdentifier?.length) {
+      return this.resource.cfnRefIdentifier;
+    }
+
+    // Filter out properties we can't find a value for (will only be optional properties)
+    return (this.resource.primaryIdentifier ?? [])
+      .filter(p => this.tryGetStringValue(p) !== undefined);
+  }
+
+  /**
+   * What `{ Ref }` returns in CloudFormation
+   */
+  public get cfnRefComponents(): string[] {
+    return this.resource.cfnRefIdentifier ?? this.resource.primaryIdentifier ?? [];
+  }
+
+  /**
+   * Return an expression to return the given value from the { Ref } or any of the attributes or properties
+   */
+  private tryGetStringValue(name: string): Expression | undefined {
+    for (const [i, field] of this.cfnRefComponents.entries()) {
+      if (field === name) {
+        // Return entire field or Split expression, depending on whether we need to split at all
+        return this.cfnRefComponents.length > 1 ? splitSelect('|', i, $this.ref) : $this.ref;
+      }
+    }
+
+    // Is it an attr?
+    if (this.resource.attributes[name]) {
+      return $this[attributePropertyName(name)];
+    }
+
+    // A required prop?
+    if (this.resource.properties[name]?.required) {
+      return $this[propertyNameFromCloudFormation(name)];
+    }
+
+    return undefined;
+  }
+
+  /**
+   * Return a value, failing if it doesn't exist.
+   */
+  private getStringValue(name: string): Expression {
+    const ret = this.tryGetStringValue(name);
+    if (ret) {
+      return ret;
+    }
+
+    const attributeNames = Object.keys(this.resource.attributes);
+    const requiredPropertyNames = Object.entries(this.resource.properties).filter(([_, p]) => p.required).map(([n, _]) => n);
+
+    throw new Error(`Cannot find reference interface value name ${name} for resource ${this.resource.cloudFormationType} (Ref components: ${this.cfnRefComponents}, attributes: ${attributeNames}, requiredProps: ${requiredPropertyNames})`);
+  }
 }
 
 class FirstOccurrenceMap<K, V> extends Map<K, V> {

tools/@aws-cdk/spec2cdk/package.json

@@ -31,9 +31,9 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-cdk/aws-service-spec": "^0.1.133",
+    "@aws-cdk/aws-service-spec": "^0.1.135",
     "@aws-cdk/service-spec-importers": "^0.0.101",
-    "@aws-cdk/service-spec-types": "^0.0.199",
+    "@aws-cdk/service-spec-types": "^0.0.201",
     "@cdklabs/tskb": "^0.0.4",
     "@cdklabs/typewriter": "^0.0.14",
     "camelcase": "^6",
@@ -46,6 +46,7 @@
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "@types/node": "^18",
+    "diff": "^8.0.2",
     "jest": "^29.7.0"
   },
   "keywords": [

tools/@aws-cdk/spec2cdk/test/__snapshots__/resources.test.ts.snap

@@ -189,7 +189,7 @@ function CfnResourcePropsFromCloudFormation(properties: any): cfn_parse.FromClou
 export type { IResourceRef, ResourceReference };"
 `;
 
-exports[`resource interface when primaryIdentifier is a property 1`] = `
+exports[`resource interface when cfnRefIdentifier is a property 1`] = `
 "/* eslint-disable prettier/prettier, @stylistic/max-len */
 import * as cdk from "aws-cdk-lib/core";
 import * as constructs from "constructs";