fix(apigateway): allow overriding apiKeyRequired on methods

RestApi has the ability to set the apiKeyRequired option for all methods via defaultMethodOptions.

Setting this option on a method should override the value set in defaultMethodOptions, but it doesn't work.

This commit fixes the behaviour and adds a test.

Mentioned in aws#8827

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

@@ -213,7 +213,7 @@ export class Method extends Resource {
       restApiId: this.api.restApiId,
       httpMethod: this.httpMethod,
       operationName: options.operationName || defaultMethodOptions.operationName,
-      apiKeyRequired: options.apiKeyRequired || defaultMethodOptions.apiKeyRequired,
+      apiKeyRequired: options.apiKeyRequired ?? defaultMethodOptions.apiKeyRequired,
       authorizationType,
       authorizerId,
       requestParameters: options.requestParameters || defaultMethodOptions.requestParameters,

packages/aws-cdk-lib/aws-apigateway/test/lambda-api.test.ts

@@ -299,7 +299,7 @@ describe('lambda api', () => {
       ResourceId: { Ref: 'lambdarestapiproxyE3AE07E3' },
       AuthorizationType: 'NONE',
       AuthorizerId: Match.absent(),
-      ApiKeyRequired: Match.absent(),
+      ApiKeyRequired: false,
       Integration: {
         IntegrationResponses: [
           {

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

@@ -1330,4 +1330,32 @@ describe('SpecRestApi', () => {
         'AWS::ApiGateway::RestApi', {});
     });
   });
+
+  test('can override "apiKeyRequired" set in "defaultMethodOptions" at the resource level', () => {
+    // GIVEN
+    const stack = new Stack();
+
+    // WHEN
+    const api = new apigw.RestApi(stack, 'myapi', {
+      defaultMethodOptions: {
+        apiKeyRequired: true,
+      },
+    });
+
+    api.root.addMethod('GET', undefined, {});
+    api.root.addMethod('POST', undefined, {
+      apiKeyRequired: false,
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::ApiGateway::Method', {
+      HttpMethod: 'GET',
+      ApiKeyRequired: true,
+    });
+
+    Template.fromStack(stack).hasResourceProperties('AWS::ApiGateway::Method', {
+      HttpMethod: 'POST',
+      ApiKeyRequired: false,
+    });
+  });
 });