fix(apigateway): method response from rest api default options are no…

…t passed to Method (#26275) `methodResponses` specified in `RestApi`'s `defaultMethodOptions` were not passed to `Method` as default. This fix solves the problem. Closes #26252. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Jul 7, 2023 · 9bcc6d5 · 9bcc6d5
1 parent af3a188
commit 9bcc6d5
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 1 deletion.
diff --git a/packages/aws-cdk-lib/aws-apigateway/lib/method.ts b/packages/aws-cdk-lib/aws-apigateway/lib/method.ts
@@ -203,7 +203,7 @@ export class Method extends Resource {
       authorizer._attachToApi(this.api);
     }
 
-    this.methodResponses = options.methodResponses ?? [];
+    this.methodResponses = options.methodResponses ?? defaultMethodOptions.methodResponses ?? [];
 
     const integration = props.integration ?? this.resource.defaultIntegration ?? new MockIntegration();
     const bindResult = integration.bind(this);

diff --git a/packages/aws-cdk-lib/aws-apigateway/test/method.test.ts b/packages/aws-cdk-lib/aws-apigateway/test/method.test.ts
@@ -909,6 +909,38 @@ describe('method', () => {
 
   });
 
+  test('methodResponse should be passed from defaultMethodOptions', () => {
+    // GIVEN
+    const stack = new cdk.Stack();
+    const api = new apigw.RestApi(stack, 'test-api', {
+      cloudWatchRole: false,
+      deploy: false,
+      defaultMethodOptions: {
+        requestParameters: { 'method.request.path.proxy': true },
+        methodResponses: [
+          {
+            statusCode: '200',
+          },
+        ],
+      },
+    });
+
+    // WHEN
+    new apigw.Method(stack, 'method-man', {
+      httpMethod: 'GET',
+      resource: api.root,
+    });
+
+    // THEN
+    Template.fromStack(stack).hasResourceProperties('AWS::ApiGateway::Method', {
+      HttpMethod: 'GET',
+      MethodResponses: [{
+        StatusCode: '200',
+      }],
+    });
+
+  });
+
   describe('Metrics', () => {
     test('metric', () => {
       // GIVEN