/******************************************************************************* * 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.StorageGateway; using Amazon.StorageGateway.Model; namespace Amazon.PowerShell.Cmdlets.SG { /// <summary> /// Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name /// (ARN) of the gateway in your request. The operation deletes the gateway; however, /// it does not delete the gateway virtual machine (VM) from your host computer. /// /// /// <para> /// After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway /// volumes are not deleted upon deleting the gateway, however, pending snapshots will /// not complete. After you delete a gateway, your next step is to remove it from your /// environment. /// </para><important><para> /// You no longer pay software charges after the gateway is deleted; however, your existing /// Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You /// can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 /// subscription. If you prefer not to cancel your Amazon EC2 subscription, you can delete /// your snapshots using the Amazon EC2 console. For more information, see the <a href="http://aws.amazon.com/storagegateway">Storage /// Gateway detail page</a>. /// </para></important> /// </summary> [Cmdlet("Remove", "SGGateway", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS Storage Gateway DeleteGateway API operation.", Operation = new[] {"DeleteGateway"}, SelectReturnType = typeof(Amazon.StorageGateway.Model.DeleteGatewayResponse))] [AWSCmdletOutput("System.String or Amazon.StorageGateway.Model.DeleteGatewayResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.StorageGateway.Model.DeleteGatewayResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveSGGatewayCmdlet : AmazonStorageGatewayClientCmdlet, IExecutor { #region Parameter GatewayARN /// <summary> /// <para> /// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. /// </para> /// </summary> #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 GatewayARN { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is 'GatewayARN'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StorageGateway.Model.DeleteGatewayResponse). /// Specifying the name of a property of type Amazon.StorageGateway.Model.DeleteGatewayResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "GatewayARN"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the GatewayARN parameter. /// The -PassThru parameter is deprecated, use -Select '^GatewayARN' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^GatewayARN' 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 /// <summary> /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// </summary> [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.GatewayARN), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-SGGateway (DeleteGateway)")) { 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<Amazon.StorageGateway.Model.DeleteGatewayResponse, RemoveSGGatewayCmdlet>(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.GatewayARN; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.GatewayARN = this.GatewayARN; #if MODULAR if (this.GatewayARN == null && ParameterWasBound(nameof(this.GatewayARN))) { WriteWarning("You are passing $null as a value for parameter GatewayARN 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.StorageGateway.Model.DeleteGatewayRequest(); if (cmdletContext.GatewayARN != null) { request.GatewayARN = cmdletContext.GatewayARN; } 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.StorageGateway.Model.DeleteGatewayResponse CallAWSServiceOperation(IAmazonStorageGateway client, Amazon.StorageGateway.Model.DeleteGatewayRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Storage Gateway", "DeleteGateway"); try { #if DESKTOP return client.DeleteGateway(request); #elif CORECLR return client.DeleteGatewayAsync(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 GatewayARN { get; set; } public System.Func<Amazon.StorageGateway.Model.DeleteGatewayResponse, RemoveSGGatewayCmdlet, object> Select { get; set; } = (response, cmdlet) => response.GatewayARN; } } }