Class: Aws::IVS::Types::CreateRecordingConfigurationRequest

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

Overview

Note:

When making an API call, you may pass CreateRecordingConfigurationRequest data as a hash:

{
  destination_configuration: { # required
    s3: {
      bucket_name: "S3DestinationBucketName", # required
    },
  },
  name: "RecordingConfigurationName",
  tags: {
    "TagKey" => "TagValue",
  },
  thumbnail_configuration: {
    recording_mode: "DISABLED", # accepts DISABLED, INTERVAL
    target_interval_seconds: 1,
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_configurationTypes::DestinationConfiguration

A complex type that contains a destination configuration for where recorded video will be stored.



449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 449

class CreateRecordingConfigurationRequest < Struct.new(
  :destination_configuration,
  :name,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Recording-configuration name. The value does not need to be unique.

Returns:

  • (String)


449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 449

class CreateRecordingConfigurationRequest < Struct.new(
  :destination_configuration,
  :name,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

Returns:

  • (Hash<String,String>)


449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 449

class CreateRecordingConfigurationRequest < Struct.new(
  :destination_configuration,
  :name,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#thumbnail_configurationTypes::ThumbnailConfiguration

A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.



449
450
451
452
453
454
455
456
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 449

class CreateRecordingConfigurationRequest < Struct.new(
  :destination_configuration,
  :name,
  :tags,
  :thumbnail_configuration)
  SENSITIVE = []
  include Aws::Structure
end