Package software.amazon.awscdk.services.mediatailor

Class CfnFunction.AwsServiceRequestConfigurationProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

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

Enclosing interface:

CfnFunction.AwsServiceRequestConfigurationProperty

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

A builder for CfnFunction.AwsServiceRequestConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	body(String body)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getBody()
CfnFunction.AwsServiceRequestConfigurationProperty	build()	Builds the configured instance.
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	headers(Map<String,String> headers)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getHeaders()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	headers(IResolvable headers)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getHeaders()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	methodType(String methodType)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getMethodType()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	output(Map<String,String> output)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getOutput()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	output(IResolvable output)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getOutput()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	requestTimeoutMilliseconds(Number requestTimeoutMilliseconds)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getRequestTimeoutMilliseconds()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	runtime(String runtime)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getRuntime()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	targetRegion(String targetRegion)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getTargetRegion()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	targetService(String targetService)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getTargetService()
CfnFunction.AwsServiceRequestConfigurationProperty.Builder	url(String url)	Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.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.AwsServiceRequestConfigurationProperty.Builder methodType(String methodType)

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getMethodType()

Parameters:

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

Returns:

this

requestTimeoutMilliseconds

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

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getRequestTimeoutMilliseconds()

Parameters:

requestTimeoutMilliseconds - The maximum time, in milliseconds, that MediaTailor waits for a response from the AWS service. This parameter is required. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values are 100 to 2000.

Returns:

this

runtime

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

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getRuntime()

Parameters:

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

Returns:

this

targetRegion

@Stability(Stable)
public CfnFunction.AwsServiceRequestConfigurationProperty.Builder targetRegion(String targetRegion)

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getTargetRegion()

Parameters:

targetRegion - The AWS Region for the target service. This parameter is required. Specify a static Region code (for example, us-east-1) or a JSONata expression that resolves to a Region code at runtime (for example, {%inference.region%}).

Returns:

this

targetService

@Stability(Stable)
public CfnFunction.AwsServiceRequestConfigurationProperty.Builder targetService(String targetService)

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getTargetService()

Parameters:

targetService - The AWS service to call. This parameter is required. Valid value: elemental-inference (AWS Elemental Inference).

Returns:

this

url

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

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getUrl()

Parameters:

url - An expression that evaluates to the endpoint URL for the target AWS service API operation. This parameter is required. Use {%...%} delimiters for dynamic expressions. The URL must correspond to a valid endpoint for the service specified in TargetService. The maximum length after evaluation is 2,048 characters.

Returns:

this

body

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

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getBody()

Parameters:

body - An expression that evaluates to the request body for the AWS service API call. The body must conform to the input format that the target service operation expects. Applies only when the target operation accepts a request body. The maximum size after evaluation is 64 KB.

Returns:

this

headers

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

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.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 to the AWS service. Use this to pass any headers required by the target service operation. You can include a maximum of 50 headers.

Returns:

this

headers

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

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.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 to the AWS service. Use this to pass any headers required by the target service operation. You can include a maximum of 50 headers.

Returns:

this

output

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

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getOutput()

Parameters:

output - A map of output bindings. Each key is a namespaced output path, such as player_params.device_type. Each value is an expression that MediaTailor evaluates at runtime and can reference the response object from the target service. For more information, 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.AwsServiceRequestConfigurationProperty.Builder output(Map<String,String> output)

Sets the value of CfnFunction.AwsServiceRequestConfigurationProperty.getOutput()

Parameters:

output - A map of output bindings. Each key is a namespaced output path, such as player_params.device_type. Each value is an expression that MediaTailor evaluates at runtime and can reference the response object from the target service. For more information, 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.AwsServiceRequestConfigurationProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnFunction.AwsServiceRequestConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided