Skip to content

WorkspaceEncryptionConfiguration

Used by
Source code in docs_src/capo_iotsitewise/types/workspace_encryption_configuration.py 
14
15
16
17
18
class WorkspaceEncryptionConfiguration(TypedDict, closed=True):
    encryption_type: "capo_iotsitewise.types.encryption_type.EncryptionType"
    """<p>The encryption scheme for the workspace. <code>SITEWISE_DEFAULT_ENCRYPTION</code> encrypts data with the IoT SiteWise default key. <code>KMS_BASED_ENCRYPTION</code> encrypts data with the customer managed KMS key identified by <code>kmsKeyId</code>.</p>"""
    kms_key_id: NotRequired["capo_iotsitewise.types.kms_key_id.KmsKeyId"]
    """<p>The customer managed KMS key used when <code>encryptionType</code> is <code>KMS_BASED_ENCRYPTION</code>. Accepts a key ID, key ARN, or key alias. Required for <code>KMS_BASED_ENCRYPTION</code>; must be omitted for <code>SITEWISE_DEFAULT_ENCRYPTION</code>. After a workspace's customer managed key configuration becomes active, the key can't be changed.</p>"""

encryption_type instance-attribute 

encryption_type: EncryptionType

The encryption scheme for the workspace. SITEWISE_DEFAULT_ENCRYPTION encrypts data with the IoT SiteWise default key. KMS_BASED_ENCRYPTION encrypts data with the customer managed KMS key identified by kmsKeyId.

kms_key_id instance-attribute 

kms_key_id: NotRequired[KmsKeyId]

The customer managed KMS key used when encryptionType is KMS_BASED_ENCRYPTION. Accepts a key ID, key ARN, or key alias. Required for KMS_BASED_ENCRYPTION; must be omitted for SITEWISE_DEFAULT_ENCRYPTION. After a workspace's customer managed key configuration becomes active, the key can't be changed.