MedicalScribeEncryptionSettings Class | AWS SDK for .NET Version 4

Contains encryption related settings to be used for data encryption with Key Management Service, including KmsEncryptionContext and KmsKeyId. The KmsKeyId is required, while KmsEncryptionContext is optional for additional layer of security.

By default, Amazon Web Services HealthScribe provides encryption at rest to protect sensitive customer data using Amazon S3-managed keys. HealthScribe uses the KMS key you specify as a second layer of encryption.

Your ResourceAccessRoleArn must permission to use your KMS key. For more information, see Data Encryption at rest for Amazon Web Services HealthScribe.

Inheritance Hierarchy

System.Object
Amazon.TranscribeStreaming.Model.MedicalScribeEncryptionSettings

Namespace: Amazon.TranscribeStreaming.Model
Assembly: AWSSDK.TranscribeStreaming.dll
Version: 3.x.y.z

Syntax

public class MedicalScribeEncryptionSettings

The MedicalScribeEncryptionSettings type exposes the following members

Constructors

	Name	Description
	MedicalScribeEncryptionSettings()

Properties

Name Type Description

	Name	Type	Description
	KmsEncryptionContext	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property KmsEncryptionContext. A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMSencryption context and Asymmetric keys in KMS . Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
	KmsKeyId	System.String	Gets and sets the property KmsKeyId. The ID of the KMS key you want to use for your streaming session. You can specify its KMS key ID, key Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with `"alias/"`. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN. For example: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias To get the key ID and key ARN for a KMS key, use the ListKeys or DescribeKey KMS API operations. To get the alias name and alias ARN, use ListKeys API operation.

KmsEncryptionContext

System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property KmsEncryptionContext.

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMSencryption context and Asymmetric keys in KMS .

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

KmsKeyId

System.String

Gets and sets the property KmsKeyId.

The ID of the KMS key you want to use for your streaming session. You can specify its KMS key ID, key Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use the ListKeys or DescribeKey KMS API operations. To get the alias name and alias ARN, use ListKeys API operation.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer