Interface CfnFunction.VastRequestConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFunction.VastRequestConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnFunction
Specifies the HTTP method, URL, headers, body, timeout, and output expressions for a request to a VAST endpoint. MediaTailor parses the response as VAST and resolves wrapper redirects, then makes the parsed ads available to the function's output expressions. For more information, see Function types and composition (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types.html) in the MediaTailor User Guide.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.mediatailor.*;
VastRequestConfigurationProperty vastRequestConfigurationProperty = VastRequestConfigurationProperty.builder()
.methodType("methodType")
.requestTimeoutMilliseconds(123)
.runtime("runtime")
.url("url")
// the properties below are optional
.body("body")
.headers(Map.of(
"headersKey", "headers"))
.output(Map.of(
"outputKey", "output"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnFunction.VastRequestConfigurationPropertystatic final classAn implementation forCfnFunction.VastRequestConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringgetBody()An expression that evaluates to the request body, for example to send an OpenRTB bid request.default ObjectA map of HTTP header names to expression values.default ObjectA map of output bindings.The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint.The expression language used to evaluate expressions in the function configuration.getUrl()An expression that evaluates to the VAST endpoint URL.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMethodType
- See Also:
-
getRequestTimeoutMilliseconds
The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint.The timeout covers the entire response, including any wrapper redirects that MediaTailor follows. If the call exceeds this timeout, MediaTailor proceeds with an empty ad list and continues output expression evaluation. Valid values are 100 to 2000.
- See Also:
-
getRuntime
The expression language used to evaluate expressions in the function configuration.Set this to JSONATA.
- See Also:
-
getUrl
An expression that evaluates to the VAST endpoint URL.Use {%...%} delimiters for dynamic expressions. A literal value must be an https:// URL. The expression can be up to 25,000 characters, and the URL after evaluation can be up to 2,048 characters.
- See Also:
-
getBody
An expression that evaluates to the request body, for example to send an OpenRTB bid request.The expression can be up to 100,000 characters, and the body after evaluation can be up to 64 KB.
- See Also:
-
getHeaders
A map of HTTP header names to expression values.MediaTailor evaluates each header value expression at runtime and includes the result in the outbound request. Headers beginning with X-Amz- are reserved by the service, and method override headers are not allowed.
Returns union: either
IResolvableor Mapinvalid input: '<'String,String>- See Also:
-
getOutput
A map of output bindings.Each key is a namespaced output path (such as temp.wrappedAds), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in a VAST_REQUEST function can reference the response object, which exposes response.parsedAds, the ads parsed from the VAST response after schema validation and wrapper resolution, and response.statusCode. For more information about expression syntax, see JSONata expression reference (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-jsonata.html) in the MediaTailor User Guide.
Returns union: either
IResolvableor Mapinvalid input: '<'String,String>- See Also:
-
builder
-