You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticTranscoder::Types::HlsContentProtection

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

Overview

Note:

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

{
  method: "HlsContentProtectionMethod",
  key: "Base64EncodedString",
  key_md_5: "Base64EncodedString",
  initialization_vector: "ZeroTo255String",
  license_acquisition_url: "ZeroTo512String",
  key_storage_policy: "KeyStoragePolicy",
}

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.

Instance Attribute Summary collapse

Instance Attribute Details

#initialization_vectorString

If Elastic Transcoder is generating your key for you, you must leave this field blank.

The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.

Returns:

  • (String)


2138
2139
2140
2141
2142
2143
2144
2145
2146
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2138

class HlsContentProtection < Struct.new(
  :method,
  :key,
  :key_md_5,
  :initialization_vector,
  :license_acquisition_url,
  :key_storage_policy)
  include Aws::Structure
end

#keyString

If you want Elastic Transcoder to generate a key for you, leave this field blank.

If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:

128, 192, or 256.

Returns:

  • (String)


2138
2139
2140
2141
2142
2143
2144
2145
2146
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2138

class HlsContentProtection < Struct.new(
  :method,
  :key,
  :key_md_5,
  :initialization_vector,
  :license_acquisition_url,
  :key_storage_policy)
  include Aws::Structure
end

#key_md_5String

If Elastic Transcoder is generating your key for you, you must leave this field blank.

The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.

Returns:

  • (String)


2138
2139
2140
2141
2142
2143
2144
2145
2146
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2138

class HlsContentProtection < Struct.new(
  :method,
  :key,
  :key_md_5,
  :initialization_vector,
  :license_acquisition_url,
  :key_storage_policy)
  include Aws::Structure
end

#key_storage_policyString

Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist.

Returns:

  • (String)


2138
2139
2140
2141
2142
2143
2144
2145
2146
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2138

class HlsContentProtection < Struct.new(
  :method,
  :key,
  :key_md_5,
  :initialization_vector,
  :license_acquisition_url,
  :key_storage_policy)
  include Aws::Structure
end

#license_acquisition_urlString

The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.

Returns:

  • (String)


2138
2139
2140
2141
2142
2143
2144
2145
2146
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2138

class HlsContentProtection < Struct.new(
  :method,
  :key,
  :key_md_5,
  :initialization_vector,
  :license_acquisition_url,
  :key_storage_policy)
  include Aws::Structure
end

#methodString

The content protection method for your output. The only valid value is: aes-128.

This value is written into the method attribute of the EXT-X-KEY metadata tag in the output playlist.

Returns:

  • (String)


2138
2139
2140
2141
2142
2143
2144
2145
2146
# File 'gems/aws-sdk-elastictranscoder/lib/aws-sdk-elastictranscoder/types.rb', line 2138

class HlsContentProtection < Struct.new(
  :method,
  :key,
  :key_md_5,
  :initialization_vector,
  :license_acquisition_url,
  :key_storage_policy)
  include Aws::Structure
end