@aws-cdk/integ-tests-alpha.HttpRequest

Experimental

@aws-cdk/integ-tests-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

HttpRequest Struct

Request to the HttpCall resource.

Stability

Experimental

Source

lib/assertions/providers/lambda-handler/types.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as integ_tests_alpha from '@aws-cdk/integ-tests-alpha';
const httpRequest: integ_tests_alpha.HttpRequest = {
  parameters: {
    url: 'url',

    // the properties below are optional
    fetchOptions: {
      body: 'body',
      headers: {
        headersKey: 'headers',
      },
      method: 'method',
      port: 123,
    },
  },

  // the properties below are optional
  flattenResponse: 'flattenResponse',
};

Properties

flattenResponsestringflatten_responsestrflattenResponseStringFlattenResponsestringFlattenResponse*string= 'false'#

Whether or not to flatten the response from the HTTP request.

notes

Valid values are 'true' or 'false' as strings

Typically when using an HttpRequest you will be passing it as the actual value to an assertion provider so this would be set to 'false' (you want the actual response).

If you are using the HttpRequest to perform more of a query to return a single value to use, then this should be set to 'true'.

parametersHttpRequestParametersparametersHttpRequestParametersparametersHttpRequestParametersParametersHttpRequestParametersParametersHttpRequestParametersrequired#

Parameters from the custom resource.