AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::MediaConnect::Types::UpdateEncryption

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

Overview

Note:

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

{
  algorithm: "aes128", # accepts aes128, aes192, aes256
  constant_initialization_vector: "__string",
  device_id: "__string",
  key_type: "speke", # accepts speke, static-key, srt-password
  region: "__string",
  resource_id: "__string",
  role_arn: "__string",
  secret_arn: "__string",
  url: "__string",
}

Information about the encryption of the flow.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#algorithmString

The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#constant_initialization_vectorString

A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#device_idString

The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#key_typeString

The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#regionString

The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#resource_idString

An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#urlString

The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.

Returns:

  • (String)


3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 3481

class UpdateEncryption < Struct.new(
  :algorithm,
  :constant_initialization_vector,
  :device_id,
  :key_type,
  :region,
  :resource_id,
  :role_arn,
  :secret_arn,
  :url)
  SENSITIVE = []
  include Aws::Structure
end