Container for the parameters to the DisableKey operation. Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS key for cryptographic operations.
For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:DisableKey (key policy)
Related operations: EnableKey
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.DisableKeyRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class DisableKeyRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The DisableKeyRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DisableKeyRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId. Identifies the KMS key to disable. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
Examples
The following example disables the specified KMS key.
To disable a KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.DisableKey(new DisableKeyRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab" // The identifier of the KMS key to disable. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
});
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5