/******************************************************************************* * 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.Lightsail; using Amazon.Lightsail.Model; namespace Amazon.PowerShell.Cmdlets.LS { /// /// Stops a specific Amazon Lightsail instance that is currently running. /// /// /// When you start a stopped instance, Lightsail assigns a new public IP address to the /// instance. To use the same IP address after stopping and starting an instance, create /// a static IP address and attach it to the instance. For more information, see the Amazon /// Lightsail Developer Guide. /// /// The stop instance operation supports tag-based access control via resource /// tags applied to the resource identified by instance name. For more information, /// see the Amazon /// Lightsail Developer Guide. /// /// [Cmdlet("Stop", "LSInstance", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Lightsail.Model.Operation")] [AWSCmdlet("Calls the Amazon Lightsail StopInstance API operation.", Operation = new[] {"StopInstance"}, SelectReturnType = typeof(Amazon.Lightsail.Model.StopInstanceResponse))] [AWSCmdletOutput("Amazon.Lightsail.Model.Operation or Amazon.Lightsail.Model.StopInstanceResponse", "This cmdlet returns a collection of Amazon.Lightsail.Model.Operation objects.", "The service call response (type Amazon.Lightsail.Model.StopInstanceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StopLSInstanceCmdlet : AmazonLightsailClientCmdlet, IExecutor { #region Parameter OverrideStuck /// /// /// When set to True, forces a Lightsail instance that is stuck in a stopping /// state to stop.Only use the force parameter if your instance is stuck in the stopping /// state. In any other state, your instance should stop normally without adding this /// parameter to your API request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? OverrideStuck { get; set; } #endregion #region Parameter InstanceName /// /// /// The name of the instance (a virtual private server) to stop. /// /// #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 InstanceName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Operations'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.StopInstanceResponse). /// Specifying the name of a property of type Amazon.Lightsail.Model.StopInstanceResponse 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; } = "Operations"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the InstanceName parameter. /// The -PassThru parameter is deprecated, use -Select '^InstanceName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceName' 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.InstanceName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Stop-LSInstance (StopInstance)")) { 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.InstanceName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.OverrideStuck = this.OverrideStuck; context.InstanceName = this.InstanceName; #if MODULAR if (this.InstanceName == null && ParameterWasBound(nameof(this.InstanceName))) { WriteWarning("You are passing $null as a value for parameter InstanceName 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.Lightsail.Model.StopInstanceRequest(); if (cmdletContext.OverrideStuck != null) { request.Force = cmdletContext.OverrideStuck.Value; } if (cmdletContext.InstanceName != null) { request.InstanceName = cmdletContext.InstanceName; } 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.Lightsail.Model.StopInstanceResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.StopInstanceRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "StopInstance"); try { #if DESKTOP return client.StopInstance(request); #elif CORECLR return client.StopInstanceAsync(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.Boolean? OverrideStuck { get; set; } public System.String InstanceName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Operations; } } }