Class: Aws::MediaTailor::Types::Function

Inherits:

Struct

• Object
• Struct
• Aws::MediaTailor::Types::Function

Defined in:

gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the function.

• #aws_service_request_configuration ⇒ Types::AwsServiceRequestConfiguration

  The configuration for an AWS_SERVICE_REQUEST function.

• #concurrent_executor_configuration ⇒ Types::ConcurrentExecutorConfiguration

  The configuration for a CONCURRENT_EXECUTOR function.

• #custom_output_configuration ⇒ Types::CustomOutputConfiguration

  The configuration for a CUSTOM_OUTPUT function.

• #description ⇒ String

  A description of the function.

• #function_id ⇒ String

  The identifier of the function.

• #function_type ⇒ String

  The type of the function.

• #http_request_configuration ⇒ Types::HttpRequestConfiguration

  The configuration for an HTTP_REQUEST function.

• #sequential_executor_configuration ⇒ Types::SequentialExecutorConfiguration

  The configuration for a SEQUENTIAL_EXECUTOR function.

• #tags ⇒ Hash<String,String>

  The tags assigned to the function.

• #vast_request_configuration ⇒ Types::VastRequestConfiguration

  The configuration for a VAST_REQUEST function.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the function.

Returns:

• (String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#aws_service_request_configuration ⇒ Types::AwsServiceRequestConfiguration

The configuration for an AWS_SERVICE_REQUEST function. Specifies the target service, target Region, and request parameters.

Returns:

• (Types::AwsServiceRequestConfiguration)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#concurrent_executor_configuration ⇒ Types::ConcurrentExecutorConfiguration

The configuration for a CONCURRENT_EXECUTOR function.

Returns:

• (Types::ConcurrentExecutorConfiguration)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#custom_output_configuration ⇒ Types::CustomOutputConfiguration

The configuration for a CUSTOM_OUTPUT function.

Returns:

• (Types::CustomOutputConfiguration)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the function.

Returns:

• (String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#function_id ⇒ String

The identifier of the function.

Returns:

• (String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#function_type ⇒ String

The type of the function.

Returns:

• (String)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#http_request_configuration ⇒ Types::HttpRequestConfiguration

The configuration for an HTTP_REQUEST function.

Returns:

• (Types::HttpRequestConfiguration)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#sequential_executor_configuration ⇒ Types::SequentialExecutorConfiguration

The configuration for a SEQUENTIAL_EXECUTOR function.

Returns:

• (Types::SequentialExecutorConfiguration)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#vast_request_configuration ⇒ Types::VastRequestConfiguration

The configuration for a VAST_REQUEST function.

Returns:

• (Types::VastRequestConfiguration)

# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2589

class Function < Struct.new(
  :function_id,
  :function_type,
  :description,
  :http_request_configuration,
  :aws_service_request_configuration,
  :custom_output_configuration,
  :concurrent_executor_configuration,
  :sequential_executor_configuration,
  :vast_request_configuration,
  :tags,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end