/******************************************************************************* * Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * Licensed under the Apache License, Version 2.0 (the "License"). You may not use * this file except in compliance with the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * ***************************************************************************** * * AWS Tools for Windows (TM) PowerShell (TM) * */ using System; using System.Collections.Generic; using System.Linq; using System.Management.Automation; using System.Text; using Amazon.PowerShell.Common; using Amazon.Runtime; using Amazon.KeyManagementService; using Amazon.KeyManagementService.Model; namespace Amazon.PowerShell.Cmdlets.KMS { /// /// Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 /// days, but you can specify a waiting period of 7-30 days. When this operation is successful, /// the key state of the KMS key changes to PendingDeletion and the key can't /// be used in any cryptographic operations. It remains in this state for the duration /// of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion /// to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes /// the KMS key, its key material, and all KMS data associated with it, including all /// aliases that refer to it. /// /// /// Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS /// key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The /// only exception is a multi-Region /// replica key, or an asymmetric /// or HMAC KMS key with imported key material.) To prevent the use of a KMS key without /// deleting it, use DisableKey. /// /// You can schedule the deletion of a multi-Region primary key and its replica keys at /// any time. However, KMS will not delete a multi-Region primary key with existing replica /// keys. If you schedule the deletion of a primary key with replicas, its key state changes /// to PendingReplicaDeletion and it cannot be replicated or used in cryptographic /// operations. This status can continue indefinitely. When the last of its replicas keys /// is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion /// and its waiting period (PendingWindowInDays) begins. For details, see /// Deleting /// multi-Region keys in the Key Management Service Developer Guide. /// /// When KMS deletes /// a KMS key from an CloudHSM key store, it makes a best effort to delete the associated /// key material from the associated CloudHSM cluster. However, you might need to manually /// delete /// the orphaned key material from the cluster and its backups. Deleting /// a KMS key from an external key store has no effect on the associated external /// key. However, for both types of custom key stores, deleting a KMS key is destructive /// and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using /// only its associated external key or CloudHSM key. Also, you cannot recreate a KMS /// key in an external key store by creating a new KMS key with the same key material. /// /// For more information about scheduling a KMS key for deletion, see Deleting /// 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:ScheduleKeyDeletion (key policy) /// Related operations /// [Cmdlet("Request", "KMSKeyDeletion", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.KeyManagementService.Model.ScheduleKeyDeletionResponse")] [AWSCmdlet("Calls the AWS Key Management Service ScheduleKeyDeletion API operation.", Operation = new[] {"ScheduleKeyDeletion"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.ScheduleKeyDeletionResponse))] [AWSCmdletOutput("Amazon.KeyManagementService.Model.ScheduleKeyDeletionResponse", "This cmdlet returns an Amazon.KeyManagementService.Model.ScheduleKeyDeletionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RequestKMSKeyDeletionCmdlet : AmazonKeyManagementServiceClientCmdlet, IExecutor { #region Parameter KeyId /// /// /// The unique identifier of the KMS key to delete.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. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] #else [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String KeyId { get; set; } #endregion #region Parameter PendingWindowInDay /// /// /// The waiting period, specified in number of days. After the waiting period ends, KMS /// deletes the KMS key.If the KMS key is a multi-Region primary key with replica keys, the waiting period /// begins when the last of its replica keys is deleted. Otherwise, the waiting period /// begins immediately.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. You can use the kms:ScheduleKeyDeletionPendingWindowInDays condition key to further /// constrain the values that principals can specify in the PendingWindowInDays /// parameter. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("PendingWindowInDays")] public System.Int32? PendingWindowInDay { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KeyManagementService.Model.ScheduleKeyDeletionResponse). /// Specifying the name of a property of type Amazon.KeyManagementService.Model.ScheduleKeyDeletionResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the KeyId parameter. /// The -PassThru parameter is deprecated, use -Select '^KeyId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^KeyId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter Force /// /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter Force { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.KeyId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Request-KMSKeyDeletion (ScheduleKeyDeletion)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); if (this.PassThru.IsPresent) { throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select)); } } else if (this.PassThru.IsPresent) { context.Select = (response, cmdlet) => this.KeyId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.KeyId = this.KeyId; #if MODULAR if (this.KeyId == null && ParameterWasBound(nameof(this.KeyId))) { WriteWarning("You are passing $null as a value for parameter KeyId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues."); } #endif context.PendingWindowInDay = this.PendingWindowInDay; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.KeyManagementService.Model.ScheduleKeyDeletionRequest(); if (cmdletContext.KeyId != null) { request.KeyId = cmdletContext.KeyId; } if (cmdletContext.PendingWindowInDay != null) { request.PendingWindowInDays = cmdletContext.PendingWindowInDay.Value; } CmdletOutput output; // issue call var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; pipelineOutput = cmdletContext.Select(response, this); output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } return output; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.KeyManagementService.Model.ScheduleKeyDeletionResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.ScheduleKeyDeletionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "ScheduleKeyDeletion"); try { #if DESKTOP return client.ScheduleKeyDeletion(request); #elif CORECLR return client.ScheduleKeyDeletionAsync(request).GetAwaiter().GetResult(); #else #error "Unknown build edition" #endif } catch (AmazonServiceException exc) { var webException = exc.InnerException as System.Net.WebException; if (webException != null) { throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException); } throw; } } #endregion internal partial class CmdletContext : ExecutorContext { public System.String KeyId { get; set; } public System.Int32? PendingWindowInDay { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }