Skip to content

UpdateEncryption

Source code in docs_src/capo_mediaconnect/types/update_encryption.py
class UpdateEncryption(TypedDict, closed=True):
    algorithm: NotRequired["capo_mediaconnect.types.algorithm.Algorithm"]
    """<p> The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).</p>"""
    constant_initialization_vector: NotRequired["str"]
    """<p> 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.</p>"""
    device_id: NotRequired["str"]
    """<p> 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.</p>"""
    key_type: NotRequired["capo_mediaconnect.types.key_type.KeyType"]
    """<p> The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).</p>"""
    region: NotRequired["str"]
    """<p> The Amazon Web Services 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.</p>"""
    resource_id: NotRequired["str"]
    """<p> 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. </p>"""
    role_arn: NotRequired["str"]
    """<p> The ARN of the role that you created during setup (when you set up MediaConnect as a trusted entity).</p>"""
    secret_arn: NotRequired["str"]
    """<p> The ARN of the secret that you created in Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.</p>"""
    url: NotRequired["str"]
    """<p> 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.</p>"""

algorithm instance-attribute

algorithm: NotRequired[Algorithm]

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

constant_initialization_vector instance-attribute

constant_initialization_vector: NotRequired[str]

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.

device_id instance-attribute

device_id: NotRequired[str]

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.

key_type instance-attribute

key_type: NotRequired[KeyType]

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

region instance-attribute

region: NotRequired[str]

The Amazon Web Services 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.

resource_id instance-attribute

resource_id: NotRequired[str]

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.

role_arn instance-attribute

role_arn: NotRequired[str]

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

secret_arn instance-attribute

secret_arn: NotRequired[str]

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

url instance-attribute

url: NotRequired[str]

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.