/******************************************************************************* * 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.Proton; using Amazon.Proton.Model; namespace Amazon.PowerShell.Cmdlets.PRO { /// /// Attempts to cancel a service instance deployment on an UpdateServiceInstance /// action, if the deployment is IN_PROGRESS. For more information, see Update /// a service instance in the Proton User guide. /// /// /// /// The following list includes potential cancellation scenarios. /// /// [Cmdlet("Stop", "PROServiceInstanceDeployment", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Proton.Model.ServiceInstance")] [AWSCmdlet("Calls the AWS Proton CancelServiceInstanceDeployment API operation.", Operation = new[] {"CancelServiceInstanceDeployment"}, SelectReturnType = typeof(Amazon.Proton.Model.CancelServiceInstanceDeploymentResponse))] [AWSCmdletOutput("Amazon.Proton.Model.ServiceInstance or Amazon.Proton.Model.CancelServiceInstanceDeploymentResponse", "This cmdlet returns an Amazon.Proton.Model.ServiceInstance object.", "The service call response (type Amazon.Proton.Model.CancelServiceInstanceDeploymentResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StopPROServiceInstanceDeploymentCmdlet : AmazonProtonClientCmdlet, IExecutor { protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter ServiceInstanceName /// /// /// The name of the service instance with the deployment to cancel. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String ServiceInstanceName { get; set; } #endregion #region Parameter ServiceName /// /// /// The name of the service with the service instance deployment to cancel. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String ServiceName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ServiceInstance'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Proton.Model.CancelServiceInstanceDeploymentResponse). /// Specifying the name of a property of type Amazon.Proton.Model.CancelServiceInstanceDeploymentResponse 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; } = "ServiceInstance"; #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 = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Stop-PROServiceInstanceDeployment (CancelServiceInstanceDeployment)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.ServiceInstanceName = this.ServiceInstanceName; #if MODULAR if (this.ServiceInstanceName == null && ParameterWasBound(nameof(this.ServiceInstanceName))) { WriteWarning("You are passing $null as a value for parameter ServiceInstanceName 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.ServiceName = this.ServiceName; #if MODULAR if (this.ServiceName == null && ParameterWasBound(nameof(this.ServiceName))) { WriteWarning("You are passing $null as a value for parameter ServiceName 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.Proton.Model.CancelServiceInstanceDeploymentRequest(); if (cmdletContext.ServiceInstanceName != null) { request.ServiceInstanceName = cmdletContext.ServiceInstanceName; } if (cmdletContext.ServiceName != null) { request.ServiceName = cmdletContext.ServiceName; } 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.Proton.Model.CancelServiceInstanceDeploymentResponse CallAWSServiceOperation(IAmazonProton client, Amazon.Proton.Model.CancelServiceInstanceDeploymentRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Proton", "CancelServiceInstanceDeployment"); try { #if DESKTOP return client.CancelServiceInstanceDeployment(request); #elif CORECLR return client.CancelServiceInstanceDeploymentAsync(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 ServiceInstanceName { get; set; } public System.String ServiceName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ServiceInstance; } } }