Amazon.KeyManagementService.AmazonKeyManagementServiceClient.ScheduleKeyDeletionAsync C# (CSharp) Метод

Документация по классу AmazonKeyManagementServiceClient Показать файл Открыть проект

ScheduleKeyDeletionAsync() публичный Метод

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

/// The system timed out while trying to fulfill the request. The request can be retried. /// /// The request was rejected because a specified ARN was not valid. /// /// The request was rejected because an internal exception occurred. The request can be /// retried. /// /// The request was rejected because the state of the specified resource is not valid /// for this request. /// /// /// /// For more information about how key state affects the use of a CMK, see How /// Key State Affects Use of a Customer Master Key in the AWS Key Management Service /// Developer Guide. /// /// /// The request was rejected because the specified entity or resource could not be found. ///

public ScheduleKeyDeletionAsync ( string keyId, int pendingWindowInDays, System cancellationToken = default(CancellationToken) ) : Task
keyId	string	The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
pendingWindowInDays	int	The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
cancellationToken	System	/// A cancellation token that can be used by other objects or threads to receive notice of cancellation. ///
Результат	Task

        public Task<ScheduleKeyDeletionResponse> ScheduleKeyDeletionAsync(string keyId, int pendingWindowInDays, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
        {
            var request = new ScheduleKeyDeletionRequest();
            request.KeyId = keyId;
            request.PendingWindowInDays = pendingWindowInDays;
            return ScheduleKeyDeletionAsync(request, cancellationToken);
        }

Same methods

AmazonKeyManagementServiceClient::ScheduleKeyDeletionAsync ( ScheduleKeyDeletionRequest request, System cancellationToken = default(CancellationToken) ) : Task
AmazonKeyManagementServiceClient::ScheduleKeyDeletionAsync ( string keyId, System cancellationToken = default(CancellationToken) ) : Task