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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destinationsArray<Types::DestinationConfiguration>

Array of destination configuration.



1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1820

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

#idempotency_tokenString

Idempotency token.

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

Returns:

  • (String)


1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1820

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

#layoutTypes::LayoutConfiguration

Layout object to configure composition parameters.



1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1820

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

#stage_arnString

ARN of the stage to be used for compositing.

Returns:

  • (String)


1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1820

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

#tagsHash<String,String>

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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>)


1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 1820

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