Class: Aws::IVSRealTime::Types::StartCompositionRequest

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::StartCompositionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ivsrealtime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #destinations ⇒ Array<Types::DestinationConfiguration>

  Array of destination configuration.

• #idempotency_token ⇒ String

  Idempotency token.

• #layout ⇒ Types::LayoutConfiguration

  Layout object to configure composition parameters.

• #stage_arn ⇒ String

  ARN of the stage to be used for compositing.

• #tags ⇒ Hash<String,String>

  Tags attached to the resource.

Instance Attribute Details

#destinations ⇒ Array<Types::DestinationConfiguration>

Array of destination configuration.

Returns:

• (Array<Types::DestinationConfiguration>)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2494

class StartCompositionRequest < Struct.new(
  :stage_arn,
  :idempotency_token,
  :layout,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_token ⇒ String

Idempotency token.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2494

class StartCompositionRequest < Struct.new(
  :stage_arn,
  :idempotency_token,
  :layout,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#layout ⇒ Types::LayoutConfiguration

Layout object to configure composition parameters.

Returns:

• (Types::LayoutConfiguration)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2494

class StartCompositionRequest < Struct.new(
  :stage_arn,
  :idempotency_token,
  :layout,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stage_arn ⇒ String

ARN of the stage to be used for compositing.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2494

class StartCompositionRequest < Struct.new(
  :stage_arn,
  :idempotency_token,
  :layout,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags attached to the resource. Array of maps, each of the form ‘string:string (key:value)`. See [Best practices and strategies] in *Tagging AWS Resources and Tag Editor* for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 2494

class StartCompositionRequest < Struct.new(
  :stage_arn,
  :idempotency_token,
  :layout,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end