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

Class: Aws::MediaConvert::Types::HlsEncryptionSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing HlsEncryptionSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  constant_initialization_vector: "__stringMin32Max32Pattern09aFAF32",
  encryption_method: "AES128", # accepts AES128, SAMPLE_AES
  initialization_vector_in_manifest: "INCLUDE", # accepts INCLUDE, EXCLUDE
  offline_encrypted: "ENABLED", # accepts ENABLED, DISABLED
  speke_key_provider: {
    certificate_arn: "__stringPatternArnAwsUsGovAcm",
    resource_id: "__string",
    system_ids: ["__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
    url: "__stringPatternHttps",
  },
  static_key_provider: {
    key_format: "__stringPatternIdentityAZaZ26AZaZ09163",
    key_format_versions: "__stringPatternDD",
    static_key_value: "__stringPatternAZaZ0932",
    url: "__string",
  },
  type: "SPEKE", # accepts SPEKE, STATIC_KEY
}

Settings for HLS encryption

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#constant_initialization_vector ⇒ String

This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.

Returns:

  • (String) —

    This is a 128-bit, 16-byte hex value represented by a 32-character text string.

#encryption_method ⇒ String

Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting \'Disabled\' in the web interface also disables encryption.

Possible values:

  • AES128
  • SAMPLE_AES

Returns:

  • (String) —

    Encrypts the segments with the given encryption scheme.

#initialization_vector_in_manifest ⇒ String

The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.

Possible values:

  • INCLUDE
  • EXCLUDE

Returns:

  • (String) —

    The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.

#offline_encrypted ⇒ String

Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String) —

    Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.

#speke_key_provider ⇒ Types::SpekeKeyProvider

If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.

Returns:

  • (Types::SpekeKeyProvider) —

    If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider.

#static_key_provider ⇒ Types::StaticKeyProvider

Use these settings to set up encryption with a static key provider.

Returns:

#type ⇒ String

Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.

Possible values:

  • SPEKE
  • STATIC_KEY

Returns:

  • (String) —

    Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.