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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destinations ⇒ Array<Types::DestinationConfiguration>

Array of destination configuration.

Returns:



2454
2455
2456
2457
2458
2459
2460
2461
2462
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 2454

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) 


2454
2455
2456
2457
2458
2459
2460
2461
2462
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 2454

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:



2454
2455
2456
2457
2458
2459
2460
2461
2462
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 2454

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) 


2454
2455
2456
2457
2458
2459
2460
2461
2462
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 2454

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.

Returns:

  • (Hash<String,String>) 


2454
2455
2456
2457
2458
2459
2460
2461
2462
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 2454

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