Class: Aws::MediaPackageV2::Types::SpekeKeyProvider

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

Overview

The parameters for the SPEKE key provider.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arn ⇒ String

The ARN for the certificate that you imported to Amazon Web Services Certificate Manager to add content key encryption to this endpoint. For this feature to work, your DRM key provider must support content key encryption.

Returns:

  • (String) 


4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 4302

class SpekeKeyProvider < Struct.new(
  :encryption_contract_configuration,
  :resource_id,
  :drm_systems,
  :role_arn,
  :url,
  :certificate_arn,
  :speke_version,
  :content_key_period_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#content_key_period_configuration ⇒ Types::ContentKeyPeriodConfiguration

The configuration that controls whether MediaPackage signals the start and end times a content key is used for, in the ContentKeyPeriod sent to your DRM key provider. Signaling this timing is supported only when key rotation is enabled (KeyRotationIntervalSeconds is set to a non-zero value) and SpekeVersion is V2_1. You can update these settings on an existing origin endpoint.

Returns:



4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 4302

class SpekeKeyProvider < Struct.new(
  :encryption_contract_configuration,
  :resource_id,
  :drm_systems,
  :role_arn,
  :url,
  :certificate_arn,
  :speke_version,
  :content_key_period_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#drm_systems ⇒ Array<String>

The DRM solution provider you're using to protect your content during distribution.

Returns:

  • (Array<String>) 


4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 4302

class SpekeKeyProvider < Struct.new(
  :encryption_contract_configuration,
  :resource_id,
  :drm_systems,
  :role_arn,
  :url,
  :certificate_arn,
  :speke_version,
  :content_key_period_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_contract_configuration ⇒ Types::EncryptionContractConfiguration

Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

Returns:



4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 4302

class SpekeKeyProvider < Struct.new(
  :encryption_contract_configuration,
  :resource_id,
  :drm_systems,
  :role_arn,
  :url,
  :certificate_arn,
  :speke_version,
  :content_key_period_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ String

The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

The following example shows a resource ID: MovieNight20171126093045

Returns:

  • (String) 


4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 4302

class SpekeKeyProvider < Struct.new(
  :encryption_contract_configuration,
  :resource_id,
  :drm_systems,
  :role_arn,
  :url,
  :certificate_arn,
  :speke_version,
  :content_key_period_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

Returns:

  • (String) 


4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 4302

class SpekeKeyProvider < Struct.new(
  :encryption_contract_configuration,
  :resource_id,
  :drm_systems,
  :role_arn,
  :url,
  :certificate_arn,
  :speke_version,
  :content_key_period_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#speke_version ⇒ String

Specifies the SPEKE version used with your DRM key provider. If you don't specify a value, the default is V2_0.

The allowed values are:

  • V2_0 - Follows the SPEKE Version 2.0 contract and signals only the content key index in key requests. This is the default.

  • V2_1 - Follows the SPEKE Version 2.1 contract and additionally supports signaling the start and end times a content key is used for, using ContentKeyPeriodConfiguration.

For more information, see SPEKE Version 2.0 payload.

Returns:

  • (String) 


4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 4302

class SpekeKeyProvider < Struct.new(
  :encryption_contract_configuration,
  :resource_id,
  :drm_systems,
  :role_arn,
  :url,
  :certificate_arn,
  :speke_version,
  :content_key_period_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ String

The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

Returns:

  • (String) 


4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'gems/aws-sdk-mediapackagev2/lib/aws-sdk-mediapackagev2/types.rb', line 4302

class SpekeKeyProvider < Struct.new(
  :encryption_contract_configuration,
  :resource_id,
  :drm_systems,
  :role_arn,
  :url,
  :certificate_arn,
  :speke_version,
  :content_key_period_configuration)
  SENSITIVE = []
  include Aws::Structure
end