View a markdown version of this page

WorkspaceEncryptionConfiguration - Amazon IoT SiteWise
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

WorkspaceEncryptionConfiguration

Contains the encryption configuration for a workspace.

Contents

encryptionType

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

Type: String

Valid Values: SITEWISE_DEFAULT_ENCRYPTION | KMS_BASED_ENCRYPTION

Required: Yes

kmsKeyId

The customer managed Amazon 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: