Class: Aws::IVSRealTime::Types::Composition

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

Overview

Object specifying a Composition resource.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

ARN of the Composition resource.

Returns:

  • (String) 


126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 126

class Composition < Struct.new(
  :arn,
  :stage_arn,
  :state,
  :layout,
  :destinations,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ Array<Types::Destination>

Array of Destination objects. A Composition can contain either one destination (‘channel` or `s3`) or two (one `channel` and one `s3`).

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 126

class Composition < Struct.new(
  :arn,
  :stage_arn,
  :state,
  :layout,
  :destinations,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

UTC time of the Composition end. This is an ISO 8601 timestamp; *note that this is returned as a string*.

Returns:

  • (Time) 


126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 126

class Composition < Struct.new(
  :arn,
  :stage_arn,
  :state,
  :layout,
  :destinations,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#layout ⇒ Types::LayoutConfiguration

Layout object to configure composition parameters.

Returns:



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 126

class Composition < Struct.new(
  :arn,
  :stage_arn,
  :state,
  :layout,
  :destinations,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#stage_arn ⇒ String

ARN of the stage used as input

Returns:

  • (String) 


126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 126

class Composition < Struct.new(
  :arn,
  :stage_arn,
  :state,
  :layout,
  :destinations,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

UTC time of the Composition start. This is an ISO 8601 timestamp; *note that this is returned as a string*.

Returns:

  • (Time) 


126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 126

class Composition < Struct.new(
  :arn,
  :stage_arn,
  :state,
  :layout,
  :destinations,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

State of the Composition.

Returns:

  • (String) 


126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 126

class Composition < Struct.new(
  :arn,
  :stage_arn,
  :state,
  :layout,
  :destinations,
  :tags,
  :start_time,
  :end_time)
  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>) 


126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/aws-sdk-ivsrealtime/types.rb', line 126

class Composition < Struct.new(
  :arn,
  :stage_arn,
  :state,
  :layout,
  :destinations,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end