View a markdown version of this page

AWS::MediaTailor::Function HttpRequestConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::MediaTailor::Function HttpRequestConfiguration

The configuration for an HTTP_REQUEST function. Specifies the HTTP method, URL, headers, body, timeout, and output expressions for the request. For more information, see HTTP_REQUEST in the MediaTailor User Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Body" : String,
  "Headers" : {Key: Value, ...},
  "MethodType" : String,
  "Output" : {Key: Value, ...},
  "RequestTimeoutMilliseconds" : Integer,
  "Runtime" : String,
  "Url" : String
}

YAML

  Body: String
  Headers: 
    Key: Value
  MethodType: String
  Output: 
    Key: Value
  RequestTimeoutMilliseconds: Integer
  Runtime: String
  Url: String

Properties

Body

An expression that evaluates to the request body. Used with POST requests. The maximum size after evaluation is 64 KB.

Required: No

Type: String

Update requires: No interruption

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 HTTP request. Maximum 50 headers.

Required: No

Type: Object of String

Pattern: .*

Update requires: No interruption

MethodType

The HTTP method for the request. Valid values: GET and POST.

Required: Yes

Type: String

Allowed values: GET | POST

Update requires: No interruption

Output

A map of output bindings. Each key is a namespaced output path (such as player_params.device_type or temp.identity), and each value is an expression that MediaTailor evaluates at runtime. Output expressions in an HTTP_REQUEST function can reference the response object returned by the HTTP call. For more information about expression syntax, see JSONata expression reference in the MediaTailor User Guide.

Required: No

Type: Object of String

Pattern: .*

Update requires: No interruption

RequestTimeoutMilliseconds

The maximum time, in milliseconds, that MediaTailor waits for a response from the external service. If the call exceeds this timeout, MediaTailor sets the response status code to null and proceeds with output expression evaluation. Valid values: 100 to 2000.

Required: Yes

Type: Integer

Update requires: No interruption

Runtime

The expression language used to evaluate expressions in the function configuration. Set this to JSONata.

Required: Yes

Type: String

Allowed values: JSONATA

Update requires: No interruption

Url

An expression that evaluates to the request URL. Use {%...%} delimiters for dynamic expressions. The maximum length after evaluation is 2,048 characters.

Required: Yes

Type: String

Update requires: No interruption