View a markdown version of this page

WorkspaceEncryptionConfigurationInfo - Amazon IoT SiteWise
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).

WorkspaceEncryptionConfigurationInfo

Contains the encryption configuration information for a workspace.

Contents

encryptionType

The type of encryption used for the workspace.

Type: String

Valid Values: SITEWISE_DEFAULT_ENCRYPTION | KMS_BASED_ENCRYPTION

Required: Yes

kmsKeyArn

The key ARN of the Amazon KMS key used for Amazon KMS encryption if encryptionType is KMS_BASED_ENCRYPTION.

Type: String

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

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

Required: No

See Also

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