/******************************************************************************* * 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.OpsWorksCM; using Amazon.OpsWorksCM.Model; namespace Amazon.PowerShell.Cmdlets.OWCM { /// <summary> /// Disassociates a node from an AWS OpsWorks CM server, and removes the node from the /// server's managed nodes. After a node is disassociated, the node key pair is no longer /// valid for accessing the configuration manager's API. For more information about how /// to associate a node, see <a>AssociateNode</a>. /// /// /// <para> /// A node can can only be disassociated from a server that is in a <code>HEALTHY</code> /// state. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> /// is thrown when the server does not exist. A <code>ValidationException</code> is raised /// when parameters of the request are not valid. /// </para> /// </summary> [Cmdlet("Remove", "OWCMNode", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.High)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS OpsWorksCM DisassociateNode API operation.", Operation = new[] {"DisassociateNode"}, SelectReturnType = typeof(Amazon.OpsWorksCM.Model.DisassociateNodeResponse))] [AWSCmdletOutput("System.String or Amazon.OpsWorksCM.Model.DisassociateNodeResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.OpsWorksCM.Model.DisassociateNodeResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class RemoveOWCMNodeCmdlet : AmazonOpsWorksCMClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter EngineAttribute /// <summary> /// <para> /// Amazon.OpsWorksCM.Model.DisassociateNodeRequest.EngineAttributes /// </para> /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("EngineAttributes")] public Amazon.OpsWorksCM.Model.EngineAttribute[] EngineAttribute { get; set; } #endregion #region Parameter NodeName /// <summary> /// <para> /// <para>The name of the client node. </para> /// </para> /// </summary> #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 NodeName { get; set; } #endregion #region Parameter ServerName /// <summary> /// <para> /// <para>The name of the server from which to disassociate the node. </para> /// </para> /// </summary> #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 ServerName { get; set; } #endregion #region Parameter Select /// <summary> /// Use the -Select parameter to control the cmdlet output. The default value is 'NodeAssociationStatusToken'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorksCM.Model.DisassociateNodeResponse). /// Specifying the name of a property of type Amazon.OpsWorksCM.Model.DisassociateNodeResponse will result in that property being returned. /// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. /// </summary> [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public string Select { get; set; } = "NodeAssociationStatusToken"; #endregion #region Parameter PassThru /// <summary> /// Changes the cmdlet behavior to return the value passed to the ServerName parameter. /// The -PassThru parameter is deprecated, use -Select '^ServerName' instead. This parameter will be removed in a future version. /// </summary> [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ServerName' 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 /// <summary> /// This parameter overrides confirmation prompts to force /// the cmdlet to continue its operation. This parameter should always /// be used with caution. /// </summary> [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.ServerName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Remove-OWCMNode (DisassociateNode)")) { 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<Amazon.OpsWorksCM.Model.DisassociateNodeResponse, RemoveOWCMNodeCmdlet>(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.ServerName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.EngineAttribute != null) { context.EngineAttribute = new List<Amazon.OpsWorksCM.Model.EngineAttribute>(this.EngineAttribute); } context.NodeName = this.NodeName; #if MODULAR if (this.NodeName == null && ParameterWasBound(nameof(this.NodeName))) { WriteWarning("You are passing $null as a value for parameter NodeName 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.ServerName = this.ServerName; #if MODULAR if (this.ServerName == null && ParameterWasBound(nameof(this.ServerName))) { WriteWarning("You are passing $null as a value for parameter ServerName 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.OpsWorksCM.Model.DisassociateNodeRequest(); if (cmdletContext.EngineAttribute != null) { request.EngineAttributes = cmdletContext.EngineAttribute; } if (cmdletContext.NodeName != null) { request.NodeName = cmdletContext.NodeName; } if (cmdletContext.ServerName != null) { request.ServerName = cmdletContext.ServerName; } 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.OpsWorksCM.Model.DisassociateNodeResponse CallAWSServiceOperation(IAmazonOpsWorksCM client, Amazon.OpsWorksCM.Model.DisassociateNodeRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS OpsWorksCM", "DisassociateNode"); try { #if DESKTOP return client.DisassociateNode(request); #elif CORECLR return client.DisassociateNodeAsync(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 List<Amazon.OpsWorksCM.Model.EngineAttribute> EngineAttribute { get; set; } public System.String NodeName { get; set; } public System.String ServerName { get; set; } public System.Func<Amazon.OpsWorksCM.Model.DisassociateNodeResponse, RemoveOWCMNodeCmdlet, object> Select { get; set; } = (response, cmdlet) => response.NodeAssociationStatusToken; } } }