fix(apigateway): cannot use requestValidatorOptions multiple times (under feature flag) (#25324)

When using `addMethod` with `requestValidatorOptions` it is not possible to do this multiple times on the same RestApi. The same node id is used for all `RequestValidators` added using this method.

This PR adds a new feature flag which when enabled will generate a unique id for the RequestValidators added in this way.

fixes #7613

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: corymhall

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

@@ -608,6 +608,41 @@ resource.addMethod('GET', integration, {
 Specifying `requestValidatorOptions` automatically creates the RequestValidator construct with the given options.
 However, if you have your RequestValidator already initialized or imported, use the `requestValidator` option instead.
 
+If you want to use `requestValidatorOptions` in multiple `addMethod()` calls
+then you need to set the `@aws-cdk/aws-apigateway:requestValidatorUniqueId`
+feature flag. When this feature flag is set, each `RequestValidator` will have a unique generated id.
+
+> **Note** if you enable this feature flag when you have already used
+> `addMethod()` with `requestValidatorOptions` the Logical Id of the resource
+> will change causing the resource to be replaced.
+
+```ts
+declare const integration: apigateway.LambdaIntegration;
+declare const resource: apigateway.Resource;
+declare const responseModel: apigateway.Model;
+declare const errorResponseModel: apigateway.Model;
+
+resource.node.setContext('@aws-cdk/aws-apigateway:requestValidatorUniqueId', true);
+
+resource.addMethod('GET', integration, {
+  // we can set request validator options like below
+  requestValidatorOptions: {
+    requestValidatorName: 'test-validator',
+    validateRequestBody: true,
+    validateRequestParameters: false
+  },
+});
+
+resource.addMethod('POST', integration, {
+  // we can set request validator options like below
+  requestValidatorOptions: {
+    requestValidatorName: 'test-validator2',
+    validateRequestBody: true,
+    validateRequestParameters: false
+  },
+});
+```
+
 ## Default Integration and Method Options
 
 The `defaultIntegration` and `defaultMethodOptions` properties can be used to

packages/aws-cdk-lib/aws-apigateway/lib/method.ts

@@ -1,5 +1,3 @@
-import * as cloudwatch from '../../aws-cloudwatch';
-import { ArnFormat, Lazy, Resource, Stack } from '../../core';
 import { Construct } from 'constructs';
 import { ApiGatewayMetrics } from './apigateway-canned-metrics.generated';
 import { CfnMethod, CfnMethodProps } from './apigateway.generated';
@@ -13,6 +11,9 @@ import { IResource } from './resource';
 import { IRestApi, RestApi, RestApiBase } from './restapi';
 import { IStage } from './stage';
 import { validateHttpMethod } from './util';
+import * as cloudwatch from '../../aws-cloudwatch';
+import { ArnFormat, FeatureFlags, Lazy, Names, Resource, Stack } from '../../core';
+import { APIGATEWAY_REQUEST_VALIDATOR_UNIQUE_ID } from '../../cx-api';
 
 export interface MethodOptions {
   /**
@@ -360,7 +361,11 @@ export class Method extends Resource {
     }
 
     if (options.requestValidatorOptions) {
-      const validator = (this.api as RestApi).addRequestValidator('validator', options.requestValidatorOptions);
+      const useUniqueId = FeatureFlags.of(this).isEnabled(APIGATEWAY_REQUEST_VALIDATOR_UNIQUE_ID);
+      const id = useUniqueId
+        ? `${Names.uniqueResourceName(new Construct(this, 'Validator'), {})}`
+        : 'validator';
+      const validator = (this.api as RestApi).addRequestValidator(id, options.requestValidatorOptions);
       return validator.requestValidatorId;
     }
 

packages/aws-cdk-lib/aws-apigateway/test/resource.test.ts

@@ -1,5 +1,6 @@
 import { Match, Template } from '../../assertions';
 import { Stack } from '../../core';
+import { APIGATEWAY_REQUEST_VALIDATOR_UNIQUE_ID } from '../../cx-api';
 import * as apigw from '../lib';
 
 /* eslint-disable quote-props */
@@ -424,4 +425,58 @@ describe('resource', () => {
     });
   });
 
+  test('can add multiple valiators through addMethod', () => {
+    // GIVEN
+    const stack = new Stack();
+    stack.node.setContext(APIGATEWAY_REQUEST_VALIDATOR_UNIQUE_ID, true);
+    const api = new apigw.RestApi(stack, 'api');
+
+    // WHEN
+    const resource = api.root.addResource('path');
+    const resource2 = api.root.addResource('anotherPath');
+
+    resource.addMethod('GET', undefined, {
+      requestValidatorOptions: {
+        requestValidatorName: 'validator1',
+      },
+    });
+
+    resource2.addMethod('GET', undefined, {
+      requestValidatorOptions: {
+        requestValidatorName: 'validator3',
+      },
+    });
+
+    resource.addMethod('POST', undefined, {
+      requestValidatorOptions: {
+        requestValidatorName: 'validator2',
+      },
+    });
+
+    // THEN
+    Template.fromStack(stack).resourceCountIs('AWS::ApiGateway::RequestValidator', 3);
+    Template.fromStack(stack).templateMatches(Match.objectLike({
+      Resources: {
+        apiapipathGETValidator833E9D62E0C84E70: {
+          Type: 'AWS::ApiGateway::RequestValidator',
+          Properties: {
+            Name: 'validator1',
+          },
+        },
+        apiapipathPOSTValidatorA9DA2EF22AA0453F: {
+          Type: 'AWS::ApiGateway::RequestValidator',
+          Properties: {
+            Name: 'validator2',
+          },
+        },
+        apiapianotherPathGETValidator0A5B8E231A9FC6EA: {
+          Type: 'AWS::ApiGateway::RequestValidator',
+          Properties: {
+            Name: 'validator3',
+          },
+        },
+      },
+    }));
+  });
+
 });

packages/aws-cdk-lib/cx-api/lib/features.ts

@@ -85,6 +85,7 @@ export const EC2_LAUNCH_TEMPLATE_DEFAULT_USER_DATA = '@aws-cdk/aws-ec2:launchTem
 export const SECRETS_MANAGER_TARGET_ATTACHMENT_RESOURCE_POLICY = '@aws-cdk/aws-secretsmanager:useAttachedSecretResourcePolicyForSecretTargetAttachments';
 export const REDSHIFT_COLUMN_ID = '@aws-cdk/aws-redshift:columnId';
 export const ENABLE_EMR_SERVICE_POLICY_V2 = '@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2';
+export const APIGATEWAY_REQUEST_VALIDATOR_UNIQUE_ID = '@aws-cdk/aws-apigateway:requestValidatorUniqueId';
 
 export const FLAGS: Record<string, FlagInfo> = {
   //////////////////////////////////////////////////////////////////////
@@ -733,6 +734,7 @@ export const FLAGS: Record<string, FlagInfo> = {
     recommendedValue: true,
   },
 
+  //////////////////////////////////////////////////////////////////////
   [ENABLE_EMR_SERVICE_POLICY_V2]: {
     type: FlagType.BugFix,
     summary: 'Enable AmazonEMRServicePolicy_v2 managed policies',
@@ -749,6 +751,21 @@ export const FLAGS: Record<string, FlagInfo> = {
     introducedIn: { v2: '2.72.0' },
     recommendedValue: true,
   },
+
+  //////////////////////////////////////////////////////////////////////
+  [APIGATEWAY_REQUEST_VALIDATOR_UNIQUE_ID]: {
+    type: FlagType.BugFix,
+    summary: 'Generate a unique id for each RequestValidator added to a method',
+    detailsMd: `
+      This flag allows multiple RequestValidators to be added to a RestApi when
+      providing the \`RequestValidatorOptions\` in the \`addMethod()\` method.
+
+      If the flag is not set then only a single RequestValidator can be added in this way.
+      Any additional RequestValidators have to be created directly with \`new RequestValidator\`.
+    `,
+    introducedIn: { v2: 'V2·NEXT' },
+    recommendedValue: true,
+  },
 };
 
 const CURRENT_MV = 'v2';