interface HttpRequest
Language | Type name |
---|---|
![]() | Amazon.CDK.IntegTests.Alpha.HttpRequest |
![]() | github.com/aws/aws-cdk-go/awscdkintegtestsalpha/v2#HttpRequest |
![]() | software.amazon.awscdk.integtests.alpha.HttpRequest |
![]() | aws_cdk.integ_tests_alpha.HttpRequest |
![]() | @aws-cdk/integ-tests-alpha » HttpRequest |
Request to the HttpCall resource.
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
Name | Type | Description |
---|---|---|
parameters | Http | Parameters from the custom resource. |
flatten | string | Whether or not to flatten the response from the HTTP request. |
parameters
Type:
Http
Parameters from the custom resource.
flattenResponse?
Type:
string
(optional, default: 'false')
Whether or not to flatten the response from the HTTP request.
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'.