Class: AWSCDK::IVS::CfnRecordingConfiguration::RenditionConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::IVS::CfnRecordingConfiguration::RenditionConfigurationProperty

Defined in:

ivs/cfn_recording_configuration.rb

Overview

The RenditionConfiguration property type describes which renditions should be recorded for a stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html

Instance Attribute Summary

• #rendition_selection ⇒ String^? readonly

  The set of renditions are recorded for a stream.

• #renditions ⇒ Array<String>^? readonly

  A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ;.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(renditions: nil, rendition_selection: nil) ⇒ RenditionConfigurationProperty constructor

  A new instance of RenditionConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(renditions: nil, rendition_selection: nil) ⇒ RenditionConfigurationProperty

Returns a new instance of RenditionConfigurationProperty.

Parameters:

• renditions (Array<String>, nil) (defaults to: nil) —

  A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ;

• rendition_selection (String, nil) (defaults to: nil) —

  The set of renditions are recorded for a stream.

# File 'ivs/cfn_recording_configuration.rb', line 637

def initialize(renditions: nil, rendition_selection: nil)
  @renditions = renditions
  Jsii::Type.check_type(@renditions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "renditions") unless @renditions.nil?
  @rendition_selection = rendition_selection
  Jsii::Type.check_type(@rendition_selection, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "renditionSelection") unless @rendition_selection.nil?
end

Instance Attribute Details

#rendition_selection ⇒ String^? (readonly)

Note:

Default: - "ALL"

The set of renditions are recorded for a stream.

For BASIC channels, the CUSTOM value has no effect. If CUSTOM is specified, a set of renditions can be specified in the renditions field. Default: ALL .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration-renditionselection

# File 'ivs/cfn_recording_configuration.rb', line 658

def rendition_selection
  @rendition_selection
end

#renditions ⇒ Array<String>^? (readonly)

A list of which renditions are recorded for a stream, if renditionSelection is CUSTOM ;

otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see Auto-Record to Amazon S3 .

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html#cfn-ivs-recordingconfiguration-renditionconfiguration-renditions

# File 'ivs/cfn_recording_configuration.rb', line 650

def renditions
  @renditions
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ivs/cfn_recording_configuration.rb', line 660

def self.jsii_properties
  {
    :renditions => "renditions",
    :rendition_selection => "renditionSelection",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ivs/cfn_recording_configuration.rb', line 667

def to_jsii
  result = {}
  result.merge!({
    "renditions" => @renditions,
    "renditionSelection" => @rendition_selection,
  })
  result.compact
end