Package software.amazon.awscdk.services.mediatailor

Class CfnFunction.VastRequestConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.mediatailor.CfnFunction.VastRequestConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFunction.VastRequestConfigurationProperty>

Enclosing interface:

CfnFunction.VastRequestConfigurationProperty

@Stability(Stable)
public static final class CfnFunction.VastRequestConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFunction.VastRequestConfigurationProperty>

A builder for CfnFunction.VastRequestConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFunction.VastRequestConfigurationProperty.Builder	body(String body)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getBody()
CfnFunction.VastRequestConfigurationProperty	build()	Builds the configured instance.
CfnFunction.VastRequestConfigurationProperty.Builder	headers(Map<String,String> headers)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getHeaders()
CfnFunction.VastRequestConfigurationProperty.Builder	headers(IResolvable headers)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getHeaders()
CfnFunction.VastRequestConfigurationProperty.Builder	methodType(String methodType)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getMethodType()
CfnFunction.VastRequestConfigurationProperty.Builder	output(Map<String,String> output)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getOutput()
CfnFunction.VastRequestConfigurationProperty.Builder	output(IResolvable output)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getOutput()
CfnFunction.VastRequestConfigurationProperty.Builder	requestTimeoutMilliseconds(Number requestTimeoutMilliseconds)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getRequestTimeoutMilliseconds()
CfnFunction.VastRequestConfigurationProperty.Builder	runtime(String runtime)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getRuntime()
CfnFunction.VastRequestConfigurationProperty.Builder	url(String url)	Sets the value of CfnFunction.VastRequestConfigurationProperty.getUrl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

methodType

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder methodType(String methodType)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getMethodType()

Parameters:

methodType - the value to be set. This parameter is required.

Returns:

this

requestTimeoutMilliseconds

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder requestTimeoutMilliseconds(Number requestTimeoutMilliseconds)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getRequestTimeoutMilliseconds()

Parameters:

requestTimeoutMilliseconds - The maximum time, in milliseconds, that MediaTailor waits for a response from the VAST endpoint. This parameter is required. 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.

Returns:

this

runtime

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder runtime(String runtime)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getRuntime()

Parameters:

runtime - The expression language used to evaluate expressions in the function configuration. This parameter is required. Set this to JSONATA.

Returns:

this

url

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder url(String url)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getUrl()

Parameters:

url - An expression that evaluates to the VAST endpoint URL. This parameter is required. 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.

Returns:

this

body

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder body(String body)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getBody()

Parameters:

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

Returns:

this

headers

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder headers(IResolvable headers)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getHeaders()

Parameters:

headers - 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:

this

headers

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder headers(Map<String,String> headers)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getHeaders()

Parameters:

headers - 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:

this

output

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder output(IResolvable output)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getOutput()

Parameters:

output - 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:

this

output

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty.Builder output(Map<String,String> output)

Sets the value of CfnFunction.VastRequestConfigurationProperty.getOutput()

Parameters:

output - 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:

this

build

@Stability(Stable)
public CfnFunction.VastRequestConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnFunction.VastRequestConfigurationProperty>

Returns:

a new instance of CfnFunction.VastRequestConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided