Interface IHttpRequest

(experimental) Request to the HttpCall resource.

Namespace: Amazon.CDK.IntegTests.Alpha
Assembly: Amazon.CDK.IntegTests.Alpha.dll
Syntax (csharp)
public interface IHttpRequest
Syntax (vb)
Public Interface IHttpRequest
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.IntegTests.Alpha;

var httpRequest = new HttpRequest {
    Parameters = new HttpRequestParameters {
        Url = "url",

        // the properties below are optional
        FetchOptions = new FetchOptions {
            Body = "body",
            Headers = new Dictionary<string, string> {
                { "headersKey", "headers" }
            },
            Method = "method",
            Port = 123
        }
    },

    // the properties below are optional
    FlattenResponse = "flattenResponse"
};

Synopsis

Properties

FlattenResponse

(experimental) Whether or not to flatten the response from the HTTP request.
Parameters

(experimental) Parameters from the custom resource.

Properties

FlattenResponse

(experimental) Whether or not to flatten the response from the HTTP request.

virtual string FlattenResponse { get; }
Property Value

System.String

Remarks

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'.

Default: 'false'

Stability: Experimental

Parameters

(experimental) Parameters from the custom resource.

IHttpRequestParameters Parameters { get; }
Property Value

IHttpRequestParameters

Remarks

Stability: Experimental