/******************************************************************************* * 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 { /// /// Deletes a custom /// key store. This operation does not affect any backing elements of the custom key /// store. It does not delete the CloudHSM cluster that is associated with an CloudHSM /// key store, or affect any users or keys in the cluster. For an external key store, /// it does not affect the external key store proxy, external key manager, or any external /// keys. /// /// /// /// This operation is part of the custom /// key stores feature in KMS, which combines the convenience and extensive integration /// of KMS with the isolation and control of a key store that you own and manage. /// /// The custom key store that you delete cannot contain any KMS /// keys. Before deleting the key store, verify that you will never need to use any /// of the KMS keys in the key store for any cryptographic /// operations. Then, use ScheduleKeyDeletion to delete the KMS keys from the /// key store. After the required waiting period expires and all KMS keys are deleted /// from the custom key store, use DisconnectCustomKeyStore to disconnect the key /// store from KMS. Then, you can delete the custom key store. /// /// For keys in an CloudHSM key store, the ScheduleKeyDeletion operation /// makes a best effort to delete the key material from the associated cluster. However, /// you might need to manually delete /// the orphaned key material from the cluster and its backups. KMS never creates, /// manages, or deletes cryptographic keys in the external key manager associated with /// an external key store. You must manage them using your external key manager tools. /// /// Instead of deleting the custom key store, consider using the DisconnectCustomKeyStore /// operation to disconnect the custom key store from its backing key store. While the /// key store is disconnected, you cannot create or use the KMS keys in the key store. /// But, you do not need to delete KMS keys and you can reconnect a disconnected custom /// key store at any time. /// /// If the operation succeeds, it returns a JSON object with no properties. /// Cross-account use: No. You cannot perform this operation on a custom key store /// in a different Amazon Web Services account. /// Required permissions: kms:DeleteCustomKeyStore /// (IAM policy) /// Related operations: /// [Cmdlet("Remove", "KMSCustomKeyStore", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("None")] [AWSCmdlet("Calls the AWS Key Management Service DeleteCustomKeyStore API operation.", Operation = new[] {"DeleteCustomKeyStore"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.DeleteCustomKeyStoreResponse))] [AWSCmdletOutput("None or Amazon.KeyManagementService.Model.DeleteCustomKeyStoreResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.KeyManagementService.Model.DeleteCustomKeyStoreResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveKMSCustomKeyStoreCmdlet : AmazonKeyManagementServiceClientCmdlet, IExecutor { #region Parameter CustomKeyStoreId /// /// /// Enter the ID of the custom key store you want to delete. To find the ID of a custom /// key store, use the DescribeCustomKeyStores operation. /// /// #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 CustomKeyStoreId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KeyManagementService.Model.DeleteCustomKeyStoreResponse). /// 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 CustomKeyStoreId parameter. /// The -PassThru parameter is deprecated, use -Select '^CustomKeyStoreId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^CustomKeyStoreId' 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.CustomKeyStoreId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-KMSCustomKeyStore (DeleteCustomKeyStore)")) { 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.CustomKeyStoreId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.CustomKeyStoreId = this.CustomKeyStoreId; #if MODULAR if (this.CustomKeyStoreId == null && ParameterWasBound(nameof(this.CustomKeyStoreId))) { WriteWarning("You are passing $null as a value for parameter CustomKeyStoreId 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 // 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.DeleteCustomKeyStoreRequest(); if (cmdletContext.CustomKeyStoreId != null) { request.CustomKeyStoreId = cmdletContext.CustomKeyStoreId; } 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.DeleteCustomKeyStoreResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.DeleteCustomKeyStoreRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "DeleteCustomKeyStore"); try { #if DESKTOP return client.DeleteCustomKeyStore(request); #elif CORECLR return client.DeleteCustomKeyStoreAsync(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 CustomKeyStoreId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }