/******************************************************************************* * 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 { /// /// Sets one or more parameters of the specified parameter group to their default values /// and sets the source values of the parameters to "engine-default". To reset the entire /// parameter group specify the ResetAllParameters parameter. For parameter changes /// to take effect you must reboot any associated clusters. /// [Cmdlet("Reset", "RSClusterParameterGroup", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Redshift.Model.ResetClusterParameterGroupResponse")] [AWSCmdlet("Calls the Amazon Redshift ResetClusterParameterGroup API operation.", Operation = new[] {"ResetClusterParameterGroup"}, SelectReturnType = typeof(Amazon.Redshift.Model.ResetClusterParameterGroupResponse))] [AWSCmdletOutput("Amazon.Redshift.Model.ResetClusterParameterGroupResponse", "This cmdlet returns an Amazon.Redshift.Model.ResetClusterParameterGroupResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class ResetRSClusterParameterGroupCmdlet : AmazonRedshiftClientCmdlet, IExecutor { #region Parameter ParameterGroupName /// /// /// The name of the cluster parameter group to be reset. /// /// #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 ParameterGroupName { get; set; } #endregion #region Parameter Parameter /// /// /// An array of names of parameters to be reset. If ResetAllParameters option is /// not used, then at least one parameter name must be supplied. Constraints: A maximum of 20 parameters can be reset in a single request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Parameters")] public Amazon.Redshift.Model.Parameter[] Parameter { get; set; } #endregion #region Parameter ResetAllParameter /// /// /// If true, all parameters in the specified parameter group will be reset /// to their default values. Default: true /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ResetAllParameters")] public System.Boolean? ResetAllParameter { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Redshift.Model.ResetClusterParameterGroupResponse). /// Specifying the name of a property of type Amazon.Redshift.Model.ResetClusterParameterGroupResponse 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; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ParameterGroupName parameter. /// The -PassThru parameter is deprecated, use -Select '^ParameterGroupName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ParameterGroupName' 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.ParameterGroupName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Reset-RSClusterParameterGroup (ResetClusterParameterGroup)")) { 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.ParameterGroupName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ParameterGroupName = this.ParameterGroupName; #if MODULAR if (this.ParameterGroupName == null && ParameterWasBound(nameof(this.ParameterGroupName))) { WriteWarning("You are passing $null as a value for parameter ParameterGroupName 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 if (this.Parameter != null) { context.Parameter = new List(this.Parameter); } context.ResetAllParameter = this.ResetAllParameter; // 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.ResetClusterParameterGroupRequest(); if (cmdletContext.ParameterGroupName != null) { request.ParameterGroupName = cmdletContext.ParameterGroupName; } if (cmdletContext.Parameter != null) { request.Parameters = cmdletContext.Parameter; } if (cmdletContext.ResetAllParameter != null) { request.ResetAllParameters = cmdletContext.ResetAllParameter.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.ResetClusterParameterGroupResponse CallAWSServiceOperation(IAmazonRedshift client, Amazon.Redshift.Model.ResetClusterParameterGroupRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Redshift", "ResetClusterParameterGroup"); try { #if DESKTOP return client.ResetClusterParameterGroup(request); #elif CORECLR return client.ResetClusterParameterGroupAsync(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 ParameterGroupName { get; set; } public List Parameter { get; set; } public System.Boolean? ResetAllParameter { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }