Interface CfnFunction.AwsServiceRequestConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFunction.AwsServiceRequestConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnFunction
Contains the target service, target Region, and request parameters that the function uses to call an AWS service API. For more information, see AWS_SERVICE_REQUEST (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-types-aws-service-request.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.*;
AwsServiceRequestConfigurationProperty awsServiceRequestConfigurationProperty = AwsServiceRequestConfigurationProperty.builder()
.methodType("methodType")
.requestTimeoutMilliseconds(123)
.runtime("runtime")
.targetRegion("targetRegion")
.targetService("targetService")
.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.AwsServiceRequestConfigurationPropertystatic final classAn implementation forCfnFunction.AwsServiceRequestConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringgetBody()An expression that evaluates to the request body for the AWS service API call.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 AWS service.The expression language used to evaluate expressions in the function configuration.The AWS Region for the target service.The AWS service to call.getUrl()An expression that evaluates to the endpoint URL for the target AWS service API operation.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 AWS service.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.
- See Also:
-
getRuntime
The expression language used to evaluate expressions in the function configuration.Set this to JSONATA.
- See Also:
-
getTargetRegion
The AWS Region for the target service.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%}).
- See Also:
-
getTargetService
The AWS service to call.Valid value: elemental-inference (AWS Elemental Inference).
- See Also:
-
getUrl
An expression that evaluates to the endpoint URL for the target AWS service API operation.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.
- See Also:
-
getBody
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.
- 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 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 union: either
IResolvableor Mapinvalid input: '<'String,String>- See Also:
-
getOutput
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 union: either
IResolvableor Mapinvalid input: '<'String,String>- See Also:
-
builder
-