Skip to content

/AWS1/CL_IOSWORKSPACEENCCONF

Contains the encryption configuration for a workspace.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_encryptiontype TYPE /AWS1/IOSENCRYPTIONTYPE /AWS1/IOSENCRYPTIONTYPE

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.

Optional arguments:

iv_kmskeyid TYPE /AWS1/IOSKMSKEYID /AWS1/IOSKMSKEYID

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.


Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_ENCRYPTIONTYPE() Getter for ENCRYPTIONTYPE, with configurable default
ASK_ENCRYPTIONTYPE() Getter for ENCRYPTIONTYPE w/ exceptions if field has no valu
HAS_ENCRYPTIONTYPE() Determine if ENCRYPTIONTYPE has a value

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.

Accessible with the following methods

Method Description
GET_KMSKEYID() Getter for KMSKEYID, with configurable default
ASK_KMSKEYID() Getter for KMSKEYID w/ exceptions if field has no value
HAS_KMSKEYID() Determine if KMSKEYID has a value