View a markdown version of this page

AWS::MediaTailor::Function - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::MediaTailor::Function

Defines reusable logic that MediaTailor executes at lifecycle hooks during ad insertion. The FunctionType determines the function's runtime behavior. For more information about functions, see Working with functions in the MediaTailor User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::MediaTailor::Function",
  "Properties" : {
      "CustomOutputConfiguration" : CustomOutputConfiguration,
      "Description" : String,
      "FunctionId" : String,
      "FunctionType" : String,
      "HttpRequestConfiguration" : HttpRequestConfiguration,
      "SequentialExecutorConfiguration" : SequentialExecutorConfiguration,
      "Tags" : [ Tag, ... ]
    }
}

Properties

CustomOutputConfiguration

The configuration for a CUSTOM_OUTPUT function.

Required: No

Type: CustomOutputConfiguration

Update requires: No interruption

Description

A description of the function.

Required: No

Type: String

Update requires: No interruption

FunctionId

The identifier of the function.

Required: Yes

Type: String

Update requires: Replacement

FunctionType

The type of the function.

Required: Yes

Type: String

Allowed values: HTTP_REQUEST | CUSTOM_OUTPUT | SEQUENTIAL_EXECUTOR

Update requires: No interruption

HttpRequestConfiguration

The configuration for an HTTP_REQUEST function.

Required: No

Type: HttpRequestConfiguration

Update requires: No interruption

SequentialExecutorConfiguration

The configuration for a SEQUENTIAL_EXECUTOR function.

Required: No

Type: SequentialExecutorConfiguration

Update requires: No interruption

Tags

The tags assigned to the function. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the function.