/******************************************************************************* * 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.Redshift; using Amazon.Redshift.Model; namespace Amazon.PowerShell.Cmdlets.RS { /// /// Deletes a previously provisioned cluster without its final snapshot being created. /// A successful response from the web service indicates that the request was received /// correctly. Use DescribeClusters to monitor the status of the deletion. The /// delete operation cannot be canceled or reverted once submitted. For more information /// about managing clusters, go to Amazon /// Redshift Clusters in the Amazon Redshift Cluster Management Guide. /// /// /// /// If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot /// to false and specify a name for FinalClusterSnapshotIdentifier. /// You can later restore this snapshot to resume using the cluster. If a final cluster /// snapshot is requested, the status of the cluster will be "final-snapshot" while the /// snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting /// the cluster. /// /// For more information about managing clusters, go to Amazon /// Redshift Clusters in the Amazon Redshift Cluster Management Guide. /// /// [Cmdlet("Remove", "RSCluster", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("Amazon.Redshift.Model.Cluster")] [AWSCmdlet("Calls the Amazon Redshift DeleteCluster API operation.", Operation = new[] {"DeleteCluster"}, SelectReturnType = typeof(Amazon.Redshift.Model.DeleteClusterResponse))] [AWSCmdletOutput("Amazon.Redshift.Model.Cluster or Amazon.Redshift.Model.DeleteClusterResponse", "This cmdlet returns an Amazon.Redshift.Model.Cluster object.", "The service call response (type Amazon.Redshift.Model.DeleteClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveRSClusterCmdlet : AmazonRedshiftClientCmdlet, IExecutor { #region Parameter ClusterIdentifier /// /// /// The identifier of the cluster to be deleted.Constraints: /// /// #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 ClusterIdentifier { get; set; } #endregion #region Parameter FinalClusterSnapshotIdentifier /// /// /// The identifier of the final snapshot that is to be created immediately before deleting /// the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be /// false. Constraints: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String FinalClusterSnapshotIdentifier { get; set; } #endregion #region Parameter FinalClusterSnapshotRetentionPeriod /// /// /// The number of days that a manual snapshot is retained. If the value is -1, the manual /// snapshot is retained indefinitely.The value must be either -1 or an integer between 1 and 3,653.The default value is -1. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? FinalClusterSnapshotRetentionPeriod { get; set; } #endregion #region Parameter SkipFinalClusterSnapshot /// /// /// Determines whether a final snapshot of the cluster is created before Amazon Redshift /// deletes the cluster. If true, a final cluster snapshot is not created. /// If false, a final cluster snapshot is created before the cluster is deleted. /// The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot /// is false.Default: false /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? SkipFinalClusterSnapshot { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Redshift.Model.DeleteClusterResponse). /// Specifying the name of a property of type Amazon.Redshift.Model.DeleteClusterResponse 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; } = "Cluster"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ClusterIdentifier parameter. /// The -PassThru parameter is deprecated, use -Select '^ClusterIdentifier' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ClusterIdentifier' 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.ClusterIdentifier), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-RSCluster (DeleteCluster)")) { 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.ClusterIdentifier; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClusterIdentifier = this.ClusterIdentifier; #if MODULAR if (this.ClusterIdentifier == null && ParameterWasBound(nameof(this.ClusterIdentifier))) { WriteWarning("You are passing $null as a value for parameter ClusterIdentifier 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.FinalClusterSnapshotIdentifier = this.FinalClusterSnapshotIdentifier; context.FinalClusterSnapshotRetentionPeriod = this.FinalClusterSnapshotRetentionPeriod; context.SkipFinalClusterSnapshot = this.SkipFinalClusterSnapshot; // 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.Redshift.Model.DeleteClusterRequest(); if (cmdletContext.ClusterIdentifier != null) { request.ClusterIdentifier = cmdletContext.ClusterIdentifier; } if (cmdletContext.FinalClusterSnapshotIdentifier != null) { request.FinalClusterSnapshotIdentifier = cmdletContext.FinalClusterSnapshotIdentifier; } if (cmdletContext.FinalClusterSnapshotRetentionPeriod != null) { request.FinalClusterSnapshotRetentionPeriod = cmdletContext.FinalClusterSnapshotRetentionPeriod.Value; } if (cmdletContext.SkipFinalClusterSnapshot != null) { request.SkipFinalClusterSnapshot = cmdletContext.SkipFinalClusterSnapshot.Value; } 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.Redshift.Model.DeleteClusterResponse CallAWSServiceOperation(IAmazonRedshift client, Amazon.Redshift.Model.DeleteClusterRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Redshift", "DeleteCluster"); try { #if DESKTOP return client.DeleteCluster(request); #elif CORECLR return client.DeleteClusterAsync(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 ClusterIdentifier { get; set; } public System.String FinalClusterSnapshotIdentifier { get; set; } public System.Int32? FinalClusterSnapshotRetentionPeriod { get; set; } public System.Boolean? SkipFinalClusterSnapshot { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Cluster; } } }