Container for the parameters to the UpdateEncryptionConfiguration operation. Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account.
Before using this API, you must set up permissions for Amazon Web Services IoT Core to access KMS. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.IoT.AmazonIoTRequest
Amazon.IoT.Model.UpdateEncryptionConfigurationRequest
Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z
Syntax
public class UpdateEncryptionConfigurationRequest : AmazonIoTRequest IAmazonWebServiceRequest
The UpdateEncryptionConfigurationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
UpdateEncryptionConfigurationRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
EncryptionType | Amazon.IoT.EncryptionType |
Gets and sets the property EncryptionType. The type of the KMS key. |
|
|
KmsAccessRoleArn | System.String |
Gets and sets the property KmsAccessRoleArn. The Amazon Resource Name (ARN) of the IAM role assumed by Amazon Web Services IoT Core to call KMS on behalf of the customer. |
|
|
KmsKeyArn | System.String |
Gets and sets the property KmsKeyArn. The ARN of the customer managedKMS key. |
Examples
This operation updates the encryption configuration.
UpdateEncryptionConfiguration example
var client = new AmazonIoTClient();
var response = client.UpdateEncryptionConfiguration(new UpdateEncryptionConfigurationRequest
{
EncryptionType = "CUSTOMER_MANAGED_KMS_KEY",
KmsAccessRoleArn = "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
KmsKeyArn = "arn:aws:iam:us-west-2:111122223333:role/myrole"
});
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