/******************************************************************************* * 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.Lightsail; using Amazon.Lightsail.Model; namespace Amazon.PowerShell.Cmdlets.LS { /// /// Attaches one or more Lightsail instances to a load balancer. /// /// /// /// After some time, the instances are attached to the load balancer and the health check /// status is available. /// /// The attach instances to load balancer operation supports tag-based access /// control via resource tags applied to the resource identified by load balancer /// name. For more information, see the Lightsail /// Developer Guide. /// /// [Cmdlet("Add", "LSInstancesToLoadBalancer", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.Lightsail.Model.Operation")] [AWSCmdlet("Calls the Amazon Lightsail AttachInstancesToLoadBalancer API operation.", Operation = new[] {"AttachInstancesToLoadBalancer"}, SelectReturnType = typeof(Amazon.Lightsail.Model.AttachInstancesToLoadBalancerResponse))] [AWSCmdletOutput("Amazon.Lightsail.Model.Operation or Amazon.Lightsail.Model.AttachInstancesToLoadBalancerResponse", "This cmdlet returns a collection of Amazon.Lightsail.Model.Operation objects.", "The service call response (type Amazon.Lightsail.Model.AttachInstancesToLoadBalancerResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class AddLSInstancesToLoadBalancerCmdlet : AmazonLightsailClientCmdlet, IExecutor { #region Parameter InstanceName /// /// /// An array of strings representing the instance name(s) you want to attach to your load /// balancer.An instance must be running before you can attach it to your load balancer.There are no additional limits on the number of instances you can attach to your load /// balancer, aside from the limit of Lightsail instances you can create in your account /// (20). /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("InstanceNames")] public System.String[] InstanceName { get; set; } #endregion #region Parameter LoadBalancerName /// /// /// The name of the load balancer. /// /// #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 LoadBalancerName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Operations'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.AttachInstancesToLoadBalancerResponse). /// Specifying the name of a property of type Amazon.Lightsail.Model.AttachInstancesToLoadBalancerResponse 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; } = "Operations"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the LoadBalancerName parameter. /// The -PassThru parameter is deprecated, use -Select '^LoadBalancerName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^LoadBalancerName' 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.LoadBalancerName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Add-LSInstancesToLoadBalancer (AttachInstancesToLoadBalancer)")) { 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.LoadBalancerName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.InstanceName != null) { context.InstanceName = new List(this.InstanceName); } #if MODULAR if (this.InstanceName == null && ParameterWasBound(nameof(this.InstanceName))) { WriteWarning("You are passing $null as a value for parameter InstanceName 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.LoadBalancerName = this.LoadBalancerName; #if MODULAR if (this.LoadBalancerName == null && ParameterWasBound(nameof(this.LoadBalancerName))) { WriteWarning("You are passing $null as a value for parameter LoadBalancerName 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.Lightsail.Model.AttachInstancesToLoadBalancerRequest(); if (cmdletContext.InstanceName != null) { request.InstanceNames = cmdletContext.InstanceName; } if (cmdletContext.LoadBalancerName != null) { request.LoadBalancerName = cmdletContext.LoadBalancerName; } 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.Lightsail.Model.AttachInstancesToLoadBalancerResponse CallAWSServiceOperation(IAmazonLightsail client, Amazon.Lightsail.Model.AttachInstancesToLoadBalancerRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lightsail", "AttachInstancesToLoadBalancer"); try { #if DESKTOP return client.AttachInstancesToLoadBalancer(request); #elif CORECLR return client.AttachInstancesToLoadBalancerAsync(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 InstanceName { get; set; } public System.String LoadBalancerName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Operations; } } }