Class CfnFunctionProps

Properties for defining a CfnFunction.

Inheritance

object

CfnFunctionProps

Implements

ICfnFunctionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.MediaTailor

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFunctionProps : ICfnFunctionProps

Syntax (vb)

Public Class CfnFunctionProps Implements ICfnFunctionProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MediaTailor;

             var cfnFunctionProps = new CfnFunctionProps {
                 FunctionId = "functionId",
                 FunctionType = "functionType",

                 // the properties below are optional
                 ConcurrentExecutorConfiguration = new ConcurrentExecutorConfigurationProperty {
                     FunctionList = new [] { new FunctionRefProperty {
                         Alias = "alias",
                         FunctionId = "functionId",
                         RunCondition = "runCondition"
                     } },
                     MaxConcurrency = 123,
                     Output = new Dictionary<string, string> {
                         { "outputKey", "output" }
                     },
                     Runtime = "runtime",
                     TimeoutMilliseconds = 123
                 },
                 CustomOutputConfiguration = new CustomOutputConfigurationProperty {
                     Runtime = "runtime",

                     // the properties below are optional
                     Output = new Dictionary<string, string> {
                         { "outputKey", "output" }
                     }
                 },
                 Description = "description",
                 HttpRequestConfiguration = new HttpRequestConfigurationProperty {
                     MethodType = "methodType",
                     RequestTimeoutMilliseconds = 123,
                     Runtime = "runtime",
                     Url = "url",

                     // the properties below are optional
                     Body = "body",
                     Headers = new Dictionary<string, string> {
                         { "headersKey", "headers" }
                     },
                     Output = new Dictionary<string, string> {
                         { "outputKey", "output" }
                     }
                 },
                 SequentialExecutorConfiguration = new SequentialExecutorConfigurationProperty {
                     FunctionList = new [] { new FunctionRefProperty {
                         Alias = "alias",
                         FunctionId = "functionId",
                         RunCondition = "runCondition"
                     } },
                     Runtime = "runtime",
                     TimeoutMilliseconds = 123,

                     // the properties below are optional
                     Output = new Dictionary<string, string> {
                         { "outputKey", "output" }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnFunctionProps()

Properties for defining a CfnFunction.

Properties

ConcurrentExecutorConfiguration	The configuration for a CONCURRENT_EXECUTOR function.
CustomOutputConfiguration	Configuration for custom output functions.
Description	A description of the function.
FunctionId	The unique identifier for the function.
FunctionType	Properties for defining a CfnFunction.
HttpRequestConfiguration	Configuration for HTTP request functions.
SequentialExecutorConfiguration	The configuration for a SEQUENTIAL_EXECUTOR function.
Tags	The tags to assign to the function resource.

Constructors

CfnFunctionProps()

Properties for defining a CfnFunction.

public CfnFunctionProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.MediaTailor;

             var cfnFunctionProps = new CfnFunctionProps {
                 FunctionId = "functionId",
                 FunctionType = "functionType",

                 // the properties below are optional
                 ConcurrentExecutorConfiguration = new ConcurrentExecutorConfigurationProperty {
                     FunctionList = new [] { new FunctionRefProperty {
                         Alias = "alias",
                         FunctionId = "functionId",
                         RunCondition = "runCondition"
                     } },
                     MaxConcurrency = 123,
                     Output = new Dictionary<string, string> {
                         { "outputKey", "output" }
                     },
                     Runtime = "runtime",
                     TimeoutMilliseconds = 123
                 },
                 CustomOutputConfiguration = new CustomOutputConfigurationProperty {
                     Runtime = "runtime",

                     // the properties below are optional
                     Output = new Dictionary<string, string> {
                         { "outputKey", "output" }
                     }
                 },
                 Description = "description",
                 HttpRequestConfiguration = new HttpRequestConfigurationProperty {
                     MethodType = "methodType",
                     RequestTimeoutMilliseconds = 123,
                     Runtime = "runtime",
                     Url = "url",

                     // the properties below are optional
                     Body = "body",
                     Headers = new Dictionary<string, string> {
                         { "headersKey", "headers" }
                     },
                     Output = new Dictionary<string, string> {
                         { "outputKey", "output" }
                     }
                 },
                 SequentialExecutorConfiguration = new SequentialExecutorConfigurationProperty {
                     FunctionList = new [] { new FunctionRefProperty {
                         Alias = "alias",
                         FunctionId = "functionId",
                         RunCondition = "runCondition"
                     } },
                     Runtime = "runtime",
                     TimeoutMilliseconds = 123,

                     // the properties below are optional
                     Output = new Dictionary<string, string> {
                         { "outputKey", "output" }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

ConcurrentExecutorConfiguration

The configuration for a CONCURRENT_EXECUTOR function.

public object? ConcurrentExecutorConfiguration { get; set; }

Property Value

object

Remarks

A CONCURRENT_EXECUTOR runs a set of child functions in parallel, up to a maximum concurrency, and combines their output when all functions complete. For more information about functions, see Working with functions (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions.html) in the MediaTailor User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-concurrentexecutorconfiguration

Type union: either IResolvable or CfnFunction.IConcurrentExecutorConfigurationProperty

CustomOutputConfiguration

Configuration for custom output functions.

public object? CustomOutputConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-customoutputconfiguration

Type union: either IResolvable or CfnFunction.ICustomOutputConfigurationProperty

Description

A description of the function.

public string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-description

FunctionId

The unique identifier for the function.

public string FunctionId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-functionid

FunctionType

Properties for defining a CfnFunction.

public string FunctionType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-functiontype

HttpRequestConfiguration

Configuration for HTTP request functions.

public object? HttpRequestConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-httprequestconfiguration

Type union: either IResolvable or CfnFunction.IHttpRequestConfigurationProperty

SequentialExecutorConfiguration

The configuration for a SEQUENTIAL_EXECUTOR function.

public object? SequentialExecutorConfiguration { get; set; }

Property Value

object

Remarks

A SEQUENTIAL_EXECUTOR runs an ordered list of child functions one at a time, passing data between them. For more information about functions, see Working with functions (https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions.html) in the MediaTailor User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-sequentialexecutorconfiguration

Type union: either IResolvable or CfnFunction.ISequentialExecutorConfigurationProperty

Tags

The tags to assign to the function resource.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mediatailor-function.html#cfn-mediatailor-function-tags

Implements

ICfnFunctionProps