/******************************************************************************* * 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.ServiceCatalog; using Amazon.ServiceCatalog.Model; namespace Amazon.PowerShell.Cmdlets.SC { /// /// Terminates the specified provisioned product. /// /// /// /// This operation does not delete any records associated with the provisioned product. /// /// You can check the status of this request using DescribeRecord. /// /// [Cmdlet("Remove", "SCProvisionedProduct", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("Amazon.ServiceCatalog.Model.RecordDetail")] [AWSCmdlet("Calls the AWS Service Catalog TerminateProvisionedProduct API operation.", Operation = new[] {"TerminateProvisionedProduct"}, SelectReturnType = typeof(Amazon.ServiceCatalog.Model.TerminateProvisionedProductResponse))] [AWSCmdletOutput("Amazon.ServiceCatalog.Model.RecordDetail or Amazon.ServiceCatalog.Model.TerminateProvisionedProductResponse", "This cmdlet returns an Amazon.ServiceCatalog.Model.RecordDetail object.", "The service call response (type Amazon.ServiceCatalog.Model.TerminateProvisionedProductResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveSCProvisionedProductCmdlet : AmazonServiceCatalogClientCmdlet, IExecutor { #region Parameter AcceptLanguage /// /// /// The language code. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AcceptLanguage { get; set; } #endregion #region Parameter IgnoreError /// /// /// If set to true, Service Catalog stops managing the specified provisioned product even /// if it cannot delete the underlying resources. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("IgnoreErrors")] public System.Boolean? IgnoreError { get; set; } #endregion #region Parameter ProvisionedProductId /// /// /// The identifier of the provisioned product. You cannot specify both ProvisionedProductName /// and ProvisionedProductId. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String ProvisionedProductId { get; set; } #endregion #region Parameter ProvisionedProductName /// /// /// The name of the provisioned product. You cannot specify both ProvisionedProductName /// and ProvisionedProductId. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ProvisionedProductName { get; set; } #endregion #region Parameter RetainPhysicalResource /// /// /// When this boolean parameter is set to true, the TerminateProvisionedProduct /// API deletes the Service Catalog provisioned product. However, it does not remove the /// CloudFormation stack, stack set, or the underlying resources of the deleted provisioned /// product. The default value is false. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("RetainPhysicalResources")] public System.Boolean? RetainPhysicalResource { get; set; } #endregion #region Parameter TerminateToken /// /// /// An idempotency token that uniquely identifies the termination request. This token /// is only valid during the termination process. After the provisioned product is terminated, /// subsequent requests to terminate the same provisioned product always return ResourceNotFound. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String TerminateToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'RecordDetail'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ServiceCatalog.Model.TerminateProvisionedProductResponse). /// Specifying the name of a property of type Amazon.ServiceCatalog.Model.TerminateProvisionedProductResponse 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; } = "RecordDetail"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ProvisionedProductId parameter. /// The -PassThru parameter is deprecated, use -Select '^ProvisionedProductId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ProvisionedProductId' 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.ProvisionedProductId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-SCProvisionedProduct (TerminateProvisionedProduct)")) { 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.ProvisionedProductId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AcceptLanguage = this.AcceptLanguage; context.IgnoreError = this.IgnoreError; context.ProvisionedProductId = this.ProvisionedProductId; context.ProvisionedProductName = this.ProvisionedProductName; context.RetainPhysicalResource = this.RetainPhysicalResource; context.TerminateToken = this.TerminateToken; // 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.ServiceCatalog.Model.TerminateProvisionedProductRequest(); if (cmdletContext.AcceptLanguage != null) { request.AcceptLanguage = cmdletContext.AcceptLanguage; } if (cmdletContext.IgnoreError != null) { request.IgnoreErrors = cmdletContext.IgnoreError.Value; } if (cmdletContext.ProvisionedProductId != null) { request.ProvisionedProductId = cmdletContext.ProvisionedProductId; } if (cmdletContext.ProvisionedProductName != null) { request.ProvisionedProductName = cmdletContext.ProvisionedProductName; } if (cmdletContext.RetainPhysicalResource != null) { request.RetainPhysicalResources = cmdletContext.RetainPhysicalResource.Value; } if (cmdletContext.TerminateToken != null) { request.TerminateToken = cmdletContext.TerminateToken; } 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.ServiceCatalog.Model.TerminateProvisionedProductResponse CallAWSServiceOperation(IAmazonServiceCatalog client, Amazon.ServiceCatalog.Model.TerminateProvisionedProductRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Service Catalog", "TerminateProvisionedProduct"); try { #if DESKTOP return client.TerminateProvisionedProduct(request); #elif CORECLR return client.TerminateProvisionedProductAsync(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 AcceptLanguage { get; set; } public System.Boolean? IgnoreError { get; set; } public System.String ProvisionedProductId { get; set; } public System.String ProvisionedProductName { get; set; } public System.Boolean? RetainPhysicalResource { get; set; } public System.String TerminateToken { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.RecordDetail; } } }