(integ-tests): awsApiCall Response object is too long

[dontirun]

Describe the bug

When using assertions.awsApiCall my response object was too large and caused the integration test stack to fail deployment.

Expected Behavior

I can limit the outputPath of the api call like done here ##2825

Current Behavior

I can't limit the output and get around the 4k response limit for CloudFormation

Reproduction Steps

integ.reproduction.ts

import * as ec2 from '@aws-cdk/aws-ec2';
import { App, Stack, StackProps } from '@aws-cdk/core';
import * as integ from '@aws-cdk/integ-tests';
import { Construct } from 'constructs';
import * as redshift from '../lib';

class RedshiftEnv extends Stack {
  readonly cluster: redshift.Cluster

  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);

    const vpc = new ec2.Vpc(this, 'VPC');

    this.cluster = new redshift.Cluster(this, 'Cluster', {
      vpc: vpc,
      vpcSubnets: {
        subnetType: ec2.SubnetType.PUBLIC,
      },
      masterUser: {
        masterUsername: 'admin',
      },
    });
  }
}

const app = new App();
const stack = new RedshiftEnv(app, 'redshift-integ');
const test = new integ.IntegTest(app, 'LoggingBucketInteg', {
  testCases: [stack],
});

test.assertions.awsApiCall('Redshift', 'describeClusters', {
  ClusterIdentifier: stack.cluster.clusterName,
});

app.synth();

Possible Solution

Implement an outputPath feature like done here ##2825 to limit the response object

Additional Information/Context

No response

CDK CLI Version

2.41.0

Framework Version

No response

Node.js Version

v16.16.0

OS

OsX

Language

Typescript

Language Version

No response

Other information

No response

[corymhall]

I'm working on an update where the assertions are done in the same handler instead of passing the data to another resource. Hopefully that will fix this issue.

[dontirun]

@corymhall I saw that #22238 was merged, but it didn't seem to fix the issue. Perhaps an easy way to fix the issue would be to use the bootstrap assets bucket as a proxy.

1. Make API Call
2. Upload Output of API Call JSON to the CDK Assets Bucket
3. Output S3 object Key
4. Assertion reads in and downloads the JSON from the Bucket
5. Nice to have: Another resource deletes all the uploaded objects after the tests

[corymhall]

Currently awsApiCall can serve two roles.

1. Make an API call in order to return a value that can be referenced elsewhere in the template
2. Make an API call and assert the results (don't need to return anything).

In order to accommodate the second we first flatten the results (if we need to) and then perform assertions and then return everything. What I want to do is change this around a little. We should perform assertions on the response (without flattening) and then if we also need to return a value we can flatten if needed and then only return the value that is needed.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.